@vscode/test-web 0.0.57 → 0.0.59

package/out/{index.js → server/index.js}

@@ -8,8 +8,8 @@ exports.open = open;
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-const main_1 = require("./server/main");
-const download_1 = require("./server/download");
+const main_1 = require("./main");
+const download_1 = require("./download");
 const playwright = require("playwright");
 const minimist = require("minimist");
 const path = require("path");
@@ -80,8 +80,9 @@ async function getBuild(options) {
         };
     }
     const quality = options.quality || options.version;
+    const commit = options.commit;
     const testRunnerDataDir = options.testRunnerDataDir ?? path.resolve(process.cwd(), '.vscode-test-web');
-    return await (0, download_1.downloadAndUnzipVSCode)(quality === 'stable' ? 'stable' : 'insider', testRunnerDataDir);
+    return await (0, download_1.downloadAndUnzipVSCode)(testRunnerDataDir, quality === 'stable' ? 'stable' : 'insider', commit);
 }
 async function open(options) {
     const config = {
@@ -335,6 +336,20 @@ function validateQuality(quality, version, vsCodeDevPath) {
     showHelp();
     process.exit(-1);
 }
+function validateCommit(commit, vsCodeDevPath) {
+    if (vsCodeDevPath && commit) {
+        console.log(`Sources folder is provided as input, commit is ignored.`);
+        return undefined;
+    }
+    if (commit === undefined || (typeof commit === 'string' && commit.match(/^[0-9a-f]{40}$/))) {
+        return commit;
+    }
+    else {
+        console.log(`Invalid format for commit. Expected a 40 character long SHA1 hash.`);
+    }
+    showHelp();
+    process.exit(-1);
+}
 function validatePortNumber(port) {
     if (typeof port === 'string') {
         const number = Number.parseInt(port);
@@ -351,6 +366,7 @@ function showHelp() {
     console.log(`  --extensionDevelopmentPath path: A path pointing to an extension under development to include. [Optional]`);
     console.log(`  --extensionTestsPath path: A path to a test module to run. [Optional]`);
     console.log(`  --quality 'insiders' | 'stable' [Optional, default 'insiders', ignored when running from sources]`);
+    console.log(`  --commit commitHash [Optional, defaults to latest build version of the given quality, ignored when running from sources]`);
     console.log(`  --sourcesPath path: If provided, running from VS Code sources at the given location. [Optional]`);
     console.log(`  --open-devtools: If set, opens the dev tools. [Optional]`);
     console.log(`  --headless: Whether to hide the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]`);
@@ -377,10 +393,10 @@ async function cliMain() {
     });
     /* eslint-disable @typescript-eslint/no-var-requires */
     /* eslint-disable @typescript-eslint/no-require-imports */
-    const manifest = require('../package.json');
+    const manifest = JSON.parse(await (0, download_1.readFileInRepo)('package.json'));
     console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
-        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserOption', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port', 'testRunnerDataDir'],
+        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserOption', 'browserType', 'quality', 'version', 'commit', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port', 'testRunnerDataDir'],
         boolean: ['open-devtools', 'headless', 'hideServerLog', 'printServerLog', 'help', 'verbose', 'coi', 'esm'],
         unknown: arg => {
             if (arg.startsWith('-')) {
@@ -404,6 +420,7 @@ async function cliMain() {
     const extensionIds = await validateExtensionIds(args.extensionId);
     const vsCodeDevPath = await validatePathOrUndefined(args, 'sourcesPath');
     const quality = validateQuality(args.quality, args.version, vsCodeDevPath);
+    const commit = validateCommit(args.commit, vsCodeDevPath);
     const devTools = validateBooleanOrUndefined(args, 'open-devtools');
     const headless = validateBooleanOrUndefined(args, 'headless');
     const permissions = validatePermissions(args.permission);
@@ -435,6 +452,7 @@ async function cliMain() {
             browserOptions,
             browserType,
             quality,
+            commit,
             devTools,
             waitForDebugger,
             folderUri,
@@ -462,6 +480,7 @@ async function cliMain() {
             browserOptions,
             browserType,
             quality,
+            commit,
             devTools,
             waitForDebugger,
             folderUri,

package/out/server/workbench.js

@@ -10,12 +10,18 @@ const fs_1 = require("fs");
 const vscode_uri_1 = require("vscode-uri");
 const Router = require("@koa/router");
 const extensions_1 = require("./extensions");
-const download_1 = require("./download");
 const mounts_1 = require("./mounts");
+const download_1 = require("./download");
 function asJSON(value) {
     return JSON.stringify(value).replace(/"/g, '"');
 }
 class Workbench {
+    baseUrl;
+    dev;
+    esm;
+    devCSSModules;
+    builtInExtensions;
+    productOverrides;
     constructor(baseUrl, dev, esm, devCSSModules, builtInExtensions = [], productOverrides) {
         this.baseUrl = baseUrl;
         this.dev = dev;
@@ -30,34 +36,51 @@ class Workbench {
         }
         const values = {
             WORKBENCH_WEB_CONFIGURATION: asJSON(workbenchWebConfiguration),
-            WORKBENCH_AUTH_SESSION: '',
             WORKBENCH_WEB_BASE_URL: this.baseUrl,
             WORKBENCH_BUILTIN_EXTENSIONS: asJSON(this.builtInExtensions),
-            WORKBENCH_MAIN: this.getMain(),
-            WORKBENCH_DEV_CSS_MODULES: JSON.stringify(this.devCSSModules)
+            WORKBENCH_MAIN: await this.getMain()
         };
         try {
-            const workbenchTemplate = (await fs_1.promises.readFile(path.resolve(__dirname, `../../views/workbench${this.esm ? '-esm' : ''}.html`))).toString();
+            const workbenchTemplate = await (0, download_1.readFileInRepo)(`views/workbench${this.esm ? '-esm' : ''}.html`);
             return workbenchTemplate.replace(/\{\{([^}]+)\}\}/g, (_, key) => values[key] ?? 'undefined');
         }
         catch (e) {
             return String(e);
         }
     }
-    getMain() {
+    async getMain() {
+        const lines = [];
         if (this.esm) {
-            return `<script type="module" src="${this.baseUrl}/out/vs/code/browser/workbench/workbench.js"></script>`;
+            let workbenchMain = await (0, download_1.readFileInRepo)(`out/browser/esm/main.js`);
+            if (this.dev) {
+                lines.push("<script>", `globalThis._VSCODE_CSS_MODULES = ${JSON.stringify(this.devCSSModules)};`, "</script>", "<script>", "const sheet = document.getElementById('vscode-css-modules').sheet;", "globalThis._VSCODE_CSS_LOAD = function (url) { sheet.insertRule(`@import url(${url});`); };", "", "const importMap = { imports: {} };", "for (const cssModule of globalThis._VSCODE_CSS_MODULES) {", "  const cssUrl = new URL(cssModule, globalThis._VSCODE_FILE_ROOT).href;", "  const jsSrc = `globalThis._VSCODE_CSS_LOAD('${cssUrl}');\\n`;", "  const blob = new Blob([jsSrc], { type: 'application/javascript' });", "  importMap.imports[cssUrl] = URL.createObjectURL(blob);", "}", "const importMapElement = document.createElement('script');", "importMapElement.type = 'importmap';", "importMapElement.setAttribute('nonce', '1nline-m4p');", "importMapElement.textContent = JSON.stringify(importMap, undefined, 2);", "document.head.appendChild(importMapElement);", "</script>");
+                workbenchMain = workbenchMain.replace('./workbench.api', `${this.baseUrl}/out/vs/workbench/workbench.web.main.internal.js`);
+                lines.push(`<script type="module">${workbenchMain}</script>`);
+            }
+            else {
+                workbenchMain = workbenchMain.replace('./workbench.api', `${this.baseUrl}/out/vs/workbench/workbench.web.main.internal.js`);
+                lines.push(`<script src="${this.baseUrl}/out/nls.messages.js"></script>`);
+                lines.push(`<script type="module">${workbenchMain}</script>`);
+            }
+            return lines.join('\n');
         }
-        if (this.dev) {
-            return `<script> require(['vs/code/browser/workbench/workbench'], function() {}); </script>`;
+        else {
+            let workbenchMain = await (0, download_1.readFileInRepo)(`out/browser/amd/main.js`); // defines a AMD module `vscode-web-browser-main`
+            workbenchMain = workbenchMain.replace('./workbench.api', `vs/workbench/workbench.web.main`);
+            workbenchMain = workbenchMain + '\nrequire(["vscode-web-browser-main"], function() { });';
+            if (this.dev) {
+            }
+            else {
+                lines.push(`<script src="${this.baseUrl}/out/nls.messages.js"></script>`);
+                lines.push(`<script src="${this.baseUrl}/out/vs/workbench/workbench.web.main.nls.js"></script>`);
+                lines.push(`<script src="${this.baseUrl}/out/vs/workbench/workbench.web.main.js"></script>`);
+            }
+            lines.push(`<script>${workbenchMain}</script>`);
         }
-        return `<script src="${this.baseUrl}/out/nls.messages.js"></script>`
-            + `<script src="${this.baseUrl}/out/vs/workbench/workbench.web.main.nls.js"></script>`
-            + `<script src="${this.baseUrl}/out/vs/workbench/workbench.web.main.js"></script>`
-            + `<script src="${this.baseUrl}/out/vs/code/browser/workbench/workbench.js"></script>`;
+        return lines.join('\n');
     }
     async renderCallback() {
-        return await (0, download_1.fetch)(`${this.baseUrl}/out/vs/code/browser/workbench/callback.html`);
+        return await (0, download_1.readFileInRepo)(`views/callback.html`);
     }
 }
 async function getWorkbenchOptions(ctx, config) {
@@ -115,8 +138,10 @@ function default_1(config) {
         if (config.build.type === 'sources') {
             const builtInExtensions = await (0, extensions_1.getScannedBuiltinExtensions)(config.build.location);
             const productOverrides = await getProductOverrides(config.build.location);
-            const devCSSModules = config.esm ? await getDevCssModules(config.build.location) : [];
-            ctx.state.workbench = new Workbench(`${ctx.protocol}://${ctx.host}/static/sources`, true, config.esm, devCSSModules, builtInExtensions, {
+            const esm = config.esm || await isESM(config.build.location);
+            console.log('Using ESM loader:', esm);
+            const devCSSModules = esm ? await getDevCssModules(config.build.location) : [];
+            ctx.state.workbench = new Workbench(`${ctx.protocol}://${ctx.host}/static/sources`, true, esm, devCSSModules, builtInExtensions, {
                 ...productOverrides,
                 webEndpointUrlTemplate: `${ctx.protocol}://{{uuid}}.${ctx.host}/static/sources`,
                 webviewContentExternalBaseUrlTemplate: `${ctx.protocol}://{{uuid}}.${ctx.host}/static/sources/out/vs/workbench/contrib/webview/browser/pre/`
@@ -159,3 +184,12 @@ async function getDevCssModules(vsCodeDevLocation) {
     const glob = await Promise.resolve().then(() => require('glob'));
     return glob.glob('**/*.css', { cwd: path.join(vsCodeDevLocation, 'out') });
 }
+async function isESM(vsCodeDevLocation) {
+    try {
+        const packageJSON = await fs_1.promises.readFile(path.join(vsCodeDevLocation, 'out', 'package.json'));
+        return JSON.parse(packageJSON.toString()).type === 'module';
+    }
+    catch (e) {
+        return false;
+    }
+}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.57",
+  "version": "0.0.59",
   "scripts": {
     "install-extensions": "npm i --prefix=fs-provider && npm i --prefix=sample",
-    "compile": "tsc -p ./ && npm run compile-fs-provider",
-    "watch": "tsc -w -p ./",
+    "compile": "tsc -b ./ && npm run compile-fs-provider",
+    "watch": "tsc -b -w ./",
     "prepack": "npm run compile",
     "test": "eslint src && tsc --noEmit",
     "preversion": "npm test",
@@ -15,9 +15,9 @@
     "sample-tests": "npm run compile && npm run compile-sample && node . --extensionDevelopmentPath=sample --extensionTestsPath=sample/dist/web/test/suite/index.js --headless=true sample/test-workspace",
     "empty": "npm run compile && node ."
   },
-  "main": "./out/index.js",
+  "main": "./out/server/index.js",
   "bin": {
-    "vscode-test-web": "./out/index.js"
+    "vscode-test-web": "./out/server/index.js"
   },
   "engines": {
     "node": ">=16"
@@ -51,8 +51,8 @@
     "@types/minimist": "^1.2.5",
     "@types/node": "^20.14.9",
     "@types/tar-fs": "^2.0.4",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
     "eslint": "^9.9.1",
     "@tony.ganchev/eslint-plugin-header": "^3.1.2",
     "typescript": "^5.5.4"