This respository is meant to demonstrate the use case that my organization uses JSDOM for one of its projects.

Specifically, our project is an SDK library that includes a set of tools that streamline creating server-side rendered a JavaScript applications.

Architecture

SDK → server.js

The server class instantiates an express app. The server's primary purpose is to server-side render static HTML from the JavaScript app.

The server is intended to work in a local dev environment as well as in a remote environment (i.e. AWS Lambda).

App → app.js

The app is what developers build using the SDK. The app assumes the SDK will provide the working server that the app can be delivered from.

The app would normally be a React app, but for demonstration purposes, it's just a JavaScript that generates some simple DOM elements that will be rendered on the server.

The app.js file does two things:

Creates server instance using the SDK server module
Creates a front-end JS application that the server will render

The app.js file is packaged with Webpack to be distributed to an AWS Lambda.

How to test

Pre-requisites

Run npm ci (or npm i) and then node_modules/.bin/lerna bootstrap

Run the App

From this project root run cd packages/app
Run npm run build
Observe the error in the console. You should see something like this:

ERROR in ../sdk/~/jsdom/lib/jsdom/utils.js
    Module not found: Error: Can't resolve 'canvas' in '/Users/Atsushi/lab/jsdom-use-case/packages/sdk/node_modules/jsdom/lib/jsdom'
     @ ../sdk/~/jsdom/lib/jsdom/utils.js 166:2-27 172:17-34
     @ ../sdk/~/jsdom/lib/jsdom/browser/Window.js
     @ ../sdk/~/jsdom/lib/api.js
     @ ../sdk/index.js
     @ ./server.js

Notice that this error appears in the App project. This means that its the users of the SDK who are burdened with the error. There are work arounds that can be applied at the app project level, but we (the SDK developers) would rather apply a fix at the SDK level.

Workaround

The error above can be bypassed by the following (horrible) hack:

From this project root run cd packages/sdk
Open node_modules/jsdom/lib/jsdom/utils.js

Delete or comment out the following lines...

let canvasInstalled = false;
try {
  require.resolve("canvas");
  canvasInstalled = true;
} catch (e) {
  // canvas is not installed
}
if (canvasInstalled) {
  const Canvas = require("canvas");
  if (typeof Canvas.createCanvas === "function") {
    // In browserify, the require will succeed but return an empty object
    exports.Canvas = Canvas;
  }
}

Repeat the "Run the App" steps above. The server should start now
Visit http://localhost:9000/

jeffkamo / jsdom-use-case