feat(cli): expanded preview

packages/cli/package.json

@@ -15,13 +15,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",
     "extract-zip": "^2.0.1",
     "fs-extra": "^10.0.0",

packages/cli/src/__test__/fsUtils.ts

@@ -0,0 +1,15 @@
+import {Dirent} from 'fs';
+
+export const getFile = (name: string) => getDirent(name, 'file');
+export const getDirectory = (name: string) => getDirent(name, 'dir');
+
+const getDirent = (name: string, type: 'file' | 'dir') => {
+  const dirent = new Dirent();
+  const isFile = type === 'file';
+  dirent.isDirectory = isFile ? () => false : () => true;
+  dirent.isFile = isFile ? () => true : () => false;
+  if (name) {
+    dirent.name = name;
+  }
+  return dirent;
+};

packages/cli/src/commands/org/config/monitor.ts

@@ -10,7 +10,7 @@ import {
   IsAuthenticated,
   Preconditions,
 } from '../../../lib/decorators/preconditions';
-import {ReportViewerStyles} from '../../../lib/snapshot/reportViewer/reportViewerStyles';
+import {ReportViewerStyles} from '../../../lib/snapshot/reportPreviewer/reportPreviewerStyles';
 import {Snapshot, waitUntilDoneOptions} from '../../../lib/snapshot/snapshot';
 import {
   getTargetOrg,

packages/cli/src/commands/org/config/preview.ts

@@ -10,6 +10,7 @@ import {
   IsAuthenticated,
   Preconditions,
 } from '../../../lib/decorators/preconditions';
+import {IsGitInstalled} from '../../../lib/decorators/preconditions/git';
 import {Snapshot} from '../../../lib/snapshot/snapshot';
 import {
   displayInvalidSnapshotError,
@@ -32,15 +33,15 @@ export default class Preview extends Command {
     }),
     showMissingResources: flags.boolean({
       char: 'd',
-      description: 'Whether or not preview missing resources',
+      description: 'Preview resources deletion when enabled',
       default: false,
       required: false,
     }),
   };
 
   public static hidden = true;
 
-  @Preconditions(IsAuthenticated())
+  @Preconditions(IsAuthenticated(), IsGitInstalled())
   public async run() {
     const {flags} = this.parse(Preview);
     const target = await getTargetOrg(this.configuration, flags.target);
@@ -53,7 +54,7 @@ export default class Preview extends Command {
       options
     );
 
-    await snapshot.preview();
+    await snapshot.preview(project, options.deleteMissingResources);
 
     if (reporter.isSuccessReport()) {
       await snapshot.delete();

packages/cli/src/commands/org/config/push.ts

@@ -36,7 +36,7 @@ export default class Push extends Command {
     }),
     deleteMissingResources: flags.boolean({
       char: 'd',
-      description: 'Whether or not to delete missing resources',
+      description: 'Delete missing resources when enabled',
       default: false,
       required: false,
     }),
@@ -65,7 +65,7 @@ export default class Push extends Command {
     );
 
     if (!flags.skipPreview) {
-      await snapshot.preview();
+      await snapshot.preview(project, options.deleteMissingResources);
     }
 
     if (reporter.isSuccessReport()) {

packages/cli/src/lib/project/project.ts

@@ -8,7 +8,7 @@ import {DotFolder, DotFolderConfig} from './dotFolder';
 
 export class Project {
   private static readonly resourceFolderName = 'resources';
-  public constructor(private pathToProject: string) {
+  public constructor(private _pathToProject: string) {
     if (!this.isCoveoProject) {
       this.makeCoveoProject();
     }
@@ -17,25 +17,25 @@ export class Project {
   public async refresh(projectContent: Blob) {
     const buffer = await projectContent.arrayBuffer();
     const view = new DataView(buffer);
-    writeFileSync(this.pathToTemporaryZip, view);
-    await extract(this.pathToTemporaryZip, {dir: this.resourcePath});
+    writeFileSync(this.temporaryZipPath, view);
+    await extract(this.temporaryZipPath, {dir: this.resourcePath});
     this.deleteTemporaryZipFile();
   }
 
   public deleteTemporaryZipFile() {
-    unlinkSync(this.pathToTemporaryZip);
+    unlinkSync(this.temporaryZipPath);
   }
 
   private ensureProjectCompliance() {
     if (!this.isResourcesProject) {
       throw new InvalidProjectError(
-        this.pathToProject,
+        this._pathToProject,
         'Does not contain any resources folder'
       );
     }
     if (!this.isCoveoProject) {
       throw new InvalidProjectError(
-        this.pathToProject,
+        this._pathToProject,
         'Does not contain any .coveo folder'
       );
     }
@@ -45,8 +45,7 @@ export class Project {
     try {
       this.ensureProjectCompliance();
       await new Promise<void>((resolve, reject) => {
-        const pathToTemporaryZip = this.pathToTemporaryZip;
-        const outputStream = createWriteStream(pathToTemporaryZip);
+        const outputStream = createWriteStream(this.temporaryZipPath);
         const archive = archiver('zip');
 
         outputStream.on('close', () => resolve());
@@ -56,22 +55,25 @@ export class Project {
         archive.directory(this.resourcePath, false);
         archive.finalize();
       });
-      return this.pathToTemporaryZip;
+      return this.temporaryZipPath;
     } catch (error) {
       cli.error(error);
     }
   }
 
-  public contains(fileName: string) {
-    return existsSync(join(this.pathToProject, fileName));
+  public get pathToProject() {
+    return this._pathToProject;
   }
 
-  private get pathToTemporaryZip() {
-    return join(this.pathToProject, 'snapshot.zip');
+  private get temporaryZipPath() {
+    return join(this._pathToProject, 'snapshot.zip');
   }
 
-  private get resourcePath() {
-    return join(this.pathToProject, Project.resourceFolderName);
+  public get resourcePath() {
+    return join(this._pathToProject, Project.resourceFolderName);
+  }
+  public contains(fileName: string) {
+    return existsSync(join(this.pathToProject, fileName));
   }
 
   private get isCoveoProject() {