feat!: Separate @arcjet/headers package from core (#824)

Closes #224 This separates the `ArcjetHeaders` package into its own package. This means it is no longer exported from `arcjet` and anyone consuming it will need to depend on `@arcjet/headers` directly. Separating it out gave me a chance to think through unnatural usage in non-TypeScript environments so I added tests and guards around those situations. Having this package separate will allow us to improve/fix it independent of arcjet core.
arcjet · May 28, 2024 · c8364f4 · c8364f4
1 parent 8b1c811
commit c8364f4
Show file tree

Hide file tree

Showing 25 changed files with 751 additions and 116 deletions.
diff --git a/.github/.release-please-manifest.json b/.github/.release-please-manifest.json
@@ -9,6 +9,7 @@
   "decorate": "1.0.0-alpha.13",
   "duration": "1.0.0-alpha.13",
   "eslint-config": "1.0.0-alpha.13",
+  "headers": "1.0.0-alpha.13",
   "ip": "1.0.0-alpha.13",
   "logger": "1.0.0-alpha.13",
   "protocol": "1.0.0-alpha.13",

diff --git a/.github/release-please-config.json b/.github/release-please-config.json
@@ -65,6 +65,10 @@
       "component": "@arcjet/eslint-config",
       "skip-github-release": true
     },
+    "headers": {
+      "component": "@arcjet/headers",
+      "skip-github-release": true
+    },
     "ip": {
       "component": "@arcjet/ip",
       "skip-github-release": true
@@ -105,6 +109,7 @@
         "@arjcet/decorate",
         "@arjcet/duration",
         "@arcjet/eslint-config",
+        "@arcjet/headers",
         "@arcjet/ip",
         "@arcjet/logger",
         "@arcjet/protocol",

diff --git a/arcjet-bun/index.ts b/arcjet-bun/index.ts
@@ -5,7 +5,6 @@ import core, {
   ArcjetOptions,
   Primitive,
   Product,
-  ArcjetHeaders,
   Runtime,
   ArcjetRequest,
   ExtraProps,
@@ -16,6 +15,7 @@ import core, {
   Arcjet,
 } from "arcjet";
 import findIP from "@arcjet/ip";
+import ArcjetHeaders from "@arcjet/headers";
 import type { Server } from "bun";
 
 // Re-export all named exports from the generic SDK

diff --git a/arcjet-bun/package.json b/arcjet-bun/package.json
@@ -38,6 +38,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
+    "@arcjet/headers": "1.0.0-alpha.13",
     "@arcjet/ip": "1.0.0-alpha.13",
     "@connectrpc/connect-node": "1.4.0",
     "arcjet": "1.0.0-alpha.13"

diff --git a/arcjet-next/index.ts b/arcjet-next/index.ts
@@ -12,7 +12,6 @@ import arcjet, {
   ArcjetOptions,
   Primitive,
   Product,
-  ArcjetHeaders,
   Runtime,
   ArcjetRequest,
   ExtraProps,
@@ -23,6 +22,7 @@ import arcjet, {
   Arcjet,
 } from "arcjet";
 import findIP from "@arcjet/ip";
+import ArcjetHeaders from "@arcjet/headers";
 
 // Re-export all named exports from the generic SDK
 export * from "arcjet";

diff --git a/arcjet-next/package.json b/arcjet-next/package.json
@@ -40,6 +40,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
+    "@arcjet/headers": "1.0.0-alpha.13",
     "@arcjet/ip": "1.0.0-alpha.13",
     "@connectrpc/connect-web": "1.4.0",
     "arcjet": "1.0.0-alpha.13"

diff --git a/arcjet-node/index.ts b/arcjet-node/index.ts
@@ -4,7 +4,6 @@ import core, {
   ArcjetOptions,
   Primitive,
   Product,
-  ArcjetHeaders,
   Runtime,
   ArcjetRequest,
   ExtraProps,
@@ -15,6 +14,7 @@ import core, {
   Arcjet,
 } from "arcjet";
 import findIP from "@arcjet/ip";
+import ArcjetHeaders from "@arcjet/headers";
 
 // Re-export all named exports from the generic SDK
 export * from "arcjet";

diff --git a/arcjet-node/package.json b/arcjet-node/package.json
@@ -40,6 +40,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
+    "@arcjet/headers": "1.0.0-alpha.13",
     "@arcjet/ip": "1.0.0-alpha.13",
     "@connectrpc/connect-node": "1.4.0",
     "arcjet": "1.0.0-alpha.13"

diff --git a/arcjet-sveltekit/index.ts b/arcjet-sveltekit/index.ts
@@ -5,7 +5,6 @@ import core, {
   ArcjetOptions,
   Primitive,
   Product,
-  ArcjetHeaders,
   Runtime,
   ArcjetRequest,
   ExtraProps,
@@ -16,6 +15,7 @@ import core, {
   Arcjet,
 } from "arcjet";
 import findIP from "@arcjet/ip";
+import ArcjetHeaders from "@arcjet/headers";
 
 // Re-export all named exports from the generic SDK
 export * from "arcjet";

diff --git a/arcjet-sveltekit/package.json b/arcjet-sveltekit/package.json
@@ -40,6 +40,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
+    "@arcjet/headers": "1.0.0-alpha.13",
     "@arcjet/ip": "1.0.0-alpha.13",
     "@connectrpc/connect-node": "1.4.0",
     "@connectrpc/connect-web": "1.4.0",

diff --git a/arcjet/index.ts b/arcjet/index.ts
@@ -40,6 +40,7 @@ import {
 import * as analyze from "@arcjet/analyze";
 import * as duration from "@arcjet/duration";
 import logger from "@arcjet/logger";
+import ArcjetHeaders from "@arcjet/headers";
 
 export * from "@arcjet/protocol";
 
@@ -49,10 +50,6 @@ function assert(condition: boolean, msg: string) {
   }
 }
 
-function isIterable(val: any): val is Iterable<any> {
-  return typeof val?.[Symbol.iterator] === "function";
-}
-
 function nowInSeconds(): number {
   return Math.floor(Date.now() / 1000);
 }
@@ -557,65 +554,6 @@ export type EmailOptions = {
   allowDomainLiteral?: boolean;
 };
 
-export class ArcjetHeaders extends Headers {
-  constructor(
-    init?: HeadersInit | Record<string, string | string[] | undefined>,
-  ) {
-    super();
-    if (typeof init !== "undefined") {
-      if (isIterable(init)) {
-        for (const [key, value] of init) {
-          this.append(key, value);
-        }
-      } else {
-        for (const [key, value] of Object.entries(
-          init as Record<string, string | string[] | undefined>,
-        )) {
-          if (typeof value === "undefined") {
-            continue;
-          }
-
-          if (Array.isArray(value)) {
-            for (const singleValue of value) {
-              this.append(key, singleValue);
-            }
-          } else {
-            this.append(key, value);
-          }
-        }
-      }
-    }
-  }
-
-  /**
-   * Append a key and value to the headers, while filtering any key named
-   * `cookie`.
-   *
-   * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/append)
-   *
-   * @param key The key to append in the headers
-   * @param value The value to append for the key in the headers
-   */
-  append(key: string, value: string): void {
-    if (key.toLowerCase() !== "cookie") {
-      super.append(key, value);
-    }
-  }
-  /**
-   * Set a key and value in the headers, but filtering any key named `cookie`.
-   *
-   * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/set)
-   *
-   * @param key The key to set in the headers
-   * @param value The value to set for the key in the headers
-   */
-  set(key: string, value: string): void {
-    if (key.toLowerCase() !== "cookie") {
-      super.set(key, value);
-    }
-  }
-}
-
 const Priority = {
   Shield: 1,
   RateLimit: 2,

diff --git a/arcjet/package.json b/arcjet/package.json
@@ -42,6 +42,7 @@
   "dependencies": {
     "@arcjet/analyze": "1.0.0-alpha.13",
     "@arcjet/duration": "1.0.0-alpha.13",
+    "@arcjet/headers": "1.0.0-alpha.13",
     "@arcjet/logger": "1.0.0-alpha.13",
     "@arcjet/protocol": "1.0.0-alpha.13"
   },

diff --git a/arcjet/test/index.node.test.ts b/arcjet/test/index.node.test.ts
@@ -33,7 +33,6 @@ import arcjet, {
   rateLimit,
   ArcjetRule,
   defaultBaseUrl,
-  ArcjetHeaders,
   Runtime,
   validateEmail,
   protectSignup,
@@ -1223,54 +1222,6 @@ describe("createRemoteClient", () => {
   });
 });
 
-describe("ArcjetHeaders", () => {
-  test("can be constructed no initializer", () => {
-    const headers = new ArcjetHeaders();
-    expect(headers).toBeInstanceOf(ArcjetHeaders);
-    expect(headers).toBeInstanceOf(Headers);
-  });
-
-  test("can be constructed with a Headers instance", () => {
-    const init = new Headers();
-    init.set("foobar", "baz");
-    const headers = new ArcjetHeaders(init);
-    expect(headers.get("foobar")).toEqual("baz");
-  });
-
-  test("can be constructed with an ArcjetHeaders instance", () => {
-    const init = new ArcjetHeaders();
-    init.set("foobar", "baz");
-    const headers = new ArcjetHeaders(init);
-    expect(headers.get("foobar")).toEqual("baz");
-  });
-
-  test("can be constructed with an array of tuples", () => {
-    const headers = new ArcjetHeaders([["foobar", "baz"]]);
-    expect(headers.get("foobar")).toEqual("baz");
-  });
-
-  test("can be constructed with an object", () => {
-    const headers = new ArcjetHeaders({
-      foobar: "baz",
-    });
-    expect(headers.get("foobar")).toEqual("baz");
-  });
-
-  test("filters undefined values in an object", () => {
-    const headers = new ArcjetHeaders({
-      foobar: undefined,
-    });
-    expect(headers.has("foobar")).toEqual(false);
-  });
-
-  test("combines array values in an object", () => {
-    const headers = new ArcjetHeaders({
-      foo: ["bar", "baz"],
-    });
-    expect(headers.get("foo")).toEqual("bar, baz");
-  });
-});
-
 describe("ArcjetDecision", () => {
   test("will default the `id` property if not specified", () => {
     const decision = new ArcjetAllowDecision({

diff --git a/headers/.eslintignore b/headers/.eslintignore
@@ -0,0 +1,6 @@
+/.turbo/
+/coverage/
+/node_modules/
+*.d.ts
+*.js
+!*.config.js
diff --git a/headers/.eslintrc.cjs b/headers/.eslintrc.cjs
@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["@arcjet/eslint-config"],
+};