Properly bundle node modules to be used by the single binary (#1701)

Author: enisdenjo

.changeset/cold-jokes-check.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/gateway': patch
+---
+
+Properly bundle node modules to be used by the single binary

.gitignore

@@ -20,3 +20,6 @@ memtest-*.svg
 *.heapsnapshot
 *.heapprofile
 *.out
+
+# hidden during isolation testing (see internal/testing/src/isolate.ts)
+HIDDEN_node_modules/

e2e/single-binary-isolate/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@e2e/single-binary-isolate",
+  "private": true
+}

e2e/single-binary-isolate/single-binary-isolate.e2e.ts

@@ -0,0 +1,25 @@
+import { createExampleSetup, createTenv } from '@internal/e2e';
+import { expect, it } from 'vitest';
+
+const { gateway, gatewayRunner } = createTenv(__dirname);
+const {
+  supergraph: createSupergraph,
+  query,
+  result,
+} = createExampleSetup(__dirname);
+
+it.runIf(gatewayRunner === 'bin')('should execute in isolation', async () => {
+  const supergraph = await createSupergraph();
+  const { execute } = await gateway({
+    supergraph,
+    env: {
+      // TODO: run other e2es with this env var
+      HIVE_IMPORTER_ONLY_PACKED_DEPS: 1,
+    },
+  });
+  await expect(
+    execute({
+      query,
+    }),
+  ).resolves.toEqual(result);
+});

packages/gateway/rollup.config.js

@@ -228,6 +228,11 @@ function packagejson() {
           // windows paths don't go in the package.json (just in case, even though we use "/" as pathSep)
           .replace(/\\/g, '/');
 
+        if (bundledFile === 'index.mjs') {
+          // there must be a "main" field for packed node modules in the binary to work
+          pkg.main = 'index.mjs';
+        }
+
         let entryPoint = './' + bundledFile;
         entryPoint = entryPoint.replace(/\.mjs$/, ''); // remove the mjs extension
         entryPoint = entryPoint.replace(/\/index$/, ''); // remove the trailing /index because we dont specify it on import (we don't do "import '@graphql-hive/gateway/index'")

packages/gateway/scripts/install-sea-packed-deps.cjs

@@ -9,7 +9,7 @@
     String(process.env['SEA_CLEAN_PACKED_DEPS']),
   );
   const isDebug = ['1', 'y', 'yes', 't', 'true'].includes(
-    String(process.env['DEBUG']),
+    String(process.env['DEBUG'] || process.env['SEA_DEBUG']),
   );
   /**
    * Will log only when DEBUG env is set to a truthy value.

packages/importer/src/hooks.ts

@@ -113,8 +113,16 @@ export const resolve: module.ResolveHook = async (
       const resolved = resolveFilename(path.join(packedDepsPath, specifier));
       debug(`Possible packed dependency "${specifier}" to "${resolved}"`);
       return await nextResolve(fixSpecifier(resolved, context), context);
-    } catch {
-      // noop
+    } catch (e) {
+      if (
+        ['1', 't', 'true'].includes(
+          process.env['HIVE_IMPORTER_ONLY_PACKED_DEPS'] || '',
+        )
+      ) {
+        throw e; // the importer enforces using only packed deps, mainly used for testing. see single-binary-isolate.e2e.ts
+      } else {
+        // noop
+      }
     }
   }
 

yarn.lock

@@ -3364,6 +3364,12 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@e2e/single-binary-isolate@workspace:e2e/single-binary-isolate":
+  version: 0.0.0-use.local
+  resolution: "@e2e/single-binary-isolate@workspace:e2e/single-binary-isolate"
+  languageName: unknown
+  linkType: soft
+
 "@e2e/subscriptions-cancellation@workspace:e2e/subscriptions-cancellation":
   version: 0.0.0-use.local
   resolution: "@e2e/subscriptions-cancellation@workspace:e2e/subscriptions-cancellation"