feat(cli): expanded preview

packages/cli/package.json

@@ -13,13 +13,16 @@
     "@oclif/plugin-help": "^3",
     "@oclif/plugin-update": "^1.3.10",
     "@openid/appauth": "^1.3.0",
+    "@types/decompress": "^4.2.3",
     "@vue/cli": "^4.5.11",
     "abortcontroller-polyfill": "^1.7.1",
     "archiver": "^5.3.0",
+    "async-retry": "^1.3.1",
     "chalk": "^4.1.1",
     "cli-ux": "^5.5.1",
     "coveo.analytics": "^2.18.4",
     "create-react-app": "^4.0.3",
+    "decompress": "^4.2.1",
     "exponential-backoff": "^3.1.0",
     "fs-extra": "^9.1.0",
     "isomorphic-fetch": "^3.0.0",
@@ -38,6 +41,7 @@
     "@oclif/errors": "^1.3.4",
     "@oclif/test": "^1",
     "@types/archiver": "^5.1.0",
+    "@types/async-retry": "^1.4.2",
     "@types/cli-progress": "^3.9.1",
     "@types/fs-extra": "^9.0.6",
     "@types/jest": "^26.0.22",

packages/cli/src/lib/snapshot/expandedPreviewer.ts

@@ -0,0 +1,85 @@
+import {
+  ResourceSnapshotsReportModel,
+  ResourceType,
+} from '@coveord/platform-client';
+import decompress from 'decompress';
+import {mkdirSync} from 'fs';
+import {join, resolve} from 'path';
+import {spawnProcess} from '../utils/process';
+import {SnapshotFactory} from './snapshotFactory';
+
+export class ExpandedPreviewer {
+  private static readonly temporaryDirectory: string = '.coveo/tmp';
+  private static readonly previewDirectory: string = '.coveo/preview';
+
+  private resourcesToPreview: ResourceType[];
+
+  public constructor(
+    private readonly report: ResourceSnapshotsReportModel,
+    private readonly orgId: string,
+    private readonly snapshotToPreviewZipPath: string
+  ) {
+    this.resourcesToPreview = Object.keys(
+      report.resourceOperationResults
+    ) as ResourceType[];
+  }
+
+  /**
+   * preview
+   */
+  public async preview() {
+    const previewLocalSlug = `${this.orgId}-${Date.now()}`;
+    const dirPath = resolve(
+      join(ExpandedPreviewer.previewDirectory, previewLocalSlug)
+    );
+    await this.initPreviewDirectory(previewLocalSlug, dirPath);
+    await this.applySnapshotToPreview(dirPath);
+  }
+
+  private async initPreviewDirectory(
+    previewLocalSlug: string,
+    dirPath: string
+  ) {
+    const zipPath = join(
+      ExpandedPreviewer.temporaryDirectory,
+      previewLocalSlug
+    );
+    mkdirSync(dirPath, {
+      recursive: true,
+    });
+    await this.getFreshSnapshot(zipPath);
+    await decompress(zipPath, dirPath);
+
+    await this.initialPreviewCommit(dirPath);
+  }
+
+  private async initialPreviewCommit(dirPath: string) {
+    await spawnProcess('git', ['init'], {cwd: dirPath});
+    await spawnProcess('git', ['add', '.'], {cwd: dirPath});
+    await spawnProcess('git', ['commit', '-m', `"${this.orgId} currently"`], {
+      cwd: dirPath,
+    });
+  }
+
+  private async applySnapshotToPreview(dirPath: string) {
+    await decompress(this.snapshotToPreviewZipPath, dirPath);
+    await spawnProcess('git', ['add', '.'], {cwd: dirPath});
+    await spawnProcess(
+      'git',
+      ['commit', '-m', `"${this.orgId} after snapshot application"`],
+      {
+        cwd: dirPath,
+      }
+    );
+  }
+
+  private async getFreshSnapshot(zipPath: string) {
+    const snapshot = await SnapshotFactory.createFromOrg(
+      this.resourcesToPreview,
+      this.orgId
+    );
+
+    await snapshot.downloadZip(zipPath);
+    return;
+  }
+}

packages/cli/src/lib/snapshot/reportViewer.ts

@@ -6,6 +6,9 @@ import {
 import {cli} from 'cli-ux';
 import {bgHex, green, yellow, red, bold, italic} from 'chalk';
 
+// TODO SRC-4448: keys should be `ResourceType` from `@coveord/platform-client`.
+type ResourceEntry = [string, ResourceSnapshotsReportOperationModel];
+
 export class ReportViewer {
   public static maximumNumberOfErrorsToPrint = 5;
   public static styles = {
@@ -85,11 +88,7 @@ export class ReportViewer {
   }
 
   private get changedResources() {
-    type resourceEntries = [string, ResourceSnapshotsReportOperationModel];
-    const resourceHasAtLeastOneOperation = ([
-      _,
-      operations,
-    ]: resourceEntries) => {
+    const resourceHasAtLeastOneOperation = ([_, operations]: ResourceEntry) => {
       return (
         operations.resourcesCreated +
           operations.resourcesUpdated +
@@ -104,7 +103,7 @@ export class ReportViewer {
     const convertArrayToObject = ([
       resourceName,
       operations,
-    ]: resourceEntries) => ({
+    ]: ResourceEntry) => ({
       resourceName,
       operations,
     });

packages/cli/src/lib/snapshot/snapshot.ts

@@ -12,6 +12,7 @@ import {ReportViewer} from './reportViewer';
 import {ensureFileSync, writeJsonSync} from 'fs-extra';
 import {join} from 'path';
 import dedent from 'ts-dedent';
+import {ExpandedPreviewer} from './expandedPreviewer';
 
 export interface ISnapshotValidation {
   isValid: boolean;
@@ -39,15 +40,19 @@ export class Snapshot {
     return {isValid: this.isValid(), report: this.latestReport};
   }
 
-  public async preview() {
+  public async preview(snapshotZipPath: string) {
     this.displayLightPreview();
-    this.displayExpandedPreview();
+    await this.displayExpandedPreview(snapshotZipPath);
   }
 
   public async delete() {
     await this.client.resourceSnapshot.delete(this.model.id);
   }
 
+  public async downloadZip(downloadPath: string) {
+    throw new Error('Method not implemented.');
+  }
+
   public requiresSynchronization() {
     // TODO: backend should provide a specific result code for snapshots that are out of sync with the target org.
     // Waiting for the JIRA number...
@@ -95,8 +100,13 @@ export class Snapshot {
     report.display();
   }
 
-  private displayExpandedPreview() {
-    // TODO: CDX-347 Display Expanded preview
+  private async displayExpandedPreview(snapshotZipPath: string) {
+    const previewer = new ExpandedPreviewer(
+      this.latestReport,
+      this.targetId!,
+      snapshotZipPath
+    );
+    await previewer.preview();
   }
 
   private isValid() {