Manually backports Windows changes from #2601 (#2647)

* [Windows] Replaces `rm -rf` with `remove.js`
* [dev/build] Facilitates using zipped archives of node releases
* [div/build] Introduces Windows as a platform
* [dev/build] Corrects cleaning of platform specific build artifacts
* [dev/build] Enhances the cleanup of downloaded node binaries
* [opensearch-dashboards-plugin] Removes prohibition on installing plugins on Windows
* [@osd/utils] Adds a method to standardize path references across platforms
* [dev/build] Standardize paths in tests
* [@osd/telemetry-tools] Normalizes the collection paths
* [plugins/url-forwarding] Fixes the usage of `normalizePath` across node and browser
* [@osd/pm] Allows symlink created for tests without elevated privileges on Windows
* [@osd/opensearch] Allows usage of Windows snapshots in integration tests
* [@osd/opensearch] Employs absolute paths in tests
* [@osd/apm-config-loader] Employs absolute paths in tests
* [core/server] Employs absolute and posix references to paths
* [@osd/optimizer] Standardize paths in tests
* [@osd/tests] Employs absolute paths in tests
* [@osd/pm] Standardize paths in project trees
* [plugins/telemetry] Accommodates the inability of Windows to create unreadable files for testing
* [@osd/config-schema] Normalize paths in tests
* [@osd/plugin-helpers] Standardize paths in tests
* [@osd/plugin-generator] Standardize paths in tests
* [Windows] Update changelog

backport PR: #2601

Signed-off-by: Miki <miki@amazon.com>

Author: Miki

CHANGELOG.md

@@ -23,6 +23,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 * [Multi DataSource] Add data source config to opensearch-dashboards-docker ([#2557](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2557))
 * [Multi DataSource] Make text content dynamically translated & update unit tests ([#2570](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2570))
 * [Vis Builder] Change classname prefix wiz to vb ([#2581](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2581/files))
+* [Windows] Facilitate building and running OSD and plugins on Windows platforms ([#2601](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2601))
 
 ### 🐛 Bug Fixes
 * [Vis Builder] Fixes auto bounds for timeseries bar chart visualization ([2401](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2401))

package.json

@@ -65,7 +65,7 @@
     "makelogs": "node scripts/makelogs",
     "uiFramework:compileCss": "cd packages/osd-ui-framework && yarn compileCss",
     "osd:watch": "node scripts/opensearch_dashboards --dev --logging.json=false",
-    "build:types": "rm -rf ./target/types && tsc --p tsconfig.types.json",
+    "build:types": "node scripts/remove.js ./target/types && tsc --p tsconfig.types.json",
     "docs:acceptApiChanges": "node --max-old-space-size=6144 scripts/check_published_api_changes.js --accept",
     "osd:bootstrap": "node scripts/build_ts_refs && node scripts/register_git_hook",
     "spec_to_console": "node scripts/spec_to_console",
@@ -410,6 +410,7 @@
     "mutation-observer": "^1.0.3",
     "ngreact": "^0.5.1",
     "nock": "12.0.3",
+    "node-stream-zip": "^1.15.0",
     "normalize-path": "^3.0.0",
     "nyc": "^15.1.0",
     "pixelmatch": "^5.1.0",
@@ -459,4 +460,4 @@
     "node": "14.20.0",
     "yarn": "^1.21.1"
   }
-}
+}

packages/osd-apm-config-loader/src/utils/get_config_file_paths.test.ts

@@ -40,7 +40,7 @@ describe('getConfigurationFilePaths', () => {
 
     expect(getConfigurationFilePaths(argv)).toEqual([
       resolve(cwd, join('.', 'relative-path')),
-      '/absolute-path',
+      resolve('/absolute-path'),
     ]);
   });
 

packages/osd-config-schema/src/errors/__snapshots__/schema_error.test.ts.snap

@@ -28,7 +28,7 @@
  * under the License.
  */
 
-import { relative } from 'path';
+import { relative, sep } from 'path';
 import { SchemaError } from '.';
 
 /**
@@ -37,7 +37,7 @@ import { SchemaError } from '.';
 export const cleanStack = (stack: string) =>
   stack
     .split('\n')
-    .filter((line) => !line.includes('node_modules/') && !line.includes('internal/'))
+    .filter((line) => !line.includes('node_modules' + sep) && !line.includes('internal/'))
     .map((line) => {
       const parts = /.*\((.*)\).?/.exec(line) || [];
 
@@ -46,7 +46,11 @@ export const cleanStack = (stack: string) =>
       }
 
       const path = parts[1];
-      return line.replace(path, relative(process.cwd(), path));
+      // Cannot use `standardize` from `@osd/utils
+      let relativePath = relative(process.cwd(), path);
+      if (process.platform === 'win32') relativePath = relativePath.replace(/\\/g, '/');
+
+      return line.replace(path, relativePath);
     })
     .join('\n');
 

packages/osd-config-schema/src/errors/schema_error.test.ts

@@ -7,8 +7,8 @@
     "devOnly": true
   },
   "scripts": {
-    "osd:bootstrap": "rm -rf target && tsc",
-    "osd:watch": "rm -rf target && tsc --watch"
+    "osd:bootstrap": "node ../../scripts/remove.js target && tsc",
+    "osd:watch": "node ../../scripts/remove.js target && tsc --watch"
   },
   "dependencies": {
     "@osd/dev-utils": "1.0.0",
@@ -17,4 +17,4 @@
   "devDependencies": {
     "@types/elasticsearch": "^5.0.33"
   }
-}
+}

packages/osd-opensearch-archiver/package.json

@@ -186,12 +186,14 @@ async function getArtifactSpecForSnapshotFromUrl(urlVersion, log) {
   // issue: https://github.com/opensearch-project/OpenSearch-Dashboards/issues/475
   const platform = process.platform === 'win32' ? 'windows' : process.platform;
   const arch = process.arch === 'arm64' ? 'arm64' : 'x64';
-  if (platform !== 'linux') {
-    throw createCliError(`Snapshots are only available for Linux`);
+  const extension = process.platform === 'win32' ? 'zip' : 'tar.gz';
+
+  if (platform !== 'linux' && platform !== 'windows') {
+    throw createCliError(`Snapshots are only available for Linux and Windows`);
   }
 
   const latestUrl = `${DAILY_SNAPSHOTS_BASE_URL}/${desiredVersion}-SNAPSHOT`;
-  const latestFile = `opensearch-min-${desiredVersion}-SNAPSHOT-${platform}-${arch}-latest.tar.gz`;
+  const latestFile = `opensearch-min-${desiredVersion}-SNAPSHOT-${platform}-${arch}-latest.${extension}`;
   const completeLatestUrl = `${latestUrl}/${latestFile}`;
 
   let { abc, resp } = await verifySnapshotUrl(completeLatestUrl, log);

packages/osd-opensearch/src/artifact.js

@@ -163,10 +163,10 @@ describe('Artifact', () => {
         });
       });
 
-      it('should throw when on a non-Linux platform', async () => {
+      it('should throw when on a non-Linux or non-Windows platform', async () => {
         Object.defineProperties(process, {
           platform: {
-            value: 'win32',
+            value: 'darwin',
           },
           arch: {
             value: ORIGINAL_ARCHITECTURE,

packages/osd-opensearch/src/artifact.test.js

@@ -52,8 +52,8 @@ beforeEach(() => {
   fs.copyFileSync(path.resolve(fixturesFolder, 'snapshot.tar.gz'), tarGzSnapshot);
 });
 
-afterEach(() => {
-  del.sync(tmpFolder, { force: true });
+afterEach(async () => {
+  await del(tmpFolder, { force: true });
 });
 
 test('zip strips root directory', async () => {

packages/osd-opensearch/src/utils/decompress.test.js

@@ -36,6 +36,7 @@ jest.mock('fs', () => ({
 
 const { extractConfigFiles } = require('./extract_config_files');
 const fs = require('fs');
+const path = require('path');
 
 afterEach(() => {
   jest.clearAllMocks();
@@ -55,7 +56,7 @@ test('copies file', () => {
   extractConfigFiles(['path=/data/foo.yml'], '/opensearch');
 
   expect(fs.readFileSync.mock.calls[0][0]).toEqual('/data/foo.yml');
-  expect(fs.writeFileSync.mock.calls[0][0]).toEqual('/opensearch/config/foo.yml');
+  expect(fs.writeFileSync.mock.calls[0][0]).toEqual(path.resolve('/opensearch/config/foo.yml'));
 });
 
 test('ignores file which does not exist', () => {