enhance(gateway-cli): respect available memory while forking processes

.changeset/serious-buses-learn.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/gateway': patch
+---
+
+Respect available memory on forking the processes not just CPU

packages/gateway/src/cli.ts

@@ -25,6 +25,7 @@ import { DefaultLogger } from '@graphql-mesh/utils';
 import parseDuration from 'parse-duration';
 import { addCommands } from './commands/index';
 import { createDefaultConfigPaths } from './config';
+import { getMaxConcurrency } from './getMaxConcurrency';
 import type { ServerConfig } from './server';
 
 export type GatewayCLIConfig = (
@@ -178,9 +179,9 @@ export type AddCommand = (ctx: CLIContext, cli: CLI) => void;
 
 // we dont use `Option.default()` in the command definitions because we want the CLI options to
 // override the config file (with option defaults, config file will always be overwritten)
-const maxAvailableFork = Math.max(availableParallelism() - 1, 1);
+const maxFork = getMaxConcurrency();
 export const defaultOptions = {
-  fork: process.env['NODE_ENV'] === 'production' ? maxAvailableFork : 1,
+  fork: process.env['NODE_ENV'] === 'production' ? maxFork : 1,
   host:
     platform().toLowerCase() === 'win32' ||
     // is WSL?
@@ -200,17 +201,17 @@ let cli = new Command()
   .addOption(
     new Option(
       '--fork <count>',
-      `count of workers to spawn. uses "${maxAvailableFork}" (available parallelism) workers when NODE_ENV is "production", otherwise "1" (the main) worker (default: ${JSON.stringify(defaultOptions.fork)}`,
+      `count of workers to spawn. uses "${maxFork}" (available parallelism) workers when NODE_ENV is "production", otherwise "1" (the main) worker (default: ${JSON.stringify(defaultOptions.fork)}`,
     )
       .env('FORK')
       .argParser((v) => {
         const count = parseInt(v);
         if (isNaN(count)) {
           throw new InvalidArgumentError('not a number.');
         }
-        if (count > maxAvailableFork) {
+        if (count > maxFork) {
           throw new InvalidArgumentError(
-            `exceedes number of available parallelism "${maxAvailableFork}".`,
+            `exceedes number of available parallelism "${maxFork}".`,
           );
         }
         return count;

packages/gateway/src/getMaxConcurrency.ts

@@ -0,0 +1,21 @@
+import { availableParallelism, freemem } from 'node:os';
+
+function getFreeMemInGb() {
+  return freemem() / 1024 ** 3;
+}
+
+function getMaxConcurrencyPerMem() {
+  return parseInt(String(getFreeMemInGb()));
+}
+
+function getMaxConcurrencyPerCpu() {
+  return availableParallelism();
+}
+
+export function getMaxConcurrency() {
+  const result = Math.min(getMaxConcurrencyPerMem(), getMaxConcurrencyPerCpu());
+  if (result < 1) {
+    return 1;
+  }
+  return result;
+}