bits-to-dead-trees 2.0.0 → 2.1.0

package/.changeset/config.json

@@ -1,6 +1,9 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.0.0/schema.json",
-  "changelog": "@changesets/cli/changelog",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "rmehner/bits-to-dead-trees" }
+  ],
   "commit": false,
   "fixed": [],
   "linked": [],

package/.github/workflows/build-docker-image-of-release.yml

@@ -23,7 +23,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push builder image
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v4
         with:
           file: Dockerfile
           push: true

package/.tool-versions

@@ -1 +1 @@
-nodejs 16.19.0
+nodejs 18.14.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # bits-to-dead-trees
 
+## 2.1.0
+
+### Minor Changes
+
+- [`567b753`](https://github.com/rmehner/bits-to-dead-trees/commit/567b753ca21c6788b246b69b62c484790bc0d478) Thanks [@rmehner](https://github.com/rmehner)! - Upgrade to Playwright 1.13 and Node 18
+
+  This includes new browser versions too!
+
+## 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

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/playwright:v1.30.0-jammy
+FROM mcr.microsoft.com/playwright:v1.31.1-jammy
 
 ENV NODE_ENV=production
 ENV SERVER_PORT=8000

package/README.md

@@ -11,7 +11,7 @@ of that. It's using [Playwright](https://playwright.dev) in the background for t
 
 ### Requirements
 
-1. Node 16+
+1. Node 18+
 2. npm
 
 ### Installation
@@ -57,7 +57,7 @@ If you want to use it internally with docker-compose, this should give you a goo
 ```yml
 services:
   pdf:
-    image: ghcr.io/rmehner/bits-to-dead-trees:v1.0.0
+    image: ghcr.io/rmehner/bits-to-dead-trees:v2.1.0
     ports:
       - 8000:8000
 ```

package/app.js

@@ -54,10 +54,10 @@ const createPDF = async (
 
     const response = await page.goto(url, gotoOptions);
     if (response?.ok()) {
-      return page.pdf(pdfOptions);
+      return await page.pdf(pdfOptions);
     }
 
-    return Promise.reject({
+    return await Promise.reject({
       error: true,
       message: await response?.text(),
       status: response?.status(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bits-to-dead-trees",
   "author": "Robin Mehner <robin@coding-robin.de>",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Turn HTML into PDF files",
   "repository": "github:rmehner/bits-to-dead-trees",
   "license": "Apache-2.0",
@@ -11,7 +11,7 @@
     "playwright"
   ],
   "engines": {
-    "node": ">= 16"
+    "node": ">= 18"
   },
   "main": "server.js",
   "type": "module",
@@ -30,19 +30,20 @@
     "ts-check": "npx tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^4.12.0",
-    "playwright-core": "^1.30.0"
+    "fastify": "^4.13.0",
+    "playwright-core": "^1.31.1"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.0",
     "@types/lodash": "^4.14.191",
-    "eslint": "^8.32.0",
+    "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "nodemon": "^2.0.20",
-    "pino-pretty": "^9.1.1",
-    "prettier": "^2.8.3",
-    "tslib": "^2.4.1",
+    "pino-pretty": "^9.3.0",
+    "prettier": "^2.8.4",
+    "tslib": "^2.5.0",
     "typescript-json-schema": "^0.55.0",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.5"
   }
 }

package/test/app.test.ts

@@ -50,7 +50,6 @@ describe("POST /pdf", () => {
     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,
@@ -223,4 +222,28 @@ describe("POST /pdf", () => {
 
     expect(close).toHaveBeenCalled();
   });
+
+  it("generates the pdf before closing the browser", async () => {
+    let i = 0;
+
+    pdf.mockImplementation(async () => {
+      await new Promise((r) => setTimeout(r, 100));
+
+      return i++;
+    });
+
+    close.mockImplementation(() => {
+      return i++;
+    });
+
+    await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "https://google.com",
+      },
+    });
+
+    expect(pdf.mock.results[0].value).toBeLessThan(close.mock.results[0].value);
+  });
 });

package/test/smoke.test.js

@@ -0,0 +1,36 @@
+import { describe, expect, it } from "vitest";
+
+import build from "../app";
+const app = build();
+
+describe("Smoke tests", () => {
+  it("sends the PDF on the success case", async () => {
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: { url: "https://coding-robin.de" },
+    });
+
+    expect(response.payload.startsWith("%PDF")).toBeTruthy();
+  });
+
+  it("returns an error object when the page could not be loaded", async () => {
+    const response = await app.inject({
+      method: "POST",
+      url: "/pdf",
+      payload: {
+        url: "http://httpbin.org/status/404",
+      },
+    });
+
+    expect(response.statusCode).toEqual(404);
+    const error = JSON.parse(response.body);
+
+    expect(error).toMatchObject({
+      error: true,
+      status: 404,
+      statusText: "NOT FOUND",
+      message: "",
+    });
+  });
+});