@graphql-mesh/serve-cli
Version:
151 lines (150 loc) • 7.72 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.defaultOptions = void 0;
exports.defineConfig = defineConfig;
exports.run = run;
exports.handleNodeWarnings = handleNodeWarnings;
exports.enableModuleCachingIfPossible = enableModuleCachingIfPossible;
const tslib_1 = require("tslib");
require("dotenv/config"); // inject dotenv options to process.env
const node_cluster_1 = tslib_1.__importDefault(require("node:cluster"));
const node_module_1 = tslib_1.__importDefault(require("node:module"));
const node_os_1 = require("node:os");
const node_path_1 = require("node:path");
const parse_duration_1 = tslib_1.__importDefault(require("parse-duration"));
const extra_typings_1 = require("@commander-js/extra-typings");
const utils_1 = require("@graphql-mesh/utils");
const index_js_1 = require("./commands/index.js");
const config_js_1 = require("./config.js");
/**
* Type helper for defining the config.
*/
function defineConfig(config) {
return config;
}
// 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((0, node_os_1.availableParallelism)() - 1, 1);
exports.defaultOptions = {
fork: process.env.NODE_ENV === 'production' ? maxAvailableFork : 1,
host: (0, node_os_1.platform)().toLowerCase() === 'win32' ||
// is WSL?
(0, node_os_1.release)().toLowerCase().includes('microsoft')
? '127.0.0.1'
: '0.0.0.0',
port: 4000,
polling: '10s',
};
/** The root cli of serve-cli. */
let cli = new extra_typings_1.Command()
.configureHelp({
// will print help of global options for each command
showGlobalOptions: true,
})
.addOption(new extra_typings_1.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(exports.defaultOptions.fork)}`)
.env('FORK')
.argParser(v => {
const count = parseInt(v);
if (isNaN(count)) {
throw new extra_typings_1.InvalidArgumentError('not a number.');
}
if (count > maxAvailableFork) {
throw new extra_typings_1.InvalidArgumentError(`exceedes number of available parallelism "${maxAvailableFork}".`);
}
return count;
}))
.addOption(new extra_typings_1.Option('-c, --config-path <path>', `path to the configuration file. defaults to the following files respectively in the current working directory: ${(0, config_js_1.createDefaultConfigPaths)('gateway').join(', ')}`).env('CONFIG_PATH'))
.option('-h, --host <hostname>', `host to use for serving (default: ${JSON.stringify(exports.defaultOptions.host)}`, exports.defaultOptions.host)
.addOption(new extra_typings_1.Option('-p, --port <number>', `port to use for serving (default: ${JSON.stringify(exports.defaultOptions.port)}`)
.env('PORT')
.argParser(v => {
const port = parseInt(v);
if (isNaN(port)) {
throw new extra_typings_1.InvalidArgumentError('not a number.');
}
return port;
}))
.addOption(new extra_typings_1.Option('--polling <duration>', `schema polling interval in human readable duration (default: ${JSON.stringify(exports.defaultOptions.polling)})`)
.env('POLLING')
.argParser(v => {
const interval = (0, parse_duration_1.default)(v);
if (!interval) {
throw new extra_typings_1.InvalidArgumentError('not a duration.');
}
return interval;
}))
.option('--no-masked-errors', "don't mask unexpected errors in responses")
.option('--masked-errors', 'mask unexpected errors in responses (default: true)',
// we use "null" intentionally so that we know when the user provided the flag vs when not
// see here https://github.com/tj/commander.js/blob/970ecae402b253de691e6a9066fea22f38fe7431/lib/command.js#L655
null)
.addOption(new extra_typings_1.Option('--hive-registry-token <token>', 'Hive registry token for usage metrics reporting').env('HIVE_REGISTRY_TOKEN'))
.option('--hive-persisted-documents-endpoint <endpoint>', '[EXPERIMENTAL] Hive CDN endpoint for fetching the persisted documents. requires the "--hive-persisted-documents-token <token>" option')
.option('--hive-persisted-documents-token <token>', '[EXPERIMENTAL] Hive persisted documents CDN endpoint. requires the "--hive-persisted-documents-endpoint <endpoint>" option')
.addOption(new extra_typings_1.Option('--hive-cdn-endpoint <endpoint>', 'Hive CDN endpoint for fetching the schema').env('HIVE_CDN_ENDPOINT'))
.addOption(new extra_typings_1.Option('--hive-cdn-key <key>', 'Hive CDN API key for fetching the schema. implies that the "schemaPathOrUrl" argument is a url').env('HIVE_CDN_KEY'))
.addOption(new extra_typings_1.Option('--apollo-graph-ref <graphRef>', 'Apollo graph ref of the managed federation graph (<YOUR_GRAPH_ID>@<VARIANT>)').env('APOLLO_GRAPH_REF'))
.addOption(new extra_typings_1.Option('--apollo-key <apiKey>', 'Apollo API key to use to authenticate with the managed federation up link').env('APOLLO_KEY'))
.option('--disable-websockets', 'Disable WebSockets support')
.addOption(new extra_typings_1.Option('--jit', 'Enable Just-In-Time compilation of GraphQL documents')
.env('JIT')
.argParser(value => {
if (value === 'false' || value === '0') {
return false;
}
if (value === 'true' || value === '1') {
return true;
}
return true;
}));
async function run(userCtx) {
node_module_1.default.register('@graphql-mesh/include/hooks', {
parentURL:
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore bob will complain when bundling for cjs
require('node:url').pathToFileURL(__filename),
data: {
packedDepsPath:
// WILL BE AVAILABLE IN SEA ENVIRONMENTS (see install-sea-packed-deps.cjs and rollup.binary.config.js)
globalThis.__PACKED_DEPS_PATH__ || '',
},
});
const ctx = {
log: new utils_1.DefaultLogger(),
productName: 'Mesh',
productDescription: 'serve GraphQL federated architecture for any API service(s)',
productPackageName: '@graphql-mesh/serve-cli',
productLink: 'https://the-guild.dev/graphql/mesh',
binName: 'mesh-serve',
configFileName: 'mesh.config',
version: globalThis.__VERSION__ || 'dev',
...userCtx,
};
const { binName, productDescription, version } = ctx;
cli = cli.name(binName).description(productDescription);
cli.version(version);
if (node_cluster_1.default.worker?.id) {
ctx.log = ctx.log.child(`Worker #${node_cluster_1.default.worker.id}`);
}
(0, index_js_1.addCommands)(ctx, cli);
return cli.parseAsync();
}
function handleNodeWarnings() {
const originalProcessEmitWarning = process.emitWarning.bind(process);
process.emitWarning = function gatewayEmitWarning(warning, ...opts) {
if (['1', 'y', 'yes', 't', 'true'].includes(String(process.env.DEBUG))) {
originalProcessEmitWarning(warning, ...opts);
}
};
}
function enableModuleCachingIfPossible() {
let cacheDir;
if (globalThis.__PACKED_DEPS_PATH__) {
cacheDir = (0, node_path_1.join)(globalThis.__PACKED_DEPS_PATH__, 'node-compile-cache');
}
// @ts-expect-error - enableCompileCache has recently been added to the module object
if (node_module_1.default.enableCompileCache) {
// @ts-expect-error - enableCompileCache has recently been added to the module object
node_module_1.default.enableCompileCache(cacheDir);
}
}