fix: refactor imports and ensure async/promises are used

mcarvin8 · mcarvin8 · commit ed43851909b5 · 2024-04-09T15:22:46.000-04:00
diff --git a/src/commands/apex-tests-git-delta/delta.ts b/src/commands/apex-tests-git-delta/delta.ts
@@ -1,6 +1,6 @@
 'use strict';
 
-import * as fs from 'node:fs';
+import { writeFile } from 'node:fs/promises';
 
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
@@ -64,7 +64,7 @@ export default class ApexTestDelta extends SfCommand<TestDeltaResult> {
     const result = await extractTestClasses(fromGitRef, toGitRef, regExFile, sfdxConfigFile);
     const tests = result.validatedClasses;
     const warnings = result.warnings;
-    fs.writeFileSync(output, tests);
+    await writeFile(output, tests);
     if (warnings.length > 0) {
       warnings.forEach((warning) => {
         this.warn(warning);
diff --git a/src/service/extractTestClasses.ts b/src/service/extractTestClasses.ts
@@ -1,4 +1,5 @@
 'use strict';
+
 import { retrieveCommitMessages } from './retrieveCommitMessages.js';
 import { validateClassPaths } from './validateClassPaths.js';
 
diff --git a/src/service/getPackageDirectories.ts b/src/service/getPackageDirectories.ts
@@ -1,19 +1,19 @@
 'use strict';
 /* eslint-disable no-await-in-loop */
 
-import * as fs from 'node:fs';
-import * as promises from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
 
 interface SfdxProject {
   packageDirectories: Array<{ path: string }>;
 }
 
 export async function getPackageDirectories(dxConfigFile: string): Promise<string[]> {
-  if (!fs.existsSync(dxConfigFile)) {
+  if (!existsSync(dxConfigFile)) {
     throw Error(`Salesforce DX Config File does not exist in this path: ${dxConfigFile}`);
   }
 
-  const sfdxProjectRaw: string = await promises.readFile(dxConfigFile, 'utf-8');
+  const sfdxProjectRaw: string = await readFile(dxConfigFile, 'utf-8');
   const sfdxProject: SfdxProject = JSON.parse(sfdxProjectRaw) as SfdxProject;
   const packageDirectories = sfdxProject.packageDirectories.map((directory) => directory.path);
   return packageDirectories;
diff --git a/src/service/retrieveCommitMessages.ts b/src/service/retrieveCommitMessages.ts
@@ -1,4 +1,5 @@
 'use strict';
+
 import { readFileSync } from 'node:fs';
 import { simpleGit, SimpleGit, SimpleGitOptions, DefaultLogFields, LogResult } from 'simple-git';
 
diff --git a/src/service/validateClassPaths.ts b/src/service/validateClassPaths.ts
@@ -1,8 +1,8 @@
 'use strict';
 /* eslint-disable no-await-in-loop */
 
-import * as promises from 'node:fs/promises';
-import * as path from 'node:path';
+import { readdir, stat } from 'node:fs/promises';
+import { join } from 'node:path';
 
 import { getPackageDirectories } from './getPackageDirectories.js';
 
@@ -33,10 +33,10 @@ export async function validateClassPaths(
 }
 
 async function searchRecursively(fileName: string, dxDirectory: string): Promise<string | undefined> {
-  const files = await promises.readdir(dxDirectory);
+  const files = await readdir(dxDirectory);
   for (const file of files) {
-    const filePath = path.join(dxDirectory, file);
-    const stats = await promises.stat(filePath);
+    const filePath = join(dxDirectory, file);
+    const stats = await stat(filePath);
     if (stats.isDirectory()) {
       const result = await searchRecursively(fileName, filePath);
       if (result) {
diff --git a/test/commands/delta/createTemporaryCommit.ts b/test/commands/delta/createTemporaryCommit.ts
@@ -1,6 +1,6 @@
 'use strict';
 
-import * as promises from 'node:fs/promises';
+import { writeFile } from 'node:fs/promises';
 import { SimpleGit } from 'simple-git';
 
 export async function createTemporaryCommit(
@@ -9,7 +9,7 @@ export async function createTemporaryCommit(
   content: string,
   git: SimpleGit
 ): Promise<string> {
-  await promises.writeFile(filePath, content);
+  await writeFile(filePath, content);
 
   // Stage the file
   await git.add(filePath);
diff --git a/test/commands/delta/empty.test.ts b/test/commands/delta/empty.test.ts
@@ -1,6 +1,7 @@
 'use strict';
 
-import * as fs from 'node:fs';
+import { mkdtempSync } from 'node:fs';
+import { mkdir, writeFile, rm } from 'node:fs/promises';
 import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';
 
 import { TestContext } from '@salesforce/core/lib/testSetup.js';
@@ -16,7 +17,7 @@ describe('scan commit messages without the regex and return an empty string.', (
   let fromSha: string;
   let toSha: string;
   const originalDir = process.cwd();
-  const tempDir = fs.mkdtempSync('../git-temp-');
+  const tempDir = mkdtempSync('../git-temp-');
 
   before(async () => {
     process.chdir(tempDir);
@@ -27,11 +28,11 @@ describe('scan commit messages without the regex and return an empty string.', (
       trimmed: false,
     };
     const git: SimpleGit = simpleGit(options);
-    fs.mkdirSync('force-app/main/default/classes', { recursive: true });
-    fs.mkdirSync('packaged/classes', { recursive: true });
+    await mkdir('force-app/main/default/classes', { recursive: true });
+    await mkdir('packaged/classes', { recursive: true });
     await git.init();
-    fs.writeFileSync(regExFile, regExFileContents);
-    fs.writeFileSync(sfdxConfigFile, sfdxConfigJsonString);
+    await writeFile(regExFile, regExFileContents);
+    await writeFile(sfdxConfigFile, sfdxConfigJsonString);
     let userName;
     let userEmail;
 
@@ -64,9 +65,9 @@ describe('scan commit messages without the regex and return an empty string.', (
     $$.restore();
   });
 
-  after(() => {
+  after(async () => {
     process.chdir(originalDir);
-    fs.rmdirSync(tempDir, { recursive: true });
+    await rm(tempDir, { recursive: true });
   });
 
   it('return an empty test string with no warnings.', async () => {
diff --git a/test/commands/delta/unit.test.ts b/test/commands/delta/unit.test.ts
@@ -1,6 +1,7 @@
 'use strict';
 
-import * as fs from 'node:fs';
+import { mkdtempSync } from 'node:fs';
+import { mkdir, writeFile, rm } from 'node:fs/promises';
 import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';
 
 import { TestContext } from '@salesforce/core/lib/testSetup.js';
@@ -16,7 +17,7 @@ describe('return the delta tests between git commits', () => {
   let fromSha: string;
   let toSha: string;
   const originalDir = process.cwd();
-  const tempDir = fs.mkdtempSync('../git-temp-');
+  const tempDir = mkdtempSync('../git-temp-');
 
   before(async () => {
     process.chdir(tempDir);
@@ -27,11 +28,11 @@ describe('return the delta tests between git commits', () => {
       trimmed: false,
     };
     const git: SimpleGit = simpleGit(options);
-    fs.mkdirSync('force-app/main/default/classes', { recursive: true });
-    fs.mkdirSync('packaged/classes', { recursive: true });
+    await mkdir('force-app/main/default/classes', { recursive: true });
+    await mkdir('packaged/classes', { recursive: true });
     await git.init();
-    fs.writeFileSync(regExFile, regExFileContents);
-    fs.writeFileSync(sfdxConfigFile, sfdxConfigJsonString);
+    await writeFile(regExFile, regExFileContents);
+    await writeFile(sfdxConfigFile, sfdxConfigJsonString);
     let userName;
     let userEmail;
 
@@ -74,9 +75,9 @@ describe('return the delta tests between git commits', () => {
     $$.restore();
   });
 
-  after(() => {
+  after(async () => {
     process.chdir(originalDir);
-    fs.rmdirSync(tempDir, { recursive: true });
+    await rm(tempDir, { recursive: true });
   });
 
   it('scan the temporary commits and return the delta test class string without any warnings.', async () => {
diff --git a/test/commands/delta/warnings.test.ts b/test/commands/delta/warnings.test.ts
@@ -1,6 +1,7 @@
 'use strict';
 
-import * as fs from 'node:fs';
+import { mkdtempSync } from 'node:fs';
+import { mkdir, writeFile, rm } from 'node:fs/promises';
 import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';
 
 import { TestContext } from '@salesforce/core/lib/testSetup.js';
@@ -16,7 +17,7 @@ describe('confirm warnings are generated when files cannot be found in a package
   let fromSha: string;
   let toSha: string;
   const originalDir = process.cwd();
-  const tempDir = fs.mkdtempSync('../git-temp-');
+  const tempDir = mkdtempSync('../git-temp-');
 
   before(async () => {
     process.chdir(tempDir);
@@ -27,11 +28,11 @@ describe('confirm warnings are generated when files cannot be found in a package
       trimmed: false,
     };
     const git: SimpleGit = simpleGit(options);
-    fs.mkdirSync('force-app/main/default/classes', { recursive: true });
-    fs.mkdirSync('packaged/classes', { recursive: true });
+    await mkdir('force-app/main/default/classes', { recursive: true });
+    await mkdir('packaged/classes', { recursive: true });
     await git.init();
-    fs.writeFileSync(regExFile, regExFileContents);
-    fs.writeFileSync(sfdxConfigFile, sfdxConfigJsonString);
+    await writeFile(regExFile, regExFileContents);
+    await writeFile(sfdxConfigFile, sfdxConfigJsonString);
     let userName;
     let userEmail;
 
@@ -73,9 +74,9 @@ describe('confirm warnings are generated when files cannot be found in a package
     $$.restore();
   });
 
-  after(() => {
+  after(async () => {
     process.chdir(originalDir);
-    fs.rmdirSync(tempDir, { recursive: true });
+    await rm(tempDir, { recursive: true });
   });
 
   it('confirm warnings are generated and no delta tests are in the log output.', async () => {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`'use strict';`
	`2`	`+`
`2`	`3`	`import { retrieveCommitMessages } from './retrieveCommitMessages.js';`
`3`	`4`	`import { validateClassPaths } from './validateClassPaths.js';`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`'use strict';`
	`2`	`+`
`2`	`3`	`import { readFileSync } from 'node:fs';`
`3`	`4`	`import { simpleGit, SimpleGit, SimpleGitOptions, DefaultLogFields, LogResult } from 'simple-git';`
`4`	`5`