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 47af944.

• 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

[sebjulliand]

Found the issue...creating a variable and escaping the value prompt would create a variable with undefined value. I fixed that and also prevented loading undefined variable values, just to be safe.

Looks like there is an issue with the library list validation (maybe unrelated to the specific changes in this PR?) where it complains about the wrong library not existing. In the example below SANJULA exists, but not SANJULA1:
image

I couldn't reproduce this one. Since it pass the library list onto content.validateLibraryList, could you check your Code for i output after you see that dialog with the wrong library being reported? Since the name is valid, I assume that liblist is reporting something weird.

Should we do the same for Copy?

I don't think so. Copy will not break the configuration or create unexpected results if run on an item being edited.

[sebjulliand]

Thanks again for your review and your suggestions @SanjulaGanepola 😄
I did my best to fix the few remaining quirks and enhance the view based on your suggestions.

Here goes:

• Added icons for nodes
• Highlight in blue actions that can run on the active editor
  • Highlighted in green instead if it's a search match
  • Run action on editor inline action only active if the action is highlighted
• Fixed the library list command not being saved after unloading a profile
• Actions node refreshes itself whenever a local actions file is changed
• Launch Workspace Actions Setup... will now offer to Append to the existing local actions, appending an index to the new action names to prevent duplicates

Back at you for a (hopefully) final review 😅 Thanks!

[SanjulaGanepola]

I couldn't reproduce this one. Since it pass the library list onto content.validateLibraryList, could you check your Code for i output after you see that dialog with the wrong library being reported? Since the name is valid, I assume that liblist is reporting something weird.

Found the problem with the library list -> In the screenshot below, SANJULA exists and SANJULA1 doesn't, but SANJULA is still found in the string so it complains about it:

Found another issue -> If you make some changes to a profile (ie. add/delete variables, change library list, add/delete filters) and then go to edit the profile, the contents displayed is outdated since it wasn't saved back to the profile yet. For example, the mis-matching variables below. Similar to 4bff5c3, maybe we need to apply changes back to the active profile directly?

[sebjulliand]

Thanks @SanjulaGanepola ; I sorted it out.

• Library list check is now accurate
• The profile editor will show the current config info if the profile is active
• Name are validated using a case insensitive method.

Back to you 🙏🏻

[SanjulaGanepola]

@sebjulliand Awesome! Everything is working as expected now and code changes look good. I just suggested below some minor tweaks to casing for some strings.

[sebjulliand]

Thanks you @SanjulaGanepola , your suggestions are now commited.
I'll leave the final review to you 😉

[SanjulaGanepola]

Great work!!

[sebjulliand]

Thank you @SanjulaGanepola, for your review and advices.
We can finally merge this! 🚀