fix(snapshot): do not delete snapshot when provided with the flag (#840)

* fix(snapshot): do not delete snapshot when provided with the flag https://coveord.atlassian.net/browse/CDX-1042 * lint https://coveord.atlassian.net/browse/CDX-1042 * Update packages/cli/src/commands/org/resources/pull.ts Co-authored-by: jpmarceau <[email protected]> * remove unused-ish code https://coveord.atlassian.net/browse/CDX-1042 * rm unused import https://coveord.atlassian.net/browse/CDX-1042 Co-authored-by: jpmarceau <[email protected]>
coveo · Jun 20, 2022 · 4ca2807 · 4ca2807
1 parent 0cae6ec
commit 4ca2807
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 52 deletions.
diff --git a/packages/cli/src/commands/org/resources/pull.spec.ts b/packages/cli/src/commands/org/resources/pull.spec.ts
@@ -87,6 +87,12 @@ const doMockSnapshotFactory = async () => {
       download: mockedDownloadSnapshot,
     } as unknown as Snapshot)
   );
+  mockedSnapshotFactory.createFromExistingSnapshot.mockReturnValue(
+    Promise.resolve({
+      delete: mockedDeleteSnapshot,
+      download: mockedDownloadSnapshot,
+    } as unknown as Snapshot)
+  );
 };
 
 describe('org:resources:pull', () => {
@@ -166,6 +172,14 @@ describe('org:resources:pull', () => {
       expect(mockedDeleteSnapshot).toHaveBeenCalled();
     });
 
+  test
+    .stdout()
+    .stderr()
+    .command(['org:resources:pull', '-s', 'someSnapshotId'])
+    .it('should not delete the snapshot', () => {
+      expect(mockedDeleteSnapshot).not.toHaveBeenCalled();
+    });
+
   test
     .stdout()
     .stderr()

diff --git a/packages/cli/src/commands/org/resources/pull.ts b/packages/cli/src/commands/org/resources/pull.ts
@@ -1,9 +1,10 @@
 import {ResourceSnapshotType} from '@coveord/platform-client';
 import {Flags, Command, CliUx} from '@oclif/core';
-import {blueBright, bold} from 'chalk';
+import {blueBright} from 'chalk';
 import {readJsonSync} from 'fs-extra';
 import {cwd} from 'process';
 import dedent from 'ts-dedent';
+import {formatOrgId} from '../../../lib/commonFormaters';
 import {Config} from '../../../lib/config/config';
 import {
   HasNecessaryCoveoPrivileges,
@@ -33,6 +34,20 @@ import {SnapshotFactory} from '../../../lib/snapshot/snapshotFactory';
 import {confirmWithAnalytics} from '../../../lib/utils/cli';
 import {spawnProcess} from '../../../lib/utils/process';
 
+const PullCommandStrings = {
+  projectOverwriteQuestion: (
+    resourceFolderName: string
+  ) => dedent`There is already a Coveo project with resources in it.
+  This command will delete the project in ${resourceFolderName} folder and start a new one, do you want to proceed? (y/n)`,
+  howToPullAfterTimeout: (targetOrgId: string, snapshotId: string) => dedent`
+
+      Once the snapshot is created, you can pull it with the following command:
+
+        ${blueBright`coveo org:resources:pull -o ${targetOrgId} -s ${snapshotId}`}
+
+        `,
+};
+
 export default class Pull extends Command {
   public static description = '(beta) Pull resources from an organization';
 
@@ -103,10 +118,18 @@ export default class Pull extends Command {
     CliUx.ux.action.start('Updating project with Snapshot');
     await this.refreshProject(project, snapshot);
     project.writeResourcesManifest(targetOrganization);
-    await snapshot.delete();
+
+    if (await this.shouldDeleteSnapshot()) {
+      await snapshot.delete();
+    }
+
     CliUx.ux.action.stop('Project updated');
   }
 
+  private async shouldDeleteSnapshot() {
+    return !(await this.parse(Pull)).flags.snapshotId;
+  }
+
   @Trackable()
   public async catch(err?: Error & {exitCode?: number}) {
     cleanupProject(this.projectPath);
@@ -120,15 +143,7 @@ export default class Pull extends Command {
     if (err instanceof SnapshotOperationTimeoutError) {
       const snapshot = err.snapshot;
       const target = await this.getTargetOrg();
-      this.log(
-        dedent`
-
-          Once the snapshot is created, you can pull it with the following command:
-
-            ${blueBright`coveo org:resources:pull -t ${target} -s ${snapshot.id}`}
-
-            `
-      );
+      this.log(PullCommandStrings.howToPullAfterTimeout(target, snapshot.id));
     }
   }
 
@@ -144,41 +159,54 @@ export default class Pull extends Command {
   }
 
   private async ensureProjectReset(project: Project) {
-    const flags = await this.getFlags();
-    if (!flags.overwrite && project.contains(Project.resourceFolderName)) {
-      const question = dedent`There is already a Coveo project with resources in it.
-        This command will overwrite the ${Project.resourceFolderName} folder content, do you want to proceed? (y/n)`;
-
-      const overwrite = await confirmWithAnalytics(
-        question,
-        'project overwrite'
-      );
-      if (!overwrite) {
-        throw new ProcessAbort();
-      }
+    if (await this.shouldAbortProjectReset(project)) {
+      throw new ProcessAbort();
     }
 
     project.reset();
   }
 
+  private async shouldAbortProjectReset(project: Project) {
+    const flags = await this.getFlags();
+    return (
+      !flags.overwrite &&
+      project.contains(Project.resourceFolderName) &&
+      !(await this.askUserShouldWeOverwrite())
+    );
+  }
+
+  private async askUserShouldWeOverwrite() {
+    const question = PullCommandStrings.projectOverwriteQuestion(
+      Project.resourceFolderName
+    );
+    return confirmWithAnalytics(question, 'project overwrite');
+  }
+
   private async getSnapshot() {
     const flags = await this.getFlags();
     const target = await this.getTargetOrg();
-    if (flags.snapshotId) {
-      CliUx.ux.action.start('Retrieving Snapshot');
-      const waitOption = await this.getWaitOption();
-      return SnapshotFactory.createFromExistingSnapshot(
-        flags.snapshotId,
-        target,
-        waitOption
-      );
-    }
+    return flags.snapshotId
+      ? this.getExistingSnapshot(flags.snapshotId, target)
+      : this.createAndGetNewSnapshot(target);
+  }
+
+  private async createAndGetNewSnapshot(target: string) {
     const resourcesToExport = await this.getResourceSnapshotTypesToExport();
-    CliUx.ux.action.start(`Creating Snapshot from ${bold.cyan(target)}`);
+    CliUx.ux.action.start(`Creating Snapshot from ${formatOrgId(target)}`);
     const waitOption = await this.getWaitOption();
     return SnapshotFactory.createFromOrg(resourcesToExport, target, waitOption);
   }
 
+  private async getExistingSnapshot(snapshotId: string, target: string) {
+    CliUx.ux.action.start('Retrieving Snapshot');
+    const waitOption = await this.getWaitOption();
+    return SnapshotFactory.createFromExistingSnapshot(
+      snapshotId,
+      target,
+      waitOption
+    );
+  }
+
   private async getWaitOption(): Promise<WaitUntilDoneOptions> {
     const flags = await this.getFlags();
     return {wait: flags.wait};
@@ -190,25 +218,9 @@ export default class Pull extends Command {
 
   private async getResourceSnapshotTypesToExport(): Promise<SnapshotPullModelResources> {
     const flags = await this.getFlags();
-    if (flags.model) {
-      const cfg = this.configuration.get();
-      if (cfg.organization !== flags.model.orgId) {
-        const question = dedent`You are currently connected to the ${bold.cyan(
-          cfg.organization
-        )} organization, but are about to pull resources from the ${bold.cyan(
-          flags.model.orgId
-        )} organization.
-            Do you wish to continue? (y/n)`;
-        const pull = await confirmWithAnalytics(question, 'resource pull');
-        if (!pull) {
-          throw new ProcessAbort();
-        }
-      }
-
-      return flags.model.resourcesToExport;
-    } else {
-      return buildResourcesToExport(flags.resourceTypes);
-    }
+    return flags.model
+      ? flags.model.resourcesToExport
+      : buildResourcesToExport(flags.resourceTypes);
   }
 
   private async getTargetOrg() {

diff --git a/packages/cli/src/lib/commonFormaters/index.ts b/packages/cli/src/lib/commonFormaters/index.ts
@@ -0,0 +1,2 @@
+import chalk from 'chalk';
+export const formatOrgId = chalk.bold.cyan;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		import chalk from 'chalk';
		export const formatOrgId = chalk.bold.cyan;