@vscode/test-web 0.0.18 → 0.0.22

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+
+## 0.0.22
+ * new option `--printServerLog` replacing `--hideServerLog`
+ * new option `--browser` replacing `--browserType`
+
+## 0.0.20
+ * new option `--extensionId publisher.name[@prerelease]` to include one or more extensions
+
 ## 0.0.18
  * new option `--browserType none` to start the server without opening a browser.
 

package/README.md

@@ -67,20 +67,21 @@ CLI options:
 
 |Option|Argument Description|
 |-----|-----|
-| --browserType | The browser to launch: `chromium` (default), `firefox`, `webkit` or `none` |
+| --browser | The browser to launch: `chromium` (default), `firefox`, `webkit` or `none`. |
 | --extensionDevelopmentPath | A path pointing to an extension under development to include. |
 | --extensionTestsPath | A path to a test module to run. |
 | --quality | `insiders` (default),  or `stable`. Ignored when sourcesPath is provided. |
-| --sourcesPath | If set, runs the server from VS Code sources located at the given path. Make sure the sources and extensions are compiled (`yarn compile` and `yarn compile-web`) |
+| --sourcesPath | If set, runs the server from VS Code sources located at the given path. Make sure the sources and extensions are compiled (`yarn compile` and `yarn compile-web`). |
 | --headless | If set, hides the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. |
-| --permission | Permission granted to the opened browser: e.g. `clipboard-read`, `clipboard-write`.  See [full list of options](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions). Argument can be provided multiple times.  |
-| --folder-uri | URI of the workspace to open VS Code on. Ignored when `folderPath` is provided |
+| --permission | Permission granted to the opened browser: e.g. `clipboard-read`, `clipboard-write`.  See [full list of options](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions). Argument can be provided multiple times. |
+| --folder-uri | URI of the workspace to open VS Code on. Ignored when `folderPath` is provided. |
 | --extensionPath | A path pointing to a folder containing additional extensions to include. Argument can be provided multiple times. |
-| --host | The host name the server is opened on. Defaults to `localhost` |
-| --port | The port the server is opened on. Defaults to `3000` |
-| --open-devtools | If set, opens the dev tools in the browser |
-| --verbose | If set, prints out more information when running the server |
-| --hideServerLog | If set, hides the server log. Defaults to true when an extensionTestsPath is provided, otherwise false. |
+| --extensionId | The id of an extension include. The format is `${publisher}.${name}`. Append `@prerelease` to use the prerelease version. |
+| --host | The host name the server is opened on. Defaults to `localhost`. |
+| --port | The port the server is opened on. Defaults to `3000`. |
+| --open-devtools | If set, opens the dev tools in the browser. |
+| --verbose | If set, prints out more information when running the server. |
+| --printServerLog | If set, prints the server access log. |
 | folderPath |  A local folder to open VS Code on. The folder content will be available as a virtual file system and opened as workspace. |
 
 Corresponding options are available in the API.

package/out/index.d.ts

@@ -1,6 +1,10 @@
 #!/usr/bin/env node
 export declare type BrowserType = 'chromium' | 'firefox' | 'webkit' | 'none';
 export declare type VSCodeQuality = 'insiders' | 'stable';
+export declare type GalleryExtension = {
+    readonly id: string;
+    readonly preRelease?: boolean;
+};
 export interface Options {
     /**
      * Browser to open: 'chromium' | 'firefox' | 'webkit' | 'none'.
@@ -47,9 +51,13 @@ export interface Options {
      */
     headless?: boolean;
     /**
-     * Do not show the server log. Defaults to `true` if a extensionTestsPath is provided, `false` otherwise.
+     * @deprecated. Use `printServerLog` instead.
      */
     hideServerLog?: boolean;
+    /**
+     * If set, the server access log is printed to the console. Defaults to `false`.
+     */
+    printServerLog?: boolean;
     /**
      * Expose browser debugging on this port number, and wait for the debugger to attach before running tests.
      */
@@ -75,6 +83,10 @@ export interface Options {
      * Absolute paths pointing to built-in extensions to include.
      */
     extensionPaths?: string[];
+    /**
+     * List of extensions to include. The id format is ${publisher}.${name}.
+     */
+    extensionIds?: GalleryExtension[];
     /**
      * Absolute path pointing to VS Code sources to use.
      */

package/out/index.js

@@ -25,8 +25,9 @@ async function runTests(options) {
         build: await getBuild(options),
         folderUri: options.folderUri,
         folderMountPath: options.folderPath,
-        hideServerLog: (_a = options.hideServerLog) !== null && _a !== void 0 ? _a : true,
-        extensionPaths: options.extensionPaths
+        printServerLog: (_a = options.printServerLog) !== null && _a !== void 0 ? _a : options.hideServerLog === false,
+        extensionPaths: options.extensionPaths,
+        extensionIds: options.extensionIds
     };
     const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
     const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
@@ -81,8 +82,9 @@ async function open(options) {
         build: await getBuild(options),
         folderUri: options.folderUri,
         folderMountPath: options.folderPath,
-        hideServerLog: (_a = options.hideServerLog) !== null && _a !== void 0 ? _a : true,
-        extensionPaths: options.extensionPaths
+        printServerLog: (_a = options.printServerLog) !== null && _a !== void 0 ? _a : options.hideServerLog === false,
+        extensionPaths: options.extensionPaths,
+        extensionIds: options.extensionIds
     };
     const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
     const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
@@ -99,8 +101,6 @@ async function open(options) {
     };
 }
 exports.open = open;
-const width = 1200;
-const height = 800;
 async function openBrowser(endpoint, options) {
     var _a, _b;
     if (options.browserType === 'none') {
@@ -120,7 +120,7 @@ async function openBrowser(endpoint, options) {
     }
     const headless = (_a = options.headless) !== null && _a !== void 0 ? _a : options.extensionTestsPath !== undefined;
     const browser = await browserType.launch({ headless, args, devtools: options.devTools });
-    const context = await browser.newContext();
+    const context = await browser.newContext({ viewport: null });
     if (options.permissions) {
         context.grantPermissions(options.permissions);
     }
@@ -144,7 +144,6 @@ async function openBrowser(endpoint, options) {
             console.log(message.text());
         });
     }
-    await page.setViewportSize({ width, height });
     await page.goto(endpoint);
     return context;
 }
@@ -170,14 +169,29 @@ function validateBooleanOrUndefined(options, name) {
     showHelp();
     process.exit(-1);
 }
-function valdiateBrowserType(browserType) {
+function validatePrintServerLog(options) {
+    const printServerLog = validateBooleanOrUndefined(options, 'printServerLog');
+    if (printServerLog !== undefined) {
+        return printServerLog;
+    }
+    const hideServerLog = validateBooleanOrUndefined(options, 'hideServerLog');
+    if (hideServerLog !== undefined) {
+        return !hideServerLog;
+    }
+    return false;
+}
+function valdiateBrowserType(options) {
+    const browserType = options.browser || options.browserType;
     if (browserType === undefined) {
         return 'chromium';
     }
+    if (options.browserType && options.browser) {
+        console.log(`Ignoring browserType option '${options.browserType}' as browser option '${options.browser}' is set.`);
+    }
     if ((typeof browserType === 'string') && ['chromium', 'firefox', 'webkit', 'none'].includes(browserType)) {
         return browserType;
     }
-    console.log(`Invalid browser type.`);
+    console.log(`Invalid browser option ${browserType}.`);
     showHelp();
     process.exit(-1);
 }
@@ -221,6 +235,39 @@ async function valdiateExtensionPaths(extensionPaths) {
     showHelp();
     process.exit(-1);
 }
+const EXTENSION_IDENTIFIER_PATTERN = /^([a-z0-9A-Z][a-z0-9-A-Z]*\.[a-z0-9A-Z][a-z0-9-A-Z]*)(@prerelease)?$/;
+async function valdiateExtensionIds(extensionIds) {
+    if (extensionIds === undefined) {
+        return undefined;
+    }
+    if (!Array.isArray(extensionIds)) {
+        extensionIds = [extensionIds];
+    }
+    if (Array.isArray(extensionIds)) {
+        const res = [];
+        for (const extensionId of extensionIds) {
+            const m = (typeof extensionId === 'string' && extensionId.match(EXTENSION_IDENTIFIER_PATTERN));
+            if (m) {
+                if (m[2]) {
+                    res.push({ id: m[1], preRelease: true });
+                }
+                else {
+                    res.push({ id: m[1] });
+                }
+            }
+            else {
+                console.log(`Invalid extension id: ${extensionId}. Format is publisher.name[@prerelease].`);
+                break;
+            }
+        }
+        return res;
+    }
+    else {
+        console.log(`Invalid extensionId`);
+    }
+    showHelp();
+    process.exit(-1);
+}
 async function validatePath(loc, isFile) {
     loc = path.resolve(loc);
     if (isFile) {
@@ -269,21 +316,22 @@ function validatePortNumber(port) {
 }
 function showHelp() {
     console.log('Usage:');
-    console.log(`  --browserType 'chromium' | 'firefox' | 'webkit' | 'none': The browser to launch. [Optional, defaults to 'chromium']`);
+    console.log(`  --browser 'chromium' | 'firefox' | 'webkit' | 'none': The browser to launch. [Optional, defaults to 'chromium']`);
     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(`  --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(`  --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]`);
-    console.log(`  --permission: Permission granted in the opened browser: e.g. 'clipboard-read', 'clipboard-write':  [Optional, Multiple]`);
-    console.log(`  --folder-uri: workspace to open VS Code on. Ignored when folderPath is provided [Optional]`);
+    console.log(`  --permission: Permission granted in the opened browser: e.g. 'clipboard-read', 'clipboard-write'. [Optional, Multiple]`);
+    console.log(`  --folder-uri: workspace to open VS Code on. Ignored when folderPath is provided. [Optional]`);
     console.log(`  --extensionPath: A path pointing to a folder containing additional extensions to include [Optional, Multiple]`);
-    console.log(`  --host: The host name the server is opened on  [Optional, defaults to localhost]`);
-    console.log(`  --port: The port the server is opened on  [Optional, defaults to 3000]`);
-    console.log(`  --open-devtools: If set, opens the dev tools  [Optional]`);
-    console.log(`  --verbose: If set, prints out more information when running the server  [Optional]`);
-    console.log(`  --hideServerLog: Whether to hide the server log. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]`);
+    console.log(`  --extensionId: The id of an extension include. The format is '\${publisher}.\${name}'. Append '@prerelease' to use a prerelease version [Optional, Multiple]`);
+    console.log(`  --host: The host name the server is opened on. [Optional, defaults to localhost]`);
+    console.log(`  --port: The port the server is opened on. [Optional, defaults to 3000]`);
+    console.log(`  --open-devtools: If set, opens the dev tools. [Optional]`);
+    console.log(`  --verbose: If set, prints out more information when running the server. [Optional]`);
+    console.log(`  --printServerLog: If set, prints the server access log. [Optional]`);
     console.log(`  folderPath. A local folder to open VS Code on. The folder content will be available as a virtual file system. [Optional]`);
 }
 async function cliMain() {
@@ -291,8 +339,8 @@ async function cliMain() {
     const manifest = require('../package.json');
     console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
-        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'sourcesPath', 'host', 'port'],
-        boolean: ['open-devtools', 'headless', 'hideServerLog', 'help', 'verbose'],
+        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port'],
+        boolean: ['open-devtools', 'headless', 'hideServerLog', 'printServerLog', 'help', 'verbose'],
         unknown: arg => {
             if (arg.startsWith('-')) {
                 console.log(`Unknown argument ${arg}`);
@@ -307,16 +355,17 @@ async function cliMain() {
         showHelp();
         process.exit();
     }
-    const browserType = valdiateBrowserType(args.browserType);
+    const browserType = valdiateBrowserType(args);
     const extensionTestsPath = await validatePathOrUndefined(args, 'extensionTestsPath', true);
     const extensionDevelopmentPath = await validatePathOrUndefined(args, 'extensionDevelopmentPath');
     const extensionPaths = await valdiateExtensionPaths(args.extensionPath);
+    const extensionIds = await valdiateExtensionIds(args.extensionId);
     const vsCodeDevPath = await validatePathOrUndefined(args, 'sourcesPath');
     const quality = validateQuality(args.quality, args.version, vsCodeDevPath);
     const devTools = validateBooleanOrUndefined(args, 'open-devtools');
     const headless = validateBooleanOrUndefined(args, 'headless');
     const permissions = valdiatePermissions(args.permission);
-    const hideServerLog = validateBooleanOrUndefined(args, 'hideServerLog');
+    const printServerLog = validatePrintServerLog(args);
     const verbose = validateBooleanOrUndefined(args, 'verbose');
     const port = validatePortNumber(args.port);
     const host = validateStringOrUndefined(args, 'host');
@@ -345,9 +394,10 @@ async function cliMain() {
             folderUri,
             folderPath,
             headless,
-            hideServerLog,
+            printServerLog: printServerLog,
             permissions,
             extensionPaths,
+            extensionIds,
             vsCodeDevPath,
             verbose,
             host,
@@ -367,9 +417,10 @@ async function cliMain() {
             folderUri,
             folderPath,
             headless,
-            hideServerLog,
+            printServerLog: printServerLog,
             permissions,
             extensionPaths,
+            extensionIds,
             vsCodeDevPath,
             verbose,
             host,

package/out/server/app.js

@@ -14,7 +14,7 @@ const mounts_1 = require("./mounts");
 const extensions_1 = require("./extensions");
 async function createApp(config) {
     const app = new Koa();
-    if (!config.hideServerLog) {
+    if (config.printServerLog) {
         app.use(morgan('dev'));
     }
     // this is here such that the iframe worker can fetch the extension files
@@ -31,6 +31,7 @@ async function createApp(config) {
         app.use(kmount('/static/build', kstatic(config.build.location, serveOptions)));
     }
     else if (config.build.type === 'sources') {
+        console.log('Serving VS Code sources from ' + config.build.location);
         app.use(kmount('/static/sources', kstatic(config.build.location, serveOptions)));
         app.use(kmount('/static/sources', kstatic((0, path_1.join)(config.build.location, 'resources', 'server'), serveOptions))); // for manifest.json, favicon and code icons.
         // built-in extension are at 'extensions` as well as prebuilt extensions dowloaded from the marketplace

package/out/server/extensions.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getScannedBuiltinExtensions = exports.prebuiltExtensionsLocation = exports.scanForExtensions = void 0;
 const fs_1 = require("fs");
 const path = require("path");
+const download_1 = require("./download");
 async function scanForExtensions(rootPath, serverURI) {
     const result = [];
     async function getExtension(relativePosixFolderPath) {
@@ -47,7 +48,20 @@ exports.prebuiltExtensionsLocation = '.build/builtInExtensions';
 async function getScannedBuiltinExtensions(vsCodeDevLocation) {
     // use the build utility as to not duplicate the code
     const extensionsUtil = await Promise.resolve().then(() => require(path.join(vsCodeDevLocation, 'build', 'lib', 'extensions.js')));
-    return extensionsUtil.scanBuiltinExtensions(path.join(vsCodeDevLocation, 'extensions'))
-        .concat(extensionsUtil.scanBuiltinExtensions(path.join(vsCodeDevLocation, exports.prebuiltExtensionsLocation)));
+    const localExtensions = extensionsUtil.scanBuiltinExtensions(path.join(vsCodeDevLocation, 'extensions'));
+    const prebuiltExtensions = extensionsUtil.scanBuiltinExtensions(path.join(vsCodeDevLocation, 'prebuiltExtensionsLocation'));
+    for (const ext of localExtensions) {
+        let browserMain = ext.packageJSON.browser;
+        if (browserMain) {
+            if (!browserMain.endsWith('.js')) {
+                browserMain = browserMain + '.js';
+            }
+            const browserMainLocation = path.join(vsCodeDevLocation, 'extensions', ext.extensionPath, browserMain);
+            if (!await (0, download_1.fileExists)(browserMainLocation)) {
+                console.log(`${browserMainLocation} not found. Make sure all extensions are compiled (use 'yarn watch-web').`);
+            }
+        }
+    }
+    return localExtensions.concat(prebuiltExtensions);
 }
 exports.getScannedBuiltinExtensions = getScannedBuiltinExtensions;

package/out/server/workbench.js

@@ -39,8 +39,8 @@ class Workbench {
     getMain() {
         return this.dev
             ? `<script> require(['vs/code/browser/workbench/workbench'], function() {}); </script>`
-            : `<script src="${this.baseUrl}/out/vs/workbench/workbench.web.api.nls.js"></script>`
-                + `<script src="${this.baseUrl}/out/vs/workbench/workbench.web.api.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>`;
     }
     async renderCallback() {
@@ -58,6 +58,12 @@ async function getWorkbenchOptions(ctx, config) {
             });
         }));
     }
+    if (config.extensionIds) {
+        if (!options.additionalBuiltinExtensions) {
+            options.additionalBuiltinExtensions = [];
+        }
+        options.additionalBuiltinExtensions.push(...config.extensionIds);
+    }
     if (config.extensionDevelopmentPath) {
         const developmentOptions = options.developmentOptions = {};
         developmentOptions.extensions = await (0, extensions_1.scanForExtensions)(config.extensionDevelopmentPath, { scheme: ctx.protocol, authority: ctx.host, path: '/static/devextensions' });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.18",
+  "version": "0.0.22",
   "scripts": {
     "install-extensions": "yarn --cwd=fs-provider && yarn --cwd=sample",
     "compile": "tsc -p ./ && yarn compile-fs-provider",
@@ -11,8 +11,8 @@
     "postversion": "git push && git push --tags",
     "compile-fs-provider": "yarn --cwd=fs-provider compile-web",
     "compile-sample": "yarn --cwd=sample compile-web",
-    "sample": "npm run compile && npm run compile-sample && node . --extensionDevelopmentPath=sample --verbose sample/test-workspace",
-    "sample-tests": "npm run compile &&  npm run compile-sample && node . --extensionDevelopmentPath=sample --extensionTestsPath=sample/dist/web/test/suite/index.js --headless=false sample/test-workspace"
+    "sample": "npm run compile && npm run compile-sample && node . --extensionDevelopmentPath=sample sample/test-workspace",
+    "sample-tests": "npm run compile && npm run compile-sample && node . --extensionDevelopmentPath=sample --extensionTestsPath=sample/dist/web/test/suite/index.js --headless=false sample/test-workspace"
   },
   "main": "./out/index.js",
   "bin": {
@@ -23,14 +23,14 @@
   },
   "dependencies": {
     "@koa/router": "^10.1.1",
-    "koa": "^2.13.1",
+    "koa": "^2.13.4",
     "koa-morgan": "^1.0.1",
     "koa-mount": "^4.0.0",
     "koa-static": "^5.0.0",
     "minimist": "^1.2.5",
-    "playwright": "1.14.1",
-    "vscode-uri": "^3.0.2",
-    "http-proxy-agent": "^4.0.1",
+    "playwright": "^1.18.1",
+    "vscode-uri": "^3.0.3",
+    "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.0",
     "decompress": "^4.2.1",
     "decompress-targz": "^4.1.1"
@@ -40,23 +40,23 @@
     "@types/koa-morgan": "^1.0.5",
     "@types/koa-mount": "^4.0.1",
     "@types/koa-static": "^4.0.2",
-    "@types/koa__router": "^8.0.8",
+    "@types/koa__router": "^8.0.11",
     "@types/minimist": "^1.2.2",
     "@types/node": "^12.19.9",
-    "@typescript-eslint/eslint-plugin": "^4.31.1",
-    "@typescript-eslint/parser": "^4.31.1",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
     "@types/decompress": "^4.2.4",
-    "eslint": "^7.32.0",
+    "eslint": "^8.8.0",
     "eslint-plugin-header": "^3.1.1",
-    "typescript": "^4.4.3"
+    "typescript": "^4.5.5"
   },
   "license": "MIT",
   "author": "Visual Studio Code Team",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Microsoft/vscode-test-web.git"
+    "url": "https://github.com/microsoft/vscode-test-web.git"
   },
   "bugs": {
-    "url": "https://github.com/Microsoft/vscode-test-web/issues"
+    "url": "https://github.com/microsoft/vscode-test-web/issues"
   }
 }

package/views/workbench.html

@@ -28,7 +28,7 @@
 		<!-- Workbench Icon/Manifest/CSS -->
 		<link rel="icon" href="{{WORKBENCH_WEB_BASE_URL}}/favicon.ico" type="image/x-icon" />
 		<link rel="manifest" href="{{WORKBENCH_WEB_BASE_URL}}/manifest.json">
-		<link data-name="vs/workbench/workbench.web.api" rel="stylesheet" href="{{WORKBENCH_WEB_BASE_URL}}/out/vs/workbench/workbench.web.api.css" />
+		<link data-name="vs/workbench/workbench.web.main" rel="stylesheet" href="{{WORKBENCH_WEB_BASE_URL}}/out/vs/workbench/workbench.web.main.css" />
 	</head>
 
 	<body aria-label="">