Manually download VSCode (#156)

Workaround for
redhat-developer/vscode-extension-tester#524

fixes `throw new Error('The `onCancel` handler was attached after the
promise settled.');`, which sporadically failed CI tests.

Author: fjakobs

.github/workflows/tests.yml

@@ -51,13 +51,7 @@ jobs:
               run: yarn test:cov
 
             - name: Integration Tests
-              uses: nick-fields/retry@v2
-              with:
-                  max_attempts: 3
-                  retry_wait_seconds: 2
-                  timeout_minutes: 10
-                  retry_on: any
-                  command: yarn run test:integ:cov
+              run: yarn run test:integ:cov
 
             - run: |
                   cd coverage
@@ -122,18 +116,12 @@ jobs:
               working-directory: packages/databricks-vscode
 
             - name: Integration Tests
-              uses: nick-fields/retry@v2
-              with:
-                  max_attempts: 3
-                  retry_wait_seconds: 2
-                  timeout_minutes: 10
-                  retry_on: any
-                  command: |
-                      yarn workspace databricks-vscode run test:integ:clean
-                      yarn install --immutable
-                      yarn build
-                      cd packages/databricks-vscode
-                      yarn run test:integ
+              run: |
+                  yarn workspace databricks-vscode run test:integ:clean
+                  yarn install --immutable
+                  yarn build
+                  cd packages/databricks-vscode
+                  yarn run test:integ
 
             - name: Upload test logs
               if: always()

packages/databricks-vscode/package.json

@@ -503,8 +503,8 @@
         "test:lint": "eslint src --ext ts && prettier . -c",
         "test:unit": "yarn run build && node ./out/test/runTest.js",
         "test:integ:clean": "yarn run clean && rm -rf /tmp/vscode-test-databricks /tmp/databricks-vscode-test-extensions",
-        "test:integ:prepare": "CODE_VERSION=1.69.1 && yarn run package && extest get-vscode --code_version $CODE_VERSION --storage /tmp/vscode-test-databricks && extest get-chromedriver --code_version 1.69.1 --storage /tmp/vscode-test-databricks",
-        "test:integ:install-vsix": "extest install-vsix --storage /tmp/vscode-test-databricks -f databricks-vscode*.vsix -e /tmp/databricks-vscode-test-extensions",
+        "test:integ:prepare": "CODE_VERSION=1.69.1 && yarn run package && ts-node src/test/vscode-extension-tester-patch/cli.ts get-vscode --code_version $CODE_VERSION --storage /tmp/vscode-test-databricks && ts-node src/test/vscode-extension-tester-patch/cli.ts get-chromedriver --code_version $CODE_VERSION --storage /tmp/vscode-test-databricks",
+        "test:integ:install-vsix": "ts-node src/test/vscode-extension-tester-patch/cli.ts install-vsix --storage /tmp/vscode-test-databricks -f databricks-vscode*.vsix -e /tmp/databricks-vscode-test-extensions",
         "test:integ:run": "yarn run build && node out/test/e2e/scripts/e2e.js -e /tmp/databricks-vscode-test-extensions --storage /tmp/vscode-test-databricks --code_settings src/test/e2e/settings.json 'out/**/*.e2e.js'",
         "test:integ": "yarn run test:integ:prepare && yarn run test:integ:install-vsix && yarn run test:integ:run",
         "test:cov": "nyc yarn run test:unit",
@@ -519,6 +519,7 @@
     },
     "devDependencies": {
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
+        "@types/fs-extra": "^9.0.13",
         "@types/glob": "^8.0.0",
         "@types/mocha": "^9.1.1",
         "@types/node": "^18.7.17",
@@ -529,12 +530,15 @@
         "@vscode/test-electron": "^2.1.5",
         "esbuild": "^0.15.7",
         "eslint": "^8.23.1",
+        "fs-extra": "^10.1.0",
         "glob": "^8.0.3",
         "mocha": "^10.0.0",
+        "mock-require": "^3.0.3",
         "nyc": "^15.1.0",
         "prettier": "^2.7.1",
         "tmp-promise": "^3.0.3",
         "ts-mockito": "^2.6.1",
+        "ts-node": "^10.9.1",
         "typescript": "^4.8.3",
         "vsce": "^2.11.0",
         "vscode-extension-tester": "^4.4.1",
@@ -558,4 +562,4 @@
         ],
         "report-dir": "coverage"
     }
-}
+}

packages/databricks-vscode/src/test/e2e/configure.e2e.ts

@@ -169,6 +169,7 @@ describe("Configure Databricks Extension", async function () {
         }
 
         await input.setText(clusterId);
+        await driver.sleep(200);
         await input.confirm();
 
         // wait for tree to update

packages/databricks-vscode/src/test/vscode-extension-tester-patch/README.md

@@ -0,0 +1,9 @@
+# UGLY HACK
+
+Please remove this folder once https://github.com/redhat-developer/vscode-extension-tester/issues/524 is fixed.
+
+This version contains a fix for https://github.com/redhat-developer/vscode-extension-tester/issues/524 to make CI more reliable.
+
+The patch in this repo is the same as this commit https://github.com/garden-io/garden/commit/eb00c57c1f84dda83c442da10362ddcfca594c37 for a different project.
+
+The code in this folder is based on https://github.com/redhat-developer/vscode-extension-tester/tree/0aced778186c1a749cc4ea2e893fc12836c846e9

packages/databricks-vscode/src/test/vscode-extension-tester-patch/cli.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+require("mock-require")(
+    "vscode-extension-tester/out/util/download",
+    "./download"
+);
+
+import {program} from "commander";
+
+require("vscode-extension-tester/out/cli");

packages/databricks-vscode/src/test/vscode-extension-tester-patch/download.ts

@@ -0,0 +1,89 @@
+import * as fs from "fs-extra";
+import got, {OptionsOfTextResponseBody, Response} from "got";
+import {promisify} from "util";
+import stream = require("stream");
+import {HttpProxyAgent, HttpsProxyAgent} from "hpagent";
+
+const httpProxyAgent = !process.env.HTTP_PROXY
+    ? undefined
+    : new HttpProxyAgent({
+          proxy: process.env.HTTP_PROXY,
+      });
+
+const httpsProxyAgent = !process.env.HTTPS_PROXY
+    ? undefined
+    : new HttpsProxyAgent({
+          proxy: process.env.HTTPS_PROXY,
+      });
+
+// This is to prevent Unhandled Promise Rejections in got
+// See: https://github.com/sindresorhus/got/issues/1489#issuecomment-805485731
+function isGotResponseOk(response: Response) {
+    const {statusCode} = response;
+    const limitStatusCode = response.request.options.followRedirect ? 299 : 399;
+
+    return (
+        (statusCode >= 200 && statusCode <= limitStatusCode) ||
+        statusCode === 304
+    );
+}
+
+const options: OptionsOfTextResponseBody & {isStream?: undefined} = {
+    headers: {
+        "user-agent": "nodejs",
+    },
+    agent: {
+        http: httpProxyAgent,
+        https: httpsProxyAgent,
+    },
+    hooks: {
+        afterResponse: [
+            (response) => {
+                if (isGotResponseOk(response)) {
+                    response.request.destroy();
+                }
+
+                return response;
+            },
+        ],
+    },
+};
+
+export class Download {
+    static async getText(uri: string): Promise<string> {
+        const body = await got(uri, options).text();
+        return JSON.parse(body as string);
+    }
+
+    static getFile(
+        uri: string,
+        destination: string,
+        progress = false
+    ): Promise<void> {
+        console.log("PATCHED DOWNLOAD");
+
+        let lastTick = 0;
+        const dlStream = got.stream(uri, options);
+        if (progress) {
+            dlStream.on("downloadProgress", ({transferred, total, percent}) => {
+                const currentTime = Date.now();
+                if (
+                    total > 0 &&
+                    (lastTick === 0 ||
+                        transferred === total ||
+                        currentTime - lastTick >= 2000)
+                ) {
+                    console.log(
+                        `progress: ${transferred}/${total} (${Math.floor(
+                            100 * percent
+                        )}%)`
+                    );
+                    lastTick = currentTime;
+                }
+            });
+        }
+        const writeStream = fs.createWriteStream(destination);
+
+        return promisify(stream.pipeline)(dlStream, writeStream);
+    }
+}

yarn.lock

@@ -662,6 +662,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/fs-extra@npm:^9.0.13":
+  version: 9.0.13
+  resolution: "@types/fs-extra@npm:9.0.13"
+  dependencies:
+    "@types/node": "*"
+  checksum: add79e212acd5ac76b97b9045834e03a7996aef60a814185e0459088fd290519a3c1620865d588fa36c4498bf614210d2a703af5cf80aa1dbc125db78f6edac3
+  languageName: node
+  linkType: hard
+
 "@types/glob@npm:^8.0.0":
   version: 8.0.0
   resolution: "@types/glob@npm:8.0.0"
@@ -1838,6 +1847,7 @@ __metadata:
     "@databricks/databricks-sdk": "*"
     "@databricks/databricks-vscode-types": "workspace:^"
     "@istanbuljs/nyc-config-typescript": ^1.0.2
+    "@types/fs-extra": ^9.0.13
     "@types/glob": ^8.0.0
     "@types/mocha": ^9.1.1
     "@types/node": ^18.7.17
@@ -1850,12 +1860,15 @@ __metadata:
     "@vscode/webview-ui-toolkit": ^1.0.1
     esbuild: ^0.15.7
     eslint: ^8.23.1
+    fs-extra: ^10.1.0
     glob: ^8.0.3
     mocha: ^10.0.0
+    mock-require: ^3.0.3
     nyc: ^15.1.0
     prettier: ^2.7.1
     tmp-promise: ^3.0.3
     ts-mockito: ^2.6.1
+    ts-node: ^10.9.1
     typescript: ^4.8.3
     vsce: ^2.11.0
     vscode-extension-tester: ^4.4.1
@@ -2741,7 +2754,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"fs-extra@npm:^10.0.0":
+"fs-extra@npm:^10.0.0, fs-extra@npm:^10.1.0":
   version: 10.1.0
   resolution: "fs-extra@npm:10.1.0"
   dependencies:
@@ -2836,6 +2849,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"get-caller-file@npm:^1.0.2":
+  version: 1.0.3
+  resolution: "get-caller-file@npm:1.0.3"
+  checksum: 2b90a7f848896abcebcdc0acc627a435bcf05b9cd280599bc980ebfcdc222416c3df12c24c4845f69adc4346728e8966f70b758f9369f3534182791dfbc25c05
+  languageName: node
+  linkType: hard
+
 "get-caller-file@npm:^2.0.1, get-caller-file@npm:^2.0.5":
   version: 2.0.5
   resolution: "get-caller-file@npm:2.0.5"
@@ -4035,6 +4055,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"mock-require@npm:^3.0.3":
+  version: 3.0.3
+  resolution: "mock-require@npm:3.0.3"
+  dependencies:
+    get-caller-file: ^1.0.2
+    normalize-path: ^2.1.1
+  checksum: 6355c0bd9d7acb5247155142928b0154ace2913264b42d9a611a85d469ed11048f405efe432ffc627a57efb87ec359589a7419bf680b4fd248612311deb031bd
+  languageName: node
+  linkType: hard
+
 "monaco-page-objects@npm:^2.0.1":
   version: 2.0.1
   resolution: "monaco-page-objects@npm:2.0.1"
@@ -4191,6 +4221,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"normalize-path@npm:^2.1.1":
+  version: 2.1.1
+  resolution: "normalize-path@npm:2.1.1"
+  dependencies:
+    remove-trailing-separator: ^1.0.1
+  checksum: 7e9cbdcf7f5b8da7aa191fbfe33daf290cdcd8c038f422faf1b8a83c972bf7a6d94c5be34c4326cb00fb63bc0fd97d9fbcfaf2e5d6142332c2cd36d2e1b86cea
+  languageName: node
+  linkType: hard
+
 "normalize-path@npm:^3.0.0, normalize-path@npm:~3.0.0":
   version: 3.0.0
   resolution: "normalize-path@npm:3.0.0"
@@ -4725,6 +4764,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"remove-trailing-separator@npm:^1.0.1":
+  version: 1.1.0
+  resolution: "remove-trailing-separator@npm:1.1.0"
+  checksum: d3c20b5a2d987db13e1cca9385d56ecfa1641bae143b620835ac02a6b70ab88f68f117a0021838db826c57b31373d609d52e4f31aca75fc490c862732d595419
+  languageName: node
+  linkType: hard
+
 "require-directory@npm:^2.1.1":
   version: 2.1.1
   resolution: "require-directory@npm:2.1.1"