feat(atomic): add support for ngsp (#1409)

Add support for NGSP in `ui:create:atomic` (and `atomic:init -t=app`) Includes as well: - E2E stabilization: _Actually_ the latest published version of the CLI was tested, not the one of the PR 😅 (because CLI build were silently failing) - Update of a bunch of deps, again, to avoid silent failures. - Normalization of the createSearchHub confirm (so that it matches the others) All that E2E tested.
coveo · Feb 13, 2024 · 0602475 · 0602475
1 parent 278de45
commit 0602475
Show file tree

Hide file tree

Showing 23 changed files with 12,617 additions and 9,436 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
     "@actions/github": "5.1.1",
     "@commitlint/config-conventional": "17.6.1",
     "@commitlint/lint": "17.6.1",
-    "@coveo/platform-client": "44.1.0",
+    "@coveo/platform-client": "52.1.0",
     "@coveo/semantic-monorepo-tools": "2.1.2",
     "@coveord/release": "1.0.0",
     "@npmcli/arborist": "6.2.8",

diff --git a/packages/cli-e2e/__tests__/__snapshots__/atomic.specs.ts.snap b/packages/cli-e2e/__tests__/__snapshots__/atomic.specs.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`ui:create:atomic when using an existing pageId (--pageId flag specified) the project has been generated properly 1`] = `
+exports[`ui:create:atomic when using an existing legacy search page (--pageId flag specified) the project has been generated properly 1`] = `
 HashedFolder {
   "children": [
     HashedFile {
@@ -117,6 +117,123 @@ HashedFolder {
 }
 `;
 
+exports[`ui:create:atomic when using an existing next gen search page (--pageId flag specified) the project has been generated properly 1`] = `
+HashedFolder {
+  "children": [
+    HashedFile {
+      "hash": "1YlrWbKI6kgpcX/5spCmIko0kgg=",
+      "name": "deployment.esbuild.mjs",
+    },
+    HashedFile {
+      "hash": "+t+HILvU+0OvGuKuRvbcamfBMRw=",
+      "name": "README.md",
+    },
+    HashedFolder {
+      "children": [],
+      "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
+      "name": "scripts",
+    },
+    HashedFolder {
+      "children": [
+        HashedFolder {
+          "children": [
+            HashedFolder {
+              "children": [
+                HashedFile {
+                  "hash": "KgjYp/iQUQT5BeQqpR/hXS7pOy0=",
+                  "name": "results-manager.tsx",
+                },
+                HashedFile {
+                  "hash": "Ko4cbmFzfOTdS1hr1HGU0cIrtOM=",
+                  "name": "template-1.html",
+                },
+              ],
+              "hash": "4hIP+uRwgSi1+UuvlB+7T+k79bI=",
+              "name": "results-manager",
+            },
+            HashedFolder {
+              "children": [
+                HashedFile {
+                  "hash": "XemX7AoOihA4SgQsvWtcStjeiGo=",
+                  "name": "sample-component.css",
+                },
+                HashedFile {
+                  "hash": "sWUDtgn9DiTjvYlLdoF4EaGoClw=",
+                  "name": "sample-component.tsx",
+                },
+              ],
+              "hash": "pPdA06Q+ujtEyI7kflypbd5kiUg=",
+              "name": "sample-component",
+            },
+            HashedFolder {
+              "children": [
+                HashedFile {
+                  "hash": "0kZk+nhPZP6DNXEt1ds/y13pPn4=",
+                  "name": "sample-result-component.css",
+                },
+                HashedFile {
+                  "hash": "uNaVrxKWu4DcnVJTCz+9hVGWQ2Q=",
+                  "name": "sample-result-component.tsx",
+                },
+              ],
+              "hash": "lIIVFoYP+9d6H0rrdSp9lYPxeWw=",
+              "name": "sample-result-component",
+            },
+          ],
+          "hash": "9ySon/mm3QAtSCUsyLo8J96FrkY=",
+          "name": "components",
+        },
+        HashedFile {
+          "hash": "2/Ssowtzkh/hx4e9vrMi11FFp1Q=",
+          "name": "components.d.ts",
+        },
+        HashedFile {
+          "hash": "/MC1IvlmPW0zAgfo82n8CnBDMrA=",
+          "name": "html.d.ts",
+        },
+        HashedFile {
+          "hash": "dIKI3aRn/2K6aO5RgC2zfGQ2wg8=",
+          "name": "index.ts",
+        },
+        HashedFolder {
+          "children": [],
+          "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
+          "name": "pages",
+        },
+        HashedFolder {
+          "children": [
+            HashedFile {
+              "hash": "GTe7oCz+pSCsM8PXrji6iYc3iq0=",
+              "name": "index.css",
+            },
+          ],
+          "hash": "6hnWHe6xxYFfk5iqbZDpprtBgUk=",
+          "name": "style",
+        },
+        HashedFolder {
+          "children": [
+            HashedFile {
+              "hash": "Yhwg1zaohXJmi0xJFywAlsL02ZA=",
+              "name": "atomic.ts",
+            },
+          ],
+          "hash": "ZyOIYW/4w45sOzwmwIaFevE1VVM=",
+          "name": "utils",
+        },
+      ],
+      "hash": "t8fIknhLbnltSfNoodcS9MQfGSM=",
+      "name": "src",
+    },
+    HashedFile {
+      "hash": "9nyo2P7hCKS4uXz6KBbyR2tzRtY=",
+      "name": "tsconfig.json",
+    },
+  ],
+  "hash": "yR554ZvROimOPuI3h7YM5DyVwQU=",
+  "name": "normalizedDir",
+}
+`;
+
 exports[`ui:create:atomic when using an existing pageId (using the list prompt of available pages) the project has been generated properly 1`] = `
 HashedFolder {
   "children": [

diff --git a/packages/cli-e2e/__tests__/atomic.specs.ts b/packages/cli-e2e/__tests__/atomic.specs.ts
@@ -1,7 +1,10 @@
 import type {Browser, Page, HTTPResponse} from 'puppeteer';
 import {captureScreenshots, getNewBrowser, openNewPage} from '../utils/browser';
 import {answerPrompt, getProjectPath, setupUIProject} from '../utils/cli';
-import {isSuccessfulSearchResponse} from '../utils/platform';
+import {
+  isSearchRequestOrResponse,
+  isSuccessfulSearchResponse,
+} from '../utils/platform';
 import {ProcessManager} from '../utils/processManager';
 import {Terminal} from '../utils/terminal/terminal';
 import {BrowserConsoleInterceptor} from '../utils/browserConsoleInterceptor';
@@ -21,6 +24,7 @@ interface BuildAppOptions {
 describe('ui:create:atomic', () => {
   const searchPageEndpoint = 'http://localhost:3333';
   const searchInterfaceSelector = 'atomic-search-interface';
+  const atomicResult = 'atomic-result';
   let normalizedProjectDir = '';
   let originalProjectDir = '';
   const normalizeProjectDirectory = (buildAppOptions: BuildAppOptions) => {
@@ -153,14 +157,25 @@ describe('ui:create:atomic', () => {
 
   describe.each([
     {
-      describeName: 'when using an existing pageId (--pageId flag specified)',
+      describeName:
+        'when using an existing legacy search page (--pageId flag specified)',
       buildAppOptions: {
         id: 'with-page-id',
         pageId: 'fffaafcc-6863-46cb-aca3-97522fcc0f5d',
         skipInstall: false,
       },
       skipBrowser: false,
     },
+    {
+      describeName:
+        'when using an existing next gen search page (--pageId flag specified)',
+      buildAppOptions: {
+        id: 'ngsp-with-id',
+        skipInstall: false,
+        pageId: '5a8eb80a-acc7-418d-a5a0-ad952fe1de96',
+      },
+      skipBrowser: false,
+    },
     {
       describeName: 'when using the default page config (pageId not specified)',
       buildAppOptions: {id: 'without-page-id', skipInstall: true},
@@ -300,7 +315,8 @@ describe('ui:create:atomic', () => {
             await serverProcessManager.killAllProcesses();
           }, 5 * 30e3);
 
-          it('should not contain console errors nor warnings', async () => {
+          //TODO CDX-1520: Should only have analytics warnings/error.
+          it.skip('should not contain console errors nor warnings', async () => {
             await page.goto(searchPageEndpoint, {
               waitUntil: 'networkidle2',
             });
@@ -316,14 +332,19 @@ describe('ui:create:atomic', () => {
             expect(await page.$(searchInterfaceSelector)).not.toBeNull();
           }, 60e3);
 
-          it('should send a search query when the page is loaded', async () => {
-            await page.goto(searchPageEndpoint, {waitUntil: 'networkidle2'});
-            await page.waitForSelector(searchInterfaceSelector);
-
-            expect(
-              interceptedResponse.some(isSuccessfulSearchResponse)
-            ).toBeTruthy();
-          }, 60e3);
+          it(
+            'should send a search query when the page is loaded',
+            async () => {
+              await page.goto(searchPageEndpoint);
+              await page.waitForResponse(isSearchRequestOrResponse, {
+                timeout: 3 * 60e3 - 10e3,
+              });
+              expect(
+                interceptedResponse.some(isSuccessfulSearchResponse)
+              ).toBeTruthy();
+            },
+            3 * 60e3
+          );
         });
       }
     }

diff --git a/packages/cli-e2e/package.json b/packages/cli-e2e/package.json
@@ -62,7 +62,7 @@
     "@babel/preset-env": "7.21.5",
     "@babel/preset-typescript": "7.21.5",
     "@coveo/cli": "3.0.16",
-    "@coveo/platform-client": "44.1.0",
+    "@coveo/platform-client": "52.1.0",
     "abortcontroller-polyfill": "1.7.5",
     "async-retry": "1.3.3",
     "babel-jest": "29.5.0",

diff --git a/packages/cli/commons/package.json b/packages/cli/commons/package.json
@@ -26,7 +26,7 @@
   "dependencies": {
     "@amplitude/analytics-node": "^1.3.3",
     "@amplitude/analytics-types": "^2.1.2",
-    "@coveo/platform-client": "44.1.0",
+    "@coveo/platform-client": "52.1.0",
     "@oclif/core": "1.24.0",
     "abortcontroller-polyfill": "1.7.5",
     "chalk": "4.1.2",

diff --git a/packages/cli/core/package.json b/packages/cli/core/package.json
@@ -11,7 +11,7 @@
     "@amplitude/identify": "^1.9.0",
     "@coveo/cli-commons": "2.7.15",
     "@coveo/cli-plugin-source": "2.1.15",
-    "@coveo/platform-client": "44.1.0",
+    "@coveo/platform-client": "52.1.0",
     "@oclif/core": "1.24.0",
     "@oclif/plugin-help": "5.1.23",
     "@oclif/plugin-plugins": "2.1.12",

diff --git a/packages/cli/core/src/commands/atomic/init.ts b/packages/cli/core/src/commands/atomic/init.ts
@@ -10,8 +10,6 @@ import {
   createAtomicApp,
   createAtomicLib,
 } from '../../lib/atomic/createAtomicProject';
-import {promptForSearchHub} from '../ui/create/shared';
-import {AuthenticatedClient} from '@coveo/cli-commons/platform/authenticatedClient';
 
 export default class AtomicInit extends CLICommand {
   public static description =

diff --git a/packages/cli/core/src/commands/org/search/dump.ts b/packages/cli/core/src/commands/org/search/dump.ts
@@ -269,7 +269,7 @@ export default class Dump extends CLICommand {
           }),
           ...(params.pipeline && {pipeline: params.pipeline}),
           ...(indexToken !== '' && {indexToken: indexToken}),
-        })) as SearchResponse;
+        })) as unknown as SearchResponse;
         return results;
       } catch (error) {
         if (this.isResponseExceededMaximumSizeError(error)) {

diff --git a/packages/cli/core/src/commands/ui/create/angular.ts b/packages/cli/core/src/commands/ui/create/angular.ts
@@ -23,7 +23,7 @@ import {
   listSearchHubsPrivilege,
 } from '@coveo/cli-commons/preconditions/platformPrivilege';
 import {Trackable} from '@coveo/cli-commons/preconditions/trackable';
-import {promptForSearchHub} from './shared';
+import {promptForSearchHub} from '../../../lib/ui/shared';
 
 export default class Angular extends CLICommand {
   public static templateName = '@coveo/angular';

diff --git a/packages/cli/core/src/commands/ui/create/atomic.ts b/packages/cli/core/src/commands/ui/create/atomic.ts
@@ -9,8 +9,6 @@ import {
   atomicAppPreconditions,
   createAtomicApp,
 } from '../../../lib/atomic/createAtomicProject';
-import {AuthenticatedClient} from '@coveo/cli-commons/platform/authenticatedClient';
-import {promptForSearchHub} from './shared';
 
 export default class Atomic extends CLICommand {
   public static description =

diff --git a/packages/cli/core/src/commands/ui/create/react.ts b/packages/cli/core/src/commands/ui/create/react.ts
@@ -22,7 +22,7 @@ import {
   IsNodeVersionInRange,
   IsNpxInstalled,
 } from '../../../lib/decorators/preconditions';
-import {promptForSearchHub} from './shared';
+import {promptForSearchHub} from '../../../lib/ui/shared';
 
 type ReactProcessEnv = {
   orgId: string;

diff --git a/packages/cli/core/src/commands/ui/create/vue.ts b/packages/cli/core/src/commands/ui/create/vue.ts
@@ -26,7 +26,7 @@ import {
 import {cwd} from 'node:process';
 import {mkdirSync, readdirSync, statSync, writeFileSync} from 'node:fs';
 import dedent from 'ts-dedent';
-import {promptForSearchHub} from './shared';
+import {promptForSearchHub} from '../../../lib/ui/shared';
 
 export default class Vue extends CLICommand {
   public static packageName = '@coveo/create-headless-vue';

diff --git a/packages/cli/core/src/lib/atomic/createAtomicProject.ts b/packages/cli/core/src/lib/atomic/createAtomicProject.ts
@@ -24,7 +24,7 @@ import {getPackageVersion} from '../utils/misc';
 import npf from '@coveo/cli-commons/npm/npf';
 import {SubprocessError} from '../errors/subprocessError';
 import {isErrorLike} from '../utils/errorSchemas';
-import {promptForSearchHub} from '../../commands/ui/create/shared';
+import {promptForSearchHub} from '../ui/shared';
 
 interface CreateAppOptions {
   initializerVersion?: string;

diff --git a/...cli/core/src/commands/ui/create/shared.ts → packages/cli/core/src/lib/ui/shared.ts b/...cli/core/src/commands/ui/create/shared.ts → packages/cli/core/src/lib/ui/shared.ts
@@ -7,7 +7,7 @@ const manuallyEnterSearchHub = () =>
 
 export async function promptForSearchHub(client: PlatformClient) {
   const createSearchHub = await confirm(
-    'An API key will be created against your organization. We strongly recommends that you associate this API key with a search hub. Would you like to do so now ? y/n',
+    'An API key will be created against your organization. We strongly recommends that you associate this API key with a search hub. Would you like to do so now ? (y/n)',
     false
   );
   if (!createSearchHub) {

diff --git a/packages/cli/source/package.json b/packages/cli/source/package.json
@@ -15,8 +15,8 @@
   ],
   "dependencies": {
     "@coveo/cli-commons": "2.7.15",
-    "@coveo/platform-client": "44.1.0",
-    "@coveo/push-api-client": "3.1.15",
+    "@coveo/platform-client": "52.1.0",
+    "@coveo/push-api-client": "4.0.1",
     "@oclif/core": "1.24.0",
     "@oclif/plugin-help": "5.1.23",
     "@oclif/plugin-plugins": "2.1.12",

diff --git a/packages/ui/atomic/create-atomic/package.json b/packages/ui/atomic/create-atomic/package.json
@@ -30,7 +30,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@coveo/platform-client": "44.1.0",
+    "@coveo/platform-client": "52.1.0",
     "abortcontroller-polyfill": "1.7.5",
     "detect-indent": "7.0.1",
     "https-proxy-agent": "5.0.1",

diff --git a/packages/ui/atomic/create-atomic/src/default/default-page.ts b/packages/ui/atomic/create-atomic/src/default/default-page.ts
@@ -5,7 +5,7 @@ import defaultSearchInterface from './default-search-interface.js';
 
 export const defaultPageManifest: IManifest = {
   config: {
-    title: 'Atomic Stencil Project',
+    name: 'Atomic Stencil Project',
   },
   markup: defaultSearchInterface,
   results: {