@vscode/test-web 0.0.26 → 0.0.29

package/CHANGELOG.md

@@ -1,12 +1,13 @@
 # Changelog
-
+## 0.0.28
+ * new option `--coi` to enable cross origin isolation.
 
 ## 0.0.22
- * new option `--printServerLog` replacing `--hideServerLog`
- * new option `--browser` replacing `--browserType`
+ * 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
+ * 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.
@@ -17,7 +18,7 @@
 
 ## 0.0.16
  * new option `--sourcesPath`: If provided, runs the server from VS Code sources at the given location.
- * option `--version` is deprecated and replaced with `quality`. Supported values: `stable`, `insiders`. Instead of `sources` use `--insiders`
+ * option `--version` is deprecated and replaced with `quality`. Supported values: `stable`, `insiders`. Instead of `sources` use `--insiders`.
 
 ## 0.0.14
  * new option `--extensionPath` : A path pointing to a folder containing additional extensions to include. Argument can be provided multiple times.

package/README.md

@@ -74,6 +74,7 @@ CLI options:
 | --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. |
+| --coi | If set, enables cross origin isolation. Defaults to false. |
 | --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. |
 | --extensionId | The id of an extension include. The format is `${publisher}.${name}`. Append `@prerelease` to use the prerelease version. |

package/out/index.d.ts

@@ -50,6 +50,10 @@ export interface Options {
      * Do not show the browser. Defaults to `true` if a `extensionTestsPath` is provided, `false` otherwise.
      */
     headless?: boolean;
+    /**
+     * If set, opens the page with cross origin isolation enabled.
+     */
+    coi?: boolean;
     /**
      * @deprecated. Use `printServerLog` instead.
      */

package/out/index.js

@@ -27,7 +27,8 @@ async function runTests(options) {
         folderMountPath: options.folderPath,
         printServerLog: (_a = options.printServerLog) !== null && _a !== void 0 ? _a : options.hideServerLog === false,
         extensionPaths: options.extensionPaths,
-        extensionIds: options.extensionIds
+        extensionIds: options.extensionIds,
+        coi: !!options.coi
     };
     const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
     const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
@@ -84,7 +85,8 @@ async function open(options) {
         folderMountPath: options.folderPath,
         printServerLog: (_a = options.printServerLog) !== null && _a !== void 0 ? _a : options.hideServerLog === false,
         extensionPaths: options.extensionPaths,
-        extensionIds: options.extensionIds
+        extensionIds: options.extensionIds,
+        coi: !!options.coi
     };
     const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
     const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
@@ -180,7 +182,7 @@ function validatePrintServerLog(options) {
     }
     return false;
 }
-function valdiateBrowserType(options) {
+function validateBrowserType(options) {
     const browserType = options.browser || options.browserType;
     if (browserType === undefined) {
         return 'chromium';
@@ -195,7 +197,7 @@ function valdiateBrowserType(options) {
     showHelp();
     process.exit(-1);
 }
-function valdiatePermissions(permissions) {
+function validatePermissions(permissions) {
     if (permissions === undefined) {
         return undefined;
     }
@@ -212,7 +214,7 @@ function valdiatePermissions(permissions) {
     showHelp();
     process.exit(-1);
 }
-async function valdiateExtensionPaths(extensionPaths) {
+async function validateExtensionPaths(extensionPaths) {
     if (extensionPaths === undefined) {
         return undefined;
     }
@@ -236,7 +238,7 @@ async function valdiateExtensionPaths(extensionPaths) {
     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) {
+async function validateExtensionIds(extensionIds) {
     if (extensionIds === undefined) {
         return undefined;
     }
@@ -324,6 +326,7 @@ function showHelp() {
     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(`  --coi: Enables cross origin isolation [Optional]`);
     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(`  --extensionId: The id of an extension include. The format is '\${publisher}.\${name}'. Append '@prerelease' to use a prerelease version [Optional, Multiple]`);
@@ -340,7 +343,7 @@ async function cliMain() {
     console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
         string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port'],
-        boolean: ['open-devtools', 'headless', 'hideServerLog', 'printServerLog', 'help', 'verbose'],
+        boolean: ['open-devtools', 'headless', 'hideServerLog', 'printServerLog', 'help', 'verbose', 'coi'],
         unknown: arg => {
             if (arg.startsWith('-')) {
                 console.log(`Unknown argument ${arg}`);
@@ -355,20 +358,21 @@ async function cliMain() {
         showHelp();
         process.exit();
     }
-    const browserType = valdiateBrowserType(args);
+    const browserType = validateBrowserType(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 extensionPaths = await validateExtensionPaths(args.extensionPath);
+    const extensionIds = await validateExtensionIds(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 permissions = validatePermissions(args.permission);
     const printServerLog = validatePrintServerLog(args);
     const verbose = validateBooleanOrUndefined(args, 'verbose');
     const port = validatePortNumber(args.port);
     const host = validateStringOrUndefined(args, 'host');
+    const coi = validateBooleanOrUndefined(args, 'coi');
     const waitForDebugger = validatePortNumber(args.waitForDebugger);
     let folderUri = validateStringOrUndefined(args, 'folder-uri');
     let folderPath;
@@ -400,6 +404,7 @@ async function cliMain() {
             extensionIds,
             vsCodeDevPath,
             verbose,
+            coi,
             host,
             port
         }).catch(e => {
@@ -423,6 +428,7 @@ async function cliMain() {
             extensionIds,
             vsCodeDevPath,
             verbose,
+            coi,
             host,
             port
         });

package/out/server/app.js

@@ -4,11 +4,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
 const Koa = require("koa");
 const morgan = require("koa-morgan");
 const kstatic = require("koa-static");
 const kmount = require("koa-mount");
 const cors = require("@koa/cors");
+const getstream = require("get-stream");
 const path_1 = require("path");
 const workbench_1 = require("./workbench");
 const mounts_1 = require("./mounts");
@@ -21,17 +23,43 @@ async function createApp(config) {
         allowMethods: ['GET'],
         credentials: true,
         origin: (ctx) => {
-            if (/^https:\/\/[^.]+\.vscode-webview\.net$/.test(ctx.get('Origin'))) {
+            if (/^https:\/\/[^.]+\.vscode-cdn\.net$/.test(ctx.get('Origin')) || // needed for the webviewContent
+                /^https:\/\/[^.]+\.vscode-webview\.net$/.test(ctx.get('Origin'))) {
                 return ctx.get('Origin');
             }
             return undefined;
         },
     }));
-    // this is here such that the iframe worker can fetch the extension files
+    if (config.build.type !== 'sources') {
+        // CSP: frame-ancestors
+        app.use((ctx, next) => {
+            ctx.set('Content-Security-Policy', `frame-ancestors 'none'`);
+            return next();
+        });
+    }
+    // COI
     app.use((ctx, next) => {
-        ctx.set('Access-Control-Allow-Origin', '*');
+        const value = ctx.query['vscode-coi'];
+        if (value === '1') {
+            ctx.set('Cross-Origin-Opener-Policy', 'same-origin');
+        }
+        else if (value === '2') {
+            ctx.set('Cross-Origin-Embedder-Policy', 'require-corp');
+        }
+        else if (value === '3' || value === '') {
+            ctx.set('Cross-Origin-Opener-Policy', 'same-origin');
+            ctx.set('Cross-Origin-Embedder-Policy', 'require-corp');
+        }
         return next();
     });
+    // shift the line numbers of source maps in extensions by 2 as the content is wrapped by an anonymous function
+    app.use(async (ctx, next) => {
+        await next();
+        if (ctx.status === 200 && ctx.path.match(/\/(dev)?extensions\/.*\.js\.map$/) && ctx.body instanceof fs_1.ReadStream) {
+            // we know it's a ReadStream as that's what kstatic uses
+            ctx.response.body = `{"version":3,"file":"${(0, path_1.basename)(ctx.path)}","sections":[{"offset":{"line":2,"column":0},"map":${await getstream(ctx.body)} }]}`;
+        }
+    });
     const serveOptions = { hidden: true };
     if (config.extensionDevelopmentPath) {
         console.log('Serving dev extensions from ' + config.extensionDevelopmentPath);

package/out/server/workbench.js

@@ -117,6 +117,10 @@ function default_1(config) {
     router.get('/', async (ctx) => {
         const options = await getWorkbenchOptions(ctx, config);
         ctx.body = await ctx.state.workbench.render(options);
+        if (config.coi) {
+            ctx.set('Cross-Origin-Opener-Policy', 'same-origin');
+            ctx.set('Cross-Origin-Embedder-Policy', 'require-corp');
+        }
     });
     return router.routes();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.26",
+  "version": "0.0.29",
   "scripts": {
     "install-extensions": "yarn --cwd=fs-provider && yarn --cwd=sample",
     "compile": "tsc -p ./ && yarn compile-fs-provider",
@@ -35,7 +35,8 @@
     "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.1",
     "decompress": "^4.2.1",
-    "decompress-targz": "^4.1.1"
+    "decompress-targz": "^4.1.1",
+    "get-stream": "6.0.1"
   },
   "devDependencies": {
     "@types/koa": "^2.13.4",