bits-to-dead-trees 1.5.1 → 2.0.1

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,49 @@
 # bits-to-dead-trees
 
+## 2.0.1
+
+### Patch Changes
+
+- 57d032f: Don't close browser if it's currently creating a PDF. We've added smoke tests, so
+  this shouldn't happen again. Sorry!
+
+## 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 await page.pdf(pdfOptions);
+    }
+
+    return await 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.1",
   "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.33.0",
     "eslint-config-prettier": "^8.6.0",
     "nodemon": "^2.0.20",
     "pino-pretty": "^9.1.1",
-    "prettier": "^2.8.2",
-    "tslib": "^2.4.1",
-    "typescript-json-schema": "^0.55.0"
+    "prettier": "^2.8.3",
+    "tslib": "^2.5.0",
+    "typescript-json-schema": "^0.55.0",
+    "vitest": "^0.28.3"
   }
 }