npm esm tag

Author: PabloSzx

.babelrc-npm.json

@@ -22,6 +22,14 @@
       "plugins": [
         ["./resources/add-extension-to-import-paths", { "extension": "mjs" }]
       ]
+    },
+    "esm": {
+      "presets": [
+        ["@babel/preset-env", { "modules": false, "targets": { "node": "12" } }]
+      ],
+      "plugins": [
+        ["./resources/add-extension-to-import-paths", { "extension": "js" }]
+      ]
     }
   }
 }

.eslintignore

@@ -3,6 +3,7 @@
 /node_modules
 /coverage
 /npmDist
+/npmEsmDist
 /denoDist
 /npm
 /deno

.eslintrc.yml

@@ -442,6 +442,10 @@ rules:
   yield-star-spacing: off
 
 overrides:
+  - files:
+      - 'integrationTests/node-esm/**/*.js'
+    parserOptions:
+      sourceType: module
   - files: '**/*.ts'
     parser: '@typescript-eslint/parser'
     parserOptions:

.gitignore

@@ -14,3 +14,4 @@
 /denoDist
 /npm
 /deno
+/npmEsmDist

.prettierignore

@@ -4,6 +4,7 @@
 /node_modules
 /coverage
 /npmDist
+/npmEsmDist
 /denoDist
 /npm
 /deno

integrationTests/integration-test.js

@@ -27,6 +27,16 @@ describe('Integration Tests', () => {
     path.join(tmpDir, 'graphql.tgz'),
   );
 
+  const esmDistDir = path.resolve('./npmEsmDist');
+  const esmArchiveName = exec(`npm --quiet pack ${esmDistDir}`, {
+    cwd: tmpDir,
+  });
+
+  fs.renameSync(
+    path.join(tmpDir, esmArchiveName),
+    path.join(tmpDir, 'graphql-esm.tgz'),
+  );
+
   function testOnNodeProject(projectName) {
     const projectPath = path.join(__dirname, projectName);
 
@@ -44,5 +54,6 @@ describe('Integration Tests', () => {
 
   testOnNodeProject('ts');
   testOnNodeProject('node');
+  testOnNodeProject('node-esm');
   testOnNodeProject('webpack');
 });

integrationTests/node-esm/index.js

@@ -0,0 +1,36 @@
+/* eslint-disable node/no-missing-import, import/no-unresolved, node/no-unsupported-features/es-syntax */
+
+import { deepStrictEqual, strictEqual } from 'assert';
+
+import { version } from 'version';
+import { schema } from 'schema';
+
+import { graphqlSync } from 'graphql';
+
+// Import without explicit extension
+import { isPromise } from 'graphql/jsutils/isPromise';
+
+// Import package.json
+import pkg from 'graphql/package.json';
+
+deepStrictEqual(version, pkg.version);
+
+const result = graphqlSync({
+  schema,
+  source: '{ hello }',
+  rootValue: { hello: 'world' },
+});
+
+deepStrictEqual(result, {
+  data: {
+    __proto__: null,
+    hello: 'world',
+  },
+});
+
+strictEqual(isPromise(Promise.resolve()), true);
+
+// The possible promise rejection is handled by "--unhandled-rejections=strict"
+import('graphql/jsutils/isPromise').then((isPromisePkg) => {
+  strictEqual(isPromisePkg.isPromise(Promise.resolve()), true);
+});

integrationTests/node-esm/package.json

@@ -0,0 +1,15 @@
+{
+  "type": "module",
+  "description": "graphql-js ESM should work on all supported node versions",
+  "scripts": {
+    "test": "node test.js"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql-esm.tgz",
+    "node-12": "npm:[email protected]",
+    "node-14": "npm:[email protected]",
+    "node-16": "npm:[email protected]",
+    "schema": "file:./schema",
+    "version": "file:./version"
+  }
+}

integrationTests/node-esm/schema/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "schema",
+  "exports": {
+    ".": {
+      "import": "./schema.mjs"
+    }
+  },
+  "peerDependencies": {
+    "graphql": "*"
+  }
+}

integrationTests/node-esm/schema/schema.mjs

@@ -0,0 +1,3 @@
+import { buildSchema } from 'graphql/utilities';
+
+export const schema = buildSchema('type Query { hello: String }');

integrationTests/node-esm/test.js

@@ -0,0 +1,22 @@
+import { execSync } from 'child_process';
+import { readFileSync } from 'fs';
+import { resolve } from 'path';
+
+const { dependencies } = JSON.parse(
+  readFileSync(resolve('package.json'), 'utf-8'),
+);
+
+const nodeVersions = Object.keys(dependencies)
+  .filter((pkg) => pkg.startsWith('node-'))
+  .sort((a, b) => b.localeCompare(a));
+
+for (const version of nodeVersions) {
+  console.log(`Testing on ${version} ...`);
+
+  const nodePath = resolve('node_modules', version, 'bin/node');
+  execSync(
+    nodePath +
+      ' --experimental-json-modules --unhandled-rejections=strict index.js',
+    { stdio: 'inherit' },
+  );
+}

integrationTests/node-esm/version/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "bar",
+  "type": "module",
+  "main": "./version.js",
+  "peerDependencies": {
+    "graphql": "*"
+  }
+}

integrationTests/node-esm/version/version.js

@@ -0,0 +1,5 @@
+/* eslint-disable import/no-unresolved, node/no-missing-import */
+
+import { version } from 'graphql';
+
+export { version };

integrationTests/ts/esm.ts

@@ -0,0 +1,38 @@
+import type { ExecutionResult } from 'graphql-esm/execution';
+
+import { graphqlSync } from 'graphql-esm';
+import {
+  GraphQLString,
+  GraphQLSchema,
+  GraphQLObjectType,
+} from 'graphql-esm/type';
+
+const queryType: GraphQLObjectType = new GraphQLObjectType({
+  name: 'Query',
+  fields: () => ({
+    sayHi: {
+      type: GraphQLString,
+      args: {
+        who: {
+          type: GraphQLString,
+          defaultValue: 'World',
+        },
+      },
+      resolve(_root, args: { who: string }) {
+        return 'Hello ' + args.who;
+      },
+    },
+  }),
+});
+
+const schema: GraphQLSchema = new GraphQLSchema({ query: queryType });
+
+const result: ExecutionResult = graphqlSync({
+  schema,
+  source: `
+    query helloWho($who: String){
+      test(who: $who)
+    }
+  `,
+  variableValues: { who: 'Dolly' },
+});

integrationTests/ts/package.json

@@ -6,9 +6,11 @@
   },
   "dependencies": {
     "graphql": "file:../graphql.tgz",
+    "graphql-esm": "file:../graphql-esm.tgz",
     "typescript-4.1": "npm:[email protected]",
     "typescript-4.2": "npm:[email protected]",
     "typescript-4.3": "npm:[email protected]",
-    "typescript-4.4": "npm:[email protected]"
+    "typescript-4.4": "npm:[email protected]",
+    "typescript-4.5": "npm:[email protected]"
   }
 }

integrationTests/webpack/entry-esm.mjs

@@ -0,0 +1,13 @@
+// eslint-disable-next-line node/no-missing-import, import/no-unresolved
+import { graphqlSync } from 'graphql-esm';
+
+// eslint-disable-next-line node/no-missing-import, import/no-unresolved
+import { buildSchema } from 'graphql-esm/utilities/buildASTSchema';
+
+const schema = buildSchema('type Query { hello: String }');
+
+export const result = graphqlSync({
+  schema,
+  source: '{ hello }',
+  rootValue: { hello: 'world' },
+});

integrationTests/webpack/package.json

@@ -6,6 +6,7 @@
   },
   "dependencies": {
     "graphql": "file:../graphql.tgz",
+    "graphql-esm": "file:../graphql-esm.tgz",
     "webpack": "5.x.x",
     "webpack-cli": "4.x.x"
   }

integrationTests/webpack/test.js

@@ -3,12 +3,23 @@
 const assert = require('assert');
 
 // eslint-disable-next-line node/no-missing-require
-const { result } = require('./dist/main.js');
+const { result: cjs } = require('./dist/cjs.js');
 
-assert.deepStrictEqual(result, {
+assert.deepStrictEqual(cjs, {
   data: {
     __proto__: null,
     hello: 'world',
   },
 });
+
+// eslint-disable-next-line node/no-missing-require
+const { result: esm } = require('./dist/esm.js');
+
+assert.deepStrictEqual(esm, {
+  data: {
+    __proto__: null,
+    hello: 'world',
+  },
+});
+
 console.log('Test script: Got correct result from Webpack bundle!');

integrationTests/webpack/webpack.config.json

@@ -1,6 +1,9 @@
 {
   "mode": "production",
-  "entry": "./entry.js",
+  "entry": {
+    "cjs": "./entry.js",
+    "esm": "./entry-esm.mjs"
+  },
   "output": {
     "libraryTarget": "commonjs2"
   }

package.json

@@ -44,7 +44,7 @@
     "prettier:check": "prettier --check .",
     "check:spelling": "cspell --cache --no-progress '**/*'",
     "check:integrations": "npm run build:npm && npm run build:deno && mocha --full-trace integrationTests/*-test.js",
-    "build:npm": "node resources/build-npm.js",
+    "build:npm": "node resources/build-npm.js && node resources/build-npm.js --esm-only",
     "build:deno": "node resources/build-deno.js",
     "gitpublish:npm": "bash ./resources/gitpublish.sh npm npmDist",
     "gitpublish:deno": "bash ./resources/gitpublish.sh deno denoDist"