Bug 1862701 - [remote] Sync to puppeteer version v21.5.2. r=webdriver-reviewers,Sasha

Differential Revision: https://phabricator.services.mozilla.com/D194190

Author: whimboo

.hgignore

@@ -143,7 +143,8 @@ _OPT\.OBJ/
 ^remote/test/puppeteer/test/output-firefox
 ^remote/test/puppeteer/test/output-chromium
 ^remote/test/puppeteer/testserver/lib/
-^remote/test/puppeteer/utils/mochaRunner/lib/
+^remote/test/puppeteer/tools/internal/
+`remote/test/puppeteer/tools/mocha-runner/bin/
 ^remote/test/puppeteer/website
 
 ^third_party/js/PKI.js/node_modules/

remote/.gitignore

@@ -18,4 +18,6 @@ test/puppeteer/src/generated
 test/puppeteer/test/**/build
 test/puppeteer/test/output-firefox
 test/puppeteer/test/output-chromium
+test/puppeteer/tools/internal/
+test/puppeteer/tools/mocha-runner/bin/
 test/puppeteer/website

remote/test/puppeteer/.eslintignore

@@ -5,6 +5,7 @@ node_modules
 # Production
 build/
 lib/
+bin/
 
 # Generated files
 **/*.tsbuildinfo

remote/test/puppeteer/.eslintrc.js

@@ -1,6 +1,25 @@
+const {readdirSync} = require('fs');
+const {join} = require('path');
+
 const rulesDirPlugin = require('eslint-plugin-rulesdir');
+
 rulesDirPlugin.RULES_DIR = 'tools/eslint/lib';
 
+function getThirdPartyPackages() {
+  return readdirSync(join(__dirname, 'packages/puppeteer-core/third_party'), {
+    withFileTypes: true,
+  })
+    .filter(dirent => {
+      return dirent.isDirectory();
+    })
+    .map(({name}) => {
+      return {
+        name,
+        message: `Import \`${name}\` from the vendored location: third_party/${name}/index.js`,
+      };
+    });
+}
+
 module.exports = {
   root: true,
   env: {
@@ -12,7 +31,13 @@ module.exports = {
 
   plugins: ['mocha', '@typescript-eslint', 'import'],
 
-  extends: ['plugin:prettier/recommended'],
+  extends: ['plugin:prettier/recommended', 'plugin:import/typescript'],
+
+  settings: {
+    'import/resolver': {
+      typescript: true,
+    },
+  },
 
   rules: {
     // Brackets keep code readable.
@@ -98,21 +123,6 @@ module.exports = {
     // ensure we don't have any it.only or describe.only in prod
     'mocha/no-exclusive-tests': 'error',
 
-    'no-restricted-imports': [
-      'error',
-      {
-        patterns: ['*Events', '*.test.js'],
-        paths: [
-          {
-            name: 'mitt',
-            message:
-              'Import `mitt` from the vendored location: third_party/mitt/index.js',
-          },
-        ],
-      },
-    ],
-    'import/extensions': ['error', 'ignorePackages'],
-
     'import/order': [
       'error',
       {
@@ -121,6 +131,8 @@ module.exports = {
       },
     ],
 
+    'import/no-cycle': ['error', {maxDepth: Infinity}],
+
     'no-restricted-syntax': [
       'error',
       // Don't allow underscored declarations on camelCased variables/properties.
@@ -145,6 +157,8 @@ module.exports = {
         'rulesdir/prettier-comments': 'error',
         // Enforces clean up of used resources.
         'rulesdir/use-using': 'error',
+        // Enforces consistent file extension
+        'rulesdir/extensions': 'error',
         // Brackets keep code readable.
         curly: ['error', 'all'],
         // Brackets keep code readable and `return` intentions clear.
@@ -156,7 +170,7 @@ module.exports = {
         'no-unused-vars': 'off',
         '@typescript-eslint/no-unused-vars': [
           'error',
-          {argsIgnorePattern: '^_'},
+          {argsIgnorePattern: '^_', varsIgnorePattern: '^_'},
         ],
         'func-call-spacing': 'off',
         '@typescript-eslint/func-call-spacing': 'error',
@@ -220,12 +234,30 @@ module.exports = {
         '@typescript-eslint/prefer-ts-expect-error': 'error',
         // This is more performant; see https://v8.dev/blog/fast-async.
         '@typescript-eslint/return-await': ['error', 'always'],
+        // This optimizes the dependency tracking for type-only files.
+        '@typescript-eslint/consistent-type-imports': 'error',
+        // So type-only exports get elided.
+        '@typescript-eslint/consistent-type-exports': 'error',
+        // Don't want to trigger unintended side-effects.
+        '@typescript-eslint/no-import-type-side-effects': 'error',
       },
       overrides: [
+        {
+          files: 'packages/puppeteer-core/src/**/*.ts',
+          rules: {
+            'no-restricted-imports': [
+              'error',
+              {
+                patterns: ['*Events', '*.test.js'],
+                paths: [...getThirdPartyPackages()],
+              },
+            ],
+          },
+        },
         {
           files: [
             'packages/puppeteer-core/src/**/*.test.ts',
-            'tools/mochaRunner/src/test.ts',
+            'tools/mocha-runner/src/test.ts',
           ],
           rules: {
             // With the Node.js test runner, `describe` and `it` are technically

remote/test/puppeteer/.mocharc.cjs

@@ -22,10 +22,14 @@ module.exports = {
   reporter: 'dot',
   logLevel: 'debug',
   require: ['./test/build/mocha-utils.js', 'source-map-support/register'],
-  spec: 'test/build/**/*.spec.js',
   exit: !!process.env.CI,
   retries: process.env.CI ? 3 : 0,
   parallel: !!process.env.PARALLEL,
   timeout: timeout,
   reporter: process.env.CI ? 'spec' : 'dot',
+  // This should make mocha crash on uncaught errors.
+  // See https://github.com/mochajs/mocha/blob/master/docs/index.md#--allow-uncaught.
+  allowUncaught: true,
+  // See https://github.com/mochajs/mocha/blob/master/docs/index.md#--async-only--a.
+  asyncOnly: true,
 };

remote/test/puppeteer/.prettierignore

@@ -5,6 +5,7 @@ node_modules
 # Production
 build/
 lib/
+bin/
 
 # Generated files
 **/*.tsbuildinfo

remote/test/puppeteer/.release-please-manifest.json

@@ -1,7 +1,7 @@
 {
-  "packages/puppeteer": "21.2.0",
-  "packages/puppeteer-core": "21.2.0",
+  "packages/puppeteer": "21.5.2",
+  "packages/puppeteer-core": "21.5.2",
   "packages/testserver": "0.6.0",
-  "packages/ng-schematics": "0.5.0",
-  "packages/browsers": "1.7.0"
+  "packages/ng-schematics": "0.5.1",
+  "packages/browsers": "1.8.0"
 }

remote/test/puppeteer/Herebyfile.mjs

@@ -0,0 +1,93 @@
+import {copyFile, readFile, writeFile} from 'fs/promises';
+
+import {execa} from 'execa';
+import {task} from 'hereby';
+import semver from 'semver';
+
+import {docgen, spliceIntoSection} from '@puppeteer/docgen';
+
+export const docsNgSchematicsTask = task({
+  name: 'docs:ng-schematics',
+  run: async () => {
+    const readme = await readFile('packages/ng-schematics/README.md', 'utf-8');
+    const index = await readFile('docs/integrations/ng-schematics.md', 'utf-8');
+    await writeFile(
+      'docs/integrations/ng-schematics.md',
+      index.replace('# API Reference\n', readme)
+    );
+  },
+});
+
+/**
+ * This logic should match the one in `website/docusaurus.config.js`.
+ */
+function getApiUrl(version) {
+  if (semver.gte(version, '19.3.0')) {
+    return `https://github.com/puppeteer/puppeteer/blob/puppeteer-${version}/docs/api/index.md`;
+  } else if (semver.gte(version, '15.3.0')) {
+    return `https://github.com/puppeteer/puppeteer/blob/${version}/docs/api/index.md`;
+  } else {
+    return `https://github.com/puppeteer/puppeteer/blob/${version}/docs/api.md`;
+  }
+}
+
+export const docsChromiumSupportTask = task({
+  name: 'docs:chromium-support',
+  run: async () => {
+    const content = await readFile('docs/chromium-support.md', {
+      encoding: 'utf8',
+    });
+    const {versionsPerRelease} = await import('./versions.js');
+    const buffer = [];
+    for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
+      if (puppeteerVersion === 'NEXT') {
+        continue;
+      }
+      if (semver.gte(puppeteerVersion, '20.0.0')) {
+        buffer.push(
+          `  * [Chrome for Testing](https://goo.gle/chrome-for-testing) ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
+            puppeteerVersion
+          )})`
+        );
+      } else {
+        buffer.push(
+          `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
+            puppeteerVersion
+          )})`
+        );
+      }
+    }
+    await writeFile(
+      'docs/chromium-support.md',
+      spliceIntoSection('version', content, buffer.join('\n'))
+    );
+  },
+});
+
+export const docsTask = task({
+  name: 'docs',
+  dependencies: [docsNgSchematicsTask, docsChromiumSupportTask],
+  run: async () => {
+    // Copy main page.
+    await copyFile('README.md', 'docs/index.md');
+
+    // Generate documentation
+    for (const [name, folder] of [
+      ['browsers', 'browsers-api'],
+      ['puppeteer', 'api'],
+    ]) {
+      docgen(`docs/${name}.api.json`, `docs/${folder}`);
+    }
+
+    // Update main @puppeteer/browsers page.
+    const readme = await readFile('packages/browsers/README.md', 'utf-8');
+    const index = await readFile('docs/browsers-api/index.md', 'utf-8');
+    await writeFile(
+      'docs/browsers-api/index.md',
+      index.replace('# API Reference', readme)
+    );
+
+    // Format everything.
+    await execa('prettier', ['--ignore-path', 'none', '--write', 'docs']);
+  },
+});

remote/test/puppeteer/README.md

@@ -90,7 +90,7 @@ information.
 
 #### `puppeteer-core`
 
-Every release since v1.7.0 we publish two packages:
+For every release since v1.7.0 we publish two packages:
 
 - [`puppeteer`](https://www.npmjs.com/package/puppeteer)
 - [`puppeteer-core`](https://www.npmjs.com/package/puppeteer-core)
@@ -110,7 +110,7 @@ You should use `puppeteer-core` if you are
 or [managing browsers yourself](https://pptr.dev/browsers-api/).
 If you are managing browsers yourself, you will need to call
 [`puppeteer.launch`](https://pptr.dev/api/puppeteer.puppeteernode.launch) with
-an an explicit
+an explicit
 [`executablePath`](https://pptr.dev/api/puppeteer.launchoptions)
 (or [`channel`](https://pptr.dev/api/puppeteer.launchoptions) if it's
 installed in a standard location).

remote/test/puppeteer/examples/README.md

@@ -1,6 +1,6 @@
 # Running the examples
 
-Assuming you have a checkout of the Puppeteer repo and have run npm i (or yarn) to install the dependencies, the examples can be run from the root folder like so:
+Assuming you have a checkout of the Puppeteer repo and have run `npm i` (or `yarn`) to install the dependencies, and `npm run build` (or `yarn run build`) to build the project, the examples can be run from the root folder like so:
 
 ```bash
 NODE_PATH=../ node examples/search.js
@@ -12,7 +12,7 @@ More complex and use case driven examples can be found at [github.com/GoogleChro
 
 # Other resources
 
-> Other useful tools, articles, and projects that use Puppeteer.
+Other useful tools, articles, and projects that use Puppeteer.
 
 ## Rendering and web scraping
 

remote/test/puppeteer/moz.yaml

@@ -5,6 +5,6 @@ origin:
   description: Headless Chrome Node API
   license: Apache-2.0
   name: puppeteer
-  release: puppeteer-v21.2.0
-  url: https://github.com/puppeteer/puppeteer.git
+  release: puppeteer-v21.5.2
+  url: ../puppeteer
 schema: 1