@salesforce/source-tracking 7.4.10 → 7.5.1

package/lib/shared/remote/remoteSourceTrackingService.js

@@ -14,14 +14,47 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.remoteChangeElementToChangeResult = exports.RemoteSourceTrackingService = void 0;
 const node_path_1 = __importDefault(require("node:path"));
-const node_fs_1 = __importDefault(require("node:fs"));
 const node_os_1 = require("node:os");
+const fs = __importStar(require("graceful-fs"));
 const ts_retry_promise_1 = require("ts-retry-promise");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
@@ -86,8 +119,8 @@ class RemoteSourceTrackingService {
     static async delete(orgId) {
         const fileToDelete = (0, fileOperations_1.getFilePath)(orgId);
         // the file might not exist, in which case we don't need to delete it
-        if (node_fs_1.default.existsSync(fileToDelete)) {
-            await node_fs_1.default.promises.unlink(fileToDelete);
+        if (fs.existsSync(fileToDelete)) {
+            await fs.promises.unlink(fileToDelete);
         }
         return node_path_1.default.isAbsolute(fileToDelete) ? fileToDelete : node_path_1.default.join(process.cwd(), fileToDelete);
     }
@@ -95,16 +128,18 @@ class RemoteSourceTrackingService {
      * pass in a series of SDR FilResponses .\
      * it sets their last retrieved revision to the current revision counter from the server.
      */
-    async syncSpecifiedElements(elements) {
+    async syncSpecifiedElements(registry, elements) {
         if (elements.length === 0) {
             return;
         }
-        const quietLogger = elements.length > 100 ? this.logger.silent.bind(this.logger) : this.logger.debug.bind(this.logger);
+        const quietLogger = elements.length > 100
+            ? this.logger.silent?.bind(this.logger) ?? (() => { })
+            : this.logger.debug.bind(this.logger);
         quietLogger(`Syncing ${elements.length} Revisions by key`);
         // this can be super-repetitive on a large ExperienceBundle where there is an element for each file but only one Revision for the entire bundle
         // any item in an aura/LWC bundle needs to represent the top (bundle) level and the file itself
         // so we de-dupe via a set
-        Array.from(new Set(elements.flatMap((element) => (0, metadataKeys_1.getMetadataKeyFromFileResponse)(element)))).map((metadataKey) => {
+        Array.from(new Set(elements.flatMap((element) => (0, metadataKeys_1.getMetadataKeyFromFileResponse)(registry)(element)))).map((metadataKey) => {
             const revision = this.sourceMembers.get(metadataKey) ?? this.sourceMembers.get(decodeURI(metadataKey));
             if (!revision) {
                 this.logger.warn(`found no matching revision for ${metadataKey}`);
@@ -187,14 +222,14 @@ class RemoteSourceTrackingService {
      * @param expectedMemberNames Array of metadata names to poll
      * @param pollingTimeout maximum amount of time in seconds to poll for SourceMembers
      */
-    async pollForSourceTracking(expectedMembers) {
+    async pollForSourceTracking(registry, expectedMembers) {
         if (core_1.envVars.getBoolean('SF_DISABLE_SOURCE_MEMBER_POLLING')) {
             return this.logger.warn('Not polling for SourceMembers since SF_DISABLE_SOURCE_MEMBER_POLLING = true.');
         }
         if (expectedMembers.length === 0) {
             return;
         }
-        const outstandingSourceMembers = (0, expectedSourceMembers_1.calculateExpectedSourceMembers)(expectedMembers);
+        const outstandingSourceMembers = (0, expectedSourceMembers_1.calculateExpectedSourceMembers)(registry, expectedMembers);
         const originalOutstandingSize = outstandingSourceMembers.size;
         // this will be the absolute timeout from the start of the poll.  We can also exit early if it doesn't look like more results are coming in
         let highestRevisionSoFar = this.serverMaxRevisionCounter;
@@ -302,7 +337,9 @@ ${formatSourceMemberWarnings(outstandingSourceMembers)}`),
         if (sourceMembers.length === 0) {
             return;
         }
-        const quietLogger = sourceMembers.length > 100 ? this.logger.silent.bind(this.logger) : this.logger.debug.bind(this.logger);
+        const quietLogger = sourceMembers.length > 100
+            ? this.logger.silent?.bind(this.logger) ?? (() => { })
+            : this.logger.debug.bind(this.logger);
         quietLogger(`Upserting ${sourceMembers.length} SourceMembers to maxRevision.json`);
         // Update the serverMaxRevisionCounter to the highest RevisionCounter
         this.serverMaxRevisionCounter = Math.max(this.serverMaxRevisionCounter, ...sourceMembers.map((m) => m.RevisionCounter));
@@ -334,7 +371,7 @@ ${formatSourceMemberWarnings(outstandingSourceMembers)}`),
             throw new core_1.SfError(messages.getMessage('NonSourceTrackedOrgError'), 'NonSourceTrackedOrgError');
         }
         this.logger = core_1.Logger.getRawRootLogger().child({ name: this.constructor.name });
-        if (node_fs_1.default.existsSync(this.filePath)) {
+        if (fs.existsSync(this.filePath)) {
             // read the file contents and turn it into the map
             const rawContents = await (0, fileOperations_1.readFileContents)(this.filePath);
             if (rawContents.serverMaxRevisionCounter && rawContents.sourceMembers) {
@@ -370,18 +407,21 @@ exports.RemoteSourceTrackingService = RemoteSourceTrackingService;
  * pass in an RCE, and this will return a pullable ChangeResult.
  * Useful for correcing bundle types where the files show change results with types but aren't resolvable
  */
-const remoteChangeElementToChangeResult = (rce) => ({
-    ...rce,
-    ...(metadataKeys_1.mappingsForSourceMemberTypesToMetadataType.has(rce.type)
-        ? {
-            // SNOWFLAKE: EmailTemplateFolder is treated as an alias for EmailFolder so it has a mapping.
-            // The name must be handled differently than with bundle types.
-            name: rce.type === 'EmailTemplateFolder' ? rce.name : rce.name.split('/')[0],
-            type: metadataKeys_1.mappingsForSourceMemberTypesToMetadataType.get(rce.type),
-        }
-        : {}),
-    origin: 'remote', // we know they're remote
-});
+const remoteChangeElementToChangeResult = (registry) => {
+    const mappings = (0, metadataKeys_1.getMappingsForSourceMemberTypesToMetadataType)(registry);
+    return (rce) => ({
+        ...rce,
+        ...(mappings.has(rce.type)
+            ? {
+                // SNOWFLAKE: EmailTemplateFolder is treated as an alias for EmailFolder so it has a mapping.
+                // The name must be handled differently than with bundle types.
+                name: rce.type === 'EmailTemplateFolder' ? rce.name : rce.name.split('/')[0],
+                type: mappings.get(rce.type),
+            }
+            : {}),
+        origin: 'remote', // we know they're remote
+    });
+};
 exports.remoteChangeElementToChangeResult = remoteChangeElementToChangeResult;
 /**
  *

package/lib/shared/remoteChangeIgnoring.d.ts

@@ -1,5 +1,5 @@
-import { ForceIgnore, MetadataMember } from '@salesforce/source-deploy-retrieve';
+import { ForceIgnore, MetadataMember, RegistryAccess } from '@salesforce/source-deploy-retrieve';
 import { ChangeResult } from './types';
 import { ChangeResultWithNameAndType } from './types';
-export declare const removeIgnored: (changeResults: ChangeResult[], forceIgnore: ForceIgnore, defaultPkgDir: string) => MetadataMember[];
+export declare const removeIgnored: (changeResults: ChangeResult[], forceIgnore: ForceIgnore, defaultPkgDir: string, registry: RegistryAccess) => MetadataMember[];
 export declare const ensureNameAndType: (cr: ChangeResult) => ChangeResultWithNameAndType;

package/lib/shared/remoteChangeIgnoring.js

@@ -1,34 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureNameAndType = exports.removeIgnored = void 0;
-/*
- * Copyright 2025, Salesforce, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const sfError_1 = require("@salesforce/core/sfError");
 const filePathGenerator_1 = require("@salesforce/source-deploy-retrieve/lib/src/utils/filePathGenerator");
 const guards_1 = require("./guards");
 const functions_1 = require("./functions");
-const removeIgnored = (changeResults, forceIgnore, defaultPkgDir) => {
-    const registry = new source_deploy_retrieve_1.RegistryAccess();
-    return changeResults
-        .map(exports.ensureNameAndType)
-        .map((0, functions_1.changeResultToMetadataComponent)(registry))
-        .filter((mc) => !(0, filePathGenerator_1.filePathsFromMetadataComponent)(mc, defaultPkgDir).some((0, functions_1.forceIgnoreDenies)(forceIgnore)))
-        .map(metadataComponentToMetadataMember);
-};
+const removeIgnored = (changeResults, forceIgnore, defaultPkgDir, registry) => changeResults
+    .map(exports.ensureNameAndType)
+    .map((0, functions_1.changeResultToMetadataComponent)(registry))
+    .filter((mc) => !(0, filePathGenerator_1.filePathsFromMetadataComponent)(mc, defaultPkgDir).some((0, functions_1.forceIgnoreDenies)(forceIgnore)))
+    .map(metadataComponentToMetadataMember);
 exports.removeIgnored = removeIgnored;
 const metadataComponentToMetadataMember = (mc) => ({
     type: mc.type.name,

package/lib/shared/types.d.ts

@@ -39,7 +39,7 @@ export type ConflictResponse = {
     type: string;
     filePath: string;
 };
-export type SourceConflictErrorType = {
+type SourceConflictErrorType = {
     name: 'SourceConflictError';
 } & SfError<ConflictResponse[]>;
 export declare class SourceConflictError extends SfError<ConflictResponse[]> implements SourceConflictErrorType {
@@ -54,3 +54,4 @@ export type SourceMemberPollingEvent = {
     consecutiveEmptyResults: number;
 };
 export type ChangeResultWithNameAndType = ChangeResult & Required<Pick<ChangeResult, 'name' | 'type'>>;
+export {};

package/lib/sourceTracking.d.ts

@@ -18,6 +18,8 @@ export type SourceTrackingOptions = {
      * If you're using STL as part of a long running process (ex: vscode extensions), set this to false
      */
     ignoreLocalCache?: boolean;
+    /** pass in an instance of SDR's RegistryAccess.  If not provided, a new one will be created */
+    registry?: RegistryAccess;
 };
 type RemoteChangesResults = {
     componentSetFromNonDeletes: ComponentSet;

package/lib/sourceTracking.js

@@ -1,7 +1,37 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceTracking = void 0;
 /*
@@ -19,7 +49,7 @@ exports.SourceTracking = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const node_fs_1 = __importDefault(require("node:fs"));
+const fs = __importStar(require("node:fs"));
 const node_path_1 = require("node:path");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
@@ -27,7 +57,6 @@ const ts_types_1 = require("@salesforce/ts-types");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 // this is not exported by SDR (see the comments in SDR regarding its limitations)
 const filePathGenerator_1 = require("@salesforce/source-deploy-retrieve/lib/src/utils/filePathGenerator");
-const performance_1 = require("@oclif/core/performance");
 const remoteSourceTrackingService_1 = require("./shared/remote/remoteSourceTrackingService");
 const localShadowRepo_1 = require("./shared/local/localShadowRepo");
 const conflicts_1 = require("./shared/conflicts");
@@ -72,7 +101,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         this.ignoreConflicts = options.ignoreConflicts ?? false;
         this.ignoreLocalCache = options.ignoreLocalCache ?? false;
         this.subscribeSDREvents = options.subscribeSDREvents ?? false;
-        this.registry = new source_deploy_retrieve_1.RegistryAccess(undefined, this.projectPath);
+        this.registry = options.registry ?? new source_deploy_retrieve_1.RegistryAccess(undefined, this.projectPath);
     }
     async init() {
         await this.maybeSubscribeLifecycleEvents();
@@ -126,7 +155,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         const componentSet = new source_deploy_retrieve_1.ComponentSet(applyIgnore ? sourceBackedComponents.filter(noFileIsIgnored(this.forceIgnore)) : sourceBackedComponents, this.registry);
         // there may be remote adds not in the SBC.  So we add those manually
         (applyIgnore
-            ? (0, remoteChangeIgnoring_1.removeIgnored)(changeResults, this.forceIgnore, this.project.getDefaultPackage().fullPath)
+            ? (0, remoteChangeIgnoring_1.removeIgnored)(changeResults, this.forceIgnore, this.project.getDefaultPackage().fullPath, this.registry)
             : changeResults.map(functions_1.remoteChangeToMetadataMember)).map((mm) => {
             componentSet.add(mm);
         });
@@ -203,11 +232,11 @@ class SourceTracking extends kit_1.AsyncCreatable {
                 // skip any remote types not in the registry.  Will emit warnings
                 .filter((rce) => (0, metadataKeys_1.registrySupportsType)(this.registry)(rce.type));
             if (options.format === 'ChangeResult') {
-                return filteredChanges.map(remoteSourceTrackingService_1.remoteChangeElementToChangeResult);
+                return filteredChanges.map((0, remoteSourceTrackingService_1.remoteChangeElementToChangeResult)(this.registry));
             }
             if (options.format === 'ChangeResultWithPaths') {
                 return (0, populateFilePaths_1.populateFilePaths)({
-                    elements: filteredChanges.map(remoteSourceTrackingService_1.remoteChangeElementToChangeResult),
+                    elements: filteredChanges.map((0, remoteSourceTrackingService_1.remoteChangeElementToChangeResult)(this.registry)),
                     packageDirPaths: this.project.getPackageDirectories().map((pkgDir) => pkgDir.fullPath),
                     registry: this.registry,
                 });
@@ -265,7 +294,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         // delete the files
         await Promise.all(filenames.map((filename) => sourceComponentByFileName.get(filename)?.type.id === 'customlabel' && nonDecomposedLabels
             ? (0, functions_2.deleteCustomLabels)(filename, changesToDelete.filter(functions_3.sourceComponentIsCustomLabel))
-            : node_fs_1.default.promises.unlink(filename)));
+            : fs.promises.unlink(filename)));
         // update the tracking files.  We're simulating SDR-style fileResponse
         await Promise.all([
             this.updateLocalTracking({ deletedFiles: filenames }),
@@ -285,8 +314,6 @@ class SourceTracking extends kit_1.AsyncCreatable {
      */
     async updateLocalTracking(options) {
         this.logger.trace('start: updateLocalTracking', options);
-        const marker = performance_1.Performance.mark('@salesforce/source-tracking', 'SourceTracking.updateLocalTracking');
-        marker?.addDetails({ nonDeletes: options.files?.length ?? 0, deletes: options.deletedFiles?.length ?? 0 });
         await this.ensureLocalTracking();
         this.logger.trace('files', options.files);
         // relative paths make smaller trees AND isogit wants them relative
@@ -313,7 +340,6 @@ class SourceTracking extends kit_1.AsyncCreatable {
             deletedFiles: relativeOptions.deletedFiles.concat((await this.localRepo.getDeleteFilenames()).filter((deployedFile) => bundlesWithDeletedFiles.some((0, functions_2.folderContainsPath)(deployedFile)) &&
                 !relativeOptions.files.includes(deployedFile))),
         });
-        marker?.stop();
         this.logger.trace('done: updateLocalTracking', options);
     }
     /**
@@ -321,16 +347,13 @@ class SourceTracking extends kit_1.AsyncCreatable {
      * Optional skip polling for the SourceMembers to exist on the server and be updated in local files
      */
     async updateRemoteTracking(fileResponses, skipPolling = false) {
-        const marker = performance_1.Performance.mark('@salesforce/source-tracking', 'SourceTracking.updateRemoteTracking');
-        marker?.addDetails({ fileResponseCount: fileResponses.length, skipPolling });
         // false to explicitly NOT query until we do the polling
         await this.ensureRemoteTracking(false);
         if (!skipPolling) {
             // poll to make sure we have the updates before syncing the ones from metadataKeys
-            await this.remoteSourceTrackingService.pollForSourceTracking(fileResponses);
+            await this.remoteSourceTrackingService.pollForSourceTracking(this.registry, fileResponses);
         }
-        await this.remoteSourceTrackingService.syncSpecifiedElements(fileResponses);
-        marker?.stop();
+        await this.remoteSourceTrackingService.syncSpecifiedElements(this.registry, fileResponses);
     }
     async reReadLocalTrackingCache() {
         await this.localRepo.getStatus(true);
@@ -417,7 +440,6 @@ class SourceTracking extends kit_1.AsyncCreatable {
      * Compares local and remote changes to detect conflicts
      */
     async getConflicts() {
-        const marker = performance_1.Performance.mark('@salesforce/source-tracking', 'SourceTracking.getConflicts');
         // we're going to need have both initialized
         await Promise.all([this.ensureRemoteTracking(), this.ensureLocalTracking()]);
         // Strategy: check local changes first (since it'll be faster) to avoid callout
@@ -447,7 +469,6 @@ class SourceTracking extends kit_1.AsyncCreatable {
             forceIgnore: this.forceIgnore,
             registry: this.registry,
         });
-        marker?.stop();
         return result;
     }
     /**
@@ -550,7 +571,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
     // reserve the right to do something more sophisticated in the future
     // via async for figuring out hypothetical filenames (ex: getting default packageDir)
     // eslint-disable-next-line @typescript-eslint/require-await
-    async remoteChangesToOutputRows(input, registry = new source_deploy_retrieve_1.RegistryAccess()) {
+    async remoteChangesToOutputRows(input) {
         this.logger.debug('converting ChangeResult to a row', input);
         this.forceIgnore ??= source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path);
         const baseObject = {
@@ -570,7 +591,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         // when the file doesn't exist locally, there are no filePaths
         // SDR can generate the hypothetical place it *would* go and check that
         if ((0, guards_1.isChangeResultWithNameAndType)(input)) {
-            const ignored = (0, filePathGenerator_1.filePathsFromMetadataComponent)((0, functions_1.changeResultToMetadataComponent)(registry)(input)).some((0, functions_2.forceIgnoreDenies)(this.forceIgnore));
+            const ignored = (0, filePathGenerator_1.filePathsFromMetadataComponent)((0, functions_1.changeResultToMetadataComponent)(this.registry)(input)).some((0, functions_2.forceIgnoreDenies)(this.forceIgnore));
             return [
                 {
                     ...baseObject,