130.0.0

https://github.com/Sparticuz/chromium/issues/247

.gitignore

@@ -12,3 +12,4 @@ _/amazon/.aws-sam
 *.tgz
 examples/**/package-lock.json
 examples/**/.serverless
+docker

Makefile

@@ -10,11 +10,17 @@ pretest:
 test:
 	sam local invoke --template _/amazon/template.yml --event _/amazon/events/example.com.json node20
 
+test16:
+	sam local invoke --template _/amazon/template.yml --event _/amazon/events/example.com.json node16
+
+test18:
+	sam local invoke --template _/amazon/template.yml --event _/amazon/events/example.com.json node18
+
 %.zip:
 	npm install --fund=false --package-lock=false
 	npm run build
 	mkdir -p nodejs
-	npm install --prefix nodejs/ tar-fs@3.0.5 follow-redirects@1.15.5 --bin-links=false --fund=false --omit=optional --omit=dev --package-lock=false --save=false
+	npm install --prefix nodejs/ tar-fs@3.0.6 follow-redirects@1.15.9 --bin-links=false --fund=false --omit=optional --omit=dev --package-lock=false --save=false
 	npm pack
 	mkdir -p nodejs/node_modules/@sparticuz/chromium/
 	tar --directory nodejs/node_modules/@sparticuz/chromium/ --extract --file sparticuz-chromium-*.tgz --strip-components=1

README.md

@@ -50,8 +50,8 @@ const test = require("node:test");
 const puppeteer = require("puppeteer-core");
 const chromium = require("@sparticuz/chromium");
 
-// Optional: If you'd like to use the new headless mode. "chrome-headless-shell" is the default.
+// Optional: If you'd like to use the new headless mode. "shell" is the default.
-// NOTE: Because we build the chrome-headless-shell binary, this option does not work.
+// NOTE: Because we build the shell binary, this option does not work.
 //       However, this option will stay so when we migrate to full chromium it will work.
 chromium.setHeadlessMode = true;
 
@@ -204,6 +204,50 @@ From what I can tell, `headless_shell` does not seem to include support for the
 
 Try marking this package as an external. Ref: https://webpack.js.org/configuration/externals/
 
+### I'm experiencing timeouts or failures closing Chromium
+
+This is a common issue. Chromium sometimes opens up more pages than you ask for. You can try the following
+
+```typescript
+for (const page of await browser.pages()) {
+  await page.close();
+}
+await browser.close();
+```
+
+You can also try the following if one of the calls is hanging for some reason.
+
+```typescript
+await Promise.race([browser.close(), browser.close(), browser.close()]);
+```
+
+Always `await browser.close()`, even if your script is returning an error.
+
+### I need Accessible pdf files
+
+This is due to the way @sparticuz/chromium is built. If you require accessible pdf's, you'll need to
+recompile chromium yourself with the following patch. You can then use that binary with @sparticuz/chromium-min.
+
+_Note_: This will increase the time required to generate a PDF.
+
+```patch
+diff --git a/_/ansible/plays/chromium.yml b/_/ansible/plays/chromium.yml
+index b42c740..49111d7 100644
+--- a/_/ansible/plays/chromium.yml
++++ b/_/ansible/plays/chromium.yml
+@@ -249,8 +249,9 @@
+           blink_symbol_level = 0
+           dcheck_always_on = false
+           disable_histogram_support = false
+-          enable_basic_print_dialog = false
+           enable_basic_printing = true
++          enable_pdf = true
++          enable_tagged_pdf = true
+           enable_keystone_registration_framework = false
+           enable_linux_installer = false
+           enable_media_remoting = false
+```
+
 ## Fonts
 
 The Amazon Linux 2 AWS Lambda runtime is not provisioned with any font faces.
@@ -260,8 +304,8 @@ By default, this package uses `swiftshader`/`angle` to do CPU acceleration for W
 | `args`                              | `Array<string>`   | Provides a list of recommended additional [Chromium flags](https://github.com/GoogleChrome/chrome-launcher/blob/master/docs/chrome-flags-for-tools.md). |
 | `defaultViewport`                   | `Object`          | Returns a sensible default viewport for serverless.                                                                                                     |
 | `executablePath(location?: string)` | `Promise<string>` | Returns the path the Chromium binary was extracted to.                                                                                                  |
-| `setHeadlessMode`                   | `void`            | Sets the headless mode to either `true` or `"chrome-headless-shell"`                                                                                                      |
+| `setHeadlessMode`                   | `void`            | Sets the headless mode to either `true` or `"shell"`                                                                                                    |
-| `headless`                          | `true \| "chrome-headless-shell"`   | Returns `true` or `"chrome-headless-shell"` depending on what version of chrome's headless you are running                                                                |
+| `headless`                          | `true \| "shell"` | Returns `true` or `"shell"` depending on what version of chrome's headless you are running                                                              |
 | `setGraphicsMode`                   | `void`            | Sets the graphics mode to either `true` or `false`                                                                                                      |
 | `graphics`                          | `boolean`         | Returns a boolean depending on whether webgl is enabled or disabled                                                                                     |
 

_/amazon/events/example.com.json

@@ -3,14 +3,14 @@
     "url": "https://example.com",
     "expected": {
       "title": "Example Domain",
-      "screenshot": "835f3ccc8fdbcb3a4a067666f1e9648e9e513570"
+      "screenshot": "e610a8be5568f23c453b08928460aae3ae0b4b0a"
     }
   },
   {
     "url": "https://get.webgl.org",
     "expected": {
       "remove": "logo-container",
-      "screenshot": "7b4110af7294ae55452d636dd8e900574b21ea2d"
+      "screenshot": "ec6c79a571b4cb5727c6fc23f9da30de3868138c"
     }
   }
 ]

_/amazon/handlers/index.js

@@ -1,5 +1,5 @@
-const { ok } = require("assert");
+const { ok } = require("node:assert");
-const { createHash } = require("crypto");
+const { createHash } = require("node:crypto");
 const puppeteer = require("puppeteer-core");
 const chromium = require("@sparticuz/chromium");
 
@@ -13,20 +13,13 @@ exports.handler = async (event, context) => {
       dumpio: true,
       executablePath: await chromium.executablePath(),
       headless: chromium.headless,
-      ignoreHTTPSErrors: true,
+      acceptInsecureCerts: true,
     });
 
     console.log("Chromium version", await browser.version());
 
-    const contexts = [browser.defaultBrowserContext()];
+    for (let job of event) {
-
+      const page = await browser.newPage();
-    while (contexts.length < event.length) {
-      contexts.push(await browser.createBrowserContext());
-    }
-
-    for (let context of contexts) {
-      const job = event.shift();
-      const page = await context.newPage();
 
       if (job.hasOwnProperty("url") === true) {
         await page.goto(job.url, { waitUntil: ["domcontentloaded", "load"] });
@@ -45,7 +38,7 @@ exports.handler = async (event, context) => {
                 document.getElementById(selector).remove();
               }, job.expected.remove);
             }
-            const screenshot = await page.screenshot();
+            const screenshot = Buffer.from(await page.screenshot());
             /*
             console.log(
               `data:image/png;base64,${screenshot.toString("base64")}`,
@@ -68,6 +61,9 @@ exports.handler = async (event, context) => {
     throw error.message;
   } finally {
     if (browser !== null) {
+      for (const page of await browser.pages()) {
+        await page.close();
+      }
       await browser.close();
     }
   }

_/ansible/inventory.ini

@@ -4,9 +4,9 @@
 [localhost:vars]
 ansible_connection=local
 ansible_python_interpreter=python
-image=ami-08d090f841c8435e9
+image=ami-06c68f701d8090592
 region=us-east-1
-instance_size=c6i.12xlarge
+instance_size=c7i.12xlarge
 
 [aws]
 
@@ -14,4 +14,4 @@ instance_size=c6i.12xlarge
 ansible_connection=ssh
 ansible_python_interpreter=auto_silent
 ansible_ssh_private_key_file=ansible.pem
-chromium_revision=1250580
+chromium_revision=1343869

_/ansible/plays/chromium.yml

@@ -236,12 +236,6 @@
         path: /srv/source/chromium/src/out/Headless
         state: directory
 
-    - name: Mounting Build Directory in Memory
-      become: true
-      become_user: root
-      shell: |
-        mount --types tmpfs --options size=24G,nr_inodes=128k,mode=1777 tmpfs /srv/source/chromium/src/out/Headless
-
     - name: Creating Headless Chromium Configuration
       copy:
         content: |

package-lock.json

@@ -1,40 +1,40 @@
 {
   "name": "@sparticuz/chromium",
-  "version": "122.0.0",
+  "version": "130.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@sparticuz/chromium",
-      "version": "122.0.0",
+      "version": "130.0.0",
       "license": "MIT",
       "dependencies": {
-        "follow-redirects": "^1.15.5",
+        "follow-redirects": "^1.15.9",
-        "tar-fs": "^3.0.5"
+        "tar-fs": "^3.0.6"
       },
       "devDependencies": {
-        "@tsconfig/node16": "^16.1.1",
+        "@tsconfig/node20": "^20.1.4",
-        "@tsconfig/strictest": "^2.0.3",
+        "@tsconfig/strictest": "^2.0.5",
         "@types/follow-redirects": "^1.14.4",
-        "@types/node": "^20.11.19",
+        "@types/node": "^20.16.10",
         "@types/tar-fs": "^2.0.4",
-        "clean-modules": "^3.0.4",
+        "clean-modules": "^3.1.1",
-        "typescript": "^5.3.3"
+        "typescript": "^5.6.2"
       },
       "engines": {
         "node": ">= 16"
       }
     },
-    "node_modules/@tsconfig/node16": {
+    "node_modules/@tsconfig/node20": {
-      "version": "16.1.1",
+      "version": "20.1.4",
-      "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-16.1.1.tgz",
+      "resolved": "https://registry.npmjs.org/@tsconfig/node20/-/node20-20.1.4.tgz",
-      "integrity": "sha512-+pio93ejHN4nINX4pXqfnR/fPLRtJBaT4ORaa5RH0Oc1zoYmo2B2koG+M328CQhHKn1Wj6FcOxCDFXAot9NhvA==",
+      "integrity": "sha512-sqgsT69YFeLWf5NtJ4Xq/xAF8p4ZQHlmGW74Nu2tD4+g5fAsposc4ZfaaPixVu4y01BEiDCWLRDCvDM5JOsRxg==",
       "dev": true
     },
     "node_modules/@tsconfig/strictest": {
-      "version": "2.0.3",
+      "version": "2.0.5",
-      "resolved": "https://registry.npmjs.org/@tsconfig/strictest/-/strictest-2.0.3.tgz",
+      "resolved": "https://registry.npmjs.org/@tsconfig/strictest/-/strictest-2.0.5.tgz",
-      "integrity": "sha512-MroLvRhMbqtXI5WBSwoomro6OQS4xnCoudUrMb20JO0vLKUs0bAaCEcvM/immEBSJjFAK1l6jW1oAO8q3Ancrg==",
+      "integrity": "sha512-ec4tjL2Rr0pkZ5hww65c+EEPYwxOi4Ryv+0MtjeaSQRJyq322Q27eOQiFbuNgw2hpL4hB1/W/HBGk3VKS43osg==",
       "dev": true
     },
     "node_modules/@types/follow-redirects": {
@@ -47,12 +47,13 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.11.19",
+      "version": "20.16.10",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.19.tgz",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.16.10.tgz",
-      "integrity": "sha512-7xMnVEcZFu0DikYjWOlRq7NTPETrm7teqUT2WkQjrTIkEgUyyGdWsj/Zg8bEJt5TNklzbPD1X3fqfsHw3SpapQ==",
+      "integrity": "sha512-vQUKgWTjEIRFCvK6CyriPH3MZYiYlNy0fKiEYHWbcoWLEgs4opurGGKlebrTLqdSMIbXImH6XExNiIyNUv3WpA==",
       "dev": true,
+      "license": "MIT",
       "dependencies": {
-        "undici-types": "~5.26.4"
+        "undici-types": "~6.19.2"
       }
     },
     "node_modules/@types/tar-fs": {
@@ -113,10 +114,11 @@
       }
     },
     "node_modules/clean-modules": {
-      "version": "3.0.4",
+      "version": "3.1.1",
-      "resolved": "https://registry.npmjs.org/clean-modules/-/clean-modules-3.0.4.tgz",
+      "resolved": "https://registry.npmjs.org/clean-modules/-/clean-modules-3.1.1.tgz",
-      "integrity": "sha512-UtidYdwZScv7TEmPuNBU1IDh2UrLH9FNYnhKYterm3jTtOGtSOa02J5aKHvnauqS/TKqJGPpC4bmuRDAXk61EQ==",
+      "integrity": "sha512-t/7dNtn6vQYxujYxdwZeLa0NsLE92KQ0XeV3CDJ2TXgLTvn3ijmjlQN0Dm9wjYQgC0miZiF66ClTQzgIeYw96A==",
       "dev": true,
+      "license": "ISC",
       "dependencies": {
         "clipanion": "^3.2.1",
         "picomatch": "^2.3.0",
@@ -157,15 +159,16 @@
       "integrity": "sha512-IgfweLvEpwyA4WgiQe9Nx6VV2QkML2NkvZnk1oKnIzXgXdWxuhF7zw4DvLTPZJn6PIUneiAXPF24QmoEqHTjyw=="
     },
     "node_modules/follow-redirects": {
-      "version": "1.15.5",
+      "version": "1.15.9",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.5.tgz",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz",
-      "integrity": "sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw==",
+      "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==",
       "funding": [
         {
           "type": "individual",
           "url": "https://github.com/sponsors/RubenVerborgh"
         }
       ],
+      "license": "MIT",
       "engines": {
         "node": ">=4.0"
       },
@@ -270,9 +273,9 @@
       }
     },
     "node_modules/tar-fs": {
-      "version": "3.0.5",
+      "version": "3.0.6",
-      "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.0.5.tgz",
+      "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.0.6.tgz",
-      "integrity": "sha512-JOgGAmZyMgbqpLwct7ZV8VzkEB6pxXFBVErLtb+XCOqzc6w1xiWKI9GVd6bwk68EX7eJ4DWmfXVmq8K2ziZTGg==",
+      "integrity": "sha512-iokBDQQkUyeXhgPYaZxmczGPhnhXZ0CmrqI+MOb/WFGS9DW5wnfrLgtjUJBvz50vQ3qfRwJ62QVoCFu8mPVu5w==",
       "dependencies": {
         "pump": "^3.0.0",
         "tar-stream": "^3.1.5"
@@ -299,10 +302,11 @@
       "dev": true
     },
     "node_modules/typescript": {
-      "version": "5.3.3",
+      "version": "5.6.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz",
-      "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==",
+      "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==",
       "dev": true,
+      "license": "Apache-2.0",
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"
@@ -312,10 +316,11 @@
       }
     },
     "node_modules/undici-types": {
-      "version": "5.26.5",
+      "version": "6.19.6",
-      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.6.tgz",
-      "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+      "integrity": "sha512-e/vggGopEfTKSvj4ihnOLTsqhrKRN3LeO6qSN/GxohhuRv8qH9bNQ4B8W7e/vFL+0XTnmHPB4/kegunZGA4Org==",
-      "dev": true
+      "dev": true,
+      "license": "MIT"
     },
     "node_modules/wrappy": {
       "version": "1.0.2",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sparticuz/chromium",
-  "version": "122.0.0",
+  "version": "130.0.0",
   "description": "Chromium Binary for Serverless Platforms",
   "keywords": [
     "aws",
@@ -36,17 +36,17 @@
     "test": "make clean && make && make pretest && make test"
   },
   "dependencies": {
-    "follow-redirects": "^1.15.5",
+    "follow-redirects": "^1.15.9",
-    "tar-fs": "^3.0.5"
+    "tar-fs": "^3.0.6"
   },
   "devDependencies": {
-    "@tsconfig/node16": "^16.1.1",
+    "@tsconfig/node20": "^20.1.4",
-    "@tsconfig/strictest": "^2.0.3",
+    "@tsconfig/strictest": "^2.0.5",
     "@types/follow-redirects": "^1.14.4",
-    "@types/node": "^20.11.19",
+    "@types/node": "^20.16.10",
     "@types/tar-fs": "^2.0.4",
-    "clean-modules": "^3.0.4",
+    "clean-modules": "^3.1.1",
-    "typescript": "^5.3.3"
+    "typescript": "^5.6.2"
   },
   "engines": {
     "node": ">= 16"

source/index.ts

@@ -93,7 +93,7 @@ class Chromium {
    * https://developer.chrome.com/articles/new-headless/#try-out-the-new-headless
    * @values true or "new"
    */
-  private static headlessMode: true | "chrome-headless-shell" = "chrome-headless-shell";
+  private static headlessMode: true | "shell" = "shell";
 
   /**
    * If true, the graphics stack and webgl is enabled,
@@ -240,9 +240,11 @@ class Chromium {
     ];
 
     // https://chromium.googlesource.com/chromium/src/+/main/docs/gpu/swiftshader.md
-    this.graphics
+    // Blocked by https://github.com/Sparticuz/chromium/issues/247
-      ? graphicsFlags.push("--use-gl=angle", "--use-angle=swiftshader")
+    //this.graphics
-      : graphicsFlags.push("--disable-webgl");
+    //  ? graphicsFlags.push("--use-gl=angle", "--use-angle=swiftshader")
+    //  : graphicsFlags.push("--disable-webgl");
+    graphicsFlags.push("--use-gl=angle", "--use-angle=swiftshader");
 
     const insecureFlags = [
       "--allow-running-insecure-content", // https://source.chromium.org/search?q=lang:cpp+symbol:kAllowRunningInsecureContent&ss=chromium
@@ -254,7 +256,7 @@ class Chromium {
     ];
 
     const headlessFlags = [
-      this.headless === "chrome-headless-shell" ? "--headless='chrome-headless-shell'" : "--headless",
+      this.headless === "shell" ? "--headless='shell'" : "--headless",
     ];
 
     return [
@@ -349,10 +351,10 @@ class Chromium {
 
   /**
    * Returns the headless mode.
-   * "chrome-headless-shell" means the 'old' (legacy, chromium < 112) headless mode.
+   * "shell" means the 'old' (legacy, chromium < 112) headless mode.
    * `true` means the 'new' headless mode.
    * https://developer.chrome.com/articles/new-headless/#try-out-the-new-headless
-   * @returns true | "chrome-headless-shell"
+   * @returns true | "shell"
    */
   public static get headless() {
     return this.headlessMode;
@@ -360,18 +362,18 @@ class Chromium {
 
   /**
    * Sets the headless mode.
-   * "chrome-headless-shell" means the 'old' (legacy, chromium < 112) headless mode.
+   * "shell" means the 'old' (legacy, chromium < 112) headless mode.
    * `true` means the 'new' headless mode.
    * https://developer.chrome.com/articles/new-headless/#try-out-the-new-headless
-   * @default "chrome-headless-shell"
+   * @default "shell"
    */
-  public static set setHeadlessMode(value: true | "chrome-headless-shell") {
+  public static set setHeadlessMode(value: true | "shell") {
     if (
-      (typeof value === "string" && value !== "chrome-headless-shell") ||
+      (typeof value === "string" && value !== "shell") ||
       (typeof value === "boolean" && value !== true)
     ) {
       throw new Error(
-        `Headless mode must be either \`true\` or 'chrome-headless-shell', you entered '${value}'`
+        `Headless mode must be either \`true\` or 'shell', you entered '${value}'`
       );
     }
     this.headlessMode = value;
@@ -398,7 +400,11 @@ class Chromium {
         `Graphics mode must be a boolean, you entered '${value}'`
       );
     }
-    this.graphicsMode = value;
+
+    // Disabling 'disabling the gpu'
+    // Blocked by https://github.com/Sparticuz/chromium/issues/247
+    // this.graphicsMode = value;
+    this.graphicsMode = true;
   }
 }
 

source/lambdafs.ts

@@ -72,4 +72,4 @@ class LambdaFS {
   }
 }
 
-export = LambdaFS;
+export default LambdaFS;

tsconfig.json

@@ -1,10 +1,10 @@
 {
-  "extends": ["@tsconfig/node16/tsconfig", "@tsconfig/strictest"],
+  "extends": ["@tsconfig/node20/tsconfig", "@tsconfig/strictest"],
   "compilerOptions": {
     "declaration": true,
-    "lib": ["dom", "ES2021"],
+    "lib": ["dom", "ES2023"],
-    "module": "Node16",
+    "module": "NodeNext",
-    "moduleResolution": "Node16",
+    "moduleResolution": "NodeNext",
     "outDir": "build"
   },
   "include": ["source"]