Actions/Custom Variables/Profiles overhaul

[sebjulliand]

Fixes #2618
Fixes #1451

Changes

This PR introduce a new Context view as a replacement to the Connection Profiles view.
It is intended to enhance the user experience regarding the management of Actions, Custom Variables and Profiles.

It also introduces a new CustomEditor class that works like CustomUI but allows to open custom editors instead of custom panels.

Actions

Actions are regrouped in three local categories, always displayed:

• Member actions
• Object actions
• Streamfile actions

Optionally, there will be additional categories for each workspace declaring local actions (in a local .vscode/actions.json file). These categories are named after the workspace they come from.

The actions available at the Actions node level are:

• Create a new action

• Setup local actions

• Search actions

  • Enables the user to search for actions by their name and command. Each matching action is highlighted in yellow and its description shows search match.
  

• Go to next search result

  • Gives focus in the list on the next item that matched the search

• Clear search results

Creating a new action is also available on each Action Type node.

Clicking on an action opens the action editor. Making a change to the action will make the editor dirty and saving the action is done like in any editor, using Save (ctrl+s). The action panel was simply turned into an editor.

Right-clicking on an action gives access to these options:

Standard actions and local actions are managed the same way in the UI; they are saved in the connection settings or in the local workspace file depending on their nature.

When an editor is open, an inline action is available on each action to run it on the active editor:

Checking of the action can run on the active editor is done when the action is executed.

Custom Variables

Each variable declared in the current connection settings are listed here and can be created/changed/deleted from this view.

Clicking on variable lets you change its value.

Profiles

Command profiles and Connection profiles have been merged - a process will run when the extension starts to create profiles out of existing Command profiles and show a dialog to warn the user the Command profiles have been migrated.

Profiles can be created from the Profiles node using one of these inline actions:

• Create an empty profile
  • Asks for the name of the new profile then opens the profile editor.
• Create a new profile from the current settings
  • Asks for the name of the new profile then shows a notification to switch to it.
  

Clicking on a profile opens the Profile editor that lets the user change some of the profile settings - object filters, IFS shortcuts and Custom variables are simply listed:

Right-clicking on a profile gives access to these options:

Activating a profile is done using the related inline action on the profile:

Activating a profile will replace the current settings with the profile's. Before the settings are replaced, they are saved back into the profile they belong to, or into the default profile if no profile was active (default profile is a unique profile with no name). This allows to automatically save the profile state before it gets erased.

The active profile is shown in green in the list, and it can't be deleted:

Its name is shown in the context description as well:

Switching back to the default profile is done using the action that appears on the Profiles node inline actions:

When a profile has a Library List Command (formerly a Command Profile), that command is ran and the library list is computed from it when the profile is activated. That operation can be re-run after the profile is made active by clicking the inline action on the profile item (the action only shows up if that profile has a library list command):

How to test this PR

1. Create, edit, delete, rename, run actions
   a. Try generating local actions and make sure they are managed correctly in the local file
2. Create, edit, delete, rename variables
3. Create, edit, delete, rename, profiles
   a. Make sure custom variables are saved on the profile
   b. Make sure settings are correctly saved into the profile so they don't get lost when re-activating it
   c. Make sure the UI is consistent with the profile's content (views must be refreshed, etc)
4. Try actions described in the PR 😅

Checklist

• have tested my change
• updated relevant documentation

[github-actions]

👋 A new build is available for this PR based on c9fc476.

• Download here.
• Read more about how to test

[worksofliam]

Initial review :)

[worksofliam]

Personally I am not sure how I feel about the 'unload' being the refresh icon:

[github-actions]

👋 A new build is available for this PR based on f995092.

• Download here.
• Read more about how to test

[sebjulliand]

Personally I am not sure how I feel about the 'unload' being the refresh icon:

I reused what your past self picked 😅

But I agree this may be confusing. How about arrow-circle-left since arrow-circle-right is used to activate the profiles?

[github-actions]

👋 A new build is available for this PR based on 744abdd.

• Download here.
• Read more about how to test

[chrjorgensen]

@sebjulliand As you know, I'm currently traveling, so I haven't got the time for a thorough review but just played around a little.

Nice work, which will simplify the concept of profiles. 👍

Two comments:

1. After creating a new profile and copying a command, the context view is not refreshed and I didn't see the new command until a manual refresh.
2. Could we have the active profile attached to the connection name in the status bar, like "System (profile)"?

[sebjulliand]

Thanks for having a look @chrjorgensen !

I fixed the refresh issue and added the profile name in the status bar (unless it's the default profile being used).

[SanjulaGanepola]

@sebjulliand I was a bit busy this week so I didn't get a chance to take a look at this PR yet. I will have a look next week!

[sebjulliand]

@sebjulliand I was a bit busy this week so I didn't get a chance to take a look at this PR yet. I will have a look next week!

Much appreciated @SanjulaGanepola , thanks a lot !

[SanjulaGanepola]

@sebjulliand After doing some initial testing, I noticed a couple issues (commented below). I still plan on reviewing the code changes more in-depth.

One question: How did you get the name Context view? I am fine with calling it that, but here are also some other names I just thought could make sense: Environment Manager or Configuration Browser (not sure if this one could be confusing tho since VS Code settings are also referred to as configurations). Just throwing out ideas. What do you think?

But I agree this may be confusing. How about arrow-circle-left since arrow-circle-right is used to activate the profiles?

I also agree that the refresh icon is a bit confusing. How about sign-in and sign-out?

[SanjulaGanepola]

Shall we also link these issues:

• Auto save profile when switching profiles #1451
• Flesh out the Profiles feature with some "simple" functionality #2618

Looks like you have most of those requests covered here in this PR!

[chrjorgensen]

Also want to add my 2c... 😄

One question: How did you get the name Context view? I am fine with calling it that, but here are also some other names I just thought could make sense: Environment Manager or Configuration Browser (not sure if this one could be confusing tho since VS Code settings are also referred to as configurations). Just throwing out ideas. What do you think?

But I agree this may be confusing. How about arrow-circle-left since arrow-circle-right is used to activate the profiles?

I also agree that the refresh icon is a bit confusing. How about sign-in and sign-out?

I agree that Context is not the best name, it's used for many different things. I like what @SanjulaGanepola propose, maybe just shorten it down to Environment?

And for the icons, I propose having the chevron-left icon to leave the environment and the chevron-right icon to enter a environment...

[sebjulliand]

Thank you @SanjulaGanepola , @chrjorgensen ! I'll look into that.
I initially came up with the Context name for the view because this is how I mention it when I talk about the profiles, custom variables, library list...it's the 'current context'. But I like the idea of calling it Environment instead, so let's roll with that.

As for the icon, I like sign-in/out, but I'll give a try to both sign-x and chevron-x and see how it looks.

[sebjulliand]

Back at you folks, I updated the icons and fixed the reported issues.
I also added additional checks so actions and profiles can't be renamed/deleted while being edited.