Merge remote-tracking branch 'origin/main' into sm/project-type-conso…

…lidation

.github/workflows/bundle.yml

@@ -38,4 +38,4 @@ jobs:
           node scripts/build.js
       - name: Post Bundling Update
         run: |
-          node scripts/postBundlingUpdate.js
+          node scripts/postBundlingUpdate.js

.github/workflows/failureNotifications.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Announce Failure
         id: slack
-        uses: slackapi/slack-github-action@v1.24.0
+        uses: slackapi/slack-github-action@v1.26.0
         env:
           # for non-CLI-team-owned plugins, you can send this anywhere you like
           SLACK_WEBHOOK_URL: ${{ secrets.CLI_ALERTS_SLACK_WEBHOOK }}

examples/yarn.lock

@@ -370,11 +370,11 @@ brace-expansion@^2.0.1:
     balanced-match "^1.0.0"
 
 braces@~3.0.2:
-  version "3.0.2"
-  resolved "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107"
-  integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==
+  version "3.0.3"
+  resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789"
+  integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==
   dependencies:
-    fill-range "^7.0.1"
+    fill-range "^7.1.1"
 
 [email protected]:
   version "1.3.1"
@@ -762,10 +762,10 @@ figures@^3.0.0:
   dependencies:
     escape-string-regexp "^1.0.5"
 
-fill-range@^7.0.1:
-  version "7.0.1"
-  resolved "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40"
-  integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==
+fill-range@^7.1.1:
+  version "7.1.1"
+  resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292"
+  integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==
   dependencies:
     to-regex-range "^5.0.1"
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "7.3.12-qa.1",
+  "version": "7.4.1",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -83,7 +83,7 @@
     "benchmark": "^2.1.4",
     "chai-string": "^1.5.0",
     "ts-node": "^10.9.2",
-    "ts-patch": "^3.1.1",
+    "ts-patch": "^3.2.0",
     "typescript": "^5.4.5"
   },
   "repository": {

src/lifecycleEvents.ts

@@ -15,7 +15,9 @@ import { Logger } from './logger/logger';
 
 // Data of any type can be passed to the callback. Can be cast to any type that is given in emit().
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-type callback = (data: any) => Promise<void>;
+export type callback = (data: any) => Promise<void>;
+type ListenerMap = Map<string, callback>;
+export type UniqueListenerMap = Map<string, ListenerMap>;
 
 declare const global: {
   salesforceCoreLifecycle?: Lifecycle;
@@ -49,7 +51,7 @@ export class Lifecycle {
 
   private constructor(
     private readonly listeners: Dictionary<callback[]> = {},
-    private readonly uniqueListeners: Map<string, Map<string, callback>> = new Map<string, Map<string, callback>>()
+    private readonly uniqueListeners: UniqueListenerMap = new Map<string, Map<string, callback>>()
   ) {}
 
   /**
@@ -89,8 +91,11 @@ export class Lifecycle {
     ) {
       const oldInstance = global.salesforceCoreLifecycle;
       // use the newer version and transfer any listeners from the old version
-      // object spread keeps them from being references
-      global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners }, oldInstance.uniqueListeners);
+      // object spread and the clone fn keep them from being references
+      global.salesforceCoreLifecycle = new Lifecycle(
+        { ...oldInstance.listeners },
+        cloneUniqueListeners(oldInstance.uniqueListeners)
+      );
       // clean up any listeners on the old version
       Object.keys(oldInstance.listeners).map((eventName) => {
         oldInstance.removeAllListeners(eventName);
@@ -176,7 +181,7 @@ export class Lifecycle {
     if (uniqueListenerIdentifier) {
       if (!this.uniqueListeners.has(eventName)) {
         // nobody is listening to the event yet
-        this.uniqueListeners.set(eventName, new Map<string, callback>([[uniqueListenerIdentifier, cb]]));
+        this.uniqueListeners.set(eventName, new Map([[uniqueListenerIdentifier, cb]]));
       } else if (!this.uniqueListeners.get(eventName)?.has(uniqueListenerIdentifier)) {
         // the unique listener identifier is not already registered
         this.uniqueListeners.get(eventName)?.set(uniqueListenerIdentifier, cb);
@@ -231,3 +236,7 @@ export class Lifecycle {
     }
   }
 }
+
+const cloneListeners: (listeners: ListenerMap) => ListenerMap = (listeners) => new Map(Array.from(listeners.entries()));
+export const cloneUniqueListeners = (uniqueListeners: UniqueListenerMap): UniqueListenerMap =>
+  new Map(Array.from(uniqueListeners.entries()).map(([key, value]) => [key, cloneListeners(value)]));

src/org/scratchOrgCreate.ts

@@ -12,6 +12,7 @@ import { ConfigAggregator } from '../config/configAggregator';
 import { OrgConfigProperties } from '../org/orgConfigProperties';
 import { SfProject } from '../sfProject';
 import { StateAggregator } from '../stateAggregator/stateAggregator';
+import { SfError } from '../sfError';
 import { Org } from './org';
 import {
   authorizeScratchOrg,
@@ -148,6 +149,15 @@ export const scratchOrgResume = async (jobId: string): Promise<ScratchOrgCreateR
         retry: 0,
       });
 
+  await setExitCodeIfError(68)(
+    scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+      alias,
+      setDefault: setDefault ?? false,
+      setDefaultDevHub: false,
+      setTracksSource: tracksSource ?? true,
+    })
+  );
+
   const scratchOrg = await Org.create({ aliasOrUsername: username });
 
   const configAggregator = await ConfigAggregator.create();
@@ -160,23 +170,19 @@ export const scratchOrgResume = async (jobId: string): Promise<ScratchOrgCreateR
     capitalizeRecordTypes,
   });
   await settingsGenerator.extract({ ...soi, ...definitionjson });
-  const [authInfo] = await Promise.all([
-    resolveUrl(scratchOrgAuthInfo),
-    deploySettings(
-      scratchOrg,
-      settingsGenerator,
-      apiVersion ??
-        configAggregator.getPropertyValue(OrgConfigProperties.ORG_API_VERSION) ??
-        (await scratchOrg.retrieveMaxApiVersion())
-    ),
-  ]);
+  const [authInfo] = await setExitCodeIfError(68)(
+    Promise.all([
+      resolveUrl(scratchOrgAuthInfo),
+      deploySettings(
+        scratchOrg,
+        settingsGenerator,
+        apiVersion ??
+          configAggregator.getPropertyValue(OrgConfigProperties.ORG_API_VERSION) ??
+          (await scratchOrg.retrieveMaxApiVersion())
+      ),
+    ])
+  );
 
-  await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
-    alias,
-    setDefault: setDefault ?? false,
-    setDefaultDevHub: false,
-    setTracksSource: tracksSource ?? true,
-  });
   cache.unset(soi.Id ?? jobId);
   const authFields = authInfo.getFields();
 
@@ -287,42 +293,43 @@ export const scratchOrgCreate = async (options: ScratchOrgCreateOptions): Promis
     retry: retry || 0,
   });
 
+  // anything after this point (org is created and auth'd) is potentially recoverable with the resume scratch command.
+  await setExitCodeIfError(68)(
+    scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+      ...{
+        alias,
+        setDefault,
+        setDefaultDevHub: false,
+        setTracksSource: tracksSource === false ? false : true,
+      },
+    })
+  );
+
   // we'll need this scratch org connection later;
-  const scratchOrg = await Org.create({
-    aliasOrUsername: soi.Username ?? soi.SignupUsername,
-  });
+  const scratchOrg = await Org.create({ aliasOrUsername: soi.Username ?? soi.SignupUsername });
   const username = scratchOrg.getUsername();
   logger.debug(`scratch org username ${username}`);
 
   await emit({ stage: 'deploy settings', scratchOrgInfo: soi });
-
   const configAggregator = await ConfigAggregator.create();
+  const [authInfo] = await setExitCodeIfError(68)(
+    Promise.all([
+      resolveUrl(scratchOrgAuthInfo),
+      deploySettings(
+        scratchOrg,
+        settingsGenerator,
+        apiversion ??
+          configAggregator.getPropertyValue(OrgConfigProperties.ORG_API_VERSION) ??
+          (await scratchOrg.retrieveMaxApiVersion()),
+        // some of our "wait" time has already been used.  Calculate how much remains that we can spend on the deployment.
+        Duration.milliseconds(wait.milliseconds - (Date.now() - startTimestamp))
+      ),
+    ])
+  );
 
-  const [authInfo] = await Promise.all([
-    resolveUrl(scratchOrgAuthInfo),
-    deploySettings(
-      scratchOrg,
-      settingsGenerator,
-      apiversion ??
-        configAggregator.getPropertyValue(OrgConfigProperties.ORG_API_VERSION) ??
-        (await scratchOrg.retrieveMaxApiVersion()),
-      // some of our "wait" time has already been used.  Calculate how much remains that we can spend on the deployment.
-      Duration.milliseconds(wait.milliseconds - (Date.now() - startTimestamp))
-    ),
-  ]);
-
-  await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
-    ...{
-      alias,
-      setDefault,
-      setDefaultDevHub: false,
-      setTracksSource: tracksSource === false ? false : true,
-    },
-  });
   cache.unset(scratchOrgInfoId);
   const authFields = authInfo.getFields();
   await Promise.all([emit({ stage: 'done', scratchOrgInfo: soi }), cache.write(), emitPostOrgCreate(authFields)]);
-
   return {
     username,
     scratchOrgInfo: soi,
@@ -345,9 +352,18 @@ const getSignupTargetLoginUrl = async (): Promise<string | undefined> => {
 async function getCapitalizeRecordTypesConfig(): Promise<boolean | undefined> {
   const configAgg = await ConfigAggregator.create();
   const value = configAgg.getInfo('org-capitalize-record-types').value as string | undefined;
-
-  if (value !== undefined) return toBoolean(value);
-
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-  return value as undefined;
+  return value !== undefined ? toBoolean(value) : undefined;
 }
+
+/** wrap an async function, intercept error and set the given exit code   */
+const setExitCodeIfError =
+  (exitCode: number) =>
+  async <P>(p: Promise<P>): Promise<P> => {
+    try {
+      return await p;
+    } catch (e) {
+      const sfError = SfError.wrap(e);
+      sfError.exitCode = exitCode;
+      throw sfError;
+    }
+  };

src/org/scratchOrgInfoApi.ts

@@ -427,6 +427,7 @@ export const deploySettings = async (
 };
 
 /**
+ * Makes sure the scratch org's instanceUrl is resolvable (that is, DNS is ready)
  *
  * @param scratchOrgAuthInfo an AuthInfo class from the scratch org
  * @returns AuthInfo
@@ -435,13 +436,14 @@ export const resolveUrl = async (scratchOrgAuthInfo: AuthInfo): Promise<AuthInfo
   const logger = await Logger.child('scratchOrgInfoApi-resolveUrl');
   const { instanceUrl } = scratchOrgAuthInfo.getFields();
   if (!instanceUrl) {
-    const sfError = new SfError('Org does not have instanceUrl');
-    sfError.setData({
-      orgId: scratchOrgAuthInfo.getFields().orgId,
-      username: scratchOrgAuthInfo.getFields().username,
-      instanceUrl,
+    throw SfError.create({
+      message: 'Org does not have instanceUrl',
+      data: {
+        orgId: scratchOrgAuthInfo.getFields().orgId,
+        username: scratchOrgAuthInfo.getFields().username,
+        instanceUrl,
+      },
     });
-    throw sfError;
   }
   logger.debug(`processScratchOrgInfoResult - resultData.instanceUrl: ${instanceUrl}`);
   const options = {

src/org/scratchOrgSettingsGenerator.ts

@@ -329,12 +329,11 @@ export default class SettingsGenerator {
       const failures = (Array.isArray(componentFailures) ? componentFailures : [componentFailures])
         .map((failure) => `[${failure.problemType}] ${failure.fullName} : ${failure.problem} `)
         .join('\n');
-      const error = new SfError(
-        `A scratch org was created with username ${username}, but the settings failed to deploy due to: \n${failures}`,
-        'ProblemDeployingSettings'
-      );
-      error.setData(result);
-      throw error;
+      throw SfError.create({
+        message: `A scratch org was created with username ${username}, but the settings failed to deploy due to: \n${failures}`,
+        name: 'ProblemDeployingSettings',
+        data: { ...result, username },
+      });
     }
   }
 

src/sfProject.ts

@@ -639,7 +639,9 @@ export class SfProject {
    */
   public getDefaultPackage(): NamedPackageDir {
     if (!this.hasPackages()) {
-      throw new SfError('The sfdx-project.json does not have any packageDirectories defined.');
+      throw new SfError('The sfdx-project.json does not have any packageDirectories defined.', 'NoPackageDirectories', [
+        `Check ${this.getPath()} for packageDirectories.`,
+      ]);
     }
     const defaultPackage = this.findPackage((packageDir) => packageDir.default === true);
     return defaultPackage ?? this.getPackageDirectories()[0];

src/testSetup.ts

@@ -666,6 +666,8 @@ export const restoreContext = (testContext: TestContext): void => {
   testContext.configStubs = {};
   // Give each test run a clean StateAggregator
   StateAggregator.clearInstance();
+  // @ts-expect-error accessing a private property
+  SfProject.instances.clear();
   // Allow each test to have their own config aggregator
   // @ts-ignore clear for testing.
   delete ConfigAggregator.instance;

test/unit/lifecycleEventsTest.ts

@@ -9,7 +9,7 @@
 import { Duration, sleep } from '@salesforce/kit/lib/duration';
 import { spyMethod } from '@salesforce/ts-sinon';
 import * as chai from 'chai';
-import { Lifecycle } from '../../src/lifecycleEvents';
+import { Lifecycle, callback, cloneUniqueListeners } from '../../src/lifecycleEvents';
 import { TestContext } from '../../src/testSetup';
 import { Logger } from '../../src/logger/logger';
 
@@ -257,3 +257,29 @@ describe('lifecycleEvents', () => {
     lifecycle2.removeAllListeners('test7');
   });
 });
+
+describe('listener map cloning', () => {
+  const cb = (): Promise<void> => Promise.resolve();
+  it('clones map, breaking event name reference', () => {
+    const map1 = new Map<string, Map<string, callback>>();
+    map1.set('evt', new Map([['uniqueId', cb]]));
+
+    const map2 = cloneUniqueListeners(map1);
+    chai.expect(map2).to.deep.equal(map1);
+    map1.delete('evt');
+    chai.expect(map1.has('evt')).to.be.false;
+    chai.expect(map2.has('evt')).to.be.true;
+  });
+  it('clones map, breaking uniqueId reference', () => {
+    const map1 = new Map<string, Map<string, callback>>();
+    map1.set('evt', new Map([['uniqueId', cb]]));
+
+    const map2 = cloneUniqueListeners(map1);
+    chai.expect(map2).to.deep.equal(map1);
+    map2.get('evt')?.set('uniqueId2', cb);
+    chai.expect(map1.has('evt')).to.be.true;
+    chai.expect(map2.has('evt')).to.be.true;
+    chai.expect(map1.get('evt')?.has('uniqueId2')).to.be.false;
+    chai.expect(map2.get('evt')?.has('uniqueId2')).to.be.true;
+  });
+});