@salesforce/source-tracking 1.1.5 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.2.0](https://github.com/forcedotcom/source-tracking/compare/v1.1.7...v1.2.0) (2022-03-23)
+
+### Features
+
+- let isogit deal with ignore files ([#135](https://github.com/forcedotcom/source-tracking/issues/135)) ([1ddb2cd](https://github.com/forcedotcom/source-tracking/commit/1ddb2cdb8f23688f7bb4876a893097a85581f4c1))
+
+### Bug Fixes
+
+- ga tracking commands compatibility ([3a31a0d](https://github.com/forcedotcom/source-tracking/commit/3a31a0de448993c643ea4661a7a37772e46e8f51))
+- support pkgDir with ./foo ([3b46454](https://github.com/forcedotcom/source-tracking/commit/3b46454b3e57f653cbe80c66fbfee1cac121c2a8))
+
+### [1.1.7](https://github.com/forcedotcom/source-tracking/compare/v1.1.6...v1.1.7) (2022-03-16)
+
+### Bug Fixes
+
+- use isogit multiple add ([0845df8](https://github.com/forcedotcom/source-tracking/commit/0845df81845f07bd2bece444118497b2ef72e7aa))
+
+### [1.1.6](https://github.com/forcedotcom/source-tracking/compare/v1.1.5...v1.1.6) (2022-03-14)
+
 ### [1.1.5](https://github.com/forcedotcom/source-tracking/compare/v1.1.4...v1.1.5) (2022-03-11)
 
 ### [1.1.4](https://github.com/forcedotcom/source-tracking/compare/v1.1.3...v1.1.4) (2022-03-07)

package/lib/compatibility.js

@@ -57,13 +57,18 @@ const throwIfInvalid = ({ org, projectPath, toValidate, command, }) => {
         throw new core_1.SfdxError(`${messages.getMessage('sourceTrackingFileVersionMismatch', ['new/beta'])}\n\nTry this:\n${messages.getMessage('useOtherVersion', ['new/beta', (0, exports.replaceRenamedCommands)(command.replace(':legacy', ''))])}.\n${messages.getMessage('clearSuggestion', [
             'new/beta',
             (0, exports.replaceRenamedCommands)('sfdx force:source:tracking:clear'),
+            (0, exports.replaceRenamedCommands)('sfdx force:source:tracking:reset', true),
         ])}.`, 'SourceTrackingFileVersionMismatch');
     }
     // We expected it to be the plugin-source version but it is using the old tracking files
     if (toValidate === 'plugin-source') {
         throw new core_1.SfdxError(messages.getMessage('sourceTrackingFileVersionMismatch', ['old/legacy']), 'SourceTrackingFileVersionMismatch', [
             messages.getMessage('useOtherVersion', ['old/legacy', (0, exports.replaceRenamedCommands)(command, true)]),
-            messages.getMessage('clearSuggestion', ['old/legacy', 'sfdx force:source:tracking:clear']),
+            messages.getMessage('clearSuggestion', [
+                'old/legacy',
+                'sfdx force:source:legacy:tracking:clear',
+                'sfdx force:source:tracking:reset',
+            ]),
         ]);
     }
 };
@@ -82,10 +87,10 @@ const replaceRenamedCommands = (input, reverse = false) => {
 };
 exports.replaceRenamedCommands = replaceRenamedCommands;
 const renames = new Map([
-    ['force:source:status', 'force:source:beta:status'],
-    ['force:source:push', 'force:source:beta:push'],
-    ['force:source:pull', 'force:source:beta:pull'],
-    ['force:source:tracking:reset', 'force:source:beta:tracking:reset'],
-    ['force:source:tracking:clear', 'force:source:beta:tracking:clear'],
+    ['force:source:legacy:status', 'force:source:status'],
+    ['force:source:legacy:push', 'force:source:push'],
+    ['force:source:legacy:pull', 'force:source:pull'],
+    ['force:source:legacy:tracking:reset', 'force:source:tracking:reset'],
+    ['force:source:legacy:tracking:clear', 'force:source:tracking:clear'],
 ]);
 //# sourceMappingURL=compatibility.js.map

package/lib/shared/localShadowRepo.d.ts

@@ -9,6 +9,7 @@ interface CommitRequest {
     deployedFiles?: string[];
     deletedFiles?: string[];
     message?: string;
+    needsUpdatedStatus?: boolean;
 }
 export declare class ShadowRepo {
     private static instanceMap;
@@ -17,7 +18,6 @@ export declare class ShadowRepo {
     private packageDirs;
     private status;
     private logger;
-    private gitIgnoreLocations;
     private constructor();
     static getInstance(options: ShadowRepoOptions): Promise<ShadowRepo>;
     init(): Promise<void>;
@@ -74,9 +74,6 @@ export declare class ShadowRepo {
      *
      * @returns sha (string)
      */
-    commitChanges({ deployedFiles, deletedFiles, message, }?: CommitRequest): Promise<string>;
-    private locateIgnoreFiles;
-    private stashIgnoreFile;
-    private unStashIgnoreFile;
+    commitChanges({ deployedFiles, deletedFiles, message, needsUpdatedStatus, }?: CommitRequest): Promise<string>;
 }
 export {};

package/lib/shared/localShadowRepo.js

@@ -10,11 +10,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShadowRepo = void 0;
 const path = require("path");
 const os = require("os");
+const fs = require("fs");
 const core_1 = require("@salesforce/core");
 const git = require("isomorphic-git");
 const functions_1 = require("./functions");
 const gitIgnoreFileName = '.gitignore';
-const stashedGitIgnoreFileName = '.BAK.gitignore';
 /**
  * returns the full path to where we store the shadow repo
  */
@@ -29,7 +29,6 @@ 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;
@@ -46,19 +45,18 @@ class ShadowRepo {
     async init() {
         this.logger = await core_1.Logger.child('ShadowRepo');
         // initialize the shadow repo if it doesn't exist
-        if (!core_1.fs.existsSync(this.gitDir)) {
+        if (!fs.existsSync(this.gitDir)) {
             this.logger.debug('initializing git repo');
             await this.gitInit();
         }
-        await this.locateIgnoreFiles();
     }
     /**
      * Initialize a new source tracking shadow repo.  Think of git init
      *
      */
     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 fs.promises.mkdir(this.gitDir, { recursive: true });
+        await git.init({ fs, dir: this.projectPath, gitdir: this.gitDir, defaultBranch: 'main' });
     }
     /**
      * Delete the local tracking files
@@ -66,12 +64,12 @@ class ShadowRepo {
      * @returns the deleted directory
      */
     async delete() {
-        if (typeof core_1.fs.promises.rm === 'function') {
-            await core_1.fs.promises.rm(this.gitDir, { recursive: true, force: true });
+        if (typeof fs.promises.rm === 'function') {
+            await fs.promises.rm(this.gitDir, { recursive: true, force: true });
         }
         else {
             // when node 12 support is over, switch to promise version
-            core_1.fs.rmdirSync(this.gitDir, { recursive: true });
+            fs.rmdirSync(this.gitDir, { recursive: true });
         }
         return this.gitDir;
     }
@@ -85,37 +83,34 @@ class ShadowRepo {
      */
     async getStatus(noCache = false) {
         if (!this.status || noCache) {
-            try {
-                // only ask about OS once but use twice
-                const isWindows = os.type() === 'Windows_NT';
-                await this.stashIgnoreFile();
-                const filepaths = isWindows
-                    ? // iso-git uses posix paths, but packageDirs has already normalized them so we need to convert if windows
-                        this.packageDirs.map((dir) => dir.path.split(path.sep).join(path.posix.sep))
-                    : this.packageDirs.map((dir) => dir.path);
-                // status hasn't been initalized yet
-                this.status = await git.statusMatrix({
-                    fs: core_1.fs,
-                    dir: this.projectPath,
-                    gitdir: this.gitDir,
-                    filepaths,
-                    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) {
-                    this.status = this.status.map((row) => [path.normalize(row[FILE]), row[HEAD], row[WORKDIR], row[3]]);
-                }
-            }
-            finally {
-                await this.unStashIgnoreFile();
+            // only ask about OS once but use twice
+            const isWindows = os.type() === 'Windows_NT';
+            // iso-git uses relative, posix paths
+            // but packageDirs has already resolved / normalized them
+            // so we need to make them project-relative again and convert if windows
+            const filepaths = this.packageDirs
+                .map((dir) => path.relative(this.projectPath, dir.fullPath))
+                .map((p) => (isWindows ? p.split(path.sep).join(path.posix.sep) : p));
+            // status hasn't been initalized yet
+            this.status = await git.statusMatrix({
+                fs,
+                dir: this.projectPath,
+                gitdir: this.gitDir,
+                filepaths,
+                ignored: true,
+                filter: (f) => 
+                // no hidden files
+                !f.includes(`${path.sep}.`) &&
+                    // no lwc tests
+                    !f.includes('__tests__') &&
+                    // no gitignore files
+                    !f.endsWith(gitIgnoreFileName) &&
+                    // 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) {
+                this.status = this.status.map((row) => [path.normalize(row[FILE]), row[HEAD], row[WORKDIR], row[3]]);
             }
         }
         return this.status;
@@ -173,61 +168,41 @@ class ShadowRepo {
      *
      * @returns sha (string)
      */
-    async commitChanges({ deployedFiles = [], deletedFiles = [], message = 'sfdx source tracking', } = {}) {
+    async commitChanges({ deployedFiles = [], deletedFiles = [], message = 'sfdx source tracking', needsUpdatedStatus = true, } = {}) {
         // if no files are specified, commit all changes
         if (deployedFiles.length === 0 && deletedFiles.length === 0) {
             // this is valid, might not be an error
             return 'no files to commit';
         }
-        this.logger.debug('changes are', deployedFiles);
-        this.logger.debug('deletes are', deletedFiles);
-        await this.stashIgnoreFile();
         // these are stored in posix/style/path format.  We have to convert inbound stuff from windows
         if (os.type() === 'Windows_NT') {
             deployedFiles = deployedFiles.map((filepath) => path.normalize(filepath).split(path.sep).join(path.posix.sep));
             deletedFiles = deletedFiles.map((filepath) => path.normalize(filepath).split(path.sep).join(path.posix.sep));
         }
-        try {
-            // stage changes
-            await Promise.all([
-                ...deployedFiles.map((filepath) => git.add({ fs: core_1.fs, dir: this.projectPath, gitdir: this.gitDir, filepath })),
-                ...deletedFiles.map((filepath) => git.remove({ fs: core_1.fs, dir: this.projectPath, gitdir: this.gitDir, filepath })),
-            ]);
-            const sha = await git.commit({
-                fs: core_1.fs,
+        if (deployedFiles.length) {
+            await git.add({
+                fs,
                 dir: this.projectPath,
                 gitdir: this.gitDir,
-                message,
-                author: { name: 'sfdx source tracking' },
+                filepath: [...new Set(deployedFiles)],
+                force: true,
             });
-            // status changed as a result of the commit.  This prevents users from having to run getStatus(true) to avoid cache
-            await this.getStatus(true);
-            return sha;
         }
-        finally {
-            await this.unStashIgnoreFile();
+        for (const filepath of [...new Set(deletedFiles)]) {
+            await git.remove({ fs, dir: this.projectPath, gitdir: this.gitDir, filepath });
         }
-    }
-    async locateIgnoreFiles() {
-        // set the gitIgnoreLocations so we only have to do it once
-        this.gitIgnoreLocations = (await git.walk({
-            fs: core_1.fs,
+        const sha = await git.commit({
+            fs,
             dir: this.projectPath,
             gitdir: this.gitDir,
-            trees: [git.WORKDIR()],
-            // eslint-disable-next-line @typescript-eslint/require-await
-            map: async (filepath) => filepath,
-        }))
-            .filter((filepath) => filepath.includes(gitIgnoreFileName))
-            .map((ignoreFile) => path.join(this.projectPath, ignoreFile));
-    }
-    async stashIgnoreFile() {
-        // 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() {
-        // 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)));
+            message,
+            author: { name: 'sfdx source tracking' },
+        });
+        // status changed as a result of the commit.  This prevents users from having to run getStatus(true) to avoid cache
+        if (needsUpdatedStatus) {
+            await this.getStatus(true);
+        }
+        return sha;
     }
 }
 exports.ShadowRepo = ShadowRepo;

package/lib/shared/remoteSourceTrackingService.js

@@ -11,6 +11,7 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.remoteChangeElementToChangeResult = exports.RemoteSourceTrackingService = void 0;
 const path = require("path");
+const fs = require("fs");
 const ts_retry_promise_1 = require("ts-retry-promise");
 const core_1 = require("@salesforce/core");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
@@ -98,8 +99,8 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
     static async delete(orgId) {
         const fileToDelete = RemoteSourceTrackingService.getFilePath(orgId);
         // the file might not exist, in which case we don't need to delete it
-        if (core_1.fs.existsSync(fileToDelete)) {
-            await core_1.fs.promises.unlink(fileToDelete);
+        if (fs.existsSync(fileToDelete)) {
+            await fs.promises.unlink(fileToDelete);
         }
         return path.isAbsolute(fileToDelete) ? fileToDelete : path.join(process.cwd(), fileToDelete);
     }

package/messages/compatibility.json

@@ -1,5 +1,5 @@
 {
   "sourceTrackingFileVersionMismatch": "This project uses the %s version of source tracking files.",
-  "clearSuggestion": "Clear the %s version of the tracking files by running '%s'",
+  "clearSuggestion": "Push/Pull any local or remote changes.  Then, clear the %s version of the tracking files by running '%s' followed by '%s'.",
   "useOtherVersion": "Use the %s version of the command, '%s' with your existing tracking files."
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-tracking",
   "description": "API for tracking local and remote Salesforce metadata changes",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -46,7 +46,7 @@
     "@salesforce/core": "^2.33.1",
     "@salesforce/kit": "^1.5.17",
     "@salesforce/source-deploy-retrieve": "^5.9.4",
-    "isomorphic-git": "^1.9.2",
+    "isomorphic-git": "1.16.0",
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {