add integration tests for dev/prod (#4446)

currently, the only difference between development and production modes is the behavior of the instanceOf() check

"production" mode is currently enabled by setting `process.env.NODE_ENV` to `production` with the default mode being "development" mode.

this PR demonstrates how to enable production mode with node, bun, deno, esbuild, rollup, swc, webpack, and rspack and demonstrates the default of development mode in those environments as well as with jest and vitest.

extracted from #4437

Author: yaacovCR

cspell.yml

@@ -67,6 +67,8 @@ words:
   # TODO: contribute upstream
   - deno
   - hashbang
+  - Rspack
+  - Rollup
 
   # Website tech
   - Nextra

integrationTests/README.md

@@ -1 +1,23 @@
-# TBD
+# Integration Tests
+
+This directory contains integration tests for GraphQL.js across different environments and bundlers, testing basic GraphQL.JS functionality, as well as development mode and production mode behavior.
+
+Tests are run via the main integration test suite in `resources/integration-test.ts`.
+
+## Test Structure
+
+### Basic GraphQL.JS Functionality Tests
+
+Each subdirectory represents a different environment/bundler:
+
+- `node` - tests for supported Node.js versions
+- `ts` - tests for supported Typescript versions
+- `webpack` - tests for Webpack
+
+### Verifying Development Mode Tests
+
+Each subdirectory represents a different environment/bundler demonstrating enabling development mode by setting the environment variable `NODE_ENV` to `development`.
+
+### Verifying Production Mode Tests
+
+Each subdirectory represents a different environment/bundler demonstrating production mode when development mode is not enabled.

integrationTests/dev-bun/package.json

@@ -0,0 +1,10 @@
+{
+  "description": "graphql-js development mode should work with Bun",
+  "private": true,
+  "scripts": {
+    "test": "docker run --rm --volume \"$PWD:/usr/src/app\" -w /usr/src/app oven/bun:latest bun test.js"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql.tgz"
+  }
+}

integrationTests/dev-bun/test.js

@@ -0,0 +1,18 @@
+import { isObjectType } from 'graphql';
+
+class GraphQLObjectType {
+  get [Symbol.toStringTag]() {
+    return 'GraphQLObjectType';
+  }
+}
+
+try {
+  isObjectType(new GraphQLObjectType());
+  throw new Error(
+    'Expected isObjectType to throw an error in Bun development mode.',
+  );
+} catch (error) {
+  if (!error.message.includes('from another module or realm')) {
+    throw error;
+  }
+}

integrationTests/dev-deno/package.json

@@ -0,0 +1,10 @@
+{
+  "description": "graphql-js development mode should work with Deno",
+  "private": true,
+  "scripts": {
+    "test": "docker run --rm --volume \"$PWD:/usr/src/app\" -w /usr/src/app denoland/deno:latest deno run --allow-env=NODE_ENV test.js"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql.tgz"
+  }
+}

integrationTests/dev-deno/test.js

@@ -0,0 +1,18 @@
+import { isObjectType } from 'graphql';
+
+class GraphQLObjectType {
+  get [Symbol.toStringTag]() {
+    return 'GraphQLObjectType';
+  }
+}
+
+try {
+  isObjectType(new GraphQLObjectType());
+  throw new Error(
+    'Expected isObjectType to throw an error in Deno implicit dev mode.',
+  );
+} catch (error) {
+  if (!error.message.includes('from another module or realm')) {
+    throw error;
+  }
+}

integrationTests/dev-esbuild/index.js

@@ -0,0 +1,18 @@
+import { isObjectType } from 'graphql';
+
+class GraphQLObjectType {
+  get [Symbol.toStringTag]() {
+    return 'GraphQLObjectType';
+  }
+}
+
+try {
+  isObjectType(new GraphQLObjectType());
+  throw new Error(
+    'Expected isObjectType to throw an error in esbuild development mode.',
+  );
+} catch (error) {
+  if (!error.message.includes('from another module or realm')) {
+    throw error;
+  }
+}

integrationTests/dev-esbuild/package.json

@@ -0,0 +1,13 @@
+{
+  "description": "graphql-js development mode should work with esbuild",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "esbuild index.js --bundle --outfile=dist/bundle.js --format=esm",
+    "test": "npm run build && node dist/bundle.js"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql.tgz",
+    "esbuild": "^0.25.0"
+  }
+}

integrationTests/dev-jest/index.test.js

@@ -0,0 +1,18 @@
+/* eslint-disable import/unambiguous */
+/* eslint-disable import/no-commonjs */
+/* eslint-disable no-undef */
+const { isObjectType } = require('graphql');
+
+class FakeGraphQLObjectType {
+  get [Symbol.toStringTag]() {
+    return 'GraphQLObjectType';
+  }
+}
+
+describe('Jest with SWC development mode tests', () => {
+  test('isObjectType should throw in development mode for instances from another realm/module', () => {
+    expect(() => isObjectType(new FakeGraphQLObjectType())).toThrowError(
+      /from another module or realm/,
+    );
+  });
+});

integrationTests/dev-jest/package.json

@@ -0,0 +1,14 @@
+{
+  "description": "graphql-js development mode should work with Jest",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "graphql": "file:../graphql.tgz"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}