enable conditional exports (#4448)

bun, module, module-sync => ESM
deno, node and require => CJS
default => ESM.

node (in versions that do not support module-sync) point sto CJS even when using import so as to avoid the dual-package hazard.
deno also points to cjs, even though it supports require(esm), see denoland/deno#29970

the require condition points to CJS just because our default is otherwise now ESM.

Author: yaacovCR

cspell.yml

@@ -66,6 +66,7 @@ words:
 
   # TODO: contribute upstream
   - deno
+  - denoland
   - hashbang
   - Rspack
   - Rollup

integrationTests/README.md

@@ -14,6 +14,10 @@ Each subdirectory represents a different environment/bundler:
 - `ts` - tests for supported Typescript versions
 - `webpack` - tests for Webpack
 
+### Verifying Conditional Exports
+
+The `conditions` subdirectory contains tests that verify the conditional exports of GraphQL.js. These tests ensure that the correct files are imported based on the environment being used.
+
 ### Verifying Development Mode Tests
 
 Each subdirectory represents a different environment/bundler demonstrating enabling development mode by setting the environment variable `NODE_ENV` to `development`.

integrationTests/conditions/check.mjs

@@ -0,0 +1,21 @@
+import assert from 'node:assert';
+
+import { GraphQLObjectType as ESMGraphQLObjectType } from 'graphql';
+
+import { CJSGraphQLObjectType, cjsPath } from './cjs-importer.cjs';
+
+const moduleSync = process.env.MODULE_SYNC === 'true';
+const expectedExtension = moduleSync ? '.mjs' : '.js';
+assert.ok(
+  cjsPath.endsWith(expectedExtension),
+  `require('graphql') should resolve to a file with extension "${expectedExtension}", but got "${cjsPath}".`,
+);
+
+const isSameModule = ESMGraphQLObjectType === CJSGraphQLObjectType;
+assert.strictEqual(
+  isSameModule,
+  true,
+  'ESM and CJS imports should be the same module instances.',
+);
+
+console.log('Module identity and path checks passed.');

integrationTests/conditions/cjs-importer.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+const { GraphQLObjectType } = require('graphql');
+
+const cjsPath = require.resolve('graphql');
+
+// eslint-disable-next-line import/no-commonjs
+module.exports = {
+  CJSGraphQLObjectType: GraphQLObjectType,
+  cjsPath,
+};

integrationTests/conditions/package.json

@@ -0,0 +1,10 @@
+{
+  "description": "graphql-js should be loaded correctly on different versions of Node.js, Deno and Bun",
+  "private": true,
+  "scripts": {
+    "test": "node test.js"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql.tgz"
+  }
+}

integrationTests/conditions/test.js

@@ -0,0 +1,31 @@
+import childProcess from 'node:child_process';
+
+const nodeTests = [
+  // Old node versions, require => CJS
+  { version: '20.18.0', moduleSync: false },
+  { version: '22.11.0', moduleSync: false },
+  // New node versions, module-sync => ESM
+  { version: '20.19.0', moduleSync: true },
+  { version: '22.12.0', moduleSync: true },
+  { version: '24.0.0', moduleSync: true },
+];
+
+for (const { version, moduleSync } of nodeTests) {
+  console.log(`Testing on node@${version} (moduleSync: ${moduleSync}) ...`);
+  childProcess.execSync(
+    `docker run --rm --volume "$PWD":/usr/src/app -w /usr/src/app --env MODULE_SYNC=${moduleSync} node:${version}-slim node ./check.mjs`,
+    { stdio: 'inherit' },
+  );
+}
+
+console.log('Testing on bun (moduleSync: true) ...');
+childProcess.execSync(
+  `docker run --rm --volume "$PWD":/usr/src/app -w /usr/src/app --env MODULE_SYNC=true oven/bun:alpine bun ./check.mjs`,
+  { stdio: 'inherit' },
+);
+
+console.log('Testing on deno (moduleSync: false) ...');
+childProcess.execSync(
+  `docker run --rm --volume "$PWD":/usr/src/app -w /usr/src/app --env MODULE_SYNC=false denoland/deno:alpine-2.4.1 deno run --allow-read --allow-env ./check.mjs`,
+  { stdio: 'inherit' },
+);

integrationTests/ts/esm.ts

@@ -18,7 +18,7 @@ const queryType: GraphQLObjectType = new GraphQLObjectType({
           default: { value: 'World' },
         },
       },
-      resolve(_root, args: { who: string }) {
+      resolve(_root: unknown, args: { who: string }) {
         return 'Hello ' + args.who;
       },
     },

integrationTests/ts/extensions-test.ts

@@ -5,6 +5,8 @@ interface SomeExtension {
   meaningOfLife: 42;
 }
 
+// Import added to support deno, which does not scan node_modules automatically.
+import 'graphql';
 declare module 'graphql' {
   interface GraphQLObjectTypeExtensions<_TSource, _TContext> {
     someObjectExtension?: SomeExtension;
@@ -32,7 +34,8 @@ const queryType: GraphQLObjectType = new GraphQLObjectType({
           },
         },
       },
-      resolve: (_root, args) => 'Hello ' + (args.who || 'World'),
+      resolve: (_root: unknown, args: { who: string }) =>
+        'Hello ' + (args.who || 'World'),
       extensions: {
         someFieldExtension: { meaningOfLife: 42 },
       },

integrationTests/ts/package.json

@@ -8,6 +8,7 @@
   "dependencies": {
     "graphql": "file:../graphql.tgz",
     "graphql-esm": "file:../graphql-esm.tgz",
+    "@types/node": "~24.0.10",
     "typescript-4.9": "npm:[email protected]",
     "typescript-5.0": "npm:[email protected]",
     "typescript-5.1": "npm:[email protected]",

integrationTests/ts/test.js

@@ -9,10 +9,16 @@ const tsVersions = Object.keys(dependencies)
   .sort((a, b) => b.localeCompare(a));
 
 for (const version of tsVersions) {
-  console.log(`Testing on ${version} ...`);
+  console.log(`Testing on node ${version} ...`);
   childProcess.execSync(tscPath(version), { stdio: 'inherit' });
 }
 
+console.log('Testing on deno ...');
+childProcess.execSync(
+  `docker run --rm --volume "$PWD":/usr/src/app -w /usr/src/app denoland/deno:alpine-2.4.1 deno check`,
+  { stdio: 'inherit' },
+);
+
 function tscPath(version) {
   return path.join('node_modules', version, 'bin', 'tsc');
 }