Merge pull request #248 from salesforcecli/sm/one-configAggregator

Sm/one config aggregator

Author: mshanemc

.github/workflows/onPushToMain.yml

@@ -3,12 +3,18 @@ name: version, tag and github release
 
 on:
   push:
-    branches: [main]
+    branches:
+      - main
+      - prerelease/*
+    tags-ignore:
+      - '*'
 
 jobs:
   release:
     uses: salesforcecli/github-workflows/.github/workflows/githubRelease.yml@main
     secrets: inherit
+    with:
+      prerelease: ${{ github.ref_name != 'main' }}
 
   # most repos won't use this
   # depends on previous job to avoid git collisions, not for any functionality reason

.github/workflows/onRelease.yml

@@ -2,7 +2,7 @@ name: publish
 
 on:
   release:
-    types: [released]
+    types: [published]
   # support manual release in case something goes wrong and needs to be repeated or tested
   workflow_dispatch:
     inputs:
@@ -11,11 +11,21 @@ on:
         type: string
         required: true
 jobs:
+  getDistTag:
+    outputs:
+      tag: ${{ steps.distTag.outputs.tag }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.release.tag_name || inputs.tag  }}
+      - uses: salesforcecli/github-workflows/.github/actions/getPreReleaseTag@main
+        id: distTag
+
   npm:
     uses: salesforcecli/github-workflows/.github/workflows/npmPublish.yml@main
+    needs: [getDistTag]
     with:
-      ctc: true
-      sign: true
-      tag: latest
+      tag: ${{ needs.getDistTag.outputs.tag || 'latest' }}
       githubTag: ${{ github.event.release.tag_name || inputs.tag }}
     secrets: inherit

CHANGELOG.md

@@ -6,8 +6,8 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^2.8.2",
-    "@salesforce/core": "^3.34.6",
-    "@salesforce/sf-plugins-core": "^2.2.4",
+    "@salesforce/core": "^3.35.0",
+    "@salesforce/sf-plugins-core": "^2.3.0",
     "fast-levenshtein": "^3.0.0",
     "tslib": "^2"
   },
@@ -19,6 +19,7 @@
     "@salesforce/dev-scripts": "^4.3.0",
     "@salesforce/kit": "^1.8.5",
     "@salesforce/plugin-command-reference": "^2.2.8",
+    "@salesforce/plugin-deploy-retrieve": "^1.8.14",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.4.4",
     "@salesforce/ts-types": "^1.7.1",
@@ -86,7 +87,8 @@
     "devPlugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-command-snapshot",
-      "@salesforce/plugin-command-reference"
+      "@salesforce/plugin-command-reference",
+      "@salesforce/plugin-deploy-retrieve"
     ],
     "topics": {
       "config": {
@@ -113,6 +115,7 @@
     "reformat": "prettier --config .prettierrc --write './*.{js,json,md}' './**/*.{ts,json,md}'",
     "test": "wireit",
     "test:nuts": "nyc mocha \"test/**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --jobs 20",
+    "test:nuts:config": "nyc mocha \"test/**/config/**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --jobs 20",
     "test:only": "wireit",
     "version": "oclif readme"
   },
@@ -224,4 +227,4 @@
       "output": []
     }
   }
-}
+}

package.json

@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { Flags, loglevel } from '@salesforce/sf-plugins-core';
-import { ConfigAggregator, Messages, SfdxConfigAggregator } from '@salesforce/core';
+import { ConfigAggregator, Messages } from '@salesforce/core';
 import { ConfigCommand, ConfigResponses, CONFIG_HELP_SECTION } from '../../config';
 
 Messages.importMessagesDirectory(__dirname);
@@ -29,9 +29,6 @@ export class Get extends ConfigCommand<ConfigResponses> {
 
   public async run(): Promise<ConfigResponses> {
     const { argv, flags } = await this.parse(Get);
-    // instantiate a SfdxConfigAggregator to get the restDeploy <-> org-metadata-rest-deploy deprecation linked
-    await SfdxConfigAggregator.create({});
-
     if (!argv || argv.length === 0) {
       throw messages.createError('error.NoConfigKeysFound');
     }
@@ -40,25 +37,10 @@ export class Get extends ConfigCommand<ConfigResponses> {
 
     for (const configName of argv as string[]) {
       try {
-        this.pushSuccess(aggregator.getInfo(configName, true));
+        this.pushSuccess(aggregator.getInfo(configName));
       } catch (err) {
         const error = err as Error;
-        if (error.message.includes('Deprecated config name')) {
-          // because we've caught the deprecated error, the 'newKey' property will be set
-          const info = aggregator.getInfo(aggregator.getPropertyMeta(configName).newKey as string);
-          // deprecated key, so we'll get the replacement and return the value
-          this.responses.push({
-            name: info.key,
-            key: configName,
-            value: info.value as string,
-            deprecated: true,
-            location: info.location,
-            path: info.path,
-            error,
-            message: error.message,
-            success: true,
-          });
-        } else if (error.name.includes('UnknownConfigKeyError') && !this.jsonEnabled()) {
+        if (error.name.includes('UnknownConfigKeyError') && !this.jsonEnabled()) {
           const suggestion = this.calculateSuggestion(configName);
           // eslint-disable-next-line no-await-in-loop
           const answer = (await this.confirm(messages.getMessage('didYouMean', [suggestion]), 10 * 1000)) ?? false;

src/commands/config/get.ts

@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { ConfigAggregator, Messages, SfdxConfigAggregator } from '@salesforce/core';
+import { ConfigAggregator, Messages } from '@salesforce/core';
 import { loglevel } from '@salesforce/sf-plugins-core';
 import { ConfigCommand, ConfigResponses } from '../../config';
 
@@ -20,7 +20,6 @@ export default class List extends ConfigCommand<ConfigResponses> {
   public static flags = { loglevel };
 
   public async run(): Promise<ConfigResponses> {
-    await SfdxConfigAggregator.create({});
     const aggregator = await ConfigAggregator.create();
 
     aggregator.getConfigInfo().forEach((c) => {

src/commands/config/list.ts

@@ -6,7 +6,7 @@
  */
 
 import { parseVarArgs, Flags, loglevel } from '@salesforce/sf-plugins-core';
-import { Config, Messages, Org, SfError, OrgConfigProperties, SfdxConfigAggregator } from '@salesforce/core';
+import { Config, Messages, Org, SfError, OrgConfigProperties } from '@salesforce/core';
 import { CONFIG_HELP_SECTION, ConfigCommand, Msg } from '../../config';
 
 Messages.importMessagesDirectory(__dirname);
@@ -42,7 +42,10 @@ export class Set extends ConfigCommand<SetConfigCommandResult> {
 
     for (const name of Object.keys(parsed)) {
       const value = parsed[name] as string;
+      let resolvedName = name;
       try {
+        // this needs to be inside the try/catch because it can throw an error
+        resolvedName = this.configAggregator.getPropertyMeta(name)?.newKey ?? name;
         if (!value) {
           // Push a failure if users are try to unset a value with `set=`.
           this.pushFailure(name, messages.createError('error.ValueRequired'), value);
@@ -51,36 +54,13 @@ export class Set extends ConfigCommand<SetConfigCommandResult> {
           // currently no way to validate an org synchronously. Therefore, we have to manually
           // validate the org here and manually set the error message if it fails
           // eslint-disable-next-line no-await-in-loop
-          if (isOrgKey(name) && value) await validateOrg(value);
-          config.set(name, value);
-          this.setResponses.successes.push({ name, value, success: true });
+          if (isOrgKey(resolvedName) && value) await validateOrg(value);
+          config.set(resolvedName, value);
+          this.setResponses.successes.push({ name: resolvedName, value, success: true });
         }
       } catch (err) {
         const error = err as Error;
-        if (error.name === 'DeprecatedConfigKeyError') {
-          const newKey = Config.getPropertyConfigMeta(name)?.key ?? name;
-          try {
-            config.set(newKey, value);
-            this.setResponses.successes.push({
-              name,
-              value,
-              success: true,
-              error,
-              message: error.message.replace(/\.\.$/, '.'),
-            });
-          } catch (e) {
-            const secondError = e as Error;
-            // if that deprecated value was also set to an invalid value
-            this.setResponses.failures.push({
-              name,
-              key: name,
-              success: false,
-              value,
-              error: secondError,
-              message: secondError.message.replace(/\.\.$/, '.'),
-            });
-          }
-        } else if (error.name.includes('UnknownConfigKeyError')) {
+        if (error.name.includes('UnknownConfigKeyError')) {
           if (this.jsonEnabled()) {
             process.exitCode = 1;
             this.setResponses.failures.push({
@@ -101,7 +81,7 @@ export class Set extends ConfigCommand<SetConfigCommandResult> {
             }
           }
         } else {
-          this.pushFailure(name, err as Error, value);
+          this.pushFailure(resolvedName, err as Error, value);
         }
       }
     }
@@ -128,7 +108,6 @@ export class Set extends ConfigCommand<SetConfigCommandResult> {
 
 const loadConfig = async (global: boolean): Promise<Config> => {
   try {
-    await SfdxConfigAggregator.create({});
     const config = await Config.create(Config.getDefaultOptions(global));
     await config.read();
     return config;

src/commands/config/set.ts

@@ -6,7 +6,7 @@
  */
 
 import { Flags, loglevel } from '@salesforce/sf-plugins-core';
-import { Config, Messages, SfdxConfigAggregator, SfError } from '@salesforce/core';
+import { Config, Messages, SfError } from '@salesforce/core';
 import { CONFIG_HELP_SECTION, ConfigCommand } from '../../config';
 import { SetConfigCommandResult } from './set';
 
@@ -32,7 +32,6 @@ export class UnSet extends ConfigCommand<SetConfigCommandResult> {
 
   public async run(): Promise<SetConfigCommandResult> {
     const { argv, flags } = await this.parse(UnSet);
-    await SfdxConfigAggregator.create({});
 
     if (!argv || argv.length === 0) {
       throw messages.createError('error.NoConfigKeysFound');
@@ -42,20 +41,12 @@ export class UnSet extends ConfigCommand<SetConfigCommandResult> {
     await config.read();
     for (const key of argv as string[]) {
       try {
-        config.unset(key);
-        this.unsetResponses.successes.push({ name: key, success: true });
+        const resolvedName = this.configAggregator.getPropertyMeta(key)?.newKey ?? key;
+        config.unset(resolvedName);
+        this.unsetResponses.successes.push({ name: resolvedName, success: true });
       } catch (err) {
         const error = err as Error;
-        if (error.message.includes('Deprecated config name')) {
-          const meta = Config.getPropertyConfigMeta(key);
-          config.unset(meta?.key ?? key);
-          this.unsetResponses.successes.push({
-            name: key,
-            success: true,
-            error,
-            message: error.message.replace(/\.\.$/, '.'),
-          });
-        } else if (error.name.includes('UnknownConfigKeyError') && !this.jsonEnabled()) {
+        if (error.name.includes('UnknownConfigKeyError') && !this.jsonEnabled()) {
           const suggestion = this.calculateSuggestion(key);
           // eslint-disable-next-line no-await-in-loop
           const answer = (await this.confirm(messages.getMessage('didYouMean', [suggestion]), 10 * 1000)) ?? false;

src/commands/config/unset.ts

@@ -51,6 +51,7 @@ export abstract class ConfigCommand<T> extends SfCommand<T> {
       name: configInfo.key,
       key: configInfo.key,
       value: configInfo.value as string | undefined,
+      path: configInfo.path,
       success: true,
       location: configInfo.location,
     });

src/config.ts

@@ -19,6 +19,7 @@ describe('alias list NUTs', () => {
   before(async () => {
     session = await TestSession.create({
       project: { name: 'aliasListNUTs' },
+      devhubAuthStrategy: 'NONE',
     });
   });