W-19263098 fix: web perf (#1604)

mshanemc · web-flow · commit bcd3a9f89dae · 2025-08-18T13:59:43.000-06:00
* refactor: top-level imports from core

* refactor: remove deepfreeze in favor of ts readonly

* refactor: create dir, but don't open/close file unnecessarily

* fix: only one object in the stream at a time on the web

* refactor: createWriteStream can create files, just not dirs

* perf: pass existing registry when creating retrieveResult

* test: remove test of mkdirp
diff --git a/src/client/deployMessages.ts b/src/client/deployMessages.ts
@@ -6,7 +6,7 @@
  */
 
 import { basename, dirname, extname, join, posix, sep } from 'node:path/posix';
-import { SfError } from '@salesforce/core';
+import { SfError } from '@salesforce/core/sfError';
 import { ensureArray } from '@salesforce/kit';
 import { ComponentLike, SourceComponent } from '../resolve';
 import { registry } from '../registry/registry';
diff --git a/src/client/diagnosticUtil.ts b/src/client/diagnosticUtil.ts
@@ -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 { basename } from 'node:path';
-import { SfError } from '@salesforce/core';
+import { SfError } from '@salesforce/core/sfError';
 import { SourceComponent } from '../resolve/sourceComponent';
 import { registry } from '../registry/registry';
 import { ComponentDiagnostic, DeployMessage } from './types';
diff --git a/src/client/metadataApiDeploy.ts b/src/client/metadataApiDeploy.ts
@@ -9,7 +9,10 @@ import { format } from 'node:util';
 import { isString } from '@salesforce/ts-types';
 import JSZip from 'jszip';
 import fs from 'graceful-fs';
-import { Lifecycle, Messages, SfError, envVars } from '@salesforce/core';
+import { Lifecycle } from '@salesforce/core/lifecycle';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
+import { envVars } from '@salesforce/core/envVars';
 import { ensureArray } from '@salesforce/kit';
 import { RegistryAccess } from '../registry/registryAccess';
 import { ReplacementEvent } from '../convert/types';
@@ -152,7 +155,11 @@ export class MetadataApiDeploy extends MetadataTransfer<
     }
     const connection = await this.getConnection();
     // Recasting to use the project's version of the type
-    return connection.metadata.checkDeployStatus(this.id, true, this.isRestDeploy) as unknown as MetadataApiDeployStatus;
+    return connection.metadata.checkDeployStatus(
+      this.id,
+      true,
+      this.isRestDeploy
+    ) as unknown as MetadataApiDeployStatus;
   }
 
   /**
diff --git a/src/client/metadataApiRetrieve.ts b/src/client/metadataApiRetrieve.ts
@@ -8,8 +8,11 @@ import { join, parse } from 'node:path';
 import fs from 'graceful-fs';
 import JSZip from 'jszip';
 import { asBoolean, isString } from '@salesforce/ts-types';
-import { Messages, SfError, Lifecycle } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
+import { Lifecycle } from '@salesforce/core/lifecycle';
 import { ensureArray } from '@salesforce/kit';
+import { RegistryAccess } from '../registry/registryAccess';
 import { ComponentSet } from '../collections/componentSet';
 import { MetadataTransfer } from './metadataTransfer';
 import {
@@ -46,9 +49,10 @@ export class RetrieveResult implements MetadataTransferResult {
     public readonly response: MetadataApiRetrieveStatus,
     public readonly components: ComponentSet,
     localComponents?: ComponentSet,
-    private partialDeleteFileResponses: FileResponse[] = []
+    private partialDeleteFileResponses: FileResponse[] = [],
+    registry?: RegistryAccess
   ) {
-    this.localComponents = new ComponentSet(localComponents?.getSourceComponents());
+    this.localComponents = new ComponentSet(localComponents?.getSourceComponents(), registry);
   }
 
   public getFileResponses(): FileResponse[] {
@@ -196,10 +200,15 @@ export class MetadataApiRetrieve extends MetadataTransfer<
         }));
       }
     }
-
     componentSet ??= new ComponentSet(undefined, this.options.registry);
 
-    const retrieveResult = new RetrieveResult(result, componentSet, this.components, partialDeleteFileResponses);
+    const retrieveResult = new RetrieveResult(
+      result,
+      componentSet,
+      this.components,
+      partialDeleteFileResponses,
+      this.options.registry
+    );
     if (!isMdapiRetrieve && !this.options.suppressEvents) {
       // This should only be done when retrieving source format since retrieving
       // mdapi format has no conversion or events/hooks
@@ -209,7 +218,6 @@ export class MetadataApiRetrieve extends MetadataTransfer<
         orgId: this.orgId,
       } as ScopedPostRetrieve);
     }
-
     return retrieveResult;
   }
 
@@ -245,7 +253,9 @@ export class MetadataApiRetrieve extends MetadataTransfer<
       apiVersion: this.components?.sourceApiVersion ?? (await connection.retrieveMaxApiVersion()),
       ...(manifestData ? { unpackaged: manifestData } : {}),
       ...(this.options.singlePackage ? { singlePackage: this.options.singlePackage } : {}),
-      ...(this.options.rootTypesWithDependencies ? { rootTypesWithDependencies: this.options.rootTypesWithDependencies } : {}),
+      ...(this.options.rootTypesWithDependencies
+        ? { rootTypesWithDependencies: this.options.rootTypesWithDependencies }
+        : {}),
       // if we're retrieving with packageNames add it
       // otherwise don't - it causes errors if undefined or an empty array
       ...(packageNames.length ? { packageNames } : {}),
diff --git a/src/client/retrieveExtract.ts b/src/client/retrieveExtract.ts
@@ -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 * as path from 'node:path';
-import { Logger } from '@salesforce/core';
+import { Logger } from '@salesforce/core/logger';
 import { isString } from '@salesforce/ts-types';
 import fs from 'graceful-fs';
 import { ConvertOutputConfig } from '../convert/types';
diff --git a/src/collections/decodeableMap.ts b/src/collections/decodeableMap.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 { Logger } from '@salesforce/core';
+import { Logger } from '@salesforce/core/logger';
 import { isString } from '@salesforce/ts-types';
 
 /**
diff --git a/src/convert/convertContext/nonDecompositionFinalizer.ts b/src/convert/convertContext/nonDecompositionFinalizer.ts
@@ -6,7 +6,7 @@
  */
 import { join } from 'node:path';
 import { ensureString, getString, JsonMap } from '@salesforce/ts-types';
-import { SfProject } from '@salesforce/core';
+import { SfProject } from '@salesforce/core/project';
 import { getXmlElement } from '../../utils/decomposed';
 import { META_XML_SUFFIX, XML_NS_KEY, XML_NS_URL } from '../../common/constants';
 import { ComponentSet } from '../../collections/componentSet';
diff --git a/src/convert/convertContext/recompositionFinalizer.ts b/src/convert/convertContext/recompositionFinalizer.ts
@@ -6,7 +6,7 @@
  */
 import { join } from 'node:path';
 import { JsonMap } from '@salesforce/ts-types';
-import { Messages } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
 import { extractUniqueElementValue, getXmlElement, unwrapAndOmitNS } from '../../utils/decomposed';
 import { MetadataComponent } from '../../resolve/types';
 import { XML_NS_KEY, XML_NS_URL } from '../../common/constants';
diff --git a/src/convert/metadataConverter.ts b/src/convert/metadataConverter.ts
@@ -6,9 +6,11 @@
  */
 import { Readable, PassThrough } from 'node:stream';
 import { dirname, join, normalize } from 'node:path';
-import { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { promises, mkdirSync } from 'graceful-fs';
 import { isString } from '@salesforce/ts-types';
+import { Global } from '@salesforce/core';
 import { SourceComponent } from '../resolve/sourceComponent';
 import { MetadataResolver } from '../resolve/metadataResolver';
 import { SourcePath } from '../common/types';
@@ -40,6 +42,10 @@ export class MetadataConverter {
     output: ConvertOutputConfig
   ): Promise<ConvertResult> {
     try {
+      // jszip does not behave well in web environments when retrieving multiple files.
+      // it has a minified `browser` target which has a v3 ReadableStream, but the extensions are using polyfilles of v4.
+      // Setting the highWaterMark to 1 seems to fix the issue.
+      const streamOptions = Global.isWeb ? { highWaterMark: 1 } : {};
       const cs = comps instanceof ComponentSet ? comps : new ComponentSet(comps, this.registry);
       const components = (
         (comps instanceof ComponentSet ? Array.from(comps.getSourceComponents()) : comps) as SourceComponent[]
@@ -58,10 +64,10 @@ export class MetadataConverter {
       } = await getConvertIngredients(output, cs, targetFormatIsSource, this.registry);
 
       const conversionPipeline = getPipeline()(
-        Readable.from(components),
+        Readable.from(components, streamOptions),
         !targetFormatIsSource && (process.env.SF_APPLY_REPLACEMENTS_ON_CONVERT === 'true' || output.type === 'zip')
           ? (await getReplacementMarkingStream(cs.projectDirectory)) ?? new PassThrough({ objectMode: true })
-          : new PassThrough({ objectMode: true }),
+          : new PassThrough({ objectMode: true, ...streamOptions }),
         new ComponentConverter(targetFormat, this.registry, mergeSet, defaultDirectory),
         writer
       );
diff --git a/src/convert/streams.ts b/src/convert/streams.ts
@@ -7,12 +7,13 @@
 import { isAbsolute, join } from 'node:path';
 import { pipeline as cbPipeline, Readable, Transform, Writable, Stream } from 'node:stream';
 import { promisify } from 'node:util';
-import { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import JSZip from 'jszip';
 import { createWriteStream, existsSync, promises as fsPromises } from 'graceful-fs';
 import { JsonMap } from '@salesforce/ts-types';
 import { XMLBuilder } from 'fast-xml-parser';
-import { Logger } from '@salesforce/core';
+import { Logger } from '@salesforce/core/logger';
 import { SourceComponent } from '../resolve/sourceComponent';
 import { SourcePath } from '../common/types';
 import { XML_COMMENT_PROP_NAME, XML_DECL } from '../common/constants';
@@ -159,7 +160,7 @@ export class StandardWriter extends ComponentWriter {
           chunk.writeInfos
             .map(makeWriteInfoAbsolute(this.rootDestination))
             .filter(existsOrDoesntMatchIgnored(this.forceignore, this.logger)) // Skip files matched by default ignore
-            .map((info) => {
+            .map(async (info) => {
               if (info.shouldDelete) {
                 this.deleted.push({
                   filePath: info.output,
@@ -187,7 +188,7 @@ export class StandardWriter extends ComponentWriter {
                 toResolve.add(info.output);
               }
 
-              ensureFileExists(info.output);
+              await ensureFileExists(info.output);
               return getPipeline()(info.source, createWriteStream(info.output));
             })
         );
diff --git a/src/convert/transformers/decomposedMetadataTransformer.ts b/src/convert/transformers/decomposedMetadataTransformer.ts
@@ -9,7 +9,7 @@ import { dirname, join } from 'node:path';
 import fs from 'node:fs';
 import { AnyJson, JsonMap, ensureString, isJsonMap } from '@salesforce/ts-types';
 import { ensureArray } from '@salesforce/kit';
-import { Messages } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
 import { calculateRelativePath } from '../../utils/path';
 import { ForceIgnore } from '../../resolve/forceIgnore';
 import { extractUniqueElementValue, objectHasSomeRealValues } from '../../utils/decomposed';
diff --git a/src/convert/transformers/metadataTransformerFactory.ts b/src/convert/transformers/metadataTransformerFactory.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 { Messages } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
 import { MetadataTransformer } from '../types';
 import { SourceComponent } from '../../resolve';
 import { ConvertContext } from '../convertContext/convertContext';
diff --git a/src/convert/transformers/nonDecomposedMetadataTransformer.ts b/src/convert/transformers/nonDecomposedMetadataTransformer.ts
@@ -7,7 +7,7 @@
 
 import { get, getString, JsonMap } from '@salesforce/ts-types';
 import { ensureArray } from '@salesforce/kit';
-import { Messages } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
 import { ToSourceFormatInput, WriteInfo } from '../types';
 import { DecomposedMetadataTransformer } from './decomposedMetadataTransformer';
 Messages.importMessagesDirectory(__dirname);
diff --git a/src/convert/transformers/staticResourceMetadataTransformer.ts b/src/convert/transformers/staticResourceMetadataTransformer.ts
@@ -10,7 +10,9 @@ import JSZip from 'jszip';
 import { getExtension } from 'mime';
 import { JsonMap } from '@salesforce/ts-types';
 import { createWriteStream } from 'graceful-fs';
-import { Logger, Messages, SfError } from '@salesforce/core';
+import { Logger } from '@salesforce/core/logger';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { isEmpty } from '@salesforce/kit';
 import { baseName } from '../../utils/path';
 import { ToSourceFormatInput, WriteInfo } from '../types';
@@ -161,7 +163,7 @@ export class StaticResourceMetadataTransformer extends BaseMetadataTransformer {
    */
   // eslint-disable-next-line class-methods-use-this
   private async pipeline(stream: Readable, destination: string): Promise<void> {
-    ensureFileExists(destination);
+    await ensureFileExists(destination);
     await getPipeline()(stream, createWriteStream(destination));
   }
 
diff --git a/src/registry/coverage.ts b/src/registry/coverage.ts
@@ -10,7 +10,7 @@ import { OptionsOfTextResponseBody } from 'got';
 import got from 'got';
 import { ProxyAgent } from 'proxy-agent';
 import { isString } from '@salesforce/ts-types';
-import { SfError } from '@salesforce/core';
+import { SfError } from '@salesforce/core/sfError';
 import { CoverageObject } from '../../src/registry/types';
 
 const getProxiedOptions = (url: string): OptionsOfTextResponseBody => ({
diff --git a/src/registry/registry.ts b/src/registry/registry.ts
@@ -4,13 +4,13 @@
  * 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 { deepFreeze } from '../utils/collections';
-// The static import of json file should never be changed,
-// other read methods might make esbuild fail to bundle the json file
 import * as registryData from './metadataRegistry.json';
 import { MetadataRegistry } from './types';
 
 /**
  * The default metadata registry.
+ *
+ * The static import of json file should never be changed,
+ * other read methods might make esbuild fail to bundle the json file
  */
-export const registry = deepFreeze(registryData as MetadataRegistry);
+export const registry = registryData as Readonly<MetadataRegistry>;
diff --git a/src/registry/registryAccess.ts b/src/registry/registryAccess.ts
@@ -4,7 +4,8 @@
  * 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 { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { MetadataRegistry, MetadataType } from './types';
 import { getEffectiveRegistry } from './variants';
 import { getSuffixGuesses, getTypeSuggestions } from './levenshtein';
diff --git a/src/registry/standardvalueset.ts b/src/registry/standardvalueset.ts
@@ -4,12 +4,12 @@
  * 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 { deepFreeze } from '../utils/collections';
-// The static import of json file should never be changed,
-// other read methods might make esbuild fail to bundle the json file
 import * as standardValueSetData from './stdValueSetRegistry.json';
 
 /**
  * The standardValueSet fullNames.
+ *
+ * The static import of json file should never be changed,
+ * other read methods might make esbuild fail to bundle the json file
  */
-export const standardValueSet = deepFreeze(standardValueSetData);
+export const standardValueSet = standardValueSetData as Readonly<typeof standardValueSetData>;
diff --git a/src/registry/variants.ts b/src/registry/variants.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { Logger, SfProject, SfProjectJson, Lifecycle, SfError } from '@salesforce/core';
-import { deepFreeze } from '../utils/collections';
 import { MetadataRegistry } from './types';
 // The static import of json file should never be changed,
 // other read methods might make esbuild fail to bundle the json file
@@ -31,14 +30,12 @@ export type RegistryLoadInput =
   | ProjectVariants;
 
 /** combine the standard registration with any overrides specific in the sfdx-project.json */
-export const getEffectiveRegistry = (input?: RegistryLoadInput): MetadataRegistry =>
-  deepFreeze(
-    removeEmptyStrings(
-      firstLevelMerge(
-        registryData as MetadataRegistry,
-        mergeVariants(
-          input?.presets?.length ?? input?.registryCustomizations ? input : getProjectVariants(input?.projectDir)
-        )
+export const getEffectiveRegistry = (input?: RegistryLoadInput): Readonly<MetadataRegistry> =>
+  removeEmptyStrings(
+    firstLevelMerge(
+      registryData as MetadataRegistry,
+      mergeVariants(
+        input?.presets?.length ?? input?.registryCustomizations ? input : getProjectVariants(input?.projectDir)
       )
     )
   );
diff --git a/src/resolve/adapters/baseSourceAdapter.ts b/src/resolve/adapters/baseSourceAdapter.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { basename, dirname, sep } from 'node:path';
-import { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { ensureString } from '@salesforce/ts-types';
 import { MetadataXml, SourceAdapter } from '../types';
 import { parseMetadataXml, parseNestedFullName } from '../../utils/path';
diff --git a/src/resolve/adapters/decomposedSourceAdapter.ts b/src/resolve/adapters/decomposedSourceAdapter.ts
@@ -4,7 +4,8 @@
  * 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 { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { SourcePath } from '../../common/types';
 import { SourceComponent } from '../sourceComponent';
 import { baseName, parentName, parseMetadataXml } from '../../utils/path';
diff --git a/src/resolve/adapters/digitalExperienceSourceAdapter.ts b/src/resolve/adapters/digitalExperienceSourceAdapter.ts
@@ -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 { dirname, join, sep } from 'node:path';
-import { Messages } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
 import { ensureString } from '@salesforce/ts-types';
 import { META_XML_SUFFIX } from '../../common/constants';
 import { SourcePath } from '../../common/types';
diff --git a/src/resolve/adapters/matchingContentSourceAdapter.ts b/src/resolve/adapters/matchingContentSourceAdapter.ts
@@ -4,7 +4,8 @@
  * 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 { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 
 import { SourcePath } from '../../common/types';
 import { META_XML_SUFFIX } from '../../common/constants';
diff --git a/src/resolve/adapters/mixedContentSourceAdapter.ts b/src/resolve/adapters/mixedContentSourceAdapter.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { dirname, basename, sep, join } from 'node:path';
-import { Messages, SfError } from '@salesforce/core';
+import { Messages } from '@salesforce/core/messages';
+import { SfError } from '@salesforce/core/sfError';
 import { baseName } from '../../utils/path';
 import { SourcePath } from '../../common/types';
 import { SourceComponent } from '../sourceComponent';
diff --git a/src/resolve/adapters/sourceAdapterFactory.ts b/src/resolve/adapters/sourceAdapterFactory.ts
diff --git a/src/resolve/forceIgnore.ts b/src/resolve/forceIgnore.ts
diff --git a/src/resolve/manifestResolver.ts b/src/resolve/manifestResolver.ts
diff --git a/src/resolve/metadataResolver.ts b/src/resolve/metadataResolver.ts
diff --git a/src/resolve/treeContainers.ts b/src/resolve/treeContainers.ts
diff --git a/src/utils/collections.ts b/src/utils/collections.ts
diff --git a/src/utils/filePathGenerator.ts b/src/utils/filePathGenerator.ts
diff --git a/src/utils/fileSystemHandler.ts b/src/utils/fileSystemHandler.ts
diff --git a/src/utils/index.ts b/src/utils/index.ts
diff --git a/src/utils/metadata.ts b/src/utils/metadata.ts
diff --git a/test/utils/fileSystemHandler.test.ts b/test/utils/fileSystemHandler.test.ts
