Switch to ESM (fixes #406)

Author: textbook

Diff for: README.md

@@ -73,7 +73,6 @@ You can also import the app factory and create your own app:
 
 ```js
 import appFactory from "fauxauth";
-// or `const { default: appFactory } = require("fauxauth");`
 
 const app = appFactory({ callbackUrl: "http://localhost:3001" });
 

Diff for: package.json

@@ -10,11 +10,12 @@
     "build": "npm --workspace packages/fauxauth run build",
     "build:docker": "docker build . --build-arg ALPINE_RELEASE=3.16 --build-arg NODE_RELEASE=$(cat .nvmrc) --tag textbook/fauxauth",
     "e2e": "npm --workspace packages/e2e run e2e",
+    "e2e:custom": "npm --workspace packages/e2e run custom-e2e",
     "pree2e:docker": "npm run build:docker",
     "e2e:docker": "cross-env NODE_RELEASE=$(cat .nvmrc) TAG=latest npm --workspace packages/e2e run docker",
     "install:chromedriver": "npm --workspace packages/e2e run chromedriver",
     "lint": "eslint --ext=js,ts .",
-    "ship": "npm run lint && npm run test && npm run build && npm run e2e",
+    "ship": "npm run lint && npm run test && npm run build && npm run e2e && npm run e2e:custom",
     "test": "npm --workspace packages/fauxauth test"
   },
   "repository": {

Diff for: packages/e2e/fauxauth.spec.js

@@ -1,6 +1,6 @@
-const axios = require("axios");
-const { format, parse, URLSearchParams } = require("url");
-const { remote } = require("webdriverio");
+import axios from "axios";
+import { format, parse, URLSearchParams } from "url";
+import { remote } from "webdriverio";
 
 const baseUrl = process.env.FAUXAUTH_URL || "http://localhost:3000";
 

Diff for: packages/e2e/jest.config.js

@@ -1,7 +1,8 @@
-module.exports = {
+export default {
 	reporters: [
 		"default",
 		["jest-junit", { outputDirectory: "./reports/jest" }],
 	],
 	testTimeout: parseInt(process.env.JEST_TIMEOUT , 10) || 30_000,
+	transform: {},
 };

Diff for: packages/e2e/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "description": "E2E tests for fauxauth",
   "main": "index.js",
+  "type": "module",
   "devDependencies": {
     "axios": "^1.1.3",
     "concurrently": "^7.5.0",
@@ -17,6 +18,7 @@
   },
   "scripts": {
     "chromedriver": "webdriver-manager update --gecko=false --versions.chrome=${CHROME_VERSION:-latest}",
+    "custom-e2e": "concurrently --kill-others --names app,run,sln --success first \"node server.js\" \"npm:e2e:run\" \"npm:e2e:sln\"",
     "predocker": "docker-compose build",
     "docker": "docker-compose run e2e || (npm run postdocker && exit 1)",
     "postdocker": "docker-compose logs fauxauth selenium && docker-compose down",
@@ -25,7 +27,7 @@
     "e2e:run": "npm run test",
     "e2e:sln": "webdriver-manager start",
     "pretest": "wait-on --timeout 30000 --log \"http-get://${SELENIUM_HOST:-localhost}:4444${SELENIUM_PATH:-/wd/hub}\"",
-    "test": "jest"
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "repository": {
     "type": "git",

Diff for: packages/e2e/server.js

@@ -0,0 +1,7 @@
+import appFactory from "fauxauth";
+
+const app = appFactory({});
+const port = parseInt(process.env.PORT ?? "3000", 10);
+
+// eslint-disable-next-line no-console
+app.listen(port, () => console.log(`listening on ${port}`));

Diff for: packages/fauxauth/jest.config.ts

@@ -2,11 +2,18 @@ import { Config } from "@jest/types";
 
 const config: Config.InitialOptions = {
 	coverageDirectory: "./coverage",
-	preset: "ts-jest",
+	extensionsToTreatAsEsm: [".ts"],
+	moduleNameMapper: {
+		"^(\\.{1,2}/.*)\\.js$": "$1",
+	},
+	preset: "ts-jest/presets/default-esm",
 	reporters: [
 		"default",
 		["jest-junit", { outputDirectory: "./reports/jest" }],
 	],
+	transform: {
+		"^.+\\.ts$": ["ts-jest", { useESM: true }],
+	},
 };
 
 export default config;

Diff for: packages/fauxauth/package.json

@@ -7,6 +7,7 @@
   },
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "type": "module",
   "files": [
     "/lib",
     "/views"
@@ -19,7 +20,7 @@
     "build": "tsc --project tsconfig.build.json",
     "postbuild": "chmod u+x ./lib/server.js && cpy ../../README.md packages/fauxauth/",
     "start": "node $npm_package_bin_fauxauth",
-    "test": "jest",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "test:cover": "npm run test -- --coverage",
     "test:watch": "npm run test -- --watch"
   },

Diff for: packages/fauxauth/src/accessToken.integration.spec.ts

@@ -3,7 +3,7 @@ import request from "supertest";
 import { parse } from "url";
 import { parseString } from "xml2js";
 
-import appFactory, { Configuration } from "./index";
+import appFactory, { Configuration } from "./index.js";
 
 describe("access_token endpoint", () => {
 	let app: Application;

Diff for: packages/fauxauth/src/app.ts

@@ -1,19 +1,19 @@
 import cors from "cors";
 import express, { Application } from "express";
 import morgan from "morgan";
-import path from "path";
+import url from "url";
 
-import { Configuration, initialise } from "./config";
-import tokenRouter from "./routes/accessToken";
-import authRouter from "./routes/authorize";
-import configRouter from "./routes/configuration";
+import { Configuration, initialise } from "./config.js";
+import tokenRouter from "./routes/accessToken.js";
+import authRouter from "./routes/authorize.js";
+import configRouter from "./routes/configuration.js";
 
 export default (overrides?: Partial<Configuration>): Application => {
 	const app = express();
 	initialise(overrides);
 
 	app.set("view engine", "pug");
-	app.set("views", path.join(__dirname, "..", "views"));
+	app.set("views", url.fileURLToPath(new URL("../views", import.meta.url)));
 	app.use(cors());
 	app.use(express.json());
 	app.use(express.urlencoded({ extended: false }));

Diff for: packages/fauxauth/src/authorize.integration.spec.ts

@@ -2,7 +2,7 @@ import { Application } from "express";
 import request from "supertest";
 import { format, parse } from "url";
 
-import appFactory, { Configuration } from "./index";
+import appFactory, { Configuration } from "./index.js";
 
 describe("authorize endpoint", () => {
 	const endpoint = "/authorize";

Diff for: packages/fauxauth/src/configuration.integration.spec.ts

@@ -1,7 +1,7 @@
 import { Application } from "express";
 import request from "supertest";
 
-import appFactory, { Configuration } from "./index";
+import appFactory, { Configuration } from "./index.js";
 
 describe("_configure endpoint", () => {
 	const endpoint = "/_configuration";

Diff for: packages/fauxauth/src/index.ts

@@ -1,4 +1,4 @@
-import appFactory from "./app";
+import appFactory from "./app.js";
 export default appFactory;
 
-export { Configuration } from "./config";
+export type { Configuration } from "./config.js";

Diff for: packages/fauxauth/src/routes/accessToken.ts

@@ -2,7 +2,7 @@ import debug from "debug";
 import { Request, Response, Router } from "express";
 import { Builder } from "xml2js";
 
-import { getAll } from "../config";
+import { getAll } from "../config.js";
 
 const log = debug("fauxauth:accessToken");
 

Diff for: packages/fauxauth/src/routes/authorize.spec.ts

@@ -1,4 +1,4 @@
-import { validateRedirect } from "./authorize";
+import { validateRedirect } from "./authorize.js";
 
 describe("validateRedirect function", () => {
 	const callback = "http://example.com/path";

Diff for: packages/fauxauth/src/routes/authorize.ts

@@ -3,8 +3,8 @@ import { Request, Response, Router } from "express";
 import { ParsedUrlQueryInput } from "querystring";
 import { format, URL } from "url";
 
-import { getAll } from "../config";
-import { generateHex } from "../utils";
+import { getAll } from "../config.js";
+import { generateHex } from "../utils.js";
 
 const log = debug("fauxauth:authorize");
 

Diff for: packages/fauxauth/src/routes/configuration.ts

@@ -1,7 +1,7 @@
 import { Request, Response, Router } from "express";
 import jiff from "jiff";
 
-import { Configuration, getAll, reset, update } from "../config";
+import { Configuration, getAll, reset, update } from "../config.js";
 
 const router = Router();
 

Diff for: packages/fauxauth/src/server.ts

@@ -2,7 +2,7 @@
 
 import http from "http";
 
-import appFactory from ".";
+import appFactory from "./index.js";
 
 const port = parseInt(process.env.PORT || "3000", 10);
 

Diff for: packages/fauxauth/src/utils.spec.ts

@@ -1,4 +1,4 @@
-import { generateHex } from "./utils";
+import { generateHex } from "./utils.js";
 
 describe("generateHex function", () => {
 	it("generates valid hex strings", () => {

Diff for: packages/fauxauth/tsconfig.json

@@ -27,9 +27,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
+    "module": "es2020",                                  /* Specify what module code is generated. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    "moduleResolution": "node",                          /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */