fix: remove deprecated sfdx-core references (#562)

* fix: remove deprecated core aliasAccessor methods * test: alias nuts don't expect consistent order of aliases * refactor: share error handler * chore: rename from pr feedback
salesforcecli · Apr 2, 2024 · 70a36ac · 70a36ac
1 parent cbc7a0c
commit 70a36ac
Show file tree

Hide file tree

Showing 12 changed files with 335 additions and 329 deletions.
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^3.20.0",
+    "@oclif/core": "^3.26.0",
     "@salesforce/core": "^6.7.3",
     "@salesforce/sf-plugins-core": "^8.0.2",
     "fast-levenshtein": "^3.0.0"
@@ -15,9 +15,8 @@
     "@oclif/test": "^3.2.8",
     "@salesforce/cli-plugins-testkit": "^5.1.13",
     "@salesforce/dev-scripts": "^8.4.2",
-    "@salesforce/kit": "^3.0.15",
     "@salesforce/plugin-command-reference": "^3.0.73",
-    "@salesforce/plugin-deploy-retrieve": "^1.20.3",
+    "@salesforce/plugin-deploy-retrieve": "^3.5.2",
     "@salesforce/ts-sinon": "^1.4.17",
     "@types/fast-levenshtein": "^0.0.4",
     "eslint-plugin-sf-plugin": "^1.17.4",

diff --git a/src/alias.ts b/src/alias.ts
@@ -49,3 +49,13 @@ export abstract class AliasCommand<T> extends SfCommand<T> {
     this.table(results, columns, { title, 'no-truncate': true });
   }
 }
+
+export const aliasErrorHandler = (err: unknown, alias: string, value?: string): AliasResult => {
+  const { name, message } =
+    err instanceof Error
+      ? err
+      : typeof err === 'string'
+      ? new Error(err)
+      : { name: 'UnknownError', message: 'Unknown Error' };
+  return { alias, success: false, error: { name, message }, value };
+};
diff --git a/src/commands/alias/set.ts b/src/commands/alias/set.ts
@@ -7,7 +7,7 @@
 
 import { loglevel, parseVarArgs } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
-import { AliasCommand, AliasResults } from '../../alias.js';
+import { AliasCommand, AliasResults, aliasErrorHandler } from '../../alias.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'alias.set');
@@ -31,28 +31,22 @@ export default class AliasSet extends AliasCommand<AliasResults> {
 
     const parsed = parseVarArgs(args, argv as string[]);
 
-    const results = Object.entries(parsed).map(([alias, value]) => {
-      try {
-        // to support plugin-settings in sfdx, which allowed setting an alias to undefined, when that happens we'll unset the alias
-        // which is what the user wants
-        if (!value) {
-          stateAggregator.aliases.unset(alias);
-        } else {
-          stateAggregator.aliases.set(alias, value);
+    const results = await Promise.all(
+      Object.entries(parsed).map(async ([alias, value]) => {
+        try {
+          // to support plugin-settings in sfdx, which allowed setting an alias to undefined, when that happens we'll unset the alias
+          // which is what the user wants
+          if (!value) {
+            await stateAggregator.aliases.unsetAndSave(alias);
+          } else {
+            await stateAggregator.aliases.setAndSave(alias, value);
+          }
+          return { alias, success: true, value };
+        } catch (err) {
+          return aliasErrorHandler(err, alias, value);
         }
-        return { alias, success: true, value };
-      } catch (err) {
-        const { name, message } =
-          err instanceof Error
-            ? err
-            : typeof err === 'string'
-            ? new Error(err)
-            : { name: 'UnknownError', message: 'Unknown Error' };
-        return { alias, success: false, error: { name, message }, value };
-      }
-    });
-
-    await stateAggregator.aliases.write();
+      })
+    );
 
     this.output('Alias Set', results);
 

diff --git a/src/commands/alias/unset.ts b/src/commands/alias/unset.ts
@@ -7,7 +7,7 @@
 
 import { Flags, loglevel } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
-import { AliasCommand, AliasResults } from '../../alias.js';
+import { AliasCommand, AliasResults, aliasErrorHandler } from '../../alias.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'alias.unset');
@@ -57,24 +57,20 @@ export default class AliasUnset extends AliasCommand<AliasResults> {
       return [];
     }
 
-    const results = toRemove.map((alias) => {
-      // We will log the value in the output in case an alias was unset by mistake.
-      const value = aliases[alias];
-      try {
-        stateAggregator.aliases.unset(alias);
-        return { alias, value, success: true };
-      } catch (err) {
-        const { name, message } =
-          err instanceof Error
-            ? err
-            : typeof err === 'string'
-            ? new Error(err)
-            : { name: 'UnknownError', message: 'Unknown Error' };
-        return { alias, value, success: false, error: { name, message } };
-      }
-    });
-
-    await stateAggregator.aliases.write();
+    const results = await Promise.all(
+      toRemove
+        // We will log the value in the output in case an alias was unset by mistake.
+        .map((alias) => ({ alias, value: aliases[alias] }))
+        .map(async ({ alias, value }) => {
+          try {
+            // safe to parallelize because of file locking
+            await stateAggregator.aliases.unsetAndSave(alias);
+            return { alias, value, success: true };
+          } catch (err) {
+            return aliasErrorHandler(err, alias, value);
+          }
+        })
+    );
 
     this.output('Alias Unset', results);
 

diff --git a/test/commands/alias/list.nut.ts b/test/commands/alias/list.nut.ts
@@ -76,7 +76,8 @@ describe('alias list NUTs', () => {
 
     it('lists multiple results correctly JSON', () => {
       const result = execCmd('alias list --json', { ensureExitCode: 0 }).jsonOutput?.result;
-      expect(result).to.deep.equal([
+      expect(result).lengthOf(3);
+      [
         {
           alias: 'DevHub',
           value: '[email protected]',
@@ -89,7 +90,7 @@ describe('alias list NUTs', () => {
           alias: 'user',
           value: '[email protected]',
         },
-      ]);
+      ].map((expected) => expect(result).to.deep.include(expected));
     });
 
     it('lists multiple results correctly stdout', () => {

diff --git a/test/commands/alias/list.test.ts b/test/commands/alias/list.test.ts
@@ -4,7 +4,6 @@
  * 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 { expect, test } from '@oclif/test';
 import { TestContext } from '@salesforce/core/lib/testSetup.js';
 

diff --git a/test/commands/alias/unset.nut.ts b/test/commands/alias/unset.nut.ts
@@ -68,8 +68,8 @@ describe('alias unset NUTs', () => {
       ]);
 
       const res = execCmd<AliasResults>('alias list --json', { ensureExitCode: 0 }).jsonOutput?.result;
-
-      expect(res).to.deep.equal([
+      expect(res).lengthOf(2);
+      [
         {
           alias: 'Admin',
           value: '[email protected]',
@@ -78,7 +78,7 @@ describe('alias unset NUTs', () => {
           alias: 'user',
           value: '[email protected]',
         },
-      ]);
+      ].map((expected) => expect(res).to.deep.include(expected));
     });
 
     it('alias unset DevHub', () => {
@@ -118,8 +118,8 @@ describe('alias unset NUTs', () => {
 
     it('alias unset --json', () => {
       const result = execCmd('alias unset DevHub user --json', { ensureExitCode: 0 }).jsonOutput?.result;
-
-      expect(result).to.deep.equal([
+      expect(result).lengthOf(2);
+      [
         {
           alias: 'DevHub',
           success: true,
@@ -130,7 +130,7 @@ describe('alias unset NUTs', () => {
           success: true,
           value: '[email protected]',
         },
-      ]);
+      ].map((expected) => expect(result).to.deep.include(expected));
 
       const res = execCmd('alias list --json', { ensureExitCode: 0 }).jsonOutput?.result;
 
@@ -155,8 +155,8 @@ describe('alias unset NUTs', () => {
 
     it('removes all aliases when passing --all', () => {
       const result = execCmd('alias unset --all --no-prompt --json', { ensureExitCode: 0 }).jsonOutput?.result;
-
-      expect(result).to.deep.equal([
+      expect(result).lengthOf(3);
+      [
         {
           alias: 'Admin',
           success: true,
@@ -172,7 +172,7 @@ describe('alias unset NUTs', () => {
           success: true,
           value: '[email protected]',
         },
-      ]);
+      ].map((expected) => expect(result).to.deep.include(expected));
 
       const res = execCmd('alias list --json', { ensureExitCode: 0 }).jsonOutput?.result;
 

diff --git a/test/commands/sfdx/config/get.nut.ts b/test/commands/sfdx/config/get.nut.ts
@@ -12,7 +12,7 @@ chaiConfig.truncateThreshold = 0;
 
 describe('config:get NUTs', async () => {
   testSession = await TestSession.create({
-    project: { name: 'configGetNUTs' },
+    project: { name: 'configGetNUTs-sfdx' },
     devhubAuthStrategy: 'NONE',
   });
 

diff --git a/test/commands/sfdx/config/list.nut.ts b/test/commands/sfdx/config/list.nut.ts
@@ -12,7 +12,7 @@ let testSession: TestSession;
 
 describe('config:list NUTs', async () => {
   testSession = await TestSession.create({
-    project: { name: 'configListNUTs' },
+    project: { name: 'configListNUTs-sfdx' },
     devhubAuthStrategy: 'NONE',
   });
   describe('config:list with no configs set', () => {

diff --git a/test/commands/sfdx/config/set.nut.ts b/test/commands/sfdx/config/set.nut.ts
@@ -84,7 +84,7 @@ function verifyKeysAndValuesStdout(key: string, value: string | boolean, asserti
 
 describe('config:set NUTs', async () => {
   testSession = await TestSession.create({
-    project: { name: 'configSetNUTs' },
+    project: { name: 'configSetNUTs-sfdx' },
     devhubAuthStrategy: 'NONE',
   });
 

diff --git a/test/commands/sfdx/config/unset.nut.ts b/test/commands/sfdx/config/unset.nut.ts
@@ -11,7 +11,7 @@ let testSession: TestSession;
 
 describe('config:unset NUTs', async () => {
   testSession = await TestSession.create({
-    project: { name: 'configUnsetNUTs' },
+    project: { name: 'configUnsetNUTs-sfdx' },
   });
 
   describe('config:unset without keys', () => {