use template literals

enisdenjo · enisdenjo · commit 7184bde516d9 · 2025-06-05T14:50:08.000+02:00
diff --git a/packages/gateway/src/commands/handleFork.ts b/packages/gateway/src/commands/handleFork.ts
@@ -10,7 +10,7 @@ export function handleFork(log: Logger, config: { fork?: number }): boolean {
     if (cluster.isPrimary && config.fork && config.fork > 1) {
       const workers = new Set<Worker>();
       let expectedToExit = false;
-      log.debug('Forking %d workers', config.fork);
+      log.debug(`Forking ${config.fork} workers`);
       for (let i = 0; i < config.fork; i++) {
         const worker = cluster.fork();
         const workerLogger = log.child({ worker: worker.id });
@@ -38,7 +38,7 @@ export function handleFork(log: Logger, config: { fork?: number }): boolean {
         workers.add(worker);
       }
       registerTerminateHandler((signal) => {
-        log.info('Killing workers on %s', signal);
+        log.info(`Killing workers on ${signal}`);
         expectedToExit = true;
         workers.forEach((w) => {
           w.kill(signal);
diff --git a/packages/gateway/src/commands/supergraph.ts b/packages/gateway/src/commands/supergraph.ts
@@ -79,15 +79,14 @@ export const addCommand: AddCommand = (ctx, cli) =>
       let supergraph:
         | UnifiedGraphConfig
         | GatewayHiveCDNOptions
-        | GatewayGraphOSManagedFederationOptions = 'supergraph.graphql';
+        | GatewayGraphOSManagedFederationOptions = './supergraph.graphql';
       if (schemaPathOrUrl) {
-        ctx.log.info('Supergraph will be loaded from %s', schemaPathOrUrl);
+        ctx.log.info(`Supergraph will be loaded from ${schemaPathOrUrl}`);
         if (hiveCdnKey) {
           ctx.log.info('Using Hive CDN key');
           if (!isUrl(schemaPathOrUrl)) {
             ctx.log.error(
-              'Hive CDN endpoint must be a URL when providing --hive-cdn-key but got %s',
-              schemaPathOrUrl,
+              `Hive CDN endpoint must be a URL when providing --hive-cdn-key but got ${schemaPathOrUrl}`,
             );
             process.exit(1);
           }
@@ -100,8 +99,7 @@ export const addCommand: AddCommand = (ctx, cli) =>
           ctx.log.info('Using GraphOS API key');
           if (!schemaPathOrUrl.includes('@')) {
             ctx.log.error(
-              `Apollo GraphOS requires a graph ref in the format <graph-id>@<graph-variant> when providing --apollo-key. Please provide a valid graph ref not %s.`,
-              schemaPathOrUrl,
+              `Apollo GraphOS requires a graph ref in the format <graph-id>@<graph-variant> when providing --apollo-key. Please provide a valid graph ref not ${schemaPathOrUrl}.`,
             );
             process.exit(1);
           }
@@ -128,7 +126,7 @@ export const addCommand: AddCommand = (ctx, cli) =>
           );
           process.exit(1);
         }
-        ctx.log.info('Using Hive CDN endpoint %s', hiveCdnEndpoint);
+        ctx.log.info(`Using Hive CDN endpoint ${hiveCdnEndpoint}`);
         supergraph = {
           type: 'hive',
           endpoint: hiveCdnEndpoint,
@@ -137,8 +135,7 @@ export const addCommand: AddCommand = (ctx, cli) =>
       } else if (apolloGraphRef) {
         if (!apolloGraphRef.includes('@')) {
           ctx.log.error(
-            'Apollo GraphOS requires a graph ref in the format <graph-id>@<graph-variant>. Please provide a valid graph ref not %s.',
-            apolloGraphRef,
+            `Apollo GraphOS requires a graph ref in the format <graph-id>@<graph-variant>. Please provide a valid graph ref not ${apolloGraphRef}.`,
           );
           process.exit(1);
         }
@@ -148,7 +145,7 @@ export const addCommand: AddCommand = (ctx, cli) =>
           );
           process.exit(1);
         }
-        ctx.log.info('Using Apollo Graph Ref %s', apolloGraphRef);
+        ctx.log.info(`Using Apollo Graph Ref ${apolloGraphRef}`);
         supergraph = {
           type: 'graphos',
           apiKey: apolloKey,
@@ -159,7 +156,7 @@ export const addCommand: AddCommand = (ctx, cli) =>
         supergraph = loadedConfig.supergraph!; // TODO: assertion wont be necessary when exactOptionalPropertyTypes
         // TODO: how to provide hive-cdn-key?
       } else {
-        ctx.log.info('Using default supergraph location %s', supergraph);
+        ctx.log.info(`Using default supergraph location "${supergraph}"`);
       }
 
       const registryConfig: Pick<SupergraphConfig, 'reporting'> = {};
@@ -276,13 +273,13 @@ export async function runSupergraph(
     absSchemaPath = isAbsolute(supergraphPath)
       ? String(supergraphPath)
       : resolve(process.cwd(), supergraphPath);
-    log.info('Reading supergraph from %s', absSchemaPath);
+    log.info({ path: absSchemaPath }, 'Reading supergraph');
     try {
       await lstat(absSchemaPath);
-    } catch {
+    } catch (err) {
       log.error(
-        'Could not read supergraph from %s. Make sure the file exists.',
-        absSchemaPath,
+        { path: absSchemaPath, err },
+        'Could not read supergraph. Make sure the file exists.',
       );
       process.exit(1);
     }
@@ -292,11 +289,14 @@ export async function runSupergraph(
     // Polling should not be enabled when watching the file
     delete config.pollingInterval;
     if (cluster.isPrimary) {
-      log.info('Watching %s for changes', absSchemaPath);
+      log.info({ path: absSchemaPath }, 'Watching supergraph for changes');
 
       const ctrl = new AbortController();
       registerTerminateHandler((signal) => {
-        log.info('Closing watcher for %s on %s', absSchemaPath, signal);
+        log.info(
+          { path: absSchemaPath },
+          `Closing watcher for supergraph on ${signal}`,
+        );
         return ctrl.abort(`Process terminated on ${signal}`);
       });
 
@@ -308,7 +308,10 @@ export async function runSupergraph(
             // TODO: or should we just ignore?
             throw new Error(`Supergraph file was renamed to "${f.filename}"`);
           }
-          log.info('%s changed. Invalidating supergraph...', absSchemaPath);
+          log.info(
+            { path: absSchemaPath },
+            'Supergraph changed. Invalidating...',
+          );
           if (config.fork && config.fork > 1) {
             for (const workerId in cluster.workers) {
               cluster.workers[workerId]!.send('invalidateUnifiedGraph');
@@ -321,10 +324,16 @@ export async function runSupergraph(
       })()
         .catch((e) => {
           if (e.name === 'AbortError') return;
-          log.error(e, 'Watcher for %s closed with an error', absSchemaPath);
+          log.error(
+            { path: absSchemaPath, err: e },
+            'Supergraph watcher closed with an error',
+          );
         })
         .then(() => {
-          log.info('Watcher for %s successfuly closed', absSchemaPath);
+          log.info(
+            { path: absSchemaPath },
+            'Supergraph watcher successfuly closed',
+          );
         });
     }
   }
@@ -359,17 +368,17 @@ export async function runSupergraph(
   const runtime = createGatewayRuntime(config);
 
   if (absSchemaPath) {
-    log.info('Serving local supergraph from %s', absSchemaPath);
+    log.info({ path: absSchemaPath }, 'Serving local supergraph');
   } else if (isUrl(String(config.supergraph))) {
-    log.info('Serving remote supergraph from %s', config.supergraph);
+    log.info({ url: config.supergraph }, 'Serving remote supergraph');
   } else if (
     typeof config.supergraph === 'object' &&
     'type' in config.supergraph &&
     config.supergraph.type === 'hive'
   ) {
     log.info(
-      'Serving supergraph from Hive CDN at %s',
-      config.supergraph.endpoint,
+      { endpoint: config.supergraph.endpoint },
+      'Serving supergraph from Hive CDN',
     );
   } else {
     log.info('Serving supergraph from config');
diff --git a/packages/gateway/src/servers/bun.ts b/packages/gateway/src/servers/bun.ts
@@ -64,6 +64,6 @@ export async function startBunServer<TContext extends Record<string, any>>(
     };
   }
   const server = Bun.serve(serverOptions);
-  opts.log.info('Listening on %s', server.url);
+  opts.log.info(`Listening on ${server.url}`);
   gwRuntime.disposableStack.use(server);
 }
diff --git a/packages/gateway/src/servers/nodeHttp.ts b/packages/gateway/src/servers/nodeHttp.ts
@@ -77,7 +77,7 @@ export async function startNodeHttpServer<TContext extends Record<string, any>>(
 
   const url = `${protocol}://${host}:${port}`.replace('0.0.0.0', 'localhost');
 
-  log.debug('Starting server on %s', url);
+  log.debug(`Starting server on ${url}`);
   if (!disableWebsockets) {
     log.debug('Setting up WebSocket server');
     const { WebSocketServer } = await import('ws');
@@ -112,7 +112,7 @@ export async function startNodeHttpServer<TContext extends Record<string, any>>(
   return new Promise((resolve, reject) => {
     server.once('error', reject);
     server.listen(port, host, () => {
-      log.info('Listening on %s', url);
+      log.info(`Listening on ${url}`);
       gwRuntime.disposableStack.defer(
         () =>
           new Promise<void>((resolve) => {
diff --git a/packages/plugins/hmac-upstream-signature/src/index.ts b/packages/plugins/hmac-upstream-signature/src/index.ts
@@ -100,12 +100,11 @@ export function useHmacUpstreamSignature(
       log: rootLog,
     }) {
       const log = rootLog.child('[useHmacUpstreamSignature] ');
-      log.debug('Running shouldSign for subgraph %s', subgraphName);
+      log.debug(`Running shouldSign for subgraph ${subgraphName}`);
 
       if (shouldSign({ subgraphName, subgraph, executionRequest })) {
         log.debug(
-          'shouldSign is true for subgraph %s, signing request',
-          subgraphName,
+          `shouldSign is true for subgraph ${subgraphName}, signing request`,
         );
         textEncoder ||= new fetchAPI.TextEncoder();
         return handleMaybePromise(
@@ -134,8 +133,7 @@ export function useHmacUpstreamSignature(
                     signature: extensionValue,
                     payload: serializedExecutionRequest,
                   },
-                  'Produced hmac signature for subgraph %s',
-                  subgraphName,
+                  `Produced hmac signature for subgraph ${subgraphName}`,
                 );
 
                 if (!executionRequest.extensions) {
@@ -205,8 +203,8 @@ export function useHmacSignatureValidation(
           );
           const serializedParams = paramsSerializer(params);
           log.debug(
-            'HMAC signature will be calculate based on serialized params %s',
-            serializedParams,
+            { serializedParams },
+            'HMAC signature will be calculate based on serialized params',
           );
 
           return handleMaybePromise(
diff --git a/packages/plugins/jwt-auth/src/index.ts b/packages/plugins/jwt-auth/src/index.ts
@@ -88,8 +88,7 @@ export function useJWT(
 
         log.debug(
           { payload: jwtData.payload },
-          '[useJWT] Forwarding JWT payload to subgraph %s',
-          subgraphName,
+          `[useJWT] Forwarding JWT payload to subgraph ${subgraphName}`,
         );
 
         setExecutionRequest({
diff --git a/packages/runtime/src/fetchers/graphos.ts b/packages/runtime/src/fetchers/graphos.ts
@@ -81,8 +81,7 @@ export function createGraphOSFetcher({
           if (nextFetchTime >= currentTime) {
             const delay = nextFetchTime - currentTime;
             log.info(
-              'Fetching supergraph with delay %s',
-              millisecondsToStr(delay),
+              `Fetching supergraph with delay ${millisecondsToStr(delay)}`,
             );
             nextFetchTime = 0;
             return delayInMs(delay).then(fetchSupergraph);
diff --git a/packages/runtime/src/plugins/useWebhooks.ts b/packages/runtime/src/plugins/useWebhooks.ts
@@ -34,14 +34,13 @@ export function useWebhooks({
       const expectedEventName = `webhook:${requestMethod}:${pathname}`;
       for (const eventName of eventNames) {
         if (eventName === expectedEventName) {
-          log.debug('Received webhook request for %s', pathname);
+          log.debug({ pathname }, 'Received webhook request');
           return handleMaybePromise(
             () => request.text(),
             function handleWebhookPayload(webhookPayload) {
               log.debug(
-                { payload: webhookPayload },
-                'Emitted webhook request for %s',
-                pathname,
+                { pathname, payload: webhookPayload },
+                'Emitted webhook request',
               );
               webhookPayload =
                 request.headers.get('content-type') === 'application/json'
diff --git a/packages/transports/http-callback/src/index.ts b/packages/transports/http-callback/src/index.ts
@@ -139,9 +139,8 @@ export default {
         }, heartbeatIntervalMs),
       );
       log.debug(
-        'Subscribing to %s with callbackUrl: %s',
-        transportEntry.location,
-        callbackUrl,
+        { location: transportEntry.location, callbackUrl },
+        'Subscribing using callback',
       );
       let pushFn: Push<ExecutionResult> = () => {
         throw new Error(
@@ -248,14 +247,13 @@ export default {
         pushFn = push;
         stopSubscription = stop;
         stopFnSet.add(stop);
-        log.debug('Listening to %s', subscriptionCallbackPath);
+        log.debug(`Listening to ${subscriptionCallbackPath}`);
         const subId = pubsub.subscribe(
           `webhook:post:${subscriptionCallbackPath}`,
           (message: HTTPCallbackMessage) => {
             log.debug(
               message,
-              'Received message from %s',
-              subscriptionCallbackPath,
+              `Received message from ${subscriptionCallbackPath}`,
             );
             if (message.verifier !== verifier) {
               return;

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,6 @@ export async function startBunServer<TContext extends Record<string, any>>(`
`64`	`64`	`};`
`65`	`65`	`}`
`66`	`66`	`const server = Bun.serve(serverOptions);`
`67`		`- opts.log.info('Listening on %s', server.url);`
	`67`	+ opts.log.info(`Listening on ${server.url}`);
`68`	`68`	`gwRuntime.disposableStack.use(server);`
`69`	`69`	`}`