[Backport 2.x] Add support for Node.js >=14.20.1 <19 (#4071) (#4153)

* Add support for Node.js >=14.20.1 <19 (#4071) * Bump Node.js requirements to 18 Signed-off-by: Miki <[email protected]> * Replace `lmdb-store` with `lmdb` Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Bump `elastic-apm-node` to the latest minor Signed-off-by: Miki <[email protected]> * Replace webpack and plugins with a patched version that uses xxhash64 * Use `xxhash64` as the hashing algorithm of webpack * Upgrade `globby` * Remove `fibers` Signed-off-by: Miki <[email protected]> * Replace `fs.rmdir` with `fs.rm` in cross-platform tests Signed-off-by: Miki <[email protected]> * Increase listener limit Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Add promise-stripping serializer Signed-off-by: Miki <[email protected]> * Bump heap for CI Signed-off-by: Miki <[email protected]> * Correct use of fs/promises in @osd/pm Signed-off-by: Miki <[email protected]> * Use fs/promise in plugin post-install cleanup Signed-off-by: Miki <[email protected]> * Set the test server's host to `0.0.0.0` Signed-off-by: Miki <[email protected]> * Sync `.node-version` file Signed-off-by: Miki <[email protected]> * Support both `isPrimary`, for Node 18, and `isMaster`, for Node 14 Signed-off-by: Miki <[email protected]> * Add types when using `isDeepStrictEqual` Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Add names to `SchemaError` to log more specific errors Signed-off-by: Miki <[email protected]> * Fix failing vega visualization tests outside the CI Signed-off-by: Miki <[email protected]> * Fix snapshot of errors thrown for undefined accessors Signed-off-by: Miki <[email protected]> * Fix flakiness of log_rotator Signed-off-by: Miki <[email protected]> * Fix asynchronous `fs` usafe in plugin discover Signed-off-by: Miki <[email protected]> * Fix mocks in @osd/optimizer Signed-off-by: Miki <[email protected]> * Fix memory leaks caused by setting states on unloaded components Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Bump Node in Dockerfile Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Remove the response `close` event as an indicator of the requesting finishing #3601 (comment) Signed-off-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * [BWC] Timeout after 3 mins of waiting for OSD to be running in tests Signed-off-by: Miki <[email protected]> * Make build use the same node version that tests are run against Signed-off-by: Miki <[email protected]> * Make Node resolve DNS by IPv4 first * This is helpful to resolve `locahost` to `127.0.0.1` Signed-off-by: Miki <[email protected]> * Standardize patterns used by plugin discovery * Enhance absolute path serialization on Windows Signed-off-by: Miki <[email protected]> * Mock fetch in SenseEditor tests Signed-off-by: Miki <[email protected]> * Restore node-sass usage to fix build performance * `sass-loader@10` is the last version that supports webpack@4 * `sass` is extremely slow when using the legacy API (`render`) and to use the "Modern API" (`compileStringAsync`), `sass-loader@13` would be needed. * The performance of `sass@10` is made acceptable only with `fibers` but that is deprecated and doesn't work on Node 18 Signed-off-by: Anan Zhuang <[email protected]> Signed-off-by: Miki <[email protected]> * Revert "[CI] setup Chrome and utilize binary path (#3997)" This reverts commit 0188d05 Signed-off-by: Miki <[email protected]> * Prevent fast-fail while running functional test in CI Signed-off-by: Miki <[email protected]> * Revert "Temporarily hardcode chromedriver to 112.0.0 to enable all ftr tests (#3976)" This reverts commit 5ea0cbe. Signed-off-by: Miki <[email protected]> * Save Cypress results artifacts during CI Signed-off-by: Miki <[email protected]> * Add missing required dependency on `set-value` * Also force all to ^4.1.0 due to a vulnerability fixed in 3.1.0. Signed-off-by: Miki <[email protected]> * Prevent multiple calls to bootstrap's shutdown Signed-off-by: Miki <[email protected]> * Use Node 18.16.0 in distributions * Bump jest-canvas-mock to fix failing tests * Extend Node engines versions Signed-off-by: Miki <[email protected]> * Normalize test snapshots across Node 14, 16, and 18 Signed-off-by: Miki <[email protected]> * Update CHANGELOG for Node.js >=14.20.1 <19 support Signed-off-by: Miki <[email protected]> --------- Signed-off-by: Miki <[email protected]> Signed-off-by: Miki <[email protected]> Signed-off-by: Anan Zhuang <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> * Set node version to 16.x Signed-off-by: Kawika Avilla <[email protected]> --------- Signed-off-by: Miki <[email protected]> Signed-off-by: Miki <[email protected]> Signed-off-by: Anan Zhuang <[email protected]> Signed-off-by: Kawika Avilla <[email protected]> Co-authored-by: Miki <[email protected]> Co-authored-by: Anan Zhuang <[email protected]>
opensearch-project · May 26, 2023 · bf59644 · bf59644
1 parent 1fb4d48
commit bf59644
Show file tree

Hide file tree

Showing 78 changed files with 4,328 additions and 3,882 deletions.
diff --git a/.github/workflows/build_and_test_workflow.yml b/.github/workflows/build_and_test_workflow.yml
@@ -25,13 +25,13 @@ env:
   TEST_OPENSEARCH_TRANSPORT_PORT: 9403
   TEST_OPENSEARCH_PORT: 9400
   OSD_SNAPSHOT_SKIP_VERIFY_CHECKSUM: true
-  # Version 112.0.5615.0
-  CHROME_VERSION: 1109208
+  NODE_OPTIONS: "--max-old-space-size=6144 --dns-result-order=ipv4first"
 
 jobs:
   build-lint-test:
     name: Build and Verify on ${{ matrix.name }}
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
         include:
@@ -137,22 +137,6 @@ jobs:
     steps:
       - run: echo Running functional tests for ciGroup${{ matrix.group }}
 
-      - name: Setup Chrome
-        id: setup-chrome
-        uses: browser-actions/setup-chrome@v1
-        with:
-          chrome-version: ${{ env.CHROME_VERSION }}
-
-      - name: Set Chrome Path
-        if: matrix.os != 'windows-latest'
-        run: |
-          echo "TEST_BROWSER_BINARY_PATH=${{ steps.setup-chrome.outputs.chrome-path }}" >> $GITHUB_ENV
-
-      - name: Set Chrome Path (Windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          echo "TEST_BROWSER_BINARY_PATH=${{ steps.setup-chrome.outputs.chrome-path }}" >> $env:GITHUB_ENV
-
       - name: Configure git's autocrlf (Windows only)
         if: matrix.os == 'windows-latest'
         run: |
@@ -403,6 +387,7 @@ jobs:
         with:
           name: ${{ matrix.version }}-test-failures
           path: |
-            ./artifacts/bwc_tmp/test/cypress/videos/without-security/*
-            ./artifacts/bwc_tmp/test/cypress/screenshots/without-security/*
+            ./artifacts/bwc_tmp/test/cypress/videos/*
+            ./artifacts/bwc_tmp/test/cypress/screenshots/*
+            ./artifacts/bwc_tmp/test/cypress/results/*
           retention-days: 1
diff --git a/.node-version b/.node-version
@@ -1 +1 @@
-14.21.3
+16.20.0
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-14.21.3
+16.20.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,11 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [VisBuilder] Add metric to metric, bucket to bucket aggregation persistence ([#3495](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3495))
 - [VisBuilder] Add UI actions handler ([#3732](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3732))
 - [VisBuilder] Add persistence to visualizations inner state ([#3751](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3751))
+- Add satisfaction survey link to help menu ([#3676] (https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3676))
+- [Vis Builder] Add persistence to visualizations inner state ([#3751](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3751))
+- [Table Visualization] Move format table, consolidate types and add unit tests ([#3397](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3397))
+- [Multiple Datasource] Support Amazon OpenSearch Serverless ([#3957](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3957))
+- Add support for Node.js >=14.20.1 <19 ([#4071](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4071))
 
 ### 🐛 Bug Fixes
 
@@ -89,6 +94,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 - Update caniuse to `1.0.30001460` to fix failed integration tests ([#3538](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3538))
 - [Tests] Fix unit tests for `get_keystore` ([#3854](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3854))
+- [Tests] Use `scripts/use_node` instead of `node` in functional test plugins ([#3783](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3783))
+
+## [2.x]
 
 ## [2.6.0]
 

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-ARG NODE_VERSION=14.20.1
+ARG NODE_VERSION=18.16.0
 FROM node:${NODE_VERSION} AS base
 
 ENV HOME '.'

diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "test:jest:ci": "scripts/use_node scripts/jest --ci --colors --runInBand",
     "test:jest:ci:coverage": "scripts/use_node scripts/jest --ci --colors --runInBand --coverage",
     "test:jest_integration": "scripts/use_node scripts/jest_integration",
-    "test:jest_integration:ci": "scripts/use_node scripts/jest_integration --ci --colors --max-old-space-size=5120",
+    "test:jest_integration:ci": "scripts/use_node scripts/jest_integration --ci --colors",
     "test:mocha": "scripts/use_node scripts/mocha",
     "test:mocha:coverage": "yarn nyc --reporter=text-summary --reporter=lcov --report-dir=./target/opensearch-dashboards-coverage/mocha scripts/use_node scripts/mocha",
     "test:ftr": "scripts/use_node scripts/functional_tests",
@@ -79,7 +79,7 @@
     "url": "https://github.com/opensearch-project/opensearch-dashboards.git"
   },
   "resolutions": {
-    "**/@types/node": "^14.17.32",
+    "**/@types/node": "~18.7.0",
     "**/ansi-regex": "^5.0.1",
     "**/async": "^3.2.3",
     "**/d3-color": "^3.1.0",
@@ -99,6 +99,7 @@
     "**/minimatch": "^3.0.5",
     "**/jest-config": "npm:@amoo-miki/[email protected]",
     "**/jest-jasmine2": "npm:@amoo-miki/[email protected]",
+    "**/set-value": "^4.1.0",
     "**/xml2js": "^0.5.0",
     "**/yaml": "^2.2.2"
   },
@@ -170,7 +171,7 @@
     "deep-freeze-strict": "^1.1.1",
     "del": "^6.1.1",
     "dns-sync": "^0.2.1",
-    "elastic-apm-node": "^3.7.0",
+    "elastic-apm-node": "^3.43.0",
     "elasticsearch": "^16.7.0",
     "http-aws-es": "npm:@zhongnansu/[email protected]",
     "execa": "^4.0.2",
@@ -180,7 +181,7 @@
     "getos": "^3.2.1",
     "glob": "^7.1.7",
     "glob-all": "^3.2.1",
-    "globby": "^8.0.1",
+    "globby": "^11.1.0",
     "handlebars": "4.7.7",
     "hjson": "3.2.1",
     "http-proxy-agent": "^2.1.0",
@@ -215,6 +216,7 @@
     "rison-node": "1.0.2",
     "rxjs": "^6.5.5",
     "semver": "^5.7.0",
+    "set-value": "^4.1.0",
     "source-map-support": "^0.5.19",
     "symbol-observable": "^1.2.0",
     "tar": "^6.1.11",
@@ -305,7 +307,7 @@
     "@types/mock-fs": "^4.10.0",
     "@types/moment-timezone": "^0.5.12",
     "@types/mustache": "^0.8.31",
-    "@types/node": "^14.17.32",
+    "@types/node": "~18.7.0",
     "@types/node-forge": "^1.0.1",
     "@types/normalize-path": "^3.0.0",
     "@types/pegjs": "^0.10.1",
@@ -400,7 +402,7 @@
     "immer": "^9.0.6",
     "intl-messageformat-parser": "^1.4.0",
     "jest": "^27.5.1",
-    "jest-canvas-mock": "^2.3.1",
+    "jest-canvas-mock": "^2.5.1",
     "jest-raw-loader": "^1.0.1",
     "jimp": "^0.14.0",
     "jquery": "^3.5.0",
@@ -473,7 +475,7 @@
     "zlib": "^1.0.5"
   },
   "engines": {
-    "node": "^14.20.1",
-    "yarn": "^1.21.1"
+    "node": ">=14.20.1 <19",
+    "yarn": "^1.22.10"
   }
 }
diff --git a/packages/osd-ace/package.json b/packages/osd-ace/package.json
@@ -16,6 +16,6 @@
     "@osd/babel-preset": "1.0.0",
     "raw-loader": "^4.0.2",
     "typescript": "4.0.2",
-    "webpack": "^4.41.5"
+    "webpack": "npm:@amoo-miki/[email protected]"
   }
 }
diff --git a/packages/osd-config-schema/src/errors/__snapshots__/schema_error.test.ts.snap b/packages/osd-config-schema/src/errors/__snapshots__/schema_error.test.ts.snap
diff --git a/packages/osd-config-schema/src/errors/schema_error.test.ts b/packages/osd-config-schema/src/errors/schema_error.test.ts
@@ -33,11 +33,14 @@ import { SchemaError } from '.';
 
 import { standardize, getRepoRoot } from '@osd/cross-platform';
 
+// ToDo: Remove this logic when Node 14 support is removed
+const isNode14 = process.version.startsWith('v14.');
+
 /**
  * Make all paths in stacktrace relative.
  */
-export const cleanStack = (stack: string) =>
-  stack
+export const cleanStack = (stack: string) => {
+  const result = stack
     .split('\n')
     .filter((line) => !line.includes('node_modules' + sep) && !line.includes('internal/'))
     .map((line) => {
@@ -54,6 +57,11 @@ export const cleanStack = (stack: string) =>
     })
     .join('\n');
 
+  return isNode14
+    ? result.replace(/Error:\s([^\n]+)\n\s*at new ([^ ]+) [^\n]*\n/, '$2: $1\n')
+    : result;
+};
+
 it('includes stack', () => {
   try {
     throw new SchemaError('test');

diff --git a/packages/osd-config-schema/src/errors/schema_error.ts b/packages/osd-config-schema/src/errors/schema_error.ts
@@ -34,6 +34,7 @@ export class SchemaError extends Error {
   constructor(message: string, cause?: Error) {
     super(message);
     this.cause = cause;
+    this.name = this.constructor.name;
 
     // Set the prototype explicitly, see:
     // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work

diff --git a/packages/osd-config/src/config_service.test.ts b/packages/osd-config/src/config_service.test.ts
@@ -94,10 +94,10 @@ test('throws if config at path does not match schema', async () => {
     );
 
   await expect(valuesReceived).toMatchInlineSnapshot(`
-      Array [
-        [Error: [config validation of [key]]: expected value of type [string] but got [number]],
-      ]
-  `);
+          Array [
+            [ValidationError: [config validation of [key]]: expected value of type [string] but got [number]],
+          ]
+        `);
 });
 
 test('re-validate config when updated', async () => {
@@ -120,11 +120,11 @@ test('re-validate config when updated', async () => {
   rawConfig$.next({ key: 123 });
 
   await expect(valuesReceived).toMatchInlineSnapshot(`
-        Array [
-          "value",
-          [Error: [config validation of [key]]: expected value of type [string] but got [number]],
-        ]
-  `);
+          Array [
+            "value",
+            [ValidationError: [config validation of [key]]: expected value of type [string] but got [number]],
+          ]
+        `);
 });
 
 test("returns undefined if fetching optional config at a path that doesn't exist", async () => {

diff --git a/packages/osd-cross-platform/src/path.test.ts b/packages/osd-cross-platform/src/path.test.ts
@@ -5,7 +5,7 @@
 
 import path from 'path';
 import fs from 'fs';
-import { access, rmdir, mkdir, writeFile, symlink } from 'fs/promises';
+import { access, rm, mkdir, writeFile, symlink } from 'fs/promises';
 
 import {
   resolveToFullNameSync,
@@ -43,9 +43,9 @@ describe('Cross Platform', () => {
           try {
             // If leftover artifacts were found, get rid of them
             await access(tmpTestFolder);
-            await rmdir(tmpTestFolder, { recursive: true });
+            await rm(tmpTestFolder, { recursive: true });
           } catch (ex) {
-            // Do nothing; if `rmdir` failed, let the `mkdir` below throw the error
+            // Do nothing; if `rm` failed, let the `mkdir` below throw the error
           }
 
           await mkdir(tmpTestFolder);
@@ -60,7 +60,7 @@ describe('Cross Platform', () => {
 
         afterAll(async () => {
           try {
-            await rmdir(tmpTestFolder, { recursive: true });
+            await rm(tmpTestFolder, { recursive: true });
           } catch (ex) {
             // Do nothing
           }

diff --git a/packages/osd-dev-utils/package.json b/packages/osd-dev-utils/package.json
@@ -22,7 +22,7 @@
     "execa": "^4.0.2",
     "exit-hook": "^2.2.0",
     "getopts": "^2.2.5",
-    "globby": "^8.0.1",
+    "globby": "^11.1.0",
     "load-json-file": "^6.2.0",
     "markdown-it": "^12.3.2",
     "moment": "^2.24.0",

diff --git a/packages/osd-dev-utils/src/proc_runner/proc.ts b/packages/osd-dev-utils/src/proc_runner/proc.ts
@@ -153,15 +153,15 @@ export function startProc(name: string, options: ProcOptions, log: ToolingLog) {
     await withTimeout(
       async () => {
         log.debug(`Sending "${signal}" to proc "${name}"`);
-        await treeKillAsync(childProcess.pid, signal);
+        await treeKillAsync(childProcess.pid!, signal);
         await outcomePromise;
       },
       STOP_TIMEOUT,
       async () => {
         log.warning(
           `Proc "${name}" was sent "${signal}" didn't emit the "exit" or "error" events after ${STOP_TIMEOUT} ms, sending SIGKILL`
         );
-        await treeKillAsync(childProcess.pid, 'SIGKILL');
+        await treeKillAsync(childProcess.pid!, 'SIGKILL');
       }
     );
 

diff --git a/packages/osd-dev-utils/src/serializers/absolute_path_serializer.ts b/packages/osd-dev-utils/src/serializers/absolute_path_serializer.ts
@@ -37,6 +37,10 @@ export function createAbsolutePathSerializer(
 ) {
   const rootPaths = Array.isArray(rootPath) ? rootPath : [rootPath];
 
+  if (process.platform === 'win32') {
+    rootPaths.push(...rootPaths.map((name) => name.replace(/\\/g, '/')));
+  }
+
   return {
     test: (value: any) =>
       typeof value === 'string' && rootPaths.some((path) => value.startsWith(path)),

diff --git a/packages/osd-dev-utils/src/serializers/index.ts b/packages/osd-dev-utils/src/serializers/index.ts
@@ -33,3 +33,4 @@ export * from './strip_ansi_serializer';
 export * from './recursive_serializer';
 export * from './any_instance_serizlizer';
 export * from './replace_serializer';
+export * from './strip_promises_serizlizer';
diff --git a/packages/osd-dev-utils/src/serializers/strip_promises_serizlizer.ts b/packages/osd-dev-utils/src/serializers/strip_promises_serizlizer.ts
@@ -0,0 +1,9 @@
+/*
+ * Copyright OpenSearch Contributors
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+export const createStripPromisesSerializer = () => ({
+  serialize: (value: string) => value.replace(/("value": Promise) \{[^}]+}/gm, '$1 {}'),
+  test: (value: any) => typeof value === 'string',
+});
diff --git a/packages/osd-dev-utils/src/simple_opensearch_dashboards_platform_plugin_discovery.ts b/packages/osd-dev-utils/src/simple_opensearch_dashboards_platform_plugin_discovery.ts
@@ -28,7 +28,8 @@
  * under the License.
  */
 
-import Path from 'path';
+import { resolve } from 'path';
+import { standardize } from '@osd/cross-platform';
 
 import globby from 'globby';
 
@@ -47,24 +48,23 @@ export function simpleOpenSearchDashboardsPlatformPluginDiscovery(
       ...scanDirs.reduce(
         (acc: string[], dir) => [
           ...acc,
-          Path.resolve(dir, '*/opensearch_dashboards.json'),
-          Path.resolve(dir, '*/*/opensearch_dashboards.json'),
-          Path.resolve(dir, '*/*/*/opensearch_dashboards.json'),
-          Path.resolve(dir, '*/*/*/*/opensearch_dashboards.json'),
-          Path.resolve(dir, '*/*/*/*/*/opensearch_dashboards.json'),
+          resolve(dir, '*/opensearch_dashboards.json'),
+          resolve(dir, '*/*/opensearch_dashboards.json'),
+          resolve(dir, '*/*/*/opensearch_dashboards.json'),
+          resolve(dir, '*/*/*/*/opensearch_dashboards.json'),
+          resolve(dir, '*/*/*/*/*/opensearch_dashboards.json'),
         ],
         []
       ),
-      ...pluginPaths.map((path) => Path.resolve(path, `opensearch_dashboards.json`)),
+      ...pluginPaths.map((path) => resolve(path, `opensearch_dashboards.json`)),
     ])
   );
 
-  const manifestPaths = globby.sync(patterns, { absolute: true }).map((path) =>
-    // absolute paths returned from globby are using normalize or
-    // something so the path separators are `/` even on windows,
-    // Path.resolve solves this
-    Path.resolve(path)
-  );
+  const standardizedPatterns = patterns.map((pattern) => standardize(pattern));
+
+  const manifestPaths = globby
+    .sync(standardizedPatterns, { absolute: true })
+    .map((path) => standardize(resolve(path)));
 
   return manifestPaths.map(parseOpenSearchDashboardsPlatformPlugin);
 }
diff --git a/packages/osd-eslint-import-resolver-opensearch-dashboards/package.json b/packages/osd-eslint-import-resolver-opensearch-dashboards/package.json
@@ -19,6 +19,6 @@
     "glob-all": "^3.2.1",
     "lru-cache": "^4.1.5",
     "resolve": "^1.7.1",
-    "webpack": "^4.41.5"
+    "webpack": "npm:@amoo-miki/[email protected]"
   }
 }