chore(decorate)!: Use console to log instead of Arcjet logger (#865)

This switches our `@arcjet/decorate` package to use `console.log` after formatting a string with our new sprintf package. Since I'm removing the singleton logger in #858 and this is a standalone package, it doesn't make sense to require users to inject a logger into this package. I believe libraries like Pino have a way to intercept `console.log` so this should be fine for most usage.
arcjet · Jun 4, 2024 · 39bfcfc · 39bfcfc
1 parent edd99a1
commit 39bfcfc
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 67 deletions.
diff --git a/decorate/index.ts b/decorate/index.ts
@@ -1,4 +1,4 @@
-import logger from "@arcjet/logger";
+import format from "@arcjet/sprintf";
 import {
   ArcjetDecision,
   ArcjetRateLimitReason,
@@ -182,7 +182,7 @@ export function setRateLimitHeaders(
     const policies = new Map<number, number>();
     for (const reason of rateLimitReasons) {
       if (policies.has(reason.max)) {
-        logger.error(
+        console.error(
           "Invalid rate limit policy—two policies should not share the same limit",
         );
         return;
@@ -194,7 +194,7 @@ export function setRateLimitHeaders(
         typeof reason.remaining !== "number" ||
         typeof reason.reset !== "number"
       ) {
-        logger.error("Invalid rate limit encountered: %s", reason);
+        console.error(format("Invalid rate limit encountered: %o", reason));
         return;
       }
 
@@ -218,7 +218,9 @@ export function setRateLimitHeaders(
         typeof decision.reason.remaining !== "number" ||
         typeof decision.reason.reset !== "number"
       ) {
-        logger.error("Invalid rate limit encountered: %s", decision.reason);
+        console.error(
+          format("Invalid rate limit encountered: %o", decision.reason),
+        );
         return;
       }
 
@@ -231,17 +233,21 @@ export function setRateLimitHeaders(
 
   if (isHeaderLike(value)) {
     if (value.has("RateLimit")) {
-      logger.warn(
-        "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
-        value.get("RateLimit"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
+          value.get("RateLimit"),
+          limit,
+        ),
       );
     }
     if (value.has("RateLimit-Policy")) {
-      logger.warn(
-        "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
-        value.get("RateLimit-Policy"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
+          value.get("RateLimit-Policy"),
+          limit,
+        ),
       );
     }
 
@@ -254,17 +260,21 @@ export function setRateLimitHeaders(
 
   if (isResponseLike(value)) {
     if (value.headers.has("RateLimit")) {
-      logger.warn(
-        "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
-        value.headers.get("RateLimit"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
+          value.headers.get("RateLimit"),
+          limit,
+        ),
       );
     }
     if (value.headers.has("RateLimit-Policy")) {
-      logger.warn(
-        "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
-        value.headers.get("RateLimit-Policy"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
+          value.headers.get("RateLimit-Policy"),
+          limit,
+        ),
       );
     }
 
@@ -277,25 +287,29 @@ export function setRateLimitHeaders(
 
   if (isOutgoingMessageLike(value)) {
     if (value.headersSent) {
-      logger.error(
+      console.error(
         "Headers have already been sent—cannot set RateLimit header",
       );
       return;
     }
 
     if (value.hasHeader("RateLimit")) {
-      logger.warn(
-        "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
-        value.getHeader("RateLimit"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit` header\n  Original: %s\n  New: %s",
+          value.getHeader("RateLimit"),
+          limit,
+        ),
       );
     }
 
     if (value.hasHeader("RateLimit-Policy")) {
-      logger.warn(
-        "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
-        value.getHeader("RateLimit-Policy"),
-        limit,
+      console.warn(
+        format(
+          "Response already contains `RateLimit-Policy` header\n  Original: %s\n  New: %s",
+          value.getHeader("RateLimit-Policy"),
+          limit,
+        ),
       );
     }
 
@@ -306,7 +320,7 @@ export function setRateLimitHeaders(
     return;
   }
 
-  logger.debug(
+  console.debug(
     "Cannot determine if response is Response or OutgoingMessage type",
   );
 }
diff --git a/decorate/package.json b/decorate/package.json
@@ -40,8 +40,8 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "dependencies": {
-    "@arcjet/logger": "1.0.0-alpha.13",
-    "@arcjet/protocol": "1.0.0-alpha.13"
+    "@arcjet/protocol": "1.0.0-alpha.13",
+    "@arcjet/sprintf": "1.0.0-alpha.13"
   },
   "devDependencies": {
     "@arcjet/eslint-config": "1.0.0-alpha.13",