[WIP] feat: Rewrite to automation-extra, Support both Playwright and Puppeteer

.eslintrc-ts.js

@@ -0,0 +1,32 @@
+module.exports = {
+  root: true,
+  extends: [
+    'standard-with-typescript',
+    'prettier',
+    'prettier/@typescript-eslint'
+  ],
+  ignorePatterns: ['dist/*', 'node_modules/*'],
+  rules: {
+    'lines-between-class-members': ['off']
+  },
+  // Typescript specific rules would throw when used with .js files
+  overrides: [
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      parserOptions: {
+        project: './tsconfig.eslint.json',
+        tsconfigRootDir: __dirname // https://github.com/typescript-eslint/typescript-eslint/issues/251
+      },
+      rules: {
+        '@typescript-eslint/strict-boolean-expressions': [
+          'warn',
+          {
+            allowNullableObject: true
+          }
+        ],
+        '@typescript-eslint/lines-between-class-members': ['off'],
+        '@typescript-eslint/explicit-function-return-type': ['off']
+      }
+    }
+  ]
+}

.github/workflows/test.yml

@@ -14,8 +14,8 @@ on:
       - 'test/*'
 
 env:
-  CI: "true"
-  FORCE_COLOR: "true"
+  CI: 'true'
+  FORCE_COLOR: 'true'
 
 jobs:
   test:
@@ -77,9 +77,12 @@ jobs:
           file node_modules/puppeteer-extra/dist/index.cjs.js
       - uses: microsoft/playwright-github-action@v1
 
+      - name: download firefox (puppeteer)
+        run: yarn download-firefox
+
       - name: test
         uses: GabrielBB/xvfb-action@v1
         env:
-          DISPLAY: ":99.0"
+          DISPLAY: ':99.0'
         with:
           run: yarn test-ci

.gitignore

@@ -16,6 +16,7 @@ dist
 .env.production.local
 .cache
 .rpt2_cache
+.idea
 
 lerna-debug.log*
 lerna-error.log*

.prettierrc.js

@@ -2,5 +2,5 @@ module.exports = {
   ...require('prettier-config-standard'),
 
   // override for Windows
-  endOfLine: 'lf',
+  endOfLine: 'lf'
 }

README.md

@@ -1,10 +1,10 @@
-# puppeteer-extra
+# puppeteer-extra [![Downloads](https://img.shields.io/endpoint?style=social&url=https://runkit.io/fezvrasta/combined-npm-downloads/1.0.0?packages=puppeteer-extra,puppeteer-extra-plugin,puppeteer-extra-plugin-stealth,puppeteer-extra-plugin-recaptcha,puppeteer-extra-plugin-adblocker)](https://github.com/berstend/puppeteer-extra/)
 
-This is the monorepo for [`puppeteer-extra`](./packages/puppeteer-extra), a modular plugin framework for [`puppeteer`](https://github.com/GoogleChrome/puppeteer). :-)
+This is the monorepo for [`puppeteer-extra`](./packages/puppeteer-extra), a modular plugin framework for [`puppeteer`](https://github.com/puppeteer/puppeteer). :-)
 
 🌟 **For the main documentation, please head over to the [`puppeteer-extra`](./packages/puppeteer-extra) package.**
 
-In case you're interested in the available plugins, check out the [packages folder](./packages/).
+We've also recently introduced support for Playwright, if you're interested in that head over to [`playwright-extra`](./packages/playwright-extra).
 
 ## Monorepo
 
@@ -28,6 +28,14 @@ This monorepo is powered by [Lerna](https://github.com/lerna/lerna) and yarn wor
 
 #### Initial setup
 
+- Make sure to have a recent Node.js version installed (hint: use `nvm`)
+- Make sure `yarn` is recent (`>=1.2`), for better workspace support:
+
+```bash
+rm -rf ~/.yarn && npm install --global yarn && yarn --version
+# Issues? Check your PATH and `which yarn`
+```
+
 ```bash
 # Install deps
 yarn
@@ -40,6 +48,10 @@ yarn bootstrap
 yarn build
 ```
 
+#### Troubleshooting
+
+> **Note regarding `fsevents`:** If you are working from a non-OSX environment you may need to run `npx json -I -f package.json -e 'this.resolutions={}'` prior to the initial `yarn` command to allow correct installation. This is a local fix and not meant to be commited afterwards.
+
 #### Development flow
 
 ```bash
@@ -53,6 +65,9 @@ yarn lerna add fs-extra --scope=puppeteer-extra-plugin-user-data-dir
 # https://github.com/lerna/lerna/issues/833
 yarn lerna exec --concurrency 1 'yarn remove fs-extra; echo 0'
 
+# Make sure firefox is installed and symlinked
+yarn download-firefox
+
 # Run test in all packages
 yarn test
 

helpers/scripts/download-firefox.js

@@ -0,0 +1,70 @@
+const fs = require('fs')
+const path = require('path')
+
+try {
+  require('puppeteer/lib/cjs/puppeteer/node/BrowserFetcher.js')
+} catch (err) {
+  console.log(
+    'Error importing BrowserFetcher, this means puppeteer is not installed or an old version is used. Skipping.'
+  )
+  process.exit(0)
+}
+
+const {
+  BrowserFetcher
+} = require('puppeteer/lib/cjs/puppeteer/node/BrowserFetcher.js')
+
+const {
+  downloadBrowser
+} = require('puppeteer/lib/cjs/puppeteer/node/install.js')
+
+const fetchUrl = url =>
+  new Promise((resolve, reject) => {
+    require('https')
+      .get(url, resp => {
+        let data = ''
+        resp.on('data', chunk => {
+          data += chunk
+        })
+        resp.on('end', () => {
+          resolve(data)
+        })
+      })
+      .on('error', err => {
+        reject(err)
+      })
+  })
+
+async function main() {
+  const browserFetcher = new BrowserFetcher(
+    path.join(process.cwd(), './node_modules/puppeteer'),
+    {
+      product: 'firefox'
+    }
+  )
+  const firefoxVersion = JSON.parse(
+    await fetchUrl(
+      'https://product-details.mozilla.org/1.0/firefox_versions.json'
+    )
+  ).FIREFOX_NIGHTLY
+
+  const sourceDir = browserFetcher.revisionInfo(firefoxVersion).folderPath
+  const targetDir = browserFetcher.revisionInfo('latest').folderPath
+
+  process.env.PUPPETEER_PRODUCT = 'firefox'
+  await downloadBrowser()
+
+  try {
+    await fs.promises.unlink(targetDir)
+  } catch (err) {}
+
+  try {
+    await fs.promises.symlink(sourceDir, targetDir)
+  } catch (err) {
+    console.log(err)
+  }
+
+  console.log(`${sourceDir} => ${targetDir}`)
+}
+
+main()

helpers/test/wrap/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@extra-test/wrap",
+  "private": true,
+  "version": "1.0.0",
+  "typings": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "npx wait-run --pattern 'src/**' yarn watch:build",
+    "watch:build": "yarn build; yarn watch"
+  },
+  "devDependencies": {
+    "@types/node": "^14.6.2",
+    "automation-extra": "*",
+    "ts-node": "^9.0.0",
+    "typescript": "4.1.2"
+  }
+}

helpers/test/wrap/readme.md

@@ -0,0 +1,3 @@
+# testing-tools
+
+Internal package to make multi driver/browser testing more convenient.