Merge pull request #1 from austinkelleher/initial-files

austinkelleher · web-flow · commit 0a3dbc092486 · 2020-02-12T06:17:40.000-05:00
Initial files
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+coverage
+dist
+yarn-error.log
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged"
+  }
+}
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,13 @@
+{
+  "linters": {
+    "*.ts": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.{md,js,json}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "ignore": []
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,13 @@
+/src/
+/test/
+/coverage/
+tsconfig*
+.editorconfig
+.travis.yml
+tslint.json
+jest.config.js
+.huskyrc
+.lintstagedrc
+.prettierignore
+.prettierrc
+yarn-error.log
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+dist
+coverage
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,5 @@
+{
+  singleQuote: true,
+  trailingComma: "es5",
+  proseWrap: "always"
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Austin Kelleher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1 +1,44 @@
 # playwright-aws-lambda
+
+Support for PlayWright running on AWS Lambda and Google Cloud Functions
+
+## Install
+
+```shell
+npm install playwrite-core playwright-aws-lambda --save
+```
+
+## Usage
+
+This package works with the `nodejs8.10`, `nodejs10.x` and `nodejs12.x` AWS
+Lambda runtimes out of the box.
+
+```javascript
+const playwright = require('playwright-aws-lambda');
+
+exports.handler = async (event, context) => {
+  let result = null;
+  let browser = null;
+
+  try {
+    const browser = await playwright.launchChromium();
+    const context = await browser.defaultContext();
+
+    const page = await context.newPage();
+    await page.goto(event.url || 'https://example.com');
+
+    console.log('Page title: ', await page.title());
+  } catch (error) {
+    throw err;
+  } finally {
+    if (browser !== null) {
+      await browser.close();
+    }
+  }
+};
+```
+
+## Thanks / Credits
+
+This project is based on the work of
+[chrome-aws-lambda](https://github.com/alixaxel/chrome-aws-lambda).
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,21 @@
+const { defaults } = require('jest-config');
+
+module.exports = {
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  testMatch: ['<rootDir>/src/**/*.test.{js,ts}'],
+  collectCoverageFrom: ['src/**/*.ts'],
+  moduleFileExtensions: [...defaults.moduleFileExtensions, 'ts'],
+  testEnvironment: 'node',
+  clearMocks: true,
+  collectCoverage: true,
+  // coverageThreshold: {
+  //   global: {
+  //     statements: 100,
+  //     branches: 100,
+  //     functions: 100,
+  //     lines: 100,
+  //   },
+  // },
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,45 @@
+{
+  "name": "playwright-aws-lambda",
+  "version": "0.3.2",
+  "description": "Support for running Microsoft's Playwrite on AWS Lambda and Google Cloud functions",
+  "main": "./dist/src/",
+  "author": "Austin Kelleher, a@alk.im",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">= 8.0.0"
+  },
+  "scripts": {
+    "compile-src-cjs": "tsc --declaration --declarationDir ./dist -p tsconfig-src-cjs.json && cp -R ./src/bin ./dist/src",
+    "precompile-src": "rm -rf ./dist",
+    "compile-src": "yarn compile-src-cjs",
+    "lint": "tslint --format codeFrame --project tsconfig.json 'src/**/*.ts' 'test/**/*.ts'",
+    "pretest": "yarn lint",
+    "test": "jest",
+    "build": "yarn compile-src",
+    "format-code": "prettier --write '**/*.[jt]s'"
+  },
+  "dependencies": {
+    "lambdafs": "^1.3.0"
+  },
+  "peerDependencies": {
+    "playwright-core": "0.10.0"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.5",
+    "@types/jest": "^24.0.18",
+    "@types/node": "~10",
+    "husky": "^3.0.5",
+    "jest": "^24.9.0",
+    "lint-staged": "8.2.1",
+    "nodemon": "^1.19.4",
+    "playwright-core": "^0.10.0",
+    "prettier": "^1.18.2",
+    "ts-jest": "^24.0.2",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.6.3"
+  }
+}
diff --git a/src/bin/aws.tar.br b/src/bin/aws.tar.br
diff --git a/src/bin/chromium.br b/src/bin/chromium.br
diff --git a/src/bin/swiftshader.tar.br b/src/bin/swiftshader.tar.br
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,149 @@
+require('playwright-core').default = require('playwright-core');
+
+import { promises as fsPromises } from 'fs';
+import { join } from 'path';
+import playwright from 'playwright-core';
+import isLambdaRuntimeEnvironment from './isLambdaRuntimeEnvironment';
+import { LaunchOptions } from 'playwright-core/lib/server/browserType';
+
+const { inflate } = require('lambdafs');
+
+if (isLambdaRuntimeEnvironment()) {
+  if (process.env.FONTCONFIG_PATH === undefined) {
+    process.env.FONTCONFIG_PATH = '/tmp/aws';
+  }
+
+  if (process.env.LD_LIBRARY_PATH === undefined) {
+    process.env.LD_LIBRARY_PATH = '/tmp/aws/lib';
+  } else if (process.env.LD_LIBRARY_PATH.startsWith('/tmp/aws/lib') !== true) {
+    process.env.LD_LIBRARY_PATH = [
+      ...new Set(['/tmp/aws/lib', ...process.env.LD_LIBRARY_PATH.split(':')]),
+    ].join(':');
+  }
+}
+
+/**
+ * Returns a list of recommended additional Chromium flags.
+ */
+function getChromiumArgs(headless: boolean) {
+  const result = [
+    '--disable-background-timer-throttling',
+    '--disable-breakpad',
+    '--disable-client-side-phishing-detection',
+    '--disable-cloud-import',
+    '--disable-default-apps',
+    '--disable-dev-shm-usage',
+    '--disable-extensions',
+    '--disable-gesture-typing',
+    '--disable-hang-monitor',
+    '--disable-infobars',
+    '--disable-notifications',
+    '--disable-offer-store-unmasked-wallet-cards',
+    '--disable-offer-upload-credit-cards',
+    '--disable-popup-blocking',
+    '--disable-print-preview',
+    '--disable-prompt-on-repost',
+    '--disable-setuid-sandbox',
+    '--disable-speech-api',
+    '--disable-sync',
+    '--disable-tab-for-desktop-share',
+    '--disable-translate',
+    '--disable-voice-input',
+    '--disable-wake-on-wifi',
+    '--disk-cache-size=33554432',
+    '--enable-async-dns',
+    '--enable-simple-cache-backend',
+    '--enable-tcp-fast-open',
+    '--enable-webgl',
+    '--hide-scrollbars',
+    '--ignore-gpu-blacklist',
+    '--media-cache-size=33554432',
+    '--metrics-recording-only',
+    '--mute-audio',
+    '--no-default-browser-check',
+    '--no-first-run',
+    '--no-pings',
+    '--no-sandbox',
+    '--no-zygote',
+    '--password-store=basic',
+    '--prerender-from-omnibox=disabled',
+    '--use-gl=swiftshader',
+    '--use-mock-keychain',
+  ];
+  if (
+    parseInt(
+      process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE ||
+        process.env.FUNCTION_MEMORY_MB ||
+        '1024',
+      10
+    ) >= 1024
+  ) {
+    result.push('--memory-pressure-off');
+  }
+  if (headless === true) {
+    result.push('--single-process');
+  } else {
+    result.push('--start-maximized');
+  }
+  return result;
+}
+async function fileExists(path: string) {
+  try {
+    await fsPromises.access(path);
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+function isHeadlessModeEnabled() {
+  if (process.env.IS_LOCAL !== undefined) {
+    return false;
+  }
+  return ['AWS_LAMBDA_FUNCTION_NAME', 'FUNCTION_NAME', 'FUNCTION_TARGET'].some(
+    key => process.env[key] !== undefined
+  );
+}
+
+async function getExecutablePath(
+  headless: boolean
+): Promise<string | undefined> {
+  if (headless !== true) {
+    return Promise.resolve(undefined);
+  }
+
+  if ((await fileExists('/tmp/chromium')) === true) {
+    for (const file of await fsPromises.readdir('/tmp')) {
+      if (file.startsWith('core.chromium') === true) {
+        await fsPromises.unlink(`/tmp/${file}`);
+      }
+    }
+
+    return Promise.resolve('/tmp/chromium');
+  }
+
+  const input = join(__dirname, 'bin');
+  const promises = [
+    inflate(`${input}/chromium.br`),
+    inflate(`${input}/swiftshader.tar.br`),
+  ];
+
+  if (isLambdaRuntimeEnvironment()) {
+    promises.push(inflate(`${input}/aws.tar.br`));
+  }
+
+  const result = await Promise.all(promises);
+  return result.shift();
+}
+
+export async function launchChromium(launchOptions?: Partial<LaunchOptions>) {
+  const headless = isHeadlessModeEnabled();
+  const browser = await playwright.chromium.launch({
+    args: getChromiumArgs(headless),
+    // defaultViewport: chromium.defaultViewport,
+    executablePath: await getExecutablePath(headless),
+    headless,
+    // headless: true
+    ...launchOptions,
+  });
+  return browser;
+}
diff --git a/src/isLambdaRuntimeEnvironment.ts b/src/isLambdaRuntimeEnvironment.ts
@@ -0,0 +1,7 @@
+export default function isLambdaRuntimeEnvironment() {
+  return (
+    ['AWS_Lambda_nodejs10.x', 'AWS_Lambda_nodejs12.x'].includes(
+      process.env.AWS_EXECUTION_ENV as string
+    ) === true
+  );
+}
diff --git a/tsconfig-src-cjs.json b/tsconfig-src-cjs.json
@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "module": "CommonJS"
+  },
+  "include": ["src/**/*"]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "rootDir": ".",
+    "baseUrl": ".",
+    "outDir": "./dist",
+    "noUnusedLocals": true,
+    "allowSyntheticDefaultImports": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "allowJs": false,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "target": "ESNext",
+    "pretty": true,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "paths": {
+      "~/*": ["./*"]
+    }
+  },
+  "include": ["src/**/*"]
+}
diff --git a/tslint.json b/tslint.json
@@ -0,0 +1,10 @@
+{
+  "extends": ["tslint-config-prettier"],
+  "rules": {
+    "interface-name": false,
+    "object-literal-sort-keys": false,
+    "ordered-imports": false,
+    "no-unused-variable": true,
+    "quotemark": [true, "single", "avoid-escape"]
+  }
+}
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "hooks": {
 +    "pre-commit": "lint-staged"
 +  }
 +}