api: export all browsers from every package (#3128)

This makes it easier to reason about our packages.
The only difference is what each package downloads.
When the browser is not downloaded, it will fail to launch.

Each browser gets a 'download' attribute in the browser.json file.

Author: dgozman

browsers.json

@@ -3,15 +3,18 @@
   "browsers": [
     {
       "name": "chromium",
-      "revision": "791201"
+      "revision": "791201",
+      "download": true
     },
     {
       "name": "firefox",
-      "revision": "1140"
+      "revision": "1140",
+      "download": true
     },
     {
       "name": "webkit",
-      "revision": "1317"
+      "revision": "1317",
+      "download": true
     }
   ]
 }

packages/.gitignore

@@ -0,0 +1 @@
+output

packages/build_package.js

@@ -64,8 +64,6 @@ const PACKAGES = {
   },
 };
 
-const cleanupPaths = [];
-
 // 1. Parse CLI arguments
 const args = process.argv.slice(2);
 if (args.some(arg => arg === '--help')) {
@@ -81,10 +79,19 @@ if (args.some(arg => arg === '--help')) {
   process.exit(1);
 }
 
+const packageName = args[0];
+const outputPath = path.resolve(args[1]);
+const packagePath = path.join(__dirname, 'output', packageName);
+const package = PACKAGES[packageName];
+if (!package) {
+  console.log(`ERROR: unknown package ${packageName}`);
+  process.exit(1);
+}
+
 // 2. Setup cleanup if needed
 if (!args.some(arg => arg === '--no-cleanup')) {
   process.on('exit', () => {
-    cleanupPaths.forEach(cleanupPath => rmSync(cleanupPath, {}));
+    rmSync(packagePath, {});
   });
   process.on('SIGINT', () => process.exit(2));
   process.on('SIGHUP', () => process.exit(3));
@@ -99,19 +106,17 @@ if (!args.some(arg => arg === '--no-cleanup')) {
   });
 }
 
-const packageName = args[0];
-const outputPath = path.resolve(args[1]);
-const packagePath = path.join(__dirname, packageName);
-const package = PACKAGES[packageName];
-if (!package) {
-  console.log(`ERROR: unknown package ${packageName}`);
-  process.exit(1);
-}
-
 (async () => {
   // 3. Copy package files.
+  rmSync(packagePath, {});
+  fs.mkdirSync(packagePath, { recursive: true });
+  await copyToPackage(path.join(__dirname, 'common') + path.sep, packagePath + path.sep);
+  if (fs.existsSync(path.join(__dirname, packageName))) {
+    // Copy package-specific files, these can overwrite common ones.
+    await copyToPackage(path.join(__dirname, packageName) + path.sep, packagePath + path.sep);
+  }
   for (const file of package.files)
-    await copyToPackage(file);
+    await copyToPackage(path.join(ROOT_PATH, file), path.join(packagePath, file));
 
   // 4. Generate package.json
   const pwInternalJSON = require(path.join(ROOT_PATH, 'package.json'));
@@ -144,7 +149,8 @@ if (!package) {
 
   // 5. Generate browsers.json
   const browsersJSON = require(path.join(ROOT_PATH, 'browsers.json'));
-  browsersJSON.browsers = browsersJSON.browsers.filter(browser => package.browsers.includes(browser.name));
+  for (const browser of browsersJSON.browsers)
+    browser.download = package.browsers.includes(browser.name);
   await writeToPackage('browsers.json', JSON.stringify(browsersJSON, null, 2));
 
   // 6. Run npm pack
@@ -163,15 +169,11 @@ if (!package) {
 
 async function writeToPackage(fileName, content) {
   const toPath = path.join(packagePath, fileName);
-  cleanupPaths.push(toPath);
   console.error(`- generating: //${path.relative(ROOT_PATH, toPath)}`);
   await writeFileAsync(toPath, content);
 }
 
-async function copyToPackage(fileOrDirectoryName) {
-  const fromPath = path.join(ROOT_PATH, fileOrDirectoryName);
-  const toPath = path.join(packagePath, fileOrDirectoryName);
-  cleanupPaths.push(toPath);
+async function copyToPackage(fromPath, toPath) {
   console.error(`- copying: //${path.relative(ROOT_PATH, fromPath)} -> //${path.relative(ROOT_PATH, toPath)}`);
   await cpAsync(fromPath, toPath);
 }

packages/playwright-core/index.d.ts renamed to packages/common/index.d.ts

@@ -17,6 +17,6 @@
 import * as types from './types/types';
 
 export * from './types/types';
-export const webkit: types.BrowserType<types.WebKitBrowser>;
 export const chromium: types.BrowserType<types.ChromiumBrowser>;
 export const firefox: types.BrowserType<types.FirefoxBrowser>;
+export const webkit: types.BrowserType<types.WebKitBrowser>;

packages/playwright-chromium/index.js renamed to packages/common/index.js

@@ -14,28 +14,9 @@
  * limitations under the License.
  */
 
-import { chromium, selectors, devices, errors } from 'playwright-chromium';
+import { chromium, firefox, webkit, selectors, devices, errors } from 'playwright-chromium';
 import playwright from 'playwright-chromium';
 import errorsFile from 'playwright-chromium/lib/errors.js';
 
-if (playwright.chromium !== chromium)
-  process.exit(1);
-
-if (playwright.errors !== errors)
-  process.exit(1);
-if (errors.TimeoutError !== errorsFile.TimeoutError)
-  process.exit(1);
-
-(async () => {
-  for (const browserType of [chromium]) {
-    const browser = await browserType.launch();
-    const context = await browser.newContext();
-    const page = await context.newPage();
-    await page.evaluate(() => navigator.userAgent);
-    await browser.close();
-  }
-  console.log(`esm SUCCESS`);
-})().catch(err => {
-  console.error(err);
-  process.exit(1);
-});
+import testESM from './esm.mjs';
+testESM({ chromium, firefox, webkit, selectors, devices, errors, playwright, errorsFile }, [chromium]);

packages/playwright-core/index.mjs renamed to packages/common/index.mjs

@@ -14,28 +14,9 @@
  * limitations under the License.
  */
 
-import { firefox, selectors, devices, errors } from 'playwright-firefox';
+import { chromium, firefox, webkit, selectors, devices, errors } from 'playwright-firefox';
 import playwright from 'playwright-firefox';
 import errorsFile from 'playwright-firefox/lib/errors.js';
 
-if (playwright.firefox !== firefox)
-  process.exit(1);
-
-if (playwright.errors !== errors)
-  process.exit(1);
-if (errors.TimeoutError !== errorsFile.TimeoutError)
-  process.exit(1);
-
-(async () => {
-  for (const browserType of [firefox]) {
-    const browser = await browserType.launch();
-    const context = await browser.newContext();
-    const page = await context.newPage();
-    await page.evaluate(() => navigator.userAgent);
-    await browser.close();
-  }
-  console.log(`esm SUCCESS`);
-})().catch(err => {
-  console.error(err);
-  process.exit(1);
-});
+import testESM from './esm.mjs';
+testESM({ chromium, firefox, webkit, selectors, devices, errors, playwright, errorsFile }, [firefox]);

packages/playwright-chromium/install.js renamed to packages/common/install.js

@@ -14,28 +14,9 @@
  * limitations under the License.
  */
 
-import { webkit, selectors, devices, errors } from 'playwright-webkit';
+import { chromium, firefox, webkit, selectors, devices, errors } from 'playwright-webkit';
 import playwright from 'playwright-webkit';
 import errorsFile from 'playwright-webkit/lib/errors.js';
 
-if (playwright.webkit !== webkit)
-  process.exit(1);
-
-if (playwright.errors !== errors)
-  process.exit(1);
-if (errors.TimeoutError !== errorsFile.TimeoutError)
-  process.exit(1);
-
-(async () => {
-  for (const browserType of [webkit]) {
-    const browser = await browserType.launch();
-    const context = await browser.newContext();
-    const page = await context.newPage();
-    await page.evaluate(() => navigator.userAgent);
-    await browser.close();
-  }
-  console.log(`esm SUCCESS`);
-})().catch(err => {
-  console.error(err);
-  process.exit(1);
-});
+import testESM from './esm.mjs';
+testESM({ chromium, firefox, webkit, selectors, devices, errors, playwright, errorsFile }, [webkit]);