@salesforce/source-tracking 1.5.0 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.
 
+## [2.0.0](https://github.com/forcedotcom/source-tracking/compare/v1.5.0...v2.0.0) (2022-05-23)
+
+### ⚠ BREAKING CHANGES
+
+- remove deprecated option since major version
+
+### Features
+
+- corev3, jsforce2 ([0c0b1cf](https://github.com/forcedotcom/source-tracking/commit/0c0b1cf377245e61d83397fcf39baf7de6c06e76))
+- support both .sfdx/.sf ([3d52e66](https://github.com/forcedotcom/source-tracking/commit/3d52e66b2228c7c6721e97d780d8b56a30cb0496))
+- use new org feature to determine tracking ([0299bfb](https://github.com/forcedotcom/source-tracking/commit/0299bfb9b49122c5e2ff9748038e10a129b26829))
+- use v3 error/messages ([41676ff](https://github.com/forcedotcom/source-tracking/commit/41676ff2d23c6bba91e807d8be152558ad849e30))
+- use v3 error/messages ([488fbfa](https://github.com/forcedotcom/source-tracking/commit/488fbfabbeedb113566b9c67201da4245338b2b6))
+
+- remove deprecated option since major version ([610930a](https://github.com/forcedotcom/source-tracking/commit/610930ac4239a0e1cca57809b0b57d2f022f0b0a))
+
 ## [1.5.0](https://github.com/forcedotcom/source-tracking/compare/v1.4.2...v1.5.0) (2022-05-04)
 
 ### Features

package/lib/compatibility.d.ts

@@ -1,5 +1,6 @@
 import { Org } from '@salesforce/core';
 declare type TrackingFileVersion = 'plugin-source' | 'toolbelt' | 'none';
+export declare const hasSfdxTrackingFiles: (orgId: string, projectPath: string) => boolean;
 /**
  * A project can have "old" (toolbelt), "new" (plugin-source) or "none" tracking files
  *

package/lib/compatibility.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceRenamedCommands = exports.throwIfInvalid = exports.getTrackingFileVersion = void 0;
+exports.replaceRenamedCommands = exports.throwIfInvalid = exports.getTrackingFileVersion = exports.hasSfdxTrackingFiles = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -11,7 +11,13 @@ const fs = require("fs");
 const path = require("path");
 const core_1 = require("@salesforce/core");
 core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/source-tracking', 'compatibility');
+const messages = core_1.Messages.load('@salesforce/source-tracking', 'compatibility', [
+    'sourceTrackingFileVersionMismatch',
+    'clearSuggestion',
+    'useOtherVersion',
+]);
+const hasSfdxTrackingFiles = (orgId, projectPath) => fs.existsSync(path.join(projectPath, '.sfdx', 'orgs', orgId));
+exports.hasSfdxTrackingFiles = hasSfdxTrackingFiles;
 /**
  * A project can have "old" (toolbelt), "new" (plugin-source) or "none" tracking files
  *
@@ -53,8 +59,8 @@ const throwIfInvalid = ({ org, projectPath, toValidate, command, }) => {
     }
     // We expected it to be the toolbelt version but it is using the new tracking files
     if (toValidate === 'toolbelt') {
-        // some of the toolbelt commands aren't using SfdxCommand and the SfdxError actions won't be automatically displayed
-        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', [
+        // some of the toolbelt commands aren't using SfdxCommand and the SfError actions won't be automatically displayed
+        throw new core_1.SfError(`${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),
@@ -62,7 +68,7 @@ const throwIfInvalid = ({ org, projectPath, toValidate, command, }) => {
     }
     // 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', [
+        throw new core_1.SfError(messages.getMessage('sourceTrackingFileVersionMismatch', ['old/legacy']), 'SourceTrackingFileVersionMismatch', [
             messages.getMessage('useOtherVersion', ['old/legacy', (0, exports.replaceRenamedCommands)(command, true)]),
             messages.getMessage('clearSuggestion', [
                 'old/legacy',

package/lib/shared/localShadowRepo.d.ts

@@ -3,6 +3,7 @@ interface ShadowRepoOptions {
     orgId: string;
     projectPath: string;
     packageDirs: NamedPackageDir[];
+    hasSfdxTrackingFiles: boolean;
 }
 declare type StatusRow = [file: string, head: number, workdir: number, stage: number];
 interface CommitRequest {

package/lib/shared/localShadowRepo.js

@@ -14,8 +14,8 @@ const core_1 = require("@salesforce/core");
 const git = require("isomorphic-git");
 const functions_1 = require("./functions");
 /** returns the full path to where we store the shadow repo */
-const getGitDir = (orgId, projectPath) => {
-    return path.join(projectPath, '.sfdx', 'orgs', orgId, 'localSourceTracking');
+const getGitDir = (orgId, projectPath, useSfdxTrackingFiles = false) => {
+    return path.join(projectPath, useSfdxTrackingFiles ? '.sfdx' : '.sf', 'orgs', orgId, 'localSourceTracking');
 };
 // filenames were normalized when read from isogit
 const toFilenames = (rows) => rows.map((row) => row[FILE]);
@@ -25,7 +25,7 @@ const HEAD = 1;
 const WORKDIR = 2;
 class ShadowRepo {
     constructor(options) {
-        this.gitDir = getGitDir(options.orgId, options.projectPath);
+        this.gitDir = getGitDir(options.orgId, options.projectPath, options.hasSfdxTrackingFiles);
         this.projectPath = options.projectPath;
         this.packageDirs = options.packageDirs;
         this.isWindows = os.type() === 'Windows_NT';
@@ -66,8 +66,7 @@ class ShadowRepo {
             await fs.promises.rm(this.gitDir, { recursive: true, force: true });
         }
         else {
-            // when node 12 support is over, switch to promise version
-            fs.rmdirSync(this.gitDir, { recursive: true });
+            await fs.promises.rm(this.gitDir, { recursive: true });
         }
         return this.gitDir;
     }
@@ -190,7 +189,7 @@ class ShadowRepo {
                 catch (e) {
                     if (e instanceof git.Errors.MultipleGitError) {
                         this.logger.error('multiple errors on git.add', e.errors.slice(0, 5));
-                        const error = new core_1.SfdxError(e.message, e.name, [], 1);
+                        const error = new core_1.SfError(e.message, e.name, [], 1);
                         error.setData(e.errors);
                         throw error;
                     }

package/lib/shared/remoteSourceTrackingService.d.ts

@@ -1,10 +1,15 @@
-import { ConfigFile, Logger } from '@salesforce/core';
-import { ChangeResult, RemoteChangeElement, SourceMember, RemoteSyncInput } from './types';
+import { ConfigFile, Logger, Org } from '@salesforce/core';
+import { Dictionary } from '@salesforce/ts-types';
+import { ChangeResult, RemoteChangeElement, MemberRevision, SourceMember, RemoteSyncInput } from './types';
+declare type Contents = {
+    serverMaxRevisionCounter: number;
+    sourceMembers: Dictionary<MemberRevision>;
+};
 export declare namespace RemoteSourceTrackingService {
     interface Options extends ConfigFile.Options {
-        orgId: string;
-        /** only used for connecting to the org */
-        username: string;
+        org: Org;
+        projectPath: string;
+        useSfdxTrackingFiles: boolean;
     }
 }
 /**
@@ -43,11 +48,10 @@ export declare namespace RemoteSourceTrackingService {
  * from the `lastRetrievedFromServer`. When a pull is performed, all of the pulled members will have their counters set
  * to the corresponding `RevisionCounter` from the `SourceMember` of the org.
  */
-export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTrackingService.Options> {
+export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTrackingService.Options, Contents> {
     private static remoteSourceTrackingServiceDictionary;
     protected logger: Logger;
     private org;
-    private isSourceTrackedOrg;
     private queryCache;
     /**
      * Get the singleton instance for a given user.
@@ -57,14 +61,14 @@ export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSource
      */
     static getInstance(options: RemoteSourceTrackingService.Options): Promise<RemoteSourceTrackingService>;
     static getFileName(): string;
-    static getFilePath(orgId: string): string;
+    static getFilePath(orgId: string, useSfdxTrackingFiles?: boolean): string;
     /**
      * Delete the RemoteSourceTracking for a given org.
      *
      * @param orgId
      * @returns the path of the deleted source tracking file
      */
-    static delete(orgId: string): Promise<string>;
+    static delete(orgId: string, useSfdxTrackingFiles?: boolean): Promise<string>;
     /**
      * Initializes the service with existing remote source tracking data, or sets
      * the state to begin source tracking of metadata changes in the org.
@@ -105,7 +109,6 @@ export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSource
     private initSourceMembers;
     private getSourceMember;
     private setMemberRevision;
-    private getTypedContents;
     trackSourceMembers(sourceMembers: SourceMember[], sync?: boolean): Promise<void>;
     /**
      * Queries the org for any new, updated, or deleted metadata and updates
@@ -140,3 +143,4 @@ export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSource
  * Useful for correcing bundle types where the files show change results with types but aren't resolvable
  */
 export declare const remoteChangeElementToChangeResult: (rce: RemoteChangeElement) => ChangeResult;
+export {};

package/lib/shared/remoteSourceTrackingService.js

@@ -64,7 +64,6 @@ const CONSECUTIVE_EMPTY_POLLING_RESULT_LIMIT = ((_a = kit_1.env.getNumber('SFDX_
 class RemoteSourceTrackingService extends core_1.ConfigFile {
     constructor() {
         super(...arguments);
-        this.isSourceTrackedOrg = true;
         // A short term cache (within the same process) of query results based on a revision.
         // Useful for source:pull, which makes 3 of the same queries; during status, building manifests, after pull success.
         this.queryCache = new Map();
@@ -79,16 +78,17 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
      * @returns {Promise<RemoteSourceTrackingService>} the remoteSourceTrackingService object for the given username
      */
     static async getInstance(options) {
-        if (!this.remoteSourceTrackingServiceDictionary[options.orgId]) {
-            this.remoteSourceTrackingServiceDictionary[options.orgId] = await RemoteSourceTrackingService.create(options);
+        const orgId = options.org.getOrgId();
+        if (!this.remoteSourceTrackingServiceDictionary[orgId]) {
+            this.remoteSourceTrackingServiceDictionary[orgId] = await RemoteSourceTrackingService.create(options);
         }
-        return this.remoteSourceTrackingServiceDictionary[options.orgId];
+        return this.remoteSourceTrackingServiceDictionary[orgId];
     }
     static getFileName() {
         return 'maxRevision.json';
     }
-    static getFilePath(orgId) {
-        return path.join('.sfdx', 'orgs', orgId, RemoteSourceTrackingService.getFileName());
+    static getFilePath(orgId, useSfdxTrackingFiles = false) {
+        return path.join(useSfdxTrackingFiles ? '.sfdx' : '.sf', 'orgs', orgId, RemoteSourceTrackingService.getFileName());
     }
     /**
      * Delete the RemoteSourceTracking for a given org.
@@ -96,8 +96,8 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
      * @param orgId
      * @returns the path of the deleted source tracking file
      */
-    static async delete(orgId) {
-        const fileToDelete = RemoteSourceTrackingService.getFilePath(orgId);
+    static async delete(orgId, useSfdxTrackingFiles = false) {
+        const fileToDelete = RemoteSourceTrackingService.getFilePath(orgId, useSfdxTrackingFiles);
         // the file might not exist, in which case we don't need to delete it
         if (fs.existsSync(fileToDelete)) {
             await fs.promises.unlink(fileToDelete);
@@ -109,17 +109,21 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
      * the state to begin source tracking of metadata changes in the org.
      */
     async init() {
-        this.org = await core_1.Org.create({ aliasOrUsername: this.options.username });
+        this.org = this.options.org;
         this.logger = await core_1.Logger.child(this.constructor.name);
-        this.options.filePath = path.join('orgs', this.org.getOrgId());
-        this.options.filename = RemoteSourceTrackingService.getFileName();
+        this.options = {
+            ...this.options,
+            stateFolder: this.options.useSfdxTrackingFiles ? '.sfdx' : '.sf',
+            filename: RemoteSourceTrackingService.getFileName(),
+            filePath: path.join('orgs', this.org.getOrgId()),
+        };
         try {
             await super.init();
         }
         catch (err) {
-            throw core_1.SfdxError.wrap(err);
+            throw core_1.SfError.wrap(err);
         }
-        const contents = this.getTypedContents();
+        const contents = this.getContents();
         // Initialize a new maxRevision.json if the file doesn't yet exist.
         if (!contents.serverMaxRevisionCounter && !contents.sourceMembers) {
             try {
@@ -135,11 +139,11 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
             }
             catch (e) {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-                if (e instanceof core_1.SfdxError &&
+                if (e instanceof core_1.SfError &&
                     e.name === 'INVALID_TYPE' &&
                     e.message.includes("sObject type 'SourceMember' is not supported")) {
                     // non-source-tracked org E.G. DevHub or trailhead playground
-                    this.isSourceTrackedOrg = false;
+                    await this.org.setTracksSource(false);
                 }
                 else {
                     throw e;
@@ -230,26 +234,23 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         };
     }
     getServerMaxRevision() {
-        return this['contents'].serverMaxRevisionCounter;
+        return this.getContents().serverMaxRevisionCounter;
     }
     setServerMaxRevision(revision = 0) {
         this['contents'].serverMaxRevisionCounter = revision;
     }
     getSourceMembers() {
-        return this['contents'].sourceMembers;
+        return this.getContents().sourceMembers;
     }
     initSourceMembers() {
-        this['contents'].sourceMembers = {};
+        this.getContents().sourceMembers = {};
     }
     // Return a tracked element as MemberRevision data.
     getSourceMember(key) {
         return this.getSourceMembers()[key];
     }
     setMemberRevision(key, sourceMember) {
-        this.getTypedContents().sourceMembers[key] = sourceMember;
-    }
-    getTypedContents() {
-        return this.getContents();
+        this.getContents().sourceMembers[key] = sourceMember;
     }
     // Adds the given SourceMembers to the list of tracked MemberRevisions, optionally updating
     // the lastRetrievedFromServer field (sync), and persists the changes to maxRevision.json.
@@ -535,20 +536,22 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         return this.query(query, quiet);
     }
     async query(query, quiet = false) {
-        if (!this.isSourceTrackedOrg) {
+        if (!(await this.org.tracksSource())) {
             core_1.Messages.importMessagesDirectory(__dirname);
-            this.messages = core_1.Messages.loadMessages('@salesforce/source-tracking', 'source');
-            throw core_1.SfdxError.create('@salesforce/source-tracking', 'source', 'NonSourceTrackedOrgError');
+            const messages = core_1.Messages.load('@salesforce/source-tracking', 'source', ['NonSourceTrackedOrgError']);
+            throw new core_1.SfError(messages.getMessage('NonSourceTrackedOrgError'), 'NonSourceTrackedOrgError');
         }
         if (!quiet) {
             this.logger.debug(query);
         }
         try {
-            const results = await this.org.getConnection().tooling.autoFetchQuery(query, { maxFetch: 50000 });
+            const results = await this.org.getConnection().tooling.query(query, {
+                autoFetch: true,
+            });
             return results.records;
         }
         catch (error) {
-            throw core_1.SfdxError.wrap(error);
+            throw core_1.SfError.wrap(error);
         }
     }
 }

package/lib/sourceTracking.d.ts

@@ -1,12 +1,10 @@
-import { Org, SfdxProject } from '@salesforce/core';
+import { Org, SfProject } from '@salesforce/core';
 import { AsyncCreatable } from '@salesforce/kit';
 import { ComponentSet, SourceComponent, FileResponse } from '@salesforce/source-deploy-retrieve';
 import { RemoteSyncInput, StatusOutputRow, ChangeOptions, ChangeResult, ChangeOptionType, LocalUpdateOptions } from './shared/types';
 export interface SourceTrackingOptions {
     org: Org;
-    project: SfdxProject;
-    /** @deprecated not used defaults to sfdxProject sourceApiVersion unless provided */
-    apiVersion?: string;
+    project: SfProject;
 }
 /**
  * Manages source tracking files (remote and local)
@@ -15,16 +13,16 @@ export interface SourceTrackingOptions {
  *
  */
 export declare class SourceTracking extends AsyncCreatable {
-    private orgId;
+    private org;
     private project;
     private projectPath;
     private packagesDirs;
-    private username;
     private logger;
     private registry;
     private localRepo;
     private remoteSourceTrackingService;
     private forceIgnore;
+    private hasSfdxTrackingFiles;
     constructor(options: SourceTrackingOptions);
     init(): Promise<void>;
     /**

package/lib/sourceTracking.js

@@ -19,6 +19,7 @@ const localShadowRepo_1 = require("./shared/localShadowRepo");
 const guards_1 = require("./shared/guards");
 const functions_1 = require("./shared/functions");
 const metadataKeys_1 = require("./shared/metadataKeys");
+const compatibility_1 = require("./compatibility");
 /**
  * Manages source tracking files (remote and local)
  *
@@ -29,12 +30,12 @@ class SourceTracking extends kit_1.AsyncCreatable {
     constructor(options) {
         super(options);
         this.registry = new source_deploy_retrieve_1.RegistryAccess();
-        this.orgId = options.org.getOrgId();
-        this.username = options.org.getUsername();
+        this.org = options.org;
         this.projectPath = options.project.getPath();
         this.packagesDirs = options.project.getPackageDirectories();
         this.logger = core_1.Logger.childFromRoot('SourceTracking');
         this.project = options.project;
+        this.hasSfdxTrackingFiles = (0, compatibility_1.hasSfdxTrackingFiles)(this.org.getOrgId(), this.projectPath);
     }
     async init() {
         // reserved for future use
@@ -337,9 +338,10 @@ class SourceTracking extends kit_1.AsyncCreatable {
             return;
         }
         this.localRepo = await localShadowRepo_1.ShadowRepo.getInstance({
-            orgId: this.orgId,
+            orgId: this.org.getOrgId(),
             projectPath: (0, path_1.normalize)(this.projectPath),
             packageDirs: this.packagesDirs,
+            hasSfdxTrackingFiles: this.hasSfdxTrackingFiles,
         });
         // loads the status from file so that it's cached
         await this.localRepo.getStatus();
@@ -356,8 +358,9 @@ class SourceTracking extends kit_1.AsyncCreatable {
         }
         this.logger.debug('ensureRemoteTracking: remote tracking does not exist yet; getting instance');
         this.remoteSourceTrackingService = await remoteSourceTrackingService_1.RemoteSourceTrackingService.getInstance({
-            username: this.username,
-            orgId: this.orgId,
+            org: this.org,
+            projectPath: this.projectPath,
+            useSfdxTrackingFiles: this.hasSfdxTrackingFiles,
         });
         if (initializeWithQuery) {
             await this.remoteSourceTrackingService.retrieveUpdates();
@@ -391,7 +394,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
      * Deletes the remote tracking files
      */
     async clearRemoteTracking() {
-        return remoteSourceTrackingService_1.RemoteSourceTrackingService.delete(this.orgId);
+        return remoteSourceTrackingService_1.RemoteSourceTrackingService.delete(this.org.getOrgId(), this.hasSfdxTrackingFiles);
     }
     /**
      * Sets the files to max revision so that no changes appear

package/messages/compatibility.md

@@ -0,0 +1,11 @@
+# sourceTrackingFileVersionMismatch
+
+This project uses the %s version of source tracking files.
+
+# 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/messages/source.md

@@ -0,0 +1,3 @@
+# NonSourceTrackedOrgError
+
+This command can only be used on orgs that have source tracking enabled, such as sandboxes and scratch orgs.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-tracking",
   "description": "API for tracking local and remote Salesforce metadata changes",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -43,9 +43,9 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@salesforce/core": "^2.33.1",
+    "@salesforce/core": "^3.19.0",
     "@salesforce/kit": "^1.5.17",
-    "@salesforce/source-deploy-retrieve": "^5.12.12",
+    "@salesforce/source-deploy-retrieve": "^6.0.1",
     "graceful-fs": "^4.2.9",
     "isomorphic-git": "1.17.0",
     "ts-retry-promise": "^0.6.0"

package/messages/compatibility.json

@@ -1,5 +0,0 @@
-{
-  "sourceTrackingFileVersionMismatch": "This project uses the %s version of source tracking files.",
-  "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/messages/source.json

@@ -1,3 +0,0 @@
-{
-  "NonSourceTrackedOrgError": "This command can only be used on orgs that have source tracking enabled, such as sandboxes and scratch orgs."
-}