Merge pull request #372 from contentstack/fix/DX-25034

fix(audit): honour skipConfirm in workflow and extension removal

Author: Madhuri-cs

.talismanrc

@@ -1,6 +1,6 @@
 fileignoreconfig:
-  - filename: pnpm-lock.yaml
-    ignore_detectors:
-      - filecontent
-      - base64content
+- filename: pnpm-lock.yaml
+  checksum: 35bd025f9eb7818f84064c14832819fa45c25b7f81748bee911d60618baf5dd0
+- filename: packages/contentstack-audit/test/unit/modules/extensions.test.ts
+  checksum: 548b6e10241eb38df4b92f2dec90987b555ed6b7c582846d539828854eb1dadc
 version: '1.0'

packages/contentstack-audit/src/modules/extensions.ts

@@ -167,7 +167,11 @@ export default class Extensions {
       } else {
         log.debug(`Extension ${title} has no valid content types or scope not found`, this.config.auditContext);
         cliux.print($t(commonMsg.EXTENSION_FIX_WARN, { title: title, uid }), { color: 'yellow' });
-        const shouldDelete = this.config.flags.yes || (await cliux.confirm(commonMsg.EXTENSION_FIX_CONFIRMATION));
+        const shouldDelete =
+          this.config.flags['copy-dir'] ||
+          this.config.flags['external-config']?.skipConfirm ||
+          this.config.flags.yes ||
+          (await cliux.confirm(commonMsg.EXTENSION_FIX_CONFIRMATION));
         if (shouldDelete) {
           log.debug(`Deleting extension: ${title} (${uid})`, this.config.auditContext);
           delete newExtensionSchema[uid];

packages/contentstack-audit/src/modules/workflows.ts

@@ -223,7 +223,12 @@ export default class Workflows {
 
           cliux.print(warningMessage, { color: 'yellow' });
 
-          if (this.config.flags.yes || (await cliux.confirm(commonMsg.WORKFLOW_FIX_CONFIRMATION))) {
+          if (
+            this.config.flags['copy-dir'] ||
+            this.config.flags['external-config']?.skipConfirm ||
+            this.config.flags.yes ||
+            (await cliux.confirm(commonMsg.WORKFLOW_FIX_CONFIRMATION))
+          ) {
             log.debug(`Deleting workflow ${name} (${uid})`, this.config.auditContext);
             delete newWorkflowSchema[workflow.uid];
           } else {

packages/contentstack-audit/test/unit/modules/extensions.test.ts

@@ -6,7 +6,7 @@ import { ux, cliux } from '@contentstack/cli-utilities';
 
 import config from '../../../src/config';
 import { Extensions } from '../../../src/modules';
-import { $t, auditMsg } from '../../../src/messages';
+import { $t, auditMsg, commonMsg } from '../../../src/messages';
 import sinon from 'sinon';
 import { Extension } from '../../../src/types';
 import { mockLogger } from '../mock-logger';
@@ -387,4 +387,67 @@ describe('Extensions scope containing content_types uids', () => {
         },
       );
   });
+
+  describe('fixExtensionsScope confirmation before removing an extension', () => {
+    class ExtensionsWithCapturedFix extends Extensions {
+      public fixedExtensions: Record<string, Extension> = {};
+
+      async writeFixContent(fixedExtensions: Record<string, Extension>) {
+        this.fixedExtensions = fixedExtensions;
+      }
+    }
+
+    // ext1 and ext2 are scoped only to missing content types, so the fix removes them.
+    const createExtensions = (flags: Record<string, unknown>) =>
+      new ExtensionsWithCapturedFix({
+        moduleName: 'extensions',
+        ctSchema: cloneDeep(require('./../mock/contents/extensions/ctSchema.json')),
+        config: Object.assign(cloneDeep(config), {
+          basePath: resolve(`./test/unit/mock/contents/extensions/invalidExtensions/`),
+          flags,
+        }),
+        fix: true,
+      });
+
+    it('should remove the extensions without prompting when external-config skipConfirm is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const ext = createExtensions({ 'external-config': { skipConfirm: true } });
+
+      await ext.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(ext.fixedExtensions).to.not.have.any.keys('ext1', 'ext2');
+    });
+
+    it('should remove the extensions without prompting when copy-dir is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const ext = createExtensions({ 'copy-dir': true });
+
+      await ext.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(ext.fixedExtensions).to.not.have.any.keys('ext1', 'ext2');
+    });
+
+    it('should remove the extensions without prompting when yes is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const ext = createExtensions({ yes: true });
+
+      await ext.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(ext.fixedExtensions).to.not.have.any.keys('ext1', 'ext2');
+    });
+
+    it('should ask once per extension to remove and keep them when the user declines', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const ext = createExtensions({});
+
+      await ext.run();
+
+      expect(confirm.callCount).to.equal(2);
+      expect(confirm.alwaysCalledWithExactly(commonMsg.EXTENSION_FIX_CONFIRMATION)).to.be.true;
+      expect(ext.fixedExtensions).to.include.all.keys('ext1', 'ext2');
+    });
+  });
 });

packages/contentstack-audit/test/unit/modules/workflow.test.ts

@@ -3,12 +3,13 @@ import { resolve } from 'path';
 import { fancy } from 'fancy-test';
 import { expect } from 'chai';
 import cloneDeep from 'lodash/cloneDeep';
-import { ux } from '@contentstack/cli-utilities';
+import { ux, cliux } from '@contentstack/cli-utilities';
 import sinon from 'sinon';
 
 import config from '../../../src/config';
 import { Workflows } from '../../../src/modules';
-import { $t, auditMsg } from '../../../src/messages';
+import { $t, auditMsg, commonMsg } from '../../../src/messages';
+import { Workflow } from '../../../src/types';
 import { values } from 'lodash';
 import { mockLogger } from '../mock-logger';
 
@@ -147,4 +148,69 @@ describe('Workflows', () => {
         ]);
       });
   });
+
+  describe('fixWorkflowSchema confirmation before removing a workflow', () => {
+    class WorkflowsWithCapturedFix extends Workflows {
+      public fixedWorkflows: Record<string, Workflow> = {};
+
+      async writeFixContent(newWorkflowSchema: Record<string, Workflow>) {
+        this.fixedWorkflows = newWorkflowSchema;
+      }
+    }
+
+    const createWorkflows = (flags: Record<string, unknown>) =>
+      new WorkflowsWithCapturedFix({
+        moduleName: 'workflows',
+        // Without ct2, every content type on wf3 is missing, so the fix removes wf3.
+        ctSchema: cloneDeep(require('./../mock/contents/workflows/ctSchema.json')).filter(
+          (ct: { uid: string }) => ct.uid !== 'ct2',
+        ),
+        config: Object.assign(cloneDeep(config), {
+          basePath: resolve(`./test/unit/mock/contents/`),
+          branch: undefined,
+          flags,
+        }),
+        fix: true,
+      });
+
+    it('should remove the workflow without prompting when external-config skipConfirm is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const wf = createWorkflows({ 'external-config': { skipConfirm: true } });
+
+      await wf.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(wf.fixedWorkflows).to.not.have.property('wf3');
+    });
+
+    it('should remove the workflow without prompting when copy-dir is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const wf = createWorkflows({ 'copy-dir': true });
+
+      await wf.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(wf.fixedWorkflows).to.not.have.property('wf3');
+    });
+
+    it('should remove the workflow without prompting when yes is set', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const wf = createWorkflows({ yes: true });
+
+      await wf.run();
+
+      expect(confirm.notCalled).to.be.true;
+      expect(wf.fixedWorkflows).to.not.have.property('wf3');
+    });
+
+    it('should ask once per workflow to remove and keep it when the user declines', async () => {
+      const confirm = sinon.stub(cliux, 'confirm').resolves(false);
+      const wf = createWorkflows({});
+
+      await wf.run();
+
+      expect(confirm.calledOnceWithExactly(commonMsg.WORKFLOW_FIX_CONFIRMATION)).to.be.true;
+      expect(wf.fixedWorkflows).to.have.property('wf3');
+    });
+  });
 });

pnpm-lock.yaml

@@ -7,4 +7,4 @@ overrides:
   brace-expansion: 5.0.12
   js-yaml: 5.4.2
   fast-uri: 4.2.1
-  ws: 8.21.3
+  ws: 8.22.0