Merge pull request #1170 from contentstack/fix/write-csv-fix

Fix: Test case fix, Write csv fix
contentstack · Nov 21, 2023 · f56f374 · f56f374
2 parents 3fbc1cf + d6803a2
commit f56f374
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/packages/contentstack-audit/src/audit-base-command.ts b/packages/contentstack-audit/src/audit-base-command.ts
@@ -282,13 +282,11 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
    * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
    */
   prepareCSV(moduleName: keyof typeof config.moduleConfig, listOfMissingRefs: Record<string, any>): Promise<void> {
-    const csvStream = csv.format({ headers: true });
     const csvPath = join(this.sharedConfig.reportPath, `${moduleName}.csv`);
-    const assetFileStream = createWriteStream(csvPath);
 
     return new Promise<void>((resolve, reject) => {
-      assetFileStream.on('error', reject);
-      csvStream.pipe(assetFileStream).on('close', resolve).on('error', reject);
+      // file deepcode ignore MissingClose: Will auto close once csv stream end
+      const ws = createWriteStream(csvPath).on('error', reject);
       const defaultColumns = Object.keys(OutputColumn);
       const userDefinedColumns = this.sharedConfig.flags.columns ? this.sharedConfig.flags.columns.split(',') : null;
       let missingRefs: RefErrorReturnType[] = Object.values(listOfMissingRefs).flat();
@@ -301,6 +299,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
         missingRefs = missingRefs.filter((row: RefErrorReturnType) => row[OutputColumn[column]] === value);
       }
 
+      const rowData: Record<string, string | string[]>[] = [];
+
       for (const issue of missingRefs) {
         let row: Record<string, string | string[]> = {};
 
@@ -313,11 +313,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           row['Fix status'] = row.fixStatus;
         }
 
-        csvStream.write(row, 'utf8');
+        rowData.push(row);
       }
 
-      csvStream.end();
-      assetFileStream.destroy();
+      csv.write(rowData, { headers: true }).pipe(ws).on('error', reject).on('finish', resolve);
     });
   }
 }
diff --git a/packages/contentstack-audit/test/unit/commands/fix.test.ts b/packages/contentstack-audit/test/unit/commands/fix.test.ts
@@ -1,3 +1,4 @@
+import fs from 'fs';
 import winston from 'winston';
 import { expect } from '@oclif/test';
 import { fancy } from '@contentstack/cli-dev-dependencies';
@@ -13,6 +14,7 @@ describe('AuditFix command', () => {
   describe('AuditFix run method', () => {
     fancy
       .stdout({ print: process.env.PRINT === 'true' || false })
+      .stub(fs, 'rmSync', () => {})
       .stub(winston.transports, 'File', () => fsTransport)
       .stub(winston, 'createLogger', () => ({ log: () => {}, error: () => {} }))
       .stub(AuditBaseCommand.prototype, 'start', () => {})

diff --git a/packages/contentstack-audit/test/unit/modules/content-types.test.ts b/packages/contentstack-audit/test/unit/modules/content-types.test.ts
@@ -108,6 +108,7 @@ describe('Content types', () => {
       });
 
     fancy
+      .stub(fs, 'rmSync', () => {})
       .stdout({ print: process.env.PRINT === 'true' || false })
       .stub(ContentType.prototype, 'writeFixContent', async () => {})
       .it('perform audit operation on the given CT schema', async () => {
@@ -120,6 +121,7 @@ describe('Content types', () => {
       });
 
     fancy
+      .stub(fs, 'rmSync', () => {})
       .stdout({ print: process.env.PRINT === 'true' || false })
       .stub(ContentType.prototype, 'writeFixContent', async () => {})
       .it('perform audit and fix operation on the given CT schema', async () => {
@@ -274,6 +276,7 @@ describe('Content types', () => {
   describe('fixGlobalFieldReferences method', () => {
     fancy
       .stdout({ print: process.env.PRINT === 'true' || false })
+      .stub(fs, 'rmSync', () => {})
       .stub(ContentType.prototype, 'runFixOnSchema', () => {})
       .stub(ContentType.prototype, 'lookForReference', () => {})
       .it('should identify missing global-field schema and attach with content-type schema', async () => {