bits-to-dead-trees 1.5.1 → 2.0.0

package/.github/workflows/ci.yml

@@ -30,3 +30,6 @@ jobs:
 
       - name: Run typecheck
         run: npm run ts-check
+
+      - name: Run tests
+        run: npm test

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # bits-to-dead-trees
 
+## 2.0.0
+
+### Major Changes
+
+- b4ebed6: Allow more options for pdf, context and goto to be passed. Also working validations.
+
+  We allow way more options now to be given in the payload:
+
+  - `pdfOptions` are the options for the `pdf` call in Playwright: https://playwright.dev/docs/api/class-page#page-pdf.
+  - `gotoOptions` are the options for the `goto` method in Playwright: https://playwright.dev/docs/api/class-page#page-goto
+    - if you don't pass anything, we default to a timeout of 60000 and wait for `networkidle`
+  - `browserContextOptions` are the options for the browser context in Playwright: https://playwright.dev/docs/api/class-browser#browser-new-context
+    - if you don't pass anything, we default to set `ignoreHTTPSErrors` to `true`
+
+  We finally added tests too! ✌️
+
+  ## Breaking Changes
+
+  - We don't allow `options` in the payload anymore. Those are `pdfOptions` now. To adapt your code, rename `options` to `pdfOptions` and you should be good to go.
+    This change was needed to allow more options for other methods we're using (like `timeout` for `goto`).
+  - We have stricter validation now and don't allow unknown keys in the option objects now. Previously we've ignored them, but we've now opted to bail out with
+    an validation error so the user gets notified on typos and such.
+
+- 484b197: Return an error if page could not be loaded
+
+  ## Breaking Changes
+
+  Previously we've ignored if the page could not be loaded and tried to create a PDF anyway. However,
+  this lead to PDFs with random error messages on them, instead of a proper error in logging or similar.
+
+  To provide an better experience, we've opted to change this, so errors are caught earlier.
+
+### Minor Changes
+
+- c7e554e: Update to Playwright 1.30.0
+- 8b2ed78: Merge passed options with default options
+
 ## 1.5.1
 
 ### Patch Changes

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/playwright:v1.29.2-jammy
+FROM mcr.microsoft.com/playwright:v1.30.0-jammy
 
 ENV NODE_ENV=production
 ENV SERVER_PORT=8000
@@ -15,7 +15,7 @@ COPY ["package.json", "package-lock.json*", "./"]
 
 RUN npm install --omit=dev --ignore-scripts
 
-COPY ["index.js", "pdf_request_body.json", "./"]
+COPY ["server.js", "app.js", "pdf_request_body.json", "./"]
 
 ENTRYPOINT ["tini", "-v", "--"]
-CMD ["node", "index.js"]
+CMD ["node", "server.js"]

package/README.md

@@ -34,11 +34,17 @@ The server exposes the `/pdf` endpoint that listens to a POST request and expect
 ```json
 {
   "url": "https://your-target-url.com/site/you/want/a/pdf/of",
-  "options": {}
+  "pdfOptions": {},
+  "gotoOptions": {},
+  "browserContextOptions": {}
 }
 ```
 
-`options` are the options Playwright knows about PDF: https://playwright.dev/docs/api/class-page#page-pdf. We pass them to Playwright directly, so please refer to their docs.
+- `pdfOptions` are the options for the `pdf` call in Playwright: https://playwright.dev/docs/api/class-page#page-pdf.
+- `gotoOptions` are the options for the `goto` method in Playwright: https://playwright.dev/docs/api/class-page#page-goto
+  - if you don't pass anything, we default to a timeout of 60000 and wait for `networkidle`
+- `browserContextOptions` are the options for the browser context in Playwright: https://playwright.dev/docs/api/class-browser#browser-new-context
+  - if you don't pass anything, we default to set `ignoreHTTPSErrors` to `true`
 
 The response is the PDF file.
 

package/app.js

@@ -0,0 +1,138 @@
+// @ts-check
+
+import { fastify } from "fastify";
+import { chromium } from "playwright-core";
+import { readFileSync } from "node:fs";
+
+// we'd love to do this, but eslint doesn't like import assertions yet
+// import PdfRequestBodySchema from "./pdf_request_body.json" assert { type: "json" };
+const PdfRequestBodySchema = JSON.parse(
+  readFileSync("./pdf_request_body.json", { encoding: "utf-8" })
+);
+
+/**
+ * @typedef {Parameters<import("playwright-core").Page["pdf"]>[0]} PdfOptions
+ * @typedef {Parameters<import("playwright-core").Page["goto"]>[1]} GotoOptions
+ * @typedef {import("playwright-core").BrowserContextOptions} BrowserContextOptions
+ */
+
+/**
+ * @typedef {Object} PdfRequestBody
+ * @property {string} url
+ * @property {PdfOptions} pdfOptions
+ * @property {BrowserContextOptions} browserContextOptions
+ * @property {GotoOptions} gotoOptions
+ */
+
+export const defaultBrowserContextOptions = /** @type {const} */ ({
+  ignoreHTTPSErrors: true,
+});
+export const defaultGotoOptions = /** @type {const} */ ({
+  timeout: 60000,
+  waitUntil: "networkidle",
+});
+
+/**
+ *
+ * @param {string} url
+ * @param {PdfOptions} pdfOptions
+ * @param {BrowserContextOptions} browserContextOptions
+ * @param {GotoOptions} gotoOptions
+ * @returns Buffer
+ */
+const createPDF = async (
+  url,
+  pdfOptions = {},
+  browserContextOptions = {},
+  gotoOptions = {}
+) => {
+  const browser = await chromium.launch();
+
+  try {
+    const context = await browser.newContext(browserContextOptions);
+    const page = await context.newPage();
+
+    const response = await page.goto(url, gotoOptions);
+    if (response?.ok()) {
+      return page.pdf(pdfOptions);
+    }
+
+    return Promise.reject({
+      error: true,
+      message: await response?.text(),
+      status: response?.status(),
+      statusText: response?.statusText(),
+    });
+  } finally {
+    await browser.close();
+  }
+};
+
+/**
+ *
+ * @param {import("fastify").FastifyServerOptions} opts
+ */
+function build(opts = {}) {
+  const fastifyOptions = {
+    ...opts,
+    ajv: {
+      customOptions: {
+        // we want validation errors if someone passes an unknown option
+        removeAdditional: false,
+        // Don't adhere to ajvs strict types, as our schema is auto generated anyway
+        allowUnionTypes: true,
+      },
+    },
+  };
+  const app = fastify(fastifyOptions);
+
+  app.post(
+    "/pdf",
+    { schema: { body: PdfRequestBodySchema }, attachValidation: true },
+    /**
+     *
+     * @param {import('fastify').FastifyRequest<{Body: PdfRequestBody}>} request
+     * @param {import('fastify').FastifyReply} response
+     */
+    async (request, response) => {
+      if (request.validationError) {
+        response.code(400);
+
+        return {
+          error: true,
+          message: request.validationError.message,
+        };
+      }
+
+      const { url, pdfOptions, browserContextOptions, gotoOptions } =
+        request.body;
+
+      const pdfOpts = { ...pdfOptions };
+
+      const contextOpts = {
+        ...defaultBrowserContextOptions,
+        ...browserContextOptions,
+      };
+
+      const gotoOpts = {
+        ...defaultGotoOptions,
+        ...gotoOptions,
+      };
+
+      try {
+        return await createPDF(url, pdfOpts, contextOpts, gotoOpts);
+      } catch (error) {
+        // @ts-ignore
+        response.code(error.status ?? 500);
+
+        return error;
+      }
+    }
+  );
+
+  app.get("/health", async (_, response) => response.code(200).send());
+
+  return app;
+}
+
+export default build;

package/nodemon.json

@@ -1,4 +1,9 @@
 {
-  "watch": ["index.js", "schemas/pdf_request_body.json", "package-lock.json"],
+  "watch": [
+    "app.js",
+    "server.js",
+    "schemas/pdf_request_body.json",
+    "package-lock.json"
+  ],
   "ext": "js,json"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bits-to-dead-trees",
   "author": "Robin Mehner <robin@coding-robin.de>",
-  "version": "1.5.1",
+  "version": "2.0.0",
   "description": "Turn HTML into PDF files",
   "repository": "github:rmehner/bits-to-dead-trees",
   "license": "Apache-2.0",
@@ -13,32 +13,36 @@
   "engines": {
     "node": ">= 16"
   },
-  "main": "index.js",
+  "main": "server.js",
+  "type": "module",
   "scripts": {
     "check-format": "prettier --check **/*.{js,ts,json,md}",
     "lint": "eslint *.js",
     "format": "prettier --write **/*.{js,ts,json,md}",
-    "start": "node index.js",
-    "start:dev": "nodemon --inspect index.js",
-    "dump-schemas": "typescript-json-schema types/schemas.ts PdfRequestBody --out pdf_request_body.json && npm run format",
+    "start": "node server.js",
+    "start:dev": "nodemon --inspect server.js",
+    "dump-schemas": "typescript-json-schema --noExtraProps --required --strictNullChecks types/schemas.ts PdfRequestBody --out pdf_request_body.json",
     "update-schemas": "npm run dump-schemas && npm run format",
     "postinstall": "npx playwright install chromium",
     "add-changeset": "changeset",
     "release": "changeset publish",
+    "test": "vitest --reporter verbose",
     "ts-check": "npx tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^4.11.0",
-    "playwright-core": "^1.29.2"
+    "fastify": "^4.12.0",
+    "playwright-core": "^1.30.0"
   },
   "devDependencies": {
     "@changesets/cli": "^2.26.0",
-    "eslint": "^8.31.0",
+    "@types/lodash": "^4.14.191",
+    "eslint": "^8.32.0",
     "eslint-config-prettier": "^8.6.0",
     "nodemon": "^2.0.20",
     "pino-pretty": "^9.1.1",
-    "prettier": "^2.8.2",
+    "prettier": "^2.8.3",
     "tslib": "^2.4.1",
-    "typescript-json-schema": "^0.55.0"
+    "typescript-json-schema": "^0.55.0",
+    "vitest": "^0.28.2"
   }
 }

package/pdf_request_body.json

@@ -1,84 +1,581 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "properties": {
-    "options": {
+  "additionalProperties": false,
+  "definitions": {
+    "BrowserContextOptions": {
+      "additionalProperties": false,
       "properties": {
-        "displayHeaderFooter": {
-          "description": "Display header and footer. Defaults to `false`.",
+        "acceptDownloads": {
+          "description": "Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.",
           "type": "boolean"
         },
-        "footerTemplate": {
-          "description": "HTML template for the print footer. Should use the same format as the `headerTemplate`.",
+        "baseURL": {
+          "description": "When using [page.goto(url[, options])](https://playwright.dev/docs/api/class-page#page-goto),\n[page.route(url, handler[, options])](https://playwright.dev/docs/api/class-page#page-route),\n[page.waitForURL(url[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-url),\n[page.waitForRequest(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-request),\nor\n[page.waitForResponse(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-response)\nit takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n  `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n  `http://localhost:3000/bar.html`",
           "type": "string"
         },
-        "format": {
-          "description": "Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.",
-          "type": "string"
+        "bypassCSP": {
+          "description": "Toggles bypassing page's Content-Security-Policy.",
+          "type": "boolean"
+        },
+        "colorScheme": {
+          "anyOf": [
+            {
+              "enum": ["dark", "light", "no-preference"],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See\n[page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.\nPassing `null` resets emulation to system defaults. Defaults to `'light'`."
+        },
+        "deviceScaleFactor": {
+          "description": "Specify device scale factor (can be thought of as dpr). Defaults to `1`.",
+          "type": "number"
+        },
+        "extraHTTPHeaders": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "An object containing additional HTTP headers to be sent with every request.",
+          "type": "object"
+        },
+        "forcedColors": {
+          "anyOf": [
+            {
+              "enum": ["active", "none"],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See\n[page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.\nPassing `null` resets emulation to system defaults. Defaults to `'none'`."
+        },
+        "geolocation": {
+          "$ref": "#/definitions/Geolocation"
+        },
+        "hasTouch": {
+          "description": "Specifies if viewport supports touch events. Defaults to false.",
+          "type": "boolean"
+        },
+        "httpCredentials": {
+          "$ref": "#/definitions/HTTPCredentials",
+          "description": "Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)."
+        },
+        "ignoreHTTPSErrors": {
+          "description": "Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "isMobile": {
+          "description": "Whether the `meta viewport` tag is taken into account and touch events are enabled. Defaults to `false`. Not\nsupported in Firefox.",
+          "type": "boolean"
+        },
+        "javaScriptEnabled": {
+          "description": "Whether or not to enable JavaScript in the context. Defaults to `true`.",
+          "type": "boolean"
         },
-        "headerTemplate": {
-          "description": "HTML template for the print header. Should be valid HTML markup with following classes used to inject printing\nvalues into them:\n- `'date'` formatted print date\n- `'title'` document title\n- `'url'` document location\n- `'pageNumber'` current page number\n- `'totalPages'` total pages in the document",
+        "locale": {
+          "description": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules.",
           "type": "string"
         },
-        "height": {
-          "description": "Paper height, accepts values labeled with units.",
-          "type": ["string", "number"]
+        "logger": {
+          "$ref": "#/definitions/Logger",
+          "description": "Logger sink for Playwright logging."
         },
-        "landscape": {
-          "description": "Paper orientation. Defaults to `false`.",
+        "offline": {
+          "description": "Whether to emulate network being offline. Defaults to `false`.",
           "type": "boolean"
         },
-        "margin": {
-          "description": "Paper margins, defaults to none.",
+        "permissions": {
+          "description": "A list of permissions to grant to all pages in this context. See\n[browserContext.grantPermissions(permissions[, options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions)\nfor more details.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "proxy": {
+          "additionalProperties": false,
+          "description": "Network proxy settings to use with this context.\n\n**NOTE** For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If\nall contexts override the proxy, global proxy will be never used and can be any string, for example `launch({\nproxy: { server: 'http://per-context' } })`.",
           "properties": {
-            "bottom": {
-              "description": "Bottom margin, accepts values labeled with units. Defaults to `0`.",
-              "type": ["string", "number"]
+            "bypass": {
+              "description": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.",
+              "type": "string"
             },
-            "left": {
-              "description": "Left margin, accepts values labeled with units. Defaults to `0`.",
-              "type": ["string", "number"]
+            "password": {
+              "description": "Optional password to use if HTTP proxy requires authentication.",
+              "type": "string"
             },
-            "right": {
-              "description": "Right margin, accepts values labeled with units. Defaults to `0`.",
-              "type": ["string", "number"]
+            "server": {
+              "description": "Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example `http://myproxy.com:3128` or\n`socks5://myproxy.com:3128`. Short form `myproxy.com:3128` is considered an HTTP proxy.",
+              "type": "string"
             },
-            "top": {
-              "description": "Top margin, accepts values labeled with units. Defaults to `0`.",
-              "type": ["string", "number"]
+            "username": {
+              "description": "Optional username to use if HTTP proxy requires authentication.",
+              "type": "string"
+            }
+          },
+          "required": ["server"],
+          "type": "object"
+        },
+        "recordHar": {
+          "additionalProperties": false,
+          "description": "Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into `recordHar.path` file.\nIf not specified, the HAR is not recorded. Make sure to await\n[browserContext.close()](https://playwright.dev/docs/api/class-browsercontext#browser-context-close) for the HAR to\nbe saved.",
+          "properties": {
+            "content": {
+              "description": "Optional setting to control resource content management. If `omit` is specified, content is not persisted. If\n`attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is\nspecified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output\nfiles and to `embed` for all other file extensions.",
+              "enum": ["attach", "embed", "omit"],
+              "type": "string"
+            },
+            "mode": {
+              "description": "When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,\ncookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.",
+              "enum": ["full", "minimal"],
+              "type": "string"
+            },
+            "omitContent": {
+              "description": "Optional setting to control whether to omit request content from the HAR. Defaults to `false`. Deprecated, use\n`content` policy instead.",
+              "type": "boolean"
+            },
+            "path": {
+              "description": "Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, `content: 'attach'` is used by\ndefault.",
+              "type": "string"
+            },
+            "urlFilter": {
+              "anyOf": [
+                {
+                  "$ref": "#/definitions/RegExp"
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "description": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor."
+            }
+          },
+          "required": ["path"],
+          "type": "object"
+        },
+        "recordVideo": {
+          "additionalProperties": false,
+          "description": "Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded.\nMake sure to await\n[browserContext.close()](https://playwright.dev/docs/api/class-browsercontext#browser-context-close) for videos to\nbe saved.",
+          "properties": {
+            "dir": {
+              "description": "Path to the directory to put videos into.",
+              "type": "string"
+            },
+            "size": {
+              "additionalProperties": false,
+              "description": "Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to\nfit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of\neach page will be scaled down if necessary to fit the specified size.",
+              "properties": {
+                "height": {
+                  "description": "Video frame height.",
+                  "type": "number"
+                },
+                "width": {
+                  "description": "Video frame width.",
+                  "type": "number"
+                }
+              },
+              "required": ["height", "width"],
+              "type": "object"
+            }
+          },
+          "required": ["dir"],
+          "type": "object"
+        },
+        "reducedMotion": {
+          "anyOf": [
+            {
+              "enum": ["no-preference", "reduce"],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See\n[page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.\nPassing `null` resets emulation to system defaults. Defaults to `'no-preference'`."
+        },
+        "screen": {
+          "additionalProperties": false,
+          "description": "Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the\n`viewport` is set.",
+          "properties": {
+            "height": {
+              "description": "page height in pixels.",
+              "type": "number"
+            },
+            "width": {
+              "description": "page width in pixels.",
+              "type": "number"
+            }
+          },
+          "required": ["height", "width"],
+          "type": "object"
+        },
+        "serviceWorkers": {
+          "description": "Whether to allow sites to register Service workers. Defaults to `'allow'`.\n- `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be\n  registered.\n- `'block'`: Playwright will block all registration of Service Workers.",
+          "enum": ["allow", "block"],
+          "type": "string"
+        },
+        "storageState": {
+          "anyOf": [
+            {
+              "additionalProperties": false,
+              "properties": {
+                "cookies": {
+                  "description": "cookies to set for context",
+                  "items": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "domain": {
+                        "description": "domain and path are required",
+                        "type": "string"
+                      },
+                      "expires": {
+                        "description": "Unix time in seconds.",
+                        "type": "number"
+                      },
+                      "httpOnly": {
+                        "type": "boolean"
+                      },
+                      "name": {
+                        "type": "string"
+                      },
+                      "path": {
+                        "description": "domain and path are required",
+                        "type": "string"
+                      },
+                      "sameSite": {
+                        "description": "sameSite flag",
+                        "enum": ["Lax", "None", "Strict"],
+                        "type": "string"
+                      },
+                      "secure": {
+                        "type": "boolean"
+                      },
+                      "value": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "domain",
+                      "expires",
+                      "httpOnly",
+                      "name",
+                      "path",
+                      "sameSite",
+                      "secure",
+                      "value"
+                    ],
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "origins": {
+                  "description": "localStorage to set for context",
+                  "items": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "localStorage": {
+                        "items": {
+                          "additionalProperties": false,
+                          "properties": {
+                            "name": {
+                              "type": "string"
+                            },
+                            "value": {
+                              "type": "string"
+                            }
+                          },
+                          "required": ["name", "value"],
+                          "type": "object"
+                        },
+                        "type": "array"
+                      },
+                      "origin": {
+                        "type": "string"
+                      }
+                    },
+                    "required": ["localStorage", "origin"],
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
+              },
+              "required": ["cookies", "origins"],
+              "type": "object"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Populates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via\n[browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state).\nEither a path to the file with saved storage, or an object with the following fields:"
+        },
+        "strictSelectors": {
+          "description": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See [Locator] to learn more about the strict\nmode.",
+          "type": "boolean"
+        },
+        "timezoneId": {
+          "description": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.",
+          "type": "string"
+        },
+        "userAgent": {
+          "description": "Specific user agent to use in this context.",
+          "type": "string"
+        },
+        "videoSize": {
+          "additionalProperties": false,
+          "properties": {
+            "height": {
+              "description": "Video frame height.",
+              "type": "number"
+            },
+            "width": {
+              "description": "Video frame width.",
+              "type": "number"
             }
           },
+          "required": ["height", "width"],
           "type": "object"
         },
-        "pageRanges": {
-          "description": "Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.",
+        "videosPath": {
+          "type": "string"
+        },
+        "viewport": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ViewportSize"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport."
+        }
+      },
+      "type": "object"
+    },
+    "Geolocation": {
+      "additionalProperties": false,
+      "properties": {
+        "accuracy": {
+          "description": "Non-negative accuracy value. Defaults to `0`.",
+          "type": "number"
+        },
+        "latitude": {
+          "description": "Latitude between -90 and 90.",
+          "type": "number"
+        },
+        "longitude": {
+          "description": "Longitude between -180 and 180.",
+          "type": "number"
+        }
+      },
+      "required": ["latitude", "longitude"],
+      "type": "object"
+    },
+    "HTTPCredentials": {
+      "additionalProperties": false,
+      "properties": {
+        "password": {
           "type": "string"
         },
-        "path": {
-          "description": "The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. If no path is provided, the PDF won't be saved to the disk.",
+        "username": {
+          "type": "string"
+        }
+      },
+      "required": ["password", "username"],
+      "type": "object"
+    },
+    "Logger": {
+      "additionalProperties": false,
+      "description": "Playwright generates a lot of logs and they are accessible via the pluggable logger sink.\n\n```js\nconst { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.\n\n(async () => {\n  const browser = await chromium.launch({\n    logger: {\n      isEnabled: (name, severity) => name === 'browser',\n      log: (name, severity, message, args) => console.log(`${name} ${message}`)\n    }\n  });\n  ...\n})();\n```",
+      "type": "object"
+    },
+    "RegExp": {
+      "additionalProperties": false,
+      "properties": {
+        "dotAll": {
+          "type": "boolean"
+        },
+        "flags": {
           "type": "string"
         },
-        "preferCSSPageSize": {
-          "description": "Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format`\noptions. Defaults to `false`, which will scale the content to fit the paper size.",
+        "global": {
+          "type": "boolean"
+        },
+        "ignoreCase": {
           "type": "boolean"
         },
-        "printBackground": {
-          "description": "Print background graphics. Defaults to `false`.",
+        "lastIndex": {
+          "type": "number"
+        },
+        "multiline": {
           "type": "boolean"
         },
-        "scale": {
-          "description": "Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.",
+        "source": {
+          "type": "string"
+        },
+        "sticky": {
+          "type": "boolean"
+        },
+        "unicode": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "dotAll",
+        "flags",
+        "global",
+        "ignoreCase",
+        "lastIndex",
+        "multiline",
+        "source",
+        "sticky",
+        "unicode"
+      ],
+      "type": "object"
+    },
+    "ViewportSize": {
+      "additionalProperties": false,
+      "properties": {
+        "height": {
+          "description": "page height in pixels.",
           "type": "number"
         },
         "width": {
-          "description": "Paper width, accepts values labeled with units.",
-          "type": ["string", "number"]
+          "description": "page width in pixels.",
+          "type": "number"
         }
       },
+      "required": ["height", "width"],
       "type": "object"
+    }
+  },
+  "properties": {
+    "browserContextOptions": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/BrowserContextOptions"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "gotoOptions": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "referer": {
+              "description": "Referer header value. If provided it will take preference over the referer header value set by\n[page.setExtraHTTPHeaders(headers)](https://playwright.dev/docs/api/class-page#page-set-extra-http-headers).",
+              "type": "string"
+            },
+            "timeout": {
+              "description": "Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can\nbe changed by using the\n[browserContext.setDefaultNavigationTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout),\n[browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout),\n[page.setDefaultNavigationTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-navigation-timeout)\nor [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods.",
+              "type": "number"
+            },
+            "waitUntil": {
+              "description": "When to consider operation succeeded, defaults to `load`. Events can be either:\n- `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.\n- `'load'` - consider operation to be finished when the `load` event is fired.\n- `'networkidle'` - consider operation to be finished when there are no network connections for at least `500`\n  ms.\n- `'commit'` - consider operation to be finished when network response is received and the document started\n  loading.",
+              "enum": ["commit", "domcontentloaded", "load", "networkidle"],
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "pdfOptions": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "displayHeaderFooter": {
+              "description": "Display header and footer. Defaults to `false`.",
+              "type": "boolean"
+            },
+            "footerTemplate": {
+              "description": "HTML template for the print footer. Should use the same format as the `headerTemplate`.",
+              "type": "string"
+            },
+            "format": {
+              "description": "Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.",
+              "type": "string"
+            },
+            "headerTemplate": {
+              "description": "HTML template for the print header. Should be valid HTML markup with following classes used to inject printing\nvalues into them:\n- `'date'` formatted print date\n- `'title'` document title\n- `'url'` document location\n- `'pageNumber'` current page number\n- `'totalPages'` total pages in the document",
+              "type": "string"
+            },
+            "height": {
+              "description": "Paper height, accepts values labeled with units.",
+              "type": ["string", "number"]
+            },
+            "landscape": {
+              "description": "Paper orientation. Defaults to `false`.",
+              "type": "boolean"
+            },
+            "margin": {
+              "additionalProperties": false,
+              "description": "Paper margins, defaults to none.",
+              "properties": {
+                "bottom": {
+                  "description": "Bottom margin, accepts values labeled with units. Defaults to `0`.",
+                  "type": ["string", "number"]
+                },
+                "left": {
+                  "description": "Left margin, accepts values labeled with units. Defaults to `0`.",
+                  "type": ["string", "number"]
+                },
+                "right": {
+                  "description": "Right margin, accepts values labeled with units. Defaults to `0`.",
+                  "type": ["string", "number"]
+                },
+                "top": {
+                  "description": "Top margin, accepts values labeled with units. Defaults to `0`.",
+                  "type": ["string", "number"]
+                }
+              },
+              "type": "object"
+            },
+            "pageRanges": {
+              "description": "Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.",
+              "type": "string"
+            },
+            "path": {
+              "description": "The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. If no path is provided, the PDF won't be saved to the disk.",
+              "type": "string"
+            },
+            "preferCSSPageSize": {
+              "description": "Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format`\noptions. Defaults to `false`, which will scale the content to fit the paper size.",
+              "type": "boolean"
+            },
+            "printBackground": {
+              "description": "Print background graphics. Defaults to `false`.",
+              "type": "boolean"
+            },
+            "scale": {
+              "description": "Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.",
+              "type": "number"
+            },
+            "width": {
+              "description": "Paper width, accepts values labeled with units.",
+              "type": ["string", "number"]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "url": {
       "type": "string"
     }
   },
+  "required": ["url"],
   "type": "object"
 }

package/server.js

@@ -0,0 +1,29 @@
+import app from "./app.js";
+const SERVER_PORT = process.env["SERVER_PORT"] ?? 8000;
+const SERVER_ADDRESS = process.env["SERVER_ADDRESS"] ?? "localhost";
+
+const server = app({
+  logger: {
+    transport:
+      process.env["NODE_ENV"] !== "production"
+        ? {
+            target: "pino-pretty",
+            options: {
+              translateTime: "HH:MM:ss Z",
+              ignore: "pid,hostname",
+            },
+          }
+        : undefined,
+  },
+});
+
+const startServer = async () => {
+  try {
+    await server.listen({ port: +SERVER_PORT, host: SERVER_ADDRESS });
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+};
+
+startServer();

package/test/app.test.ts

@@ -0,0 +1,226 @@
+import { chromium } from "playwright-core";
+import { afterEach, beforeEach, describe, expect, it, vi, Mock } from "vitest";
+
+import build, {
+  defaultBrowserContextOptions,
+  defaultGotoOptions,
+} from "../app";
+const app = build();
+
+describe("GET /health", () => {
+  it("provides a simple health check", async () => {
+    const response = await app.inject({
+      method: "GET",
+      url: "/health",
+    });
+
+    expect(response.statusCode).toEqual(200);
+  });
+});
+
+vi.mock("playwright-core", () => {
+  const playwright = {
+    chromium: {
+      launch: vi.fn(),
+    },
+  };
+  return playwright;
+});
+
+describe("POST /pdf", () => {
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
+
+  let gotoMethod = vi.fn();
+  let pdf = vi.fn();
+  let newPage = vi.fn();
+  let newContext = vi.fn();
+  let close = vi.fn();
+
+  beforeEach(() => {
+    gotoMethod = vi.fn().mockResolvedValue({
+      ok() {
+        return true;
+      },
+      status() {
+        return 200;
+      },
+    });
+    pdf = vi.fn().mockResolvedValue(Buffer.from("pdf"));
+    newPage = vi.fn().mockResolvedValue({ goto: gotoMethod, pdf });
+    newContext = vi.fn().mockResolvedValue({ newPage });
+    close = vi.fn();
+
+    (chromium.launch as Mock<any[], any>).mockResolvedValue({
+      newContext,
+      close,
+    });
+  });
+
+  it("sends a buffer of the PDF as response", async () => {
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: { url: "/foobar" },
+    });
+
+    expect(gotoMethod).toHaveBeenCalledTimes(1);
+    expect(gotoMethod).toHaveBeenLastCalledWith("/foobar", defaultGotoOptions);
+
+    expect(response.statusCode).toEqual(200);
+    expect(response.payload).toEqual("pdf");
+  });
+
+  it("allows to overwrite gotoOptions but merges them with the defaults", async () => {
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: { url: "/foobar", gotoOptions: { timeout: 300 } },
+    });
+
+    expect(gotoMethod).toHaveBeenCalledWith("/foobar", {
+      timeout: 300,
+      waitUntil: "networkidle",
+    });
+  });
+
+  it("uses the default browserContextOptions if not passed or empty", async () => {
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: { url: "/foobar", browserContextOptions: {} },
+    });
+
+    expect(newContext).toHaveBeenCalledWith(defaultBrowserContextOptions);
+  });
+
+  it("allows to overwrite browserContextOptions", async () => {
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+        browserContextOptions: { ignoreHTTPSErrors: false },
+      },
+    });
+
+    expect(newContext).toHaveBeenCalledWith({
+      ignoreHTTPSErrors: false,
+    });
+  });
+
+  it("returns validation errors", async () => {
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+        gotoOptions: { doesNot: "exist" },
+      },
+    });
+
+    expect(response.statusCode).toEqual(400);
+
+    const parsedResponse = JSON.parse(response.body);
+
+    expect(parsedResponse.error).toBeTruthy();
+    expect(parsedResponse.message).toContain("body/gotoOptions");
+  });
+
+  it("returns error if page could not load", async () => {
+    gotoMethod.mockResolvedValue({
+      ok() {
+        return false;
+      },
+
+      status() {
+        return 404;
+      },
+
+      statusText() {
+        return "Not found";
+      },
+
+      async text() {
+        return "We tried very hard, but could not find the page.";
+      },
+    });
+
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+      },
+    });
+
+    expect(response.statusCode).toEqual(404);
+    const error = JSON.parse(response.body);
+
+    expect(error).toMatchObject({
+      error: true,
+      status: 404,
+      statusText: "Not found",
+      message: "We tried very hard, but could not find the page.",
+    });
+  });
+
+  it("allows to pass options to the pdf call", async () => {
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+        pdfOptions: {
+          headerTemplate: "moin",
+        },
+      },
+    });
+
+    expect(pdf).toHaveBeenCalledWith({ headerTemplate: "moin" });
+  });
+
+  it("returns 500 if something broke", async () => {
+    pdf.mockRejectedValue(new Error("OH NO"));
+
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+      },
+    });
+
+    expect(response.statusCode).toEqual(500);
+    expect(JSON.parse(response.body)).toMatchObject({
+      statusCode: 500,
+      error: "Internal Server Error",
+      message: "OH NO",
+    });
+  });
+
+  it("allows null as empty for options", async () => {
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: { url: "/foobar", gotoOptions: null },
+    });
+
+    expect(gotoMethod).toHaveBeenCalledWith("/foobar", defaultGotoOptions);
+  });
+
+  it("closes the browser", async () => {
+    pdf.mockRejectedValue("OH NO");
+
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "/foobar",
+      },
+    });
+
+    expect(close).toHaveBeenCalled();
+  });
+});

package/tsconfig.json

@@ -7,6 +7,8 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "module": "ESNext",
 
     "checkJs": true
   }

package/types/schemas.ts

@@ -1,7 +1,10 @@
-import { Page } from "playwright-core";
+import { BrowserContextOptions, Page } from "playwright-core";
 
 export type PdfOptions = Parameters<Page["pdf"]>[0];
+export type GotoOptions = Parameters<Page["goto"]>[1];
 export type PdfRequestBody = {
   url: string;
-  options?: PdfOptions;
+  pdfOptions?: PdfOptions | null;
+  gotoOptions?: GotoOptions | null;
+  browserContextOptions?: BrowserContextOptions | null;
 };

package/index.js

@@ -1,95 +0,0 @@
-// @ts-check
-
-/**
- * @typedef {Parameters<import("playwright-core").Page["pdf"]>[0]} PdfOptions
- */
-
-/**
- * @typedef {Object} PdfRequestBody
- * @property {string} url
- * @property {PdfOptions} options
- */
-
-const { fastify } = require("fastify");
-const playwright = require("playwright-core");
-const PdfRequestBodySchema = require("./pdf_request_body.json");
-
-const SERVER_PORT = process.env["SERVER_PORT"] ?? 8000;
-const SERVER_ADDRESS = process.env["SERVER_ADDRESS"] ?? "localhost";
-
-const server = fastify({
-  logger: {
-    transport:
-      process.env["NODE_ENV"] !== "production"
-        ? {
-            target: "pino-pretty",
-            options: {
-              translateTime: "HH:MM:ss Z",
-              ignore: "pid,hostname",
-            },
-          }
-        : undefined,
-  },
-});
-
-/**
- *
- * @param {string} url
- * @param {PdfOptions} options
- * @returns Buffer
- */
-const createPDF = async (url, options = {}) => {
-  const browser = await playwright.chromium.launch();
-  const context = await browser.newContext({ ignoreHTTPSErrors: true });
-  const page = await context.newPage();
-  await page.goto(url, { timeout: 60000 });
-  await page.waitForLoadState("networkidle");
-
-  const pdf = await page.pdf(options);
-  await browser.close();
-
-  return pdf;
-};
-
-server.post(
-  "/pdf",
-  { schema: { body: PdfRequestBodySchema }, attachValidation: true },
-  /**
-   *
-   * @param {import('fastify').FastifyRequest<{Body: PdfRequestBody}>} request
-   * @param {import('fastify').FastifyReply} response
-   */
-  async (request, response) => {
-    if (request.validationError) {
-      response.code(400);
-
-      return {
-        error: true,
-        message: request.validationError.message,
-      };
-    }
-
-    try {
-      return createPDF(request.body.url, request.body.options);
-    } catch (error) {
-      response.code(500);
-
-      return {
-        error,
-      };
-    }
-  }
-);
-
-server.get("/health", async (_, response) => response.code(200).send());
-
-const startServer = async () => {
-  try {
-    await server.listen({ port: +SERVER_PORT, host: SERVER_ADDRESS });
-  } catch (error) {
-    console.error(error);
-    process.exit(1);
-  }
-};
-
-startServer();