feat(cli): expanded preview

.github/workflows/renovate-config-validator.yml

@@ -2,11 +2,11 @@ name: 'Renovate Config Validator'
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
     paths:
       - 'renovate.json'
   pull_request:
-    branches: [ master ]
+    branches: [master]
     paths:
       - 'renovate.json'
 
@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
-      - name:  Check Renovate config
+      - name: Check Renovate config
         run: |
           npm i renovate
           node_modules/.bin/renovate-config-validator

README.md

@@ -1,7 +1,9 @@
 # Coveo CLI
 
 <!-- removefromdocs -->
+
 [![Build](https://github.com/coveo/cli/actions/workflows/build.yml/badge.svg)](https://github.com/coveo/cli/actions/workflows/build.yml)
+
 <!-- endremovefromdocs -->
 
 ## About

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/commands/org/config/preview.ts

@@ -32,7 +32,7 @@ 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,
     }),
@@ -53,7 +53,10 @@ export default class Preview extends Command {
       options
     );
 
-    await snapshot.preview();
+    await snapshot.preview(
+      project.resourcePath,
+      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,10 @@ export default class Push extends Command {
     );
 
     if (!flags.skipPreview) {
-      await snapshot.preview();
+      await snapshot.preview(
+        project.resourcePath,
+        options.deleteMissingResources
+      );
     }
 
     if (reporter.isSuccessReport()) {

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

@@ -6,18 +6,18 @@ import {InvalidProjectError} from '../errors';
 import extract from 'extract-zip';
 
 export class Project {
-  public constructor(private pathToProject: string) {}
+  public constructor(private _pathToProject: string) {}
 
   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() {
@@ -36,8 +36,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());
@@ -47,17 +46,21 @@ export class Project {
         archive.directory(this.resourcePath, false);
         archive.finalize();
       });
-      return this.pathToTemporaryZip;
+      return this.temporaryZipPath;
     } catch (error) {
       cli.error(error);
     }
   }
 
-  private get pathToTemporaryZip() {
+  public get pathToProject() {
+    return this._pathToProject;
+  }
+
+  public get temporaryZipPath() {
     return join(this.pathToProject, 'snapshot.zip');
   }
 
-  private get resourcePath() {
+  public get resourcePath() {
     return join(this.pathToProject, 'resources');
   }
 }

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

@@ -0,0 +1,74 @@
+jest.mock('fs');
+import {ResourceSnapshotsReportType} from '@coveord/platform-client';
+import {Dirent, readdirSync, rmSync} from 'fs';
+import {join} from 'path';
+
+import {mocked} from 'ts-jest/utils';
+import {getSuccessReport} from '../../__stub__/resourceSnapshotsReportModel';
+import {ExpandedPreviewer} from './expandedPreviewer';
+
+describe('ExpandedPreviewer', () => {
+  const getDirectory = (name?: string) => {
+    const dirent = new Dirent();
+    dirent.isDirectory = () => true;
+    if (name) {
+      dirent.name = name;
+    }
+    return dirent;
+  };
+  describe('when there are more than 5 expanded preview stored', () => {
+    const mockedReaddirSync = mocked(readdirSync);
+    const mockedRmSync = mocked(rmSync);
+
+    beforeAll(() => {
+      const dirs = new Array<Dirent>();
+      for (let i = 0; i < 8; i++) {
+        dirs.push(getDirectory(`someOrgId-${i}`));
+      }
+      mockedReaddirSync.mockReturnValue(dirs);
+    });
+
+    afterAll(() => {
+      mockedReaddirSync.mockRestore();
+      mockedRmSync.mockRestore();
+    });
+
+    it('should delete the exceeding preview directories', async () => {
+      const expandedPreviewer = new ExpandedPreviewer(
+        getSuccessReport('some-id', ResourceSnapshotsReportType.DryRun),
+        'someorg',
+        'my/awesome/path',
+        false
+      );
+      await expandedPreviewer.preview();
+
+      expect(mockedReaddirSync).toBeCalledWith('.coveo/preview', {
+        withFileTypes: true,
+      });
+      expect(mockedRmSync).toHaveBeenCalledTimes(4);
+      for (let index = 0; index < 4; index++) {
+        expect(mockedRmSync).toHaveBeenNthCalledWith(
+          index + 1,
+          join('.coveo/preview', `someOrgId-${index}`),
+          expect.anything()
+        );
+      }
+    });
+  });
+
+  describe('when shouldDelete is false', () => {
+    it.todo('should not delete missing resources');
+    it.todo('should not delete missing resourceType/file');
+  });
+
+  describe('when shouldDelete is true', () => {
+    it.todo('should not delete missing resources');
+    it.todo('should not delete missing resourceType/file');
+  });
+
+  it.todo('should download the before snapshot');
+  it.todo('should do two commits');
+  it.todo(
+    "should replace the value of the 'before' snapshot with the one of the applied snapshot"
+  );
+});