chore: add basic E2E tests

.github/workflows/main.yml

@@ -74,7 +74,7 @@ jobs:
         run: yarn --cwd packages/renderer run size
 
   test:
-    name: Run tests (Node.js ${{ matrix.node_version }}; React ${{ matrix.react_version }})
+    name: Run unit tests (Node.js ${{ matrix.node_version }}; React ${{ matrix.react_version }})
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -106,3 +106,36 @@ jobs:
 
       - name: Run tests
         run: REACT_VERSION=${{ matrix.react_version }} yarn test
+
+  e2e-node:
+    name: Run E2E tests (Node.js ${{ matrix.node_version }}; ${{ matrix.cjs_or_esm.toUpperCase() }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        cjs_or_esm: [cjs, esm]
+        node_version: [18, 20, 21]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Cache Yarn cache
+        uses: actions/cache@v4
+        env:
+          cache-name: yarn-cache
+        with:
+          path: ~/.cache/yarn
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node_version }}
+
+      - name: Install dependencies and build
+        run: yarn --frozen-lockfile
+
+      - name: Run E2E tests
+        run: yarn --cwd e2e/node-${{ matrix.cjs_or_esm }} run start

e2e/node-cjs/index.js

@@ -0,0 +1,45 @@
+const fs = require('node:fs/promises');
+const assert = require('node:assert');
+const { test } = require('node:test');
+const { jsx } = require('react/jsx-runtime');
+const { Document, Page, Text, renderToBuffer } = require('@react-pdf/renderer');
+
+const MyDocument = () =>
+  jsx(Document, {
+    children: jsx(Page, {
+      size: 'A4',
+      children: jsx(Text, {
+        children: 'Hello world',
+      }),
+    }),
+  });
+
+function removeMovingParts(buffer) {
+  return Buffer.from(
+    buffer
+      .toString('ascii')
+      .replace(/\(D:[0-9]{14}Z\)/g, '(D:20240101000000Z)')
+      .replace(
+        /\/ID \[.*\]/,
+        '/ID [<00000000000000000000000000000000> <00000000000000000000000000000000>]',
+      ),
+  );
+}
+
+test('rendering a PDF', async () => {
+  const bufferPromise = renderToBuffer(jsx(MyDocument, {}));
+  const referenceBufferPromise = fs.readFile('../reference.pdf');
+
+  const [buffer, referenceBuffer] = await Promise.all([
+    bufferPromise,
+    referenceBufferPromise,
+  ]);
+
+  const bufferAsciiWithIDsRemoved = removeMovingParts(buffer);
+  const referenceBufferAsciiWithIDsRemoved = removeMovingParts(referenceBuffer);
+
+  assert.deepStrictEqual(
+    bufferAsciiWithIDsRemoved,
+    referenceBufferAsciiWithIDsRemoved,
+  );
+});

e2e/node-cjs/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@react-pdf/e2e-node-cjs",
+  "version": "2.0.0",
+  "license": "MIT",
+  "private": true,
+  "type": "commonjs",
+  "author": "Diego Muracciole <[email protected]>",
+  "homepage": "https://github.com/diegomura/react-pdf#readme",
+  "repository": "[email protected]:diegomura/react-pdf.git",
+  "scripts": {
+    "dev": "node --watch ./index.js",
+    "start": "node ./index.js"
+  },
+  "dependencies": {
+    "@react-pdf/renderer": "^3.3.7",
+    "react": "^18.2.0"
+  }
+}

e2e/node-esm/index.js

@@ -0,0 +1,45 @@
+import fs from 'node:fs/promises';
+import assert from 'node:assert';
+import { test } from 'node:test';
+import { jsx } from 'react/jsx-runtime';
+import { Document, Page, Text, renderToBuffer } from '@react-pdf/renderer';
+
+const MyDocument = () =>
+  jsx(Document, {
+    children: jsx(Page, {
+      size: 'A4',
+      children: jsx(Text, {
+        children: 'Hello world',
+      }),
+    }),
+  });
+
+function removeMovingParts(buffer) {
+  return Buffer.from(
+    buffer
+      .toString('ascii')
+      .replace(/\(D:[0-9]{14}Z\)/g, '(D:20240101000000Z)')
+      .replace(
+        /\/ID \[.*\]/,
+        '/ID [<00000000000000000000000000000000> <00000000000000000000000000000000>]',
+      ),
+  );
+}
+
+test('rendering a PDF', async () => {
+  const bufferPromise = renderToBuffer(jsx(MyDocument, {}));
+  const referenceBufferPromise = fs.readFile('../reference.pdf');
+
+  const [buffer, referenceBuffer] = await Promise.all([
+    bufferPromise,
+    referenceBufferPromise,
+  ]);
+
+  const bufferAsciiWithIDsRemoved = removeMovingParts(buffer);
+  const referenceBufferAsciiWithIDsRemoved = removeMovingParts(referenceBuffer);
+
+  assert.deepStrictEqual(
+    bufferAsciiWithIDsRemoved,
+    referenceBufferAsciiWithIDsRemoved,
+  );
+});

e2e/node-esm/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@react-pdf/e2e-node-esm",
+  "version": "2.0.0",
+  "license": "MIT",
+  "private": true,
+  "type": "module",
+  "author": "Diego Muracciole <[email protected]>",
+  "homepage": "https://github.com/diegomura/react-pdf#readme",
+  "repository": "[email protected]:diegomura/react-pdf.git",
+  "scripts": {
+    "dev": "node --watch ./index.js",
+    "start": "node ./index.js"
+  },
+  "dependencies": {
+    "@react-pdf/renderer": "^3.3.7",
+    "react": "^18.2.0"
+  }
+}

lerna.json

@@ -1,5 +1,5 @@
 {
   "version": "independent",
-  "packages": ["packages/*"],
+  "packages": ["packages/*", "e2e/*"],
   "npmClient": "yarn"
 }

package.json

@@ -8,7 +8,8 @@
   "type": "module",
   "repository": "[email protected]:diegomura/react-pdf.git",
   "workspaces": [
-    "packages/*"
+    "packages/*",
+    "e2e/*"
   ],
   "scripts": {
     "prepare": "husky",