@vscode/test-web 0.0.48 → 0.0.49

package/README.md

@@ -31,12 +31,20 @@ vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLoca
 
 Open VS Code in the Browser on a folder with test data from the local disk:
 
-```
+```sh
 vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLocation $testDataLocation
 ```
 
 VS Code for the Web will open on a virtual workspace (scheme `vscode-test-web`), backed by a file system provider that gets the file/folder data from the local disk. Changes to the file system are kept in memory and are not written back to disk.
 
+Open VS Code in the Browser with external network access:
+
+```sh
+vscode-test-web --browserType=chromium --browserOption=--disable-web-security extensionDevelopmentPath=$extensionLocation
+```
+
+This allows the extension being tested to make network requests to external hosts.
+
 Via API:
 
 ```ts
@@ -68,6 +76,7 @@ CLI options:
 |Option|Argument Description|
 |-----|-----|
 | --browser | The browser to launch: `chromium` (default), `firefox`, `webkit` or `none`. |
+| --browserOption | Command line argument to use when launching the browser instance. Argument can be provided multiple times. |
 | --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. |

package/out/index.d.ts

@@ -10,6 +10,10 @@ export interface Options {
      * Browser to open: 'chromium' | 'firefox' | 'webkit' | 'none'.
      */
     browserType: BrowserType;
+    /**
+     * Browser command line options.
+     */
+    browserOptions?: string[];
     /**
      * Absolute path to folder that contains one or more extensions (in subfolders).
      * Extension folders include a `package.json` extension manifest.

package/out/index.js

@@ -120,6 +120,9 @@ async function openBrowser(endpoint, options, configPage) {
         return undefined;
     }
     const args = [];
+    if (options.browserOptions) {
+        args.push(...options.browserOptions);
+    }
     if (process.platform === 'linux' && options.browserType === 'chromium') {
         args.push('--no-sandbox');
     }
@@ -219,7 +222,24 @@ function validatePermissions(permissions) {
     if (Array.isArray(permissions) && permissions.every(isValidPermission)) {
         return permissions;
     }
-    console.log(`Invalid permission`);
+    console.log(`Invalid permission: ${permissions}`);
+    showHelp();
+    process.exit(-1);
+}
+function validateBrowserOptions(browserOptions) {
+    if (browserOptions === undefined) {
+        return undefined;
+    }
+    function isValidOption(p) {
+        return typeof p === 'string';
+    }
+    if (isValidOption(browserOptions)) {
+        return [browserOptions];
+    }
+    if (Array.isArray(browserOptions) && browserOptions.every(isValidOption)) {
+        return browserOptions;
+    }
+    console.log(`Invalid browser option: ${browserOptions}`);
     showHelp();
     process.exit(-1);
 }
@@ -328,6 +348,7 @@ function validatePortNumber(port) {
 function showHelp() {
     console.log('Usage:');
     console.log(`  --browser 'chromium' | 'firefox' | 'webkit' | 'none': The browser to launch. [Optional, defaults to 'chromium']`);
+    console.log(`  --browserOption option: Command line argument to use when launching the browser instance. [Optional, Multiple]`);
     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]`);
@@ -359,7 +380,7 @@ async function cliMain() {
     const manifest = require('../package.json');
     console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
-        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port', 'testRunnerDataDir'],
+        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserOption', 'browserType', 'quality', 'version', '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('-')) {
@@ -375,6 +396,7 @@ async function cliMain() {
         showHelp();
         process.exit();
     }
+    const browserOptions = validateBrowserOptions(args.browserOption);
     const browserType = validateBrowserType(args);
     const extensionTestsPath = await validatePathOrUndefined(args, 'extensionTestsPath', true);
     const extensionDevelopmentPath = await validatePathOrUndefined(args, 'extensionDevelopmentPath');
@@ -410,6 +432,7 @@ async function cliMain() {
         runTests({
             extensionTestsPath,
             extensionDevelopmentPath,
+            browserOptions,
             browserType,
             quality,
             devTools,
@@ -436,6 +459,7 @@ async function cliMain() {
     else {
         open({
             extensionDevelopmentPath,
+            browserOptions,
             browserType,
             quality,
             devTools,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.48",
+  "version": "0.0.49",
   "scripts": {
     "install-extensions": "npm i --prefix=fs-provider && npm i --prefix=sample",
     "compile": "tsc -p ./ && npm run compile-fs-provider",
@@ -30,8 +30,8 @@
     "koa-mount": "^4.0.0",
     "koa-static": "^5.0.0",
     "minimist": "^1.2.8",
-    "playwright": "^1.39.0",
-    "@playwright/browser-chromium": "^1.39.0",
+    "playwright": "^1.40.1",
+    "@playwright/browser-chromium": "^1.40.1",
     "vscode-uri": "^3.0.8",
     "http-proxy-agent": "^7.0.0",
     "https-proxy-agent": "^7.0.2",
@@ -39,20 +39,20 @@
     "gunzip-maybe": "^1.4.2"
   },
   "devDependencies": {
-    "@types/koa": "^2.13.10",
-    "@types/koa-morgan": "^1.0.7",
-    "@types/koa-mount": "^4.0.4",
-    "@types/koa-static": "^4.0.3",
-    "@types/koa__router": "^12.0.3",
-    "@types/minimist": "^1.2.4",
-    "@types/node": "^20.8.9",
-    "@types/gunzip-maybe": "^1.4.1",
-    "@types/tar-fs": "^2.0.3",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
-    "eslint": "^8.52.0",
+    "@types/koa": "^2.13.12",
+    "@types/koa-morgan": "^1.0.8",
+    "@types/koa-mount": "^4.0.5",
+    "@types/koa-static": "^4.0.4",
+    "@types/koa__router": "^12.0.4",
+    "@types/minimist": "^1.2.5",
+    "@types/node": "^20.10.1",
+    "@types/gunzip-maybe": "^1.4.2",
+    "@types/tar-fs": "^2.0.4",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
+    "eslint": "^8.54.0",
     "eslint-plugin-header": "^3.1.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "license": "MIT",
   "author": "Visual Studio Code Team",
@@ -63,4 +63,4 @@
   "bugs": {
     "url": "https://github.com/microsoft/vscode-test-web/issues"
   }
-}
+}