@salesforce/source-tracking 0.5.0 → 1.0.1

package/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.0.1](https://github.com/forcedotcom/source-tracking/compare/v1.0.0...v1.0.1) (2022-01-25)
+
+### Bug Fixes
+
+- emailTempalteFolder via aliased types ([f4c88f9](https://github.com/forcedotcom/source-tracking/commit/f4c88f9b59ad6d061933bfd3f6827e44a59b0e80))
+
+## [1.0.0](https://github.com/forcedotcom/source-tracking/compare/v0.5.2...v1.0.0) (2022-01-20)
+
+### Bug Fixes
+
+- handle element count errors ([8817329](https://github.com/forcedotcom/source-tracking/commit/8817329f8198ce701aba22c7a4476ef31a4d73a4))
+- lightning EmailTemplateFolder ([554c766](https://github.com/forcedotcom/source-tracking/commit/554c76676a85c7a4b673879116912cde51dd1498))
+- remove emailtf attempt ([262839d](https://github.com/forcedotcom/source-tracking/commit/262839dc025c7094d8868d3ae9d769dd39ad5324))
+- sourceMember excepton for nondecomposed children ([05db59e](https://github.com/forcedotcom/source-tracking/commit/05db59e7a6e070224a45f5fbf08013565c9f2131))
+
+### [0.5.2](https://github.com/forcedotcom/source-tracking/compare/v0.5.1...v0.5.2) (2022-01-05)
+
+### Features
+
+- path-scoped singleton ([de46db4](https://github.com/forcedotcom/source-tracking/commit/de46db4b08a3fe087a2931936655c75b3b7cc32c))
+
+### Bug Fixes
+
+- distributed .gitignore and loose pkgDir matching ([a148a36](https://github.com/forcedotcom/source-tracking/commit/a148a366739b6941f3f479b375147897103316bb))
+- remove singleton behavior for localShadowRepo ([887bb68](https://github.com/forcedotcom/source-tracking/commit/887bb684528df8df07fe9b4edf1bd2f4165fe3e2))
+
+### [0.5.1](https://github.com/forcedotcom/source-tracking/compare/v0.5.0...v0.5.1) (2021-12-03)
+
+### Bug Fixes
+
+- support addressable child types ([8251095](https://github.com/forcedotcom/source-tracking/commit/82510955ba8ffe4a2e7e5411973795da3671d01e))
+
 ## [0.5.0](https://github.com/forcedotcom/source-tracking/compare/v0.4.4...v0.5.0) (2021-12-02)
 
 ### ⚠ BREAKING CHANGES

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021, Salesforce.com, Inc.
+Copyright (c) 2022, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/shared/functions.d.ts

@@ -3,3 +3,8 @@ import { RemoteChangeElement, ChangeResult } from './types';
 export declare const getMetadataKey: (metadataType: string, metadataName: string) => string;
 export declare const getKeyFromObject: (element: RemoteChangeElement | ChangeResult) => string;
 export declare const isBundle: (cmp: SourceComponent) => boolean;
+/**
+ * Verify that a filepath starts exactly with a complete parent path
+ * ex: '/foo/bar-extra/baz'.startsWith('foo/bar') would be true, but this function understands that they are not in the same folder
+ */
+export declare const pathIsInFolder: (filePath: string, folder: string) => boolean;

package/lib/shared/functions.js

@@ -6,7 +6,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBundle = exports.getKeyFromObject = exports.getMetadataKey = void 0;
+exports.pathIsInFolder = exports.isBundle = exports.getKeyFromObject = exports.getMetadataKey = void 0;
+const path_1 = require("path");
+const ts_types_1 = require("@salesforce/ts-types");
 const getMetadataKey = (metadataType, metadataName) => {
     return `${metadataType}__${metadataName}`;
 };
@@ -20,4 +22,19 @@ const getKeyFromObject = (element) => {
 exports.getKeyFromObject = getKeyFromObject;
 const isBundle = (cmp) => { var _a; return ((_a = cmp.type.strategies) === null || _a === void 0 ? void 0 : _a.adapter) === 'bundle'; };
 exports.isBundle = isBundle;
+/**
+ * Verify that a filepath starts exactly with a complete parent path
+ * ex: '/foo/bar-extra/baz'.startsWith('foo/bar') would be true, but this function understands that they are not in the same folder
+ */
+const pathIsInFolder = (filePath, folder) => {
+    const biggerStringParts = (0, path_1.normalize)(filePath).split(path_1.sep).filter(nonEmptyStringFilter);
+    return (0, path_1.normalize)(folder)
+        .split(path_1.sep)
+        .filter(nonEmptyStringFilter)
+        .every((part, index) => part === biggerStringParts[index]);
+};
+exports.pathIsInFolder = pathIsInFolder;
+const nonEmptyStringFilter = (value) => {
+    return (0, ts_types_1.isString)(value) && value.length > 0;
+};
 //# sourceMappingURL=functions.js.map

package/lib/shared/localShadowRepo.d.ts

@@ -11,12 +11,13 @@ interface CommitRequest {
     message?: string;
 }
 export declare class ShadowRepo {
-    private static instance;
+    private static instanceMap;
     gitDir: string;
     projectPath: string;
     private packageDirs;
     private status;
     private logger;
+    private gitIgnoreLocations;
     private constructor();
     static getInstance(options: ShadowRepoOptions): Promise<ShadowRepo>;
     init(): Promise<void>;
@@ -74,6 +75,7 @@ export declare class ShadowRepo {
      * @returns sha (string)
      */
     commitChanges({ deployedFiles, deletedFiles, message, }?: CommitRequest): Promise<string>;
+    private locateIgnoreFiles;
     private stashIgnoreFile;
     private unStashIgnoreFile;
 }

package/lib/shared/localShadowRepo.js

@@ -12,6 +12,7 @@ const path = require("path");
 const os = require("os");
 const core_1 = require("@salesforce/core");
 const git = require("isomorphic-git");
+const functions_1 = require("./functions");
 const gitIgnoreFileName = '.gitignore';
 const stashedGitIgnoreFileName = '.BAK.gitignore';
 /**
@@ -28,16 +29,19 @@ const HEAD = 1;
 const WORKDIR = 2;
 class ShadowRepo {
     constructor(options) {
+        this.gitIgnoreLocations = [];
         this.gitDir = getGitDir(options.orgId, options.projectPath);
         this.projectPath = options.projectPath;
         this.packageDirs = options.packageDirs;
     }
+    // think of singleton behavior but unique to the projectPath
     static async getInstance(options) {
-        if (!ShadowRepo.instance) {
-            ShadowRepo.instance = new ShadowRepo(options);
-            await ShadowRepo.instance.init();
+        if (!ShadowRepo.instanceMap.has(options.projectPath)) {
+            const newInstance = new ShadowRepo(options);
+            await newInstance.init();
+            ShadowRepo.instanceMap.set(options.projectPath, newInstance);
         }
-        return ShadowRepo.instance;
+        return ShadowRepo.instanceMap.get(options.projectPath);
     }
     async init() {
         this.logger = await core_1.Logger.child('ShadowRepo');
@@ -54,6 +58,7 @@ class ShadowRepo {
     async gitInit() {
         await core_1.fs.promises.mkdir(this.gitDir, { recursive: true });
         await git.init({ fs: core_1.fs, dir: this.projectPath, gitdir: this.gitDir, defaultBranch: 'main' });
+        await this.locateIgnoreFiles();
     }
     /**
      * Delete the local tracking files
@@ -94,8 +99,15 @@ class ShadowRepo {
                     dir: this.projectPath,
                     gitdir: this.gitDir,
                     filepaths,
-                    // filter out hidden files and __tests__ patterns, regardless of gitignore
-                    filter: (f) => !f.includes(`${path.sep}.`) && !f.includes('__tests__'),
+                    filter: (f) => 
+                    // no hidden files
+                    !f.includes(`${path.sep}.`) &&
+                        // no lwc tests
+                        !f.includes('__tests__') &&
+                        // no gitignore files
+                        ![gitIgnoreFileName, stashedGitIgnoreFileName].includes(path.basename(f)) &&
+                        // isogit uses `startsWith` for filepaths so it's possible to get a false positive
+                        filepaths.some((pkgDir) => (0, functions_1.pathIsInFolder)(f, pkgDir)),
                 });
                 // isomorphic-git stores things in unix-style tree.  Convert to windows-style if necessary
                 if (isWindows) {
@@ -196,20 +208,31 @@ class ShadowRepo {
             await this.unStashIgnoreFile();
         }
     }
+    async locateIgnoreFiles() {
+        // set the gitIgnoreLocations so we only have to do it once
+        this.gitIgnoreLocations = (await git.walk({
+            fs: core_1.fs,
+            dir: this.projectPath,
+            gitdir: this.gitDir,
+            trees: [git.WORKDIR()],
+            // TODO: this can be marginally faster if we limit it to pkgDirs and toplevel project files
+            // eslint-disable-next-line @typescript-eslint/require-await
+            map: async (filepath) => filepath,
+        }))
+            .filter((filepath) => filepath.includes(gitIgnoreFileName) &&
+            // can be top-level like '.' (no sep) OR must be in one of the package dirs
+            (!filepath.includes(path.sep) || this.packageDirs.some((dir) => (0, functions_1.pathIsInFolder)(filepath, dir.name))))
+            .map((ignoreFile) => path.join(this.projectPath, ignoreFile));
+    }
     async stashIgnoreFile() {
-        const originalLocation = path.join(this.projectPath, gitIgnoreFileName);
-        // another process may have already stashed the file
-        if (core_1.fs.existsSync(originalLocation)) {
-            await core_1.fs.promises.rename(originalLocation, path.join(this.projectPath, stashedGitIgnoreFileName));
-        }
+        // allSettled allows them to fail (example, the file wasn't where it was expected).
+        await Promise.allSettled(this.gitIgnoreLocations.map((originalLocation) => core_1.fs.promises.rename(originalLocation, originalLocation.replace(gitIgnoreFileName, stashedGitIgnoreFileName))));
     }
     async unStashIgnoreFile() {
-        const stashedLocation = path.join(this.projectPath, stashedGitIgnoreFileName);
-        // another process may have already un-stashed the file
-        if (core_1.fs.existsSync(stashedLocation)) {
-            await core_1.fs.promises.rename(stashedLocation, path.join(this.projectPath, gitIgnoreFileName));
-        }
+        // allSettled allows them to fail (example, the file wasn't where it was expected).
+        await Promise.allSettled(this.gitIgnoreLocations.map((originalLocation) => core_1.fs.promises.rename(originalLocation.replace(gitIgnoreFileName, stashedGitIgnoreFileName), originalLocation)));
     }
 }
 exports.ShadowRepo = ShadowRepo;
+ShadowRepo.instanceMap = new Map();
 //# sourceMappingURL=localShadowRepo.js.map

package/lib/shared/metadataKeys.d.ts

@@ -1,2 +1,3 @@
 import { RemoteSyncInput } from './types';
 export declare const getMetadataKeyFromFileResponse: (fileResponse: RemoteSyncInput) => string[];
+export declare const mappingsForSourceMemberTypesToMetadataType: Map<string, string>;

package/lib/shared/metadataKeys.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMetadataKeyFromFileResponse = void 0;
+exports.mappingsForSourceMemberTypesToMetadataType = exports.getMetadataKeyFromFileResponse = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -8,11 +8,18 @@ exports.getMetadataKeyFromFileResponse = void 0;
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const path = require("path");
+const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const functions_1 = require("./functions");
 // LWC can have child folders (ex: dynamic templates like /templates/noDataIllustration.html
 const pathAfterFullName = (fileResponse) => fileResponse && fileResponse.filePath
     ? fileResponse.filePath.substr(fileResponse.filePath.indexOf(fileResponse.fullName)).replace(/\\/gi, '/')
     : '';
+const registry = new source_deploy_retrieve_1.RegistryAccess();
+// only compute once
+const aliasTypes = registry
+    .getAliasTypes()
+    .map((aliasType) => [aliasType.name, registry.getTypeByName(aliasType.aliasFor).name]);
+const reverseAliasTypes = new Map(aliasTypes.map(([alias, type]) => [type, alias]));
 // handle all "weird" type/name translation between SourceMember and SDR FileResponse
 // These get de-duplicated in a set later, so it's ok to have one per file
 const getMetadataKeyFromFileResponse = (fileResponse) => {
@@ -38,8 +45,27 @@ const getMetadataKeyFromFileResponse = (fileResponse) => {
             (0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
         ];
     }
-    // standard key
+    // CustomLabels (file) => CustomLabel[] (how they're storedin SourceMembers)
+    if (fileResponse.type === 'CustomLabels' && fileResponse.filePath) {
+        return source_deploy_retrieve_1.ComponentSet.fromSource(fileResponse.filePath)
+            .getSourceComponents()
+            .toArray()
+            .flatMap((component) => component.getChildren().map((child) => (0, functions_1.getMetadataKey)('CustomLabel', child.fullName)));
+    }
+    // if we've aliased a type, we'll have to possibly sync both types--you can't tell from the sourceComponent retrieved which way it was stored on the server
+    if (reverseAliasTypes.has(fileResponse.type)) {
+        return [
+            (0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
+            (0, functions_1.getMetadataKey)(reverseAliasTypes.get(fileResponse.type), fileResponse.fullName),
+        ];
+    }
+    // standard key for everything else
     return [(0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName)];
 };
 exports.getMetadataKeyFromFileResponse = getMetadataKeyFromFileResponse;
+exports.mappingsForSourceMemberTypesToMetadataType = new Map([
+    ...aliasTypes,
+    ['AuraDefinition', 'AuraDefinitionBundle'],
+    ['LightningComponentResource', 'LightningComponentBundle'],
+]);
 //# sourceMappingURL=metadataKeys.js.map

package/lib/shared/remoteSourceTrackingService.js

@@ -477,18 +477,14 @@ RemoteSourceTrackingService.remoteSourceTrackingServiceDictionary = {};
 const remoteChangeElementToChangeResult = (rce) => {
     return {
         ...rce,
-        ...(mappingsForSourceMemberTypesToMetadataType.has(rce.type)
+        ...(metadataKeys_1.mappingsForSourceMemberTypesToMetadataType.has(rce.type)
             ? {
                 name: rce.name.split('/')[0],
-                type: mappingsForSourceMemberTypesToMetadataType.get(rce.type),
+                type: metadataKeys_1.mappingsForSourceMemberTypesToMetadataType.get(rce.type),
             }
             : {}),
         origin: 'remote', // we know they're remote
     };
 };
 exports.remoteChangeElementToChangeResult = remoteChangeElementToChangeResult;
-const mappingsForSourceMemberTypesToMetadataType = new Map([
-    ['AuraDefinition', 'AuraDefinitionBundle'],
-    ['LightningComponentResource', 'LightningComponentBundle'],
-]);
 //# sourceMappingURL=remoteSourceTrackingService.js.map

package/lib/sourceTracking.js

@@ -18,6 +18,7 @@ const remoteSourceTrackingService_1 = require("./shared/remoteSourceTrackingServ
 const localShadowRepo_1 = require("./shared/localShadowRepo");
 const guards_1 = require("./shared/guards");
 const functions_1 = require("./shared/functions");
+const metadataKeys_1 = require("./shared/metadataKeys");
 /**
  * Manages source tracking files (remote and local)
  *
@@ -59,8 +60,8 @@ class SourceTracking extends kit_1.AsyncCreatable {
         const groupings = (byPackageDir
             ? this.packagesDirs.map((pkgDir) => ({
                 path: pkgDir.name,
-                nonDeletes: allNonDeletes.filter((f) => f.startsWith(pkgDir.name)),
-                deletes: allDeletes.filter((f) => f.startsWith(pkgDir.name)),
+                nonDeletes: allNonDeletes.filter((f) => (0, functions_1.pathIsInFolder)(f, pkgDir.name)),
+                deletes: allDeletes.filter((f) => (0, functions_1.pathIsInFolder)(f, pkgDir.name)),
             }))
             : [
                 {
@@ -282,7 +283,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
             .filter(ts_types_1.isString);
         await this.localRepo.commitChanges({
             deployedFiles: relativeOptions.files,
-            deletedFiles: relativeOptions.deletedFiles.concat((await this.localRepo.getDeleteFilenames()).filter((deployedFile) => bundlesWithDeletedFiles.some((bundlePath) => deployedFile.startsWith(bundlePath)) &&
+            deletedFiles: relativeOptions.deletedFiles.concat((await this.localRepo.getDeleteFilenames()).filter((deployedFile) => bundlesWithDeletedFiles.some((bundlePath) => (0, functions_1.pathIsInFolder)(deployedFile, bundlePath)) &&
                 !relativeOptions.files.includes(deployedFile))),
         });
     }
@@ -518,11 +519,18 @@ class SourceTracking extends kit_1.AsyncCreatable {
         return results;
     }
     registrySupportsType(type) {
-        if (this.registry.findType((metadataType) => metadataType.name === type)) {
+        try {
+            if (metadataKeys_1.mappingsForSourceMemberTypesToMetadataType.has(type)) {
+                return true;
+            }
+            // this must use getTypeByName because findType doesn't support addressable child types (ex: customField!)
+            this.registry.getTypeByName(type);
             return true;
         }
-        process.emitWarning(`Unable to find type ${type} in registry`);
-        return false;
+        catch (e) {
+            process.emitWarning(`Unable to find type ${type} in registry`);
+            return false;
+        }
     }
     /**
      * uses SDR to translate remote metadata records into local file paths
@@ -547,11 +555,16 @@ class SourceTracking extends kit_1.AsyncCreatable {
         const remoteChangesAsComponentSet = new source_deploy_retrieve_1.ComponentSet(remoteChangesAsMetadataMember);
         this.logger.debug(` the generated component set has ${remoteChangesAsComponentSet.size.toString()} items`);
         if (remoteChangesAsComponentSet.size < elements.length) {
+            // there *could* be something missing
+            // some types (ex: LWC) show up as multiple files in the remote changes, but only one in the component set
             // iterate the elements to see which ones didn't make it into the component set
-            throw new Error(`unable to generate complete component set for ${elements
-                .filter((element) => !remoteChangesAsComponentSet.has({ type: element === null || element === void 0 ? void 0 : element.type, fullName: element === null || element === void 0 ? void 0 : element.name }))
-                .map((element) => `${element.name} (${element.type})`)
-                .join(os_1.EOL)}`);
+            const missingComponents = elements.filter((element) => !remoteChangesAsComponentSet.has({ type: element === null || element === void 0 ? void 0 : element.type, fullName: element === null || element === void 0 ? void 0 : element.name }));
+            // Throw if anything was actually missing
+            if (missingComponents.length > 0) {
+                throw new Error(`unable to generate complete component set for ${elements
+                    .map((element) => `${element.name} (${element.type})`)
+                    .join(os_1.EOL)}`);
+            }
         }
         const matchingLocalSourceComponentsSet = source_deploy_retrieve_1.ComponentSet.fromSource({
             fsPaths: this.packagesDirs.map((dir) => dir.path),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-tracking",
   "description": "API for tracking local and remote Salesforce metadata changes",
-  "version": "0.5.0",
+  "version": "1.0.1",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -24,7 +24,8 @@
     "pretest": "sf-compile-test",
     "prune:dead": "ts-prune | grep -v 'source-deploy-retrieve' | grep -v 'index.ts'",
     "test": "sf-test",
-    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel"
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "test:nuts:local": "mocha \"**/local/*.nut.ts\" --slow 4500 --timeout 600000 --parallel"
   },
   "keywords": [
     "force",
@@ -42,16 +43,16 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@salesforce/core": "^2.31.0",
+    "@salesforce/core": "^2.33.1",
     "@salesforce/kit": "^1.5.17",
-    "@salesforce/source-deploy-retrieve": "^5.8.0",
+    "@salesforce/source-deploy-retrieve": "^5.9.4",
     "isomorphic-git": "^1.9.2",
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {
     "@salesforce/cli-plugins-testkit": "^1.3.7",
-    "@salesforce/dev-config": "^2.1.2",
-    "@salesforce/dev-scripts": "^1.0.2",
+    "@salesforce/dev-config": "^3.0.0",
+    "@salesforce/dev-scripts": "^2.0.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/shelljs": "^0.8.9",
@@ -65,11 +66,11 @@
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^0.2.7",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "2.24.2",
+    "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jsdoc": "^37.0.1",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.4",
-    "mocha": "^9.0.3",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "prettier": "^2.3.2",
     "pretty-quick": "^3.1.1",