Intent

This PR introduces a configuration option to disable the use of the KeyRing for credential storage and instead use the file system. This is extremely useful for development as well as a good escape hatch for customers who may not have a working KeyRing environment (or preference there-towards).

Resolves #2519

Type of Change

• • Bug Fix
• • New Feature
• • Breaking Change
• • Documentation
• • Refactor
• • Tooling

Approach

I first added a new configuration option for the publisher extension, which is enabled by default:

I then added a corresponding command line option for the agent. This was a more straightforward change than passing the option for every credential-related call. The impact of this decision is that the user must restart the extension after changing the configuration setting. Since this won't be very common, I believe this was a reasonable optimization to keep the complexity low.

$(just executable-path) ui -h
Usage: publisher ui [<path>] [flags]

Arguments:
  [<path>]    Sets the current working directory for the agent.

Flags:
  -h, --help                  Show context-sensitive help.
  -v, --verbose               Enable verbose logging. Use -vv or --verbose=2 for debug logging.

      --listen=HOST[:PORT]    Network address to listen on.
      --use-keychain          Use Keychain services to store/manage credentials.

After those two changes were in place, I added a helper function within the extension to access the setting, then updated the service spawning code to reflect the current configuration value. The agent then stores that value and each time the agent's credential code initializes, it either bypasses or attempts to use the KeyChain dependency.

The agent's debug launch profile has been updated to support launching the agent with the command line set. I set the initial value to false as I found myself wanting to debug using the file-based credentials more often than the KeyChain alternative. If this is not desired by the developer, they can easily change it within their own config.

User Impact

New feature, but default maintains the behavior they had previously.

Automated Tests

Unit tests added to validate the desired behavior.

Directions for Reviewers

Launching a debug version of the extension from your VSCode instance for the extension, will work for verification. The configuration value is respected and maintained after being set, when you then reload the window with Developer: Reload Window. I'd suggest verification of the functionality by:

1. Confirm the configuration setting for the extension is set to enabled (checked). If have to change it, then reload the VSCode window
2. Activate the publisher extension and view the credentials. You should be able to confirm that your existing credentials is listed.
3. Change the configuration setting to disabled and reload the window.
4. Activate the publisher extension and view the credentials. You should either have none or whatever you had stored within the ~.connect-credentials file.
5. Add a new credential and make sure it shows up in your credential list
6. Reload the window again and make sure the credentials have remained.
7. Change the configuration setting back to enabled and reload the window
8. You should be able to validate that the original KeyChain based credentials are now shown.

Checklist

• I have updated CHANGELOG.md to cover notable changes.