Merge pull request #561 from forcedotcom/sm/refactor-interfaces

fix: interfaces to types, no-param-reassign for windows normalization

Author: iowillhoit

package.json

@@ -47,7 +47,7 @@
     "@oclif/core": "^3.26.0",
     "@salesforce/core": "^6.7.6",
     "@salesforce/kit": "^3.1.0",
-    "@salesforce/source-deploy-retrieve": "^10.9.0",
+    "@salesforce/source-deploy-retrieve": "^10.9.1",
     "@salesforce/ts-types": "^2.0.9",
     "fast-xml-parser": "^4.3.6",
     "graceful-fs": "^4.2.11",
@@ -61,7 +61,7 @@
     "eslint-plugin-sf-plugin": "^1.17.4",
     "ts-node": "^10.9.2",
     "ts-patch": "^3.1.2",
-    "typescript": "^5.4.3"
+    "typescript": "^5.4.4"
   },
   "config": {},
   "publishConfig": {

src/shared/localComponentSetArray.ts

@@ -17,16 +17,16 @@ import {
 import { sourceComponentGuard } from './guards';
 import { supportsPartialDelete, pathIsInFolder } from './functions';
 
-interface GroupedFileInput {
+type GroupedFileInput = {
   packageDirs: NamedPackageDir[];
   nonDeletes: string[];
   deletes: string[];
-}
-interface GroupedFile {
+};
+type GroupedFile = {
   path: string;
   nonDeletes: string[];
   deletes: string[];
-}
+};
 
 export const getGroupedFiles = (input: GroupedFileInput, byPackageDir = false): GroupedFile[] =>
   (byPackageDir ? getSequential(input) : getNonSequential(input)).filter(

src/shared/localShadowRepo.ts

@@ -34,11 +34,11 @@ const redirectToCliRepoError = (e: unknown): never => {
   throw e;
 };
 
-interface ShadowRepoOptions {
+type ShadowRepoOptions = {
   orgId: string;
   projectPath: string;
   packageDirs: NamedPackageDir[];
-}
+};
 
 // https://isomorphic-git.org/docs/en/statusMatrix#docsNav
 type StatusRow = [file: string, head: number, workdir: number, stage: number];
@@ -48,12 +48,12 @@ const FILE = 0;
 const HEAD = 1;
 const WORKDIR = 2;
 
-interface CommitRequest {
+type CommitRequest = {
   deployedFiles?: string[];
   deletedFiles?: string[];
   message?: string;
   needsUpdatedStatus?: boolean;
-}
+};
 
 export class ShadowRepo {
   private static instanceMap = new Map<string, ShadowRepo>();
@@ -256,16 +256,13 @@ export class ShadowRepo {
       deployedFiles: deployedFiles.length,
       deletedFiles: deletedFiles.length,
     });
-    // these are stored in posix/style/path format.  We have to convert inbound stuff from windows
-    if (this.isWindows) {
-      this.logger.trace('start: transforming windows paths to posix');
-      deployedFiles = deployedFiles.map(normalize).map(ensurePosix);
-      deletedFiles = deletedFiles.map(normalize).map(ensurePosix);
-      this.logger.trace('done: transforming windows paths to posix');
-    }
 
     if (deployedFiles.length) {
-      const chunks = chunkArray([...new Set(deployedFiles)], this.maxFileAdd);
+      const chunks = chunkArray(
+        // these are stored in posix/style/path format.  We have to convert inbound stuff from windows
+        [...new Set(this.isWindows ? deployedFiles.map(normalize).map(ensurePosix) : deployedFiles)],
+        this.maxFileAdd
+      );
       for (const chunk of chunks) {
         try {
           this.logger.debug(`adding ${chunk.length} files of ${deployedFiles.length} deployedFiles to git`);
@@ -297,7 +294,7 @@ export class ShadowRepo {
       }
     }
 
-    for (const filepath of [...new Set(deletedFiles)]) {
+    for (const filepath of [...new Set(this.isWindows ? deletedFiles.map(normalize).map(ensurePosix) : deletedFiles)]) {
       try {
         // these need to be done sequentially because isogit manages file locking.  Isogit remove does not support multiple files at once
         // eslint-disable-next-line no-await-in-loop

src/shared/remoteSourceTrackingService.ts

@@ -42,10 +42,10 @@ const CONSECUTIVE_EMPTY_POLLING_RESULT_LIMIT =
   (env.getNumber('SFDX_SOURCE_MEMBER_POLLING_TIMEOUT') ?? 120) / Duration.milliseconds(POLLING_DELAY_MS).seconds;
 
 /** Options for RemoteSourceTrackingService.getInstance */
-export interface RemoteSourceTrackingServiceOptions {
+export type RemoteSourceTrackingServiceOptions = {
   org: Org;
   projectPath: string;
-}
+};
 
 /**
  * This service handles source tracking of metadata between a local project and an org.

src/shared/types.ts

@@ -8,11 +8,11 @@
 import { FileResponse, SourceComponent } from '@salesforce/source-deploy-retrieve';
 import { SfError } from '@salesforce/core';
 
-export interface ChangeOptions {
+export type ChangeOptions = {
   origin: 'local' | 'remote';
   state: 'add' | 'delete' | 'modify' | 'nondelete';
   format: 'ChangeResult' | 'SourceComponent' | 'string' | 'ChangeResultWithPaths';
-}
+};
 
 export type RemoteSyncInput = Pick<FileResponse, 'fullName' | 'filePath' | 'type' | 'state'>;
 
@@ -21,10 +21,10 @@ export type StatusOutputRow = Pick<FileResponse, 'fullName' | 'filePath' | 'type
   ignored?: boolean;
 } & Pick<ChangeOptions, 'origin' | 'state'>;
 
-export interface LocalUpdateOptions {
+export type LocalUpdateOptions = {
   files?: string[];
   deletedFiles?: string[];
-}
+};
 
 export type RemoteChangeElement = {
   name: string;
@@ -57,12 +57,12 @@ export type SourceMember = {
   ignored?: boolean;
 };
 
-export interface ConflictResponse {
+export type ConflictResponse = {
   state: 'Conflict';
   fullName: string;
   type: string;
   filePath: string;
-}
+};
 
 // this and the related class are not enforced but a convention of this library.
 // This helps the consumers get correct typing--if the error name matches SourceConflictError,

src/sourceTracking.ts

@@ -68,7 +68,7 @@ import { populateFilePaths } from './shared/populateFilePaths';
 import { populateTypesAndNames } from './shared/populateTypesAndNames';
 import { getComponentSets, getGroupedFiles } from './shared/localComponentSetArray';
 import { sourceComponentIsCustomLabel } from './shared/functions';
-export interface SourceTrackingOptions {
+export type SourceTrackingOptions = {
   org: Org;
   project: SfProject;
 
@@ -87,7 +87,7 @@ export interface SourceTrackingOptions {
    * If you're using STL as part of a long running process (ex: vscode extensions), set this to false
    */
   ignoreLocalCache?: boolean;
-}
+};
 
 type RemoteChangesResults = {
   componentSetFromNonDeletes: ComponentSet;

yarn.lock

@@ -670,10 +670,10 @@
   resolved "https://registry.yarnpkg.com/@salesforce/schemas/-/schemas-1.7.0.tgz#b7e0af3ee414ae7160bce351c0184d77ccb98fe3"
   integrity sha512-Z0PiCEV55khm0PG+DsnRYCjaDmacNe3HDmsoSm/CSyYvJJm+D5vvkHKN9/PKD/gaRe8XAU836yfamIYFblLINw==
 
-"@salesforce/source-deploy-retrieve@^10.9.0":
-  version "10.9.0"
-  resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-10.9.0.tgz#eb7b824a9ec643828bae22317f44327af617ca92"
-  integrity sha512-BOcOsoizC9rOTciNUmzvu5R51GJIXdcrLwdR+MwAWohIvQNa90R7BdxBS3YSIep7epi5lXUWQpPGQAKDumuaZA==
+"@salesforce/source-deploy-retrieve@^10.9.1":
+  version "10.9.1"
+  resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-10.9.1.tgz#315981e58e684b4fe49dd812b3e3c6a3daf92bf6"
+  integrity sha512-FmSO6F4DFv7CqtFIzs0v8yuMlEie+hG2fq7QrBmhBxd6+1WNfk7wM3vXZyO0zOv9uarkILStB5+Dy91DYVrRHw==
   dependencies:
     "@salesforce/core" "^6.7.3"
     "@salesforce/kit" "^3.1.0"
@@ -5656,10 +5656,10 @@ typedoc@^0.25.12:
     minimatch "^9.0.3"
     shiki "^0.14.7"
 
-"typescript@^4.6.4 || ^5.0.0", typescript@^5.4.3:
-  version "5.4.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.3.tgz#5c6fedd4c87bee01cd7a528a30145521f8e0feff"
-  integrity sha512-KrPd3PKaCLr78MalgiwJnA25Nm8HAmdwN3mYUYZgG/wizIo9EainNVQI9/yDavtVFRN2h3k8uf3GLHuhDMgEHg==
+"typescript@^4.6.4 || ^5.0.0", typescript@^5.4.3, typescript@^5.4.4:
+  version "5.4.4"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.4.tgz#eb2471e7b0a5f1377523700a21669dce30c2d952"
+  integrity sha512-dGE2Vv8cpVvw28v8HCPqyb08EzbBURxDpuhJvTrusShUfGnhHBafDsLdS1EhhxyL6BJQE+2cT3dDPAv+MQ6oLw==
 
 unbox-primitive@^1.0.2:
   version "1.0.2"