Publish as ESM-only

Require Node v20.19 (which enables require(esm) support by default).

This new package is supposed to be compatible with Apollo Server 4 which
does an elaborate dance to publish as both CJS and ESM, but we already
decided it was OK for this package itself to require Node v20.

Turns out CJS-only plays poorly with the AS4-style dual build:
apollographql/apollo-server#8069

And we're likely to go ESM-only with AS5 because newer Node makes this
easier. So let's do that here too.

Making tests work requires:
- Tweaking ts-jest to some new presets.
- Passing an experimental option to Node (and disabling the warning
  about it).
- Upgrading the integration test suite to a version that is dual-built
  instead of CJS-only (otherwise we end up with different ApolloServers
  from the `@apollo/server` we load directly (ESM) and via the
  integration test suite (CJS)).
- I had a lot of trouble getting imports in the tests to work. It ended
  up working if I import from `dist` and are sure to build first, which
  seems wrong. But it works.

Author: glasser

.changeset/modern-kiwis-look.md

@@ -0,0 +1,5 @@
+---
+'@as-integrations/express5': major
+---
+
+Publish as ESM-only, and require Node v20.19 (which enables require(esm) support by default).

jest.config.ts

@@ -1,14 +1,11 @@
-import type { Config } from '@jest/types';
+import type { Config } from 'jest';
+import { createDefaultEsmPreset } from 'ts-jest';
 
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  roots: ['src'],
-  transform: {
-    '/__tests__/.*.test.ts$': ['ts-jest', { tsconfig: 'tsconfig.test.json' }],
-  },
-  testRegex: '/__tests__/.*.test.ts$',
-  verbose: true,
-};
+const presetConfig = createDefaultEsmPreset({
+  tsconfig: 'tsconfig.test.json',
+});
 
-export default config;
+export default {
+  ...presetConfig,
+  testRegex: '/__tests__/.*.test.ts$',
+} satisfies Config;

package-lock.json

@@ -12,10 +12,12 @@
   "bugs": {
     "url": "https://github.com/apollo-server-integrations/apollo-server-integration-express5/issues"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
   "engines": {
-    "node": ">=20"
+    "node": ">=20.19"
   },
   "scripts": {
     "build": "tsc --build tsconfig.build.json",
@@ -27,14 +29,16 @@
     "changeset-check": "changeset status --verbose --since=origin/main",
     "changeset-version": "changeset version && npm i",
     "spell-check": "cspell lint '**' --no-progress || (echo 'Add any real words to cspell-dict.txt.'; exit 1)",
-    "test": "jest",
-    "test:ci": "jest --coverage --ci --maxWorkers=2 --reporters=default --reporters=jest-junit",
+    "pretest": "npm run build",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules --disable-warning=ExperimentalWarning\" jest",
+    "test:ci": "npm run test --coverage --ci --maxWorkers=2 --reporters=default --reporters=jest-junit",
     "watch": "tsc --build --watch",
+    "prelint": "npm run build",
     "lint": "eslint ."
   },
   "devDependencies": {
-    "@apollo/server": "4.12.0",
-    "@apollo/server-integration-testsuite": "4.12.0",
+    "@apollo/server": "4.12.2",
+    "@apollo/server-integration-testsuite": "4.12.2",
     "@apollo/utils.withrequired": "3.0.0",
     "@changesets/changelog-github": "0.5.1",
     "@changesets/cli": "2.29.3",

package.json

@@ -3,10 +3,9 @@ import request from 'supertest';
 import compression, { filter as defaultFilter } from 'compression';
 import type { BaseContext } from '@apollo/server';
 import { ApolloServer } from '@apollo/server';
-import { expressMiddleware } from '..';
+import { expressMiddleware } from '../../dist/index.js';
 import { it, expect } from '@jest/globals';
 import cors from 'cors';
-import { resolvable } from './utils';
 
 it('gives helpful error if json middleware is not installed', async () => {
   const server = new ApolloServer({ typeDefs: 'type Query {f: ID}' });
@@ -203,3 +202,36 @@ it('supporting doubly-encoded variables example from migration guide', async ()
 
   await server.stop();
 });
+
+// Copyright 2019 Joseph Gentle
+
+// Permission to use, copy, modify, and / or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+// FITNESS.IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+//   INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+export type Resolvable<T> = Promise<T> & {
+  resolve: (t: T) => void;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  reject: (e: any) => void;
+};
+
+export function resolvable<T = void>(): Resolvable<T> {
+  let resolve: (val: T) => void;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let reject: (err: any) => void;
+  const promise = new Promise<T>((_resolve, _reject) => {
+    resolve = _resolve;
+    reject = _reject;
+  }) as Resolvable<T>;
+  promise.resolve = resolve!;
+  promise.reject = reject!;
+  return promise;
+}

src/__tests__/expressSpecific.test.ts

@@ -10,8 +10,28 @@ import cors from 'cors';
 import express, { json } from 'express';
 import type { RequestListener } from 'http';
 import http from 'http';
-import { expressMiddleware } from '..';
-import { urlForHttpServer } from './utils';
+import { expressMiddleware } from '../../dist/index.js';
+import type { Server } from 'http';
+import type { AddressInfo } from 'net';
+import { format } from 'url';
+
+export function urlForHttpServer(httpServer: Server): string {
+  const { address, port } = httpServer.address() as AddressInfo;
+
+  // Convert IPs which mean "any address" (IPv4 or IPv6) into localhost
+  // corresponding loopback ip. Note that the url field we're setting is
+  // primarily for consumption by our test suite. If this heuristic is wrong for
+  // your use case, explicitly specify a frontend host (in the `host` option
+  // when listening).
+  const hostname = address === '' || address === '::' ? 'localhost' : address;
+
+  return format({
+    protocol: 'http',
+    hostname,
+    port,
+    pathname: '/',
+  });
+}
 
 defineIntegrationTestSuite(async function (
   serverOptions: ApolloServerOptions<BaseContext>,

src/__tests__/integration.test.ts

@@ -2,10 +2,10 @@
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
-    "target": "es2020",
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "target": "ESNext",
+    "module": "NodeNext",
     "esModuleInterop": true,
+    "isolatedModules": true,
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,