fix: again with the promises

Author: mshanemc

src/shared/localShadowRepo.ts

@@ -7,8 +7,6 @@
 /* eslint-disable no-console */
 
 import { join as pathJoin } from 'path';
-// what's fsp?  well, we'd like to fs.promises but can't until we upgrade node beyond 12
-import { promises as fsp, existsSync } from 'fs';
 import * as fs from 'fs';
 import { AsyncCreatable } from '@salesforce/kit';
 import { NamedPackageDir, Logger } from '@salesforce/core';
@@ -65,7 +63,7 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
     this.logger = await Logger.child('ShadowRepo');
     this.logger.debug('options for constructor are', this.options);
     // initialize the shadow repo if it doesn't exist
-    if (!existsSync(this.gitDir)) {
+    if (!fs.existsSync(this.gitDir)) {
       this.logger.debug('initializing git repo');
       await this.gitInit();
     }
@@ -76,12 +74,12 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
    *
    */
   public async gitInit(): Promise<void> {
-    await fsp.mkdir(this.gitDir, { recursive: true });
+    await fs.promises.mkdir(this.gitDir, { recursive: true });
     await git.init({ fs, dir: this.projectPath, gitdir: this.gitDir, defaultBranch: 'main' });
   }
 
   public async delete(): Promise<string> {
-    await fsp.rm(this.gitDir, { recursive: true, force: true });
+    await fs.promises.rm(this.gitDir, { recursive: true, force: true });
     return this.gitDir;
   }
   /**
@@ -211,14 +209,14 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
   private async stashIgnoreFile(): Promise<void> {
     if (!this.stashed) {
       this.stashed = true;
-      await fsp.rename(pathJoin(this.projectPath, '.gitignore'), pathJoin(this.projectPath, '.BAK.gitignore'));
+      await fs.promises.rename(pathJoin(this.projectPath, '.gitignore'), pathJoin(this.projectPath, '.BAK.gitignore'));
     }
   }
 
   private async unStashIgnoreFile(): Promise<void> {
     if (this.stashed) {
       this.stashed = false;
-      await fsp.rename(pathJoin(this.projectPath, '.BAK.gitignore'), pathJoin(this.projectPath, '.gitignore'));
+      await fs.promises.rename(pathJoin(this.projectPath, '.BAK.gitignore'), pathJoin(this.projectPath, '.gitignore'));
     }
   }
 }

src/shared/remoteSourceTrackingService.ts

@@ -8,7 +8,7 @@
 /* eslint-disable @typescript-eslint/member-ordering */
 
 import * as path from 'path';
-import { promises as fs, existsSync } from 'fs';
+import * as fs from 'fs';
 import { retryDecorator } from 'ts-retry-promise';
 import { ConfigFile, Logger, Org, SfdxError, Messages } from '@salesforce/core';
 import { ComponentStatus } from '@salesforce/source-deploy-retrieve';
@@ -132,8 +132,8 @@ export class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTracking
   public static async delete(orgId: string): Promise<string> {
     const fileToDelete = RemoteSourceTrackingService.getFilePath(orgId);
     // the file might not exist, in which case we don't need to delete it
-    if (existsSync(fileToDelete)) {
-      await fs.rm(fileToDelete, { recursive: true });
+    if (fs.existsSync(fileToDelete)) {
+      await fs.promises.rm(fileToDelete, { recursive: true });
     }
     return path.isAbsolute(fileToDelete) ? fileToDelete : path.join(process.cwd(), fileToDelete);
   }

src/sourceTracking.ts

@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { promises as fs } from 'fs';
+import * as fs from 'fs';
 import * as path from 'path';
 import { NamedPackageDir, Logger, Org, SfdxProject } from '@salesforce/core';
 import { getString } from '@salesforce/ts-types';
@@ -210,7 +210,7 @@ export class SourceTracking extends AsyncCreatable {
         .map((change) => change.filenames as string[])
         .flat()
         .filter(Boolean);
-      await Promise.all(filenames.map((filename) => fs.unlink(filename)));
+      await Promise.all(filenames.map((filename) => fs.promises.unlink(filename)));
       await Promise.all([
         this.updateLocalTracking({ deletedFiles: filenames }),
         this.updateRemoteTracking(

test/nuts/commands/basics.nut.ts

@@ -8,7 +8,7 @@
 /* eslint-disable no-console */
 
 import * as path from 'path';
-import { promises as fs } from 'fs';
+import * as fs from 'fs';
 
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
 import { Env } from '@salesforce/kit';
@@ -72,8 +72,8 @@ describe('end-to-end-test for tracking with an org (single packageDir)', () => {
     it('sees a local delete in local status', async () => {
       const classDir = path.join(session.project.dir, 'force-app', 'main', 'default', 'classes');
       await Promise.all([
-        fs.rm(path.join(classDir, 'TestOrderController.cls')),
-        fs.rm(path.join(classDir, 'TestOrderController.cls-meta.xml')),
+        fs.promises.rm(path.join(classDir, 'TestOrderController.cls')),
+        fs.promises.rm(path.join(classDir, 'TestOrderController.cls-meta.xml')),
       ]);
       const result = execCmd<StatusResult[]>('force:source:status --json --local', { ensureExitCode: 0 }).jsonOutput
         .result;

test/nuts/commands/conflicts.nut.ts

@@ -10,7 +10,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 
 import * as path from 'path';
-import { promises as fs } from 'fs';
+import * as fs from 'fs';
 import { expect } from 'chai';
 
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
@@ -70,9 +70,9 @@ describe('conflict detection and resolution', () => {
       'applications',
       'Ebikes.app-meta.xml'
     );
-    await fs.writeFile(
+    await fs.promises.writeFile(
       filePath,
-      (await fs.readFile(filePath, { encoding: 'utf-8' })).replace('Lightning App Builder', 'App Builder')
+      (await fs.promises.readFile(filePath, { encoding: 'utf-8' })).replace('Lightning App Builder', 'App Builder')
     );
   });
   it('can see the conflict in status', () => {

test/nuts/commands/forceIgnore.nut.ts

@@ -11,7 +11,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 
 import * as path from 'path';
-import { promises as fs } from 'fs';
+import * as fs from 'fs';
 import { expect } from 'chai';
 import * as shell from 'shelljs';
 
@@ -36,7 +36,7 @@ describe('forceignore changes', () => {
         `sfdx force:apex:class:create -n IgnoreTest --outputdir ${classdir}`,
       ],
     });
-    originalForceIgnore = await fs.readFile(path.join(session.project.dir, '.forceignore'), 'utf8');
+    originalForceIgnore = await fs.promises.readFile(path.join(session.project.dir, '.forceignore'), 'utf8');
     conn = await Connection.create({
       authInfo: await AuthInfo.create({
         username: (session.setup[0] as { result: { username: string } }).result?.username,
@@ -53,7 +53,7 @@ describe('forceignore changes', () => {
     it('will not push a file that was created, then ignored', async () => {
       // setup a forceIgnore with some file
       const newForceIgnore = originalForceIgnore + '\n' + `${classdir}/IgnoreTest.cls`;
-      await fs.writeFile(path.join(session.project.dir, '.forceignore'), newForceIgnore);
+      await fs.promises.writeFile(path.join(session.project.dir, '.forceignore'), newForceIgnore);
       // nothing should push
       const output = execCmd<PushPullResponse[]>('force:source:push --json', { ensureExitCode: 0 }).jsonOutput.result;
       expect(output).to.deep.equal([]);
@@ -63,7 +63,7 @@ describe('forceignore changes', () => {
       // setup a forceIgnore with some file
       const newForceIgnore =
         originalForceIgnore + '\n' + `${classdir}/UnIgnoreTest.cls` + '\n' + `${classdir}/IgnoreTest.cls`;
-      await fs.writeFile(path.join(session.project.dir, '.forceignore'), newForceIgnore);
+      await fs.promises.writeFile(path.join(session.project.dir, '.forceignore'), newForceIgnore);
 
       // add a file in the local source
       shell.exec(`sfdx force:apex:class:create -n UnIgnoreTest --outputdir ${classdir}`, {
@@ -79,7 +79,7 @@ describe('forceignore changes', () => {
 
     it('will push files that are now un-ignored', async () => {
       // un-ignore the file
-      await fs.writeFile(path.join(session.project.dir, '.forceignore'), originalForceIgnore);
+      await fs.promises.writeFile(path.join(session.project.dir, '.forceignore'), originalForceIgnore);
 
       // verify file pushed in results
       const unIgnoredOutput = execCmd<PushPullResponse[]>('force:source:push --json', { ensureExitCode: 0 }).jsonOutput
@@ -105,7 +105,10 @@ describe('forceignore changes', () => {
 
     it('will not pull a remote file added to the ignore AFTER it is being tracked', async () => {
       // add that type to the forceignore
-      await fs.writeFile(path.join(session.project.dir, '.forceignore'), originalForceIgnore + '\n' + classdir);
+      await fs.promises.writeFile(
+        path.join(session.project.dir, '.forceignore'),
+        originalForceIgnore + '\n' + classdir
+      );
 
       // gets file into source tracking
       const statusOutput = execCmd<StatusResult[]>('force:source:status --json --remote', { ensureExitCode: 0 })

test/nuts/commands/resetClear.nut.ts

@@ -11,7 +11,7 @@
 /* eslint-disable no-console */
 
 import * as path from 'path';
-import { promises as fs, existsSync } from 'fs';
+import * as fs from 'fs';
 
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';
@@ -25,7 +25,9 @@ let trackingFileFolder: string;
 let conn: Connection;
 
 const getRevisionsAsArray = async (): Promise<MemberRevision[]> => {
-  const revisionFile = JSON.parse(await fs.readFile(path.join(trackingFileFolder, 'maxRevision.json'), 'utf8'));
+  const revisionFile = JSON.parse(
+    await fs.promises.readFile(path.join(trackingFileFolder, 'maxRevision.json'), 'utf8')
+  );
   return Reflect.ownKeys(revisionFile.sourceMembers).map((key) => revisionFile.sourceMembers[key] as MemberRevision);
 };
 
@@ -58,10 +60,10 @@ describe('reset and clear', () => {
     });
 
     it('local tracking file exists', () => {
-      expect(existsSync(path.join(trackingFileFolder, 'localSourceTracking'))).to.equal(true);
+      expect(fs.existsSync(path.join(trackingFileFolder, 'localSourceTracking'))).to.equal(true);
     });
     it('remote tracking file exists', () => {
-      expect(existsSync(path.join(trackingFileFolder, 'maxRevision.json'))).to.equal(true);
+      expect(fs.existsSync(path.join(trackingFileFolder, 'maxRevision.json'))).to.equal(true);
     });
     it('runs clear', () => {
       const clearResult = execCmd<SourceTrackingClearResult>('force:source:tracking:clear --noprompt --json', {
@@ -70,10 +72,10 @@ describe('reset and clear', () => {
       expect(clearResult.clearedFiles.some((file) => file.includes('maxRevision.json'))).to.equal(true);
     });
     it('local tracking is gone', () => {
-      expect(existsSync(path.join(trackingFileFolder, 'localSourceTracking'))).to.equal(false);
+      expect(fs.existsSync(path.join(trackingFileFolder, 'localSourceTracking'))).to.equal(false);
     });
     it('remote tracking is gone', () => {
-      expect(existsSync(path.join(trackingFileFolder, 'maxRevision.json'))).to.equal(false);
+      expect(fs.existsSync(path.join(trackingFileFolder, 'maxRevision.json'))).to.equal(false);
     });
   });
 
@@ -98,7 +100,9 @@ describe('reset and clear', () => {
       // gets tracking files from server
       execCmd('force:source:status --json --remote', { ensureExitCode: 0 });
       const revisions = await getRevisionsAsArray();
-      const revisionFile = JSON.parse(await fs.readFile(path.join(trackingFileFolder, 'maxRevision.json'), 'utf8'));
+      const revisionFile = JSON.parse(
+        await fs.promises.readFile(path.join(trackingFileFolder, 'maxRevision.json'), 'utf8')
+      );
       lowestRevision = revisions.reduce(
         (previousValue, revision) => Math.min(previousValue, revision.serverRevisionCounter),
         revisionFile.serverMaxRevisionCounter

test/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "@salesforce/dev-config/tsconfig-test",
-  "include": ["./**/*.ts"],
+  "include": ["./**/*.ts", "nuts/commands/aura.nut.ts.future"],
   "compilerOptions": {
     "skipLibCheck": true
   }