deprecate!: deprecate reason for ArcjetAllowDecision

arcjet · Jan 2, 2025 · 252d92f · 252d92f
1 parent 02e4435
commit 252d92f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/decorate/index.ts b/decorate/index.ts
@@ -208,7 +208,7 @@ export function setRateLimitHeaders(
       .sort(sortByLowestMax)
       .map(toPolicyString)
       .join(", ");
-  } else {
+  } else if (typeof decision.reason !== "undefined") {
     // For cached decisions, we may not have rule results, but we'd still have
     // the top-level reason.
     if (isRateLimitReason(decision.reason)) {
@@ -229,6 +229,8 @@ export function setRateLimitHeaders(
     } else {
       return;
     }
+  } else {
+    return;
   }
 
   if (isHeaderLike(value)) {

diff --git a/protocol/client.ts b/protocol/client.ts
@@ -8,6 +8,7 @@ import {
 } from "./convert.js";
 import type {
   ArcjetContext,
+  ArcjetDecisionWithReason,
   ArcjetRequestDetails,
   ArcjetRule,
 } from "./index.js";
@@ -127,7 +128,7 @@ export function createClient(options: ClientOptions): Client {
     report(
       context: ArcjetContext,
       details: ArcjetRequestDetails,
-      decision: ArcjetDecision,
+      decision: ArcjetDecisionWithReason,
       rules: ArcjetRule[],
     ): void {
       const { log } = context;

diff --git a/protocol/convert.ts b/protocol/convert.ts
@@ -9,6 +9,7 @@ import type {
   ArcjetSlidingWindowRateLimitRule,
   ArcjetShieldRule,
   ArcjetSensitiveInfoRule,
+  ArcjetDecisionWithReason,
 } from "./index.js";
 import {
   ArcjetAllowDecision,
@@ -391,7 +392,9 @@ export function ArcjetRuleResultFromProtocol(
   });
 }
 
-export function ArcjetDecisionToProtocol(decision: ArcjetDecision): Decision {
+export function ArcjetDecisionToProtocol(
+  decision: ArcjetDecisionWithReason,
+): Decision {
   return new Decision({
     id: decision.id,
     ttl: decision.ttl,

diff --git a/protocol/index.ts b/protocol/index.ts
@@ -591,7 +591,7 @@ export abstract class ArcjetDecision {
   ip: ArcjetIpDetails;
 
   abstract conclusion: ArcjetConclusion;
-  abstract reason: ArcjetReason;
+  abstract reason: ArcjetReason | undefined;
 
   constructor(init: {
     id?: string;
@@ -627,15 +627,20 @@ export abstract class ArcjetDecision {
   }
 }
 
+export type ArcjetDecisionWithReason = ArcjetDecision & {
+  reason: NonNullable<ArcjetDecision["reason"]>;
+};
+
 export class ArcjetAllowDecision extends ArcjetDecision {
   conclusion = "ALLOW" as const;
-  reason: ArcjetReason;
+  /** @deprecated */
+  reason: ArcjetReason | undefined;
 
   constructor(init: {
     id?: string;
     results: ArcjetRuleResult[];
     ttl: number;
-    reason: ArcjetReason;
+    reason?: ArcjetReason;
     ip?: ArcjetIpDetails;
   }) {
     super(init);

diff --git a/protocol/test/convert.test.ts b/protocol/test/convert.test.ts
@@ -36,6 +36,7 @@ import type {
   ArcjetFixedWindowRateLimitRule,
   ArcjetSlidingWindowRateLimitRule,
   ArcjetShieldRule,
+  ArcjetDecisionWithReason,
 } from "../index.js";
 import {
   ArcjetAllowDecision,
@@ -519,7 +520,7 @@ describe("convert", () => {
           results: [],
           reason: new ArcjetReason(),
           ip: new ArcjetIpDetails(),
-        }),
+        }) as ArcjetDecisionWithReason,
       ),
     ).toEqual(
       new Decision({