@graphql-hive/logger 0.0.0

package/dist/request.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+const requestIdByRequest = /* @__PURE__ */ new WeakMap();
+function loggerForRequest(log, request, getId) {
+  let requestId = requestIdByRequest.get(request);
+  if (!requestId) {
+    if (getId === void 0) {
+      return log;
+    }
+    requestId = getId(request);
+    requestIdByRequest.set(request, requestId);
+  }
+  if (log.attrs && "requestId" in log.attrs && log.attrs["requestId"] === requestId) {
+    return log;
+  }
+  return log.child({ requestId });
+}
+
+exports.loggerForRequest = loggerForRequest;
+exports.requestIdByRequest = requestIdByRequest;

package/dist/request.d.cts

@@ -0,0 +1,26 @@
+import { L as Logger } from './Logger-BMj0djMW.js';
+
+declare const requestIdByRequest: WeakMap<Request, string>;
+/** The getter function that extracts the requestID from the {@link request} or creates a new one if none-exist. */
+type GetRequestID = (request: Request) => string;
+/**
+ * Creates a child {@link Logger} under the {@link log given logger} for the {@link request}.
+ *
+ * Request's ID will be stored in the {@link requestIdByRequest} weak map; meaning, all
+ * subsequent calls to this function with the same {@link request} will return the same ID.
+ *
+ * The {@link getId} argument will be used to create a new ID if the {@link request} does not
+ * have one. The convention is to the `X-Request-ID` header or create a new ID which is an
+ * UUID v4.
+ *
+ * On the other hand, if the {@link getId} argument is omitted, the {@link requestIdByRequest} weak
+ * map will be looked up, and if there is no ID stored for the {@link request} - the function
+ * will not attempt to create a new ID and will just return the same {@link log logger}.
+ *
+ * The request ID will be added to the logger attributes under the `requestId` key and
+ * will be logged in every subsequent log.
+ */
+declare function loggerForRequest(log: Logger, request: Request): Logger;
+declare function loggerForRequest(log: Logger, request: Request, getId: GetRequestID): Logger;
+
+export { type GetRequestID, loggerForRequest, requestIdByRequest };

package/dist/request.d.ts

@@ -0,0 +1,26 @@
+import { L as Logger } from './Logger-BMj0djMW.js';
+
+declare const requestIdByRequest: WeakMap<Request, string>;
+/** The getter function that extracts the requestID from the {@link request} or creates a new one if none-exist. */
+type GetRequestID = (request: Request) => string;
+/**
+ * Creates a child {@link Logger} under the {@link log given logger} for the {@link request}.
+ *
+ * Request's ID will be stored in the {@link requestIdByRequest} weak map; meaning, all
+ * subsequent calls to this function with the same {@link request} will return the same ID.
+ *
+ * The {@link getId} argument will be used to create a new ID if the {@link request} does not
+ * have one. The convention is to the `X-Request-ID` header or create a new ID which is an
+ * UUID v4.
+ *
+ * On the other hand, if the {@link getId} argument is omitted, the {@link requestIdByRequest} weak
+ * map will be looked up, and if there is no ID stored for the {@link request} - the function
+ * will not attempt to create a new ID and will just return the same {@link log logger}.
+ *
+ * The request ID will be added to the logger attributes under the `requestId` key and
+ * will be logged in every subsequent log.
+ */
+declare function loggerForRequest(log: Logger, request: Request): Logger;
+declare function loggerForRequest(log: Logger, request: Request, getId: GetRequestID): Logger;
+
+export { type GetRequestID, loggerForRequest, requestIdByRequest };

package/dist/request.js

@@ -0,0 +1,17 @@
+const requestIdByRequest = /* @__PURE__ */ new WeakMap();
+function loggerForRequest(log, request, getId) {
+  let requestId = requestIdByRequest.get(request);
+  if (!requestId) {
+    if (getId === void 0) {
+      return log;
+    }
+    requestId = getId(request);
+    requestIdByRequest.set(request, requestId);
+  }
+  if (log.attrs && "requestId" in log.attrs && log.attrs["requestId"] === requestId) {
+    return log;
+  }
+  return log.child({ requestId });
+}
+
+export { loggerForRequest, requestIdByRequest };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@graphql-hive/logger",
+  "version": "0.0.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphql-hive/gateway.git",
+    "directory": "packages/logger"
+  },
+  "author": {
+    "email": "contact@the-guild.dev",
+    "name": "The Guild",
+    "url": "https://the-guild.dev"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./request": {
+      "require": {
+        "types": "./dist/request.d.cts",
+        "default": "./dist/request.cjs"
+      },
+      "import": {
+        "types": "./dist/request.d.ts",
+        "default": "./dist/request.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll --clean-dist",
+    "prepack": "yarn build"
+  },
+  "devDependencies": {
+    "@types/quick-format-unescaped": "^4.0.3",
+    "fast-safe-stringify": "^2.1.1",
+    "pkgroll": "2.11.2",
+    "quick-format-unescaped": "^4.0.4"
+  },
+  "sideEffects": false
+}