@arcjet/node 1.0.0-alpha.21 → 1.0.0-alpha.22

package/index.d.ts

@@ -15,6 +15,7 @@ export type RemoteClientOptions = {
     timeout?: number;
 };
 export declare function createRemoteClient(options?: RemoteClientOptions): import("@arcjet/protocol/client.js").Client;
+type EventHandlerLike = (event: string, listener: (...args: any[]) => void) => void;
 export interface ArcjetNodeRequest {
     headers?: Record<string, string | string[] | undefined>;
     socket?: Partial<{
@@ -24,6 +25,10 @@ export interface ArcjetNodeRequest {
     method?: string;
     httpVersion?: string;
     url?: string;
+    body?: unknown;
+    on?: EventHandlerLike;
+    removeListener?: EventHandlerLike;
+    readable?: boolean;
 }
 /**
  * The ArcjetNode client provides a public `protect()` method to

package/index.js

@@ -6,7 +6,22 @@ import { logLevel, baseUrl, isDevelopment, platform } from '@arcjet/env';
 import { Logger } from '@arcjet/logger';
 import { createClient } from '@arcjet/protocol/client.js';
 import { createTransport } from '@arcjet/transport';
+import { readBody } from '@arcjet/body';
 
+// TODO: Deduplicate with other packages
+function errorMessage(err) {
+    if (err) {
+        if (typeof err === "string") {
+            return err;
+        }
+        if (typeof err === "object" &&
+            "message" in err &&
+            typeof err.message === "string") {
+            return err.message;
+        }
+    }
+    return "Unknown problem";
+}
 function createRemoteClient(options) {
     // The base URL for the Arcjet API. Will default to the standard production
     // API unless environment variable `ARCJET_BASE_URL` is set.
@@ -17,7 +32,7 @@ function createRemoteClient(options) {
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createTransport(url);
     const sdkStack = "NODEJS";
-    const sdkVersion = "1.0.0-alpha.21";
+    const sdkVersion = "1.0.0-alpha.22";
     return createClient({
         transport,
         baseUrl: url,
@@ -122,7 +137,50 @@ function arcjet(options) {
                 // Further investigation makes it seem like it has something to do with
                 // the definition of `props` in the signature but it's hard to track down
                 const req = toArcjetRequest(request, props ?? {});
-                return aj.protect({}, req);
+                const getBody = async () => {
+                    try {
+                        // If request.body is present then the body was likely read by a package like express' `body-parser`.
+                        // If it's not present then we attempt to read the bytes from the IncomingMessage ourselves.
+                        if (typeof request.body === "string") {
+                            return request.body;
+                        }
+                        else if (typeof request.body !== "undefined" &&
+                            // BigInt cannot be serialized with JSON.stringify
+                            typeof request.body !== "bigint") {
+                            return JSON.stringify(request.body);
+                        }
+                        if (typeof request.on === "function" &&
+                            typeof request.removeListener === "function") {
+                            let expectedLength;
+                            // TODO: This shouldn't need to build headers again but the type
+                            // for `req` above is overly relaxed
+                            const headers = new ArcjetHeaders(request.headers);
+                            const expectedLengthStr = headers.get("content-length");
+                            if (typeof expectedLengthStr === "string") {
+                                try {
+                                    expectedLength = parseInt(expectedLengthStr, 10);
+                                }
+                                catch {
+                                    // If the expected length couldn't be parsed we'll just not set one.
+                                }
+                            }
+                            // Awaited to throw if it rejects and we'll just return undefined
+                            const body = await readBody(request, {
+                                // We will process 1mb bodies
+                                limit: 1048576,
+                                expectedLength,
+                            });
+                            return body;
+                        }
+                        log.warn("no body available");
+                        return;
+                    }
+                    catch (e) {
+                        log.error("failed to get request body: %s", errorMessage(e));
+                        return;
+                    }
+                };
+                return aj.protect({ getBody }, req);
             },
         });
     }

package/index.ts

@@ -15,10 +15,30 @@ import { baseUrl, isDevelopment, logLevel, platform } from "@arcjet/env";
 import { Logger } from "@arcjet/logger";
 import { createClient } from "@arcjet/protocol/client.js";
 import { createTransport } from "@arcjet/transport";
+import { readBody } from "@arcjet/body";
 
 // Re-export all named exports from the generic SDK
 export * from "arcjet";
 
+// TODO: Deduplicate with other packages
+function errorMessage(err: unknown): string {
+  if (err) {
+    if (typeof err === "string") {
+      return err;
+    }
+
+    if (
+      typeof err === "object" &&
+      "message" in err &&
+      typeof err.message === "string"
+    ) {
+      return err.message;
+    }
+  }
+
+  return "Unknown problem";
+}
+
 // Type helpers from https://github.com/sindresorhus/type-fest but adjusted for
 // our use.
 //
@@ -85,6 +105,11 @@ export function createRemoteClient(options?: RemoteClientOptions) {
   });
 }
 
+type EventHandlerLike = (
+  event: string,
+  listener: (...args: any[]) => void,
+) => void;
+
 // Interface of fields that the Arcjet Node.js SDK expects on `IncomingMessage`
 // objects.
 export interface ArcjetNodeRequest {
@@ -93,6 +118,11 @@ export interface ArcjetNodeRequest {
   method?: string;
   httpVersion?: string;
   url?: string;
+  // Things needed for getting a body
+  body?: unknown;
+  on?: EventHandlerLike;
+  removeListener?: EventHandlerLike;
+  readable?: boolean;
 }
 
 function cookiesToString(cookies: string | string[] | undefined): string {
@@ -255,7 +285,54 @@ export default function arcjet<
           ExtraProps<Rules>
         >;
 
-        return aj.protect({}, req);
+        const getBody = async () => {
+          try {
+            // If request.body is present then the body was likely read by a package like express' `body-parser`.
+            // If it's not present then we attempt to read the bytes from the IncomingMessage ourselves.
+            if (typeof request.body === "string") {
+              return request.body;
+            } else if (
+              typeof request.body !== "undefined" &&
+              // BigInt cannot be serialized with JSON.stringify
+              typeof request.body !== "bigint"
+            ) {
+              return JSON.stringify(request.body);
+            }
+
+            if (
+              typeof request.on === "function" &&
+              typeof request.removeListener === "function"
+            ) {
+              let expectedLength: number | undefined;
+              // TODO: This shouldn't need to build headers again but the type
+              // for `req` above is overly relaxed
+              const headers = new ArcjetHeaders(request.headers);
+              const expectedLengthStr = headers.get("content-length");
+              if (typeof expectedLengthStr === "string") {
+                try {
+                  expectedLength = parseInt(expectedLengthStr, 10);
+                } catch {
+                  // If the expected length couldn't be parsed we'll just not set one.
+                }
+              }
+              // Awaited to throw if it rejects and we'll just return undefined
+              const body = await readBody(request, {
+                // We will process 1mb bodies
+                limit: 1048576,
+                expectedLength,
+              });
+              return body;
+            }
+
+            log.warn("no body available");
+            return;
+          } catch (e) {
+            log.error("failed to get request body: %s", errorMessage(e));
+            return;
+          }
+        };
+
+        return aj.protect({ getBody }, req);
       },
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/node",
-  "version": "1.0.0-alpha.21",
+  "version": "1.0.0-alpha.22",
   "description": "Arcjet SDK for Node.js",
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
@@ -40,21 +40,22 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
-    "@arcjet/env": "1.0.0-alpha.21",
-    "@arcjet/headers": "1.0.0-alpha.21",
-    "@arcjet/ip": "1.0.0-alpha.21",
-    "@arcjet/logger": "1.0.0-alpha.21",
-    "@arcjet/protocol": "1.0.0-alpha.21",
-    "@arcjet/transport": "1.0.0-alpha.21",
-    "arcjet": "1.0.0-alpha.21"
+    "@arcjet/env": "1.0.0-alpha.22",
+    "@arcjet/headers": "1.0.0-alpha.22",
+    "@arcjet/ip": "1.0.0-alpha.22",
+    "@arcjet/logger": "1.0.0-alpha.22",
+    "@arcjet/protocol": "1.0.0-alpha.22",
+    "@arcjet/transport": "1.0.0-alpha.22",
+    "@arcjet/body": "1.0.0-alpha.22",
+    "arcjet": "1.0.0-alpha.22"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-alpha.21",
-    "@arcjet/rollup-config": "1.0.0-alpha.21",
-    "@arcjet/tsconfig": "1.0.0-alpha.21",
+    "@arcjet/eslint-config": "1.0.0-alpha.22",
+    "@arcjet/rollup-config": "1.0.0-alpha.22",
+    "@arcjet/tsconfig": "1.0.0-alpha.22",
     "@jest/globals": "29.7.0",
     "@types/node": "18.18.0",
-    "@rollup/wasm-node": "4.20.0",
+    "@rollup/wasm-node": "4.21.0",
     "jest": "29.7.0",
     "typescript": "5.5.4"
   },