@terreno/feature-flags 57.16.1 → 57.17.0

package/dist/evaluate.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.evaluateAllFlags = exports.evaluateFlag = exports.deterministicHash = void 0;
 const api_1 = require("@terreno/api");
 const get_1 = __importDefault(require("lodash/get"));
-const isDebugEnabled = () => process.env.FEATURE_FLAGS_DEBUG !== "false";
+// Evaluation diagnostics are opt-in and never include the user's attribute values.
+const isDebugEnabled = () => process.env.FEATURE_FLAGS_DEBUG === "true";
 /**
  * Deterministic hash of a string to a number between 0 and 99.
  * Uses a simple but effective hash (djb2) to ensure the same user+flag
@@ -58,7 +59,7 @@ const matchesFieldRule = (user, rule) => {
             break;
     }
     if (isDebugEnabled()) {
-        api_1.logger.info(`[feature-flags] field rule: user.${rule.field}=${JSON.stringify(fieldValue)} ${rule.operator} ${JSON.stringify(ruleValue)} → ${result}`);
+        api_1.logger.debug(`[feature-flags] field rule: user.${rule.field} ${rule.operator} → ${result}`);
     }
     return result;
 };
@@ -72,7 +73,7 @@ const matchesRule = (user, rule, segments) => {
         try {
             const result = segmentFn(user);
             if (isDebugEnabled()) {
-                api_1.logger.info(`[feature-flags] segment rule: "${rule.segment}" → ${result}`);
+                api_1.logger.debug(`[feature-flags] segment rule: "${rule.segment}" → ${result}`);
             }
             return result;
         }
@@ -91,7 +92,7 @@ const evaluateFlag = (flag, userId, user, segments) => {
     const debug = isDebugEnabled();
     if (!flag.enabled) {
         if (debug) {
-            api_1.logger.info(`[feature-flags] "${flag.key}" is disabled → ${flag.type === "variant" ? "null" : "false"}`);
+            api_1.logger.debug(`[feature-flags] "${flag.key}" is disabled → ${flag.type === "variant" ? "null" : "false"}`);
         }
         return flag.type === "variant" ? null : false;
     }
@@ -102,7 +103,7 @@ const evaluateFlag = (flag, userId, user, segments) => {
         if (matched) {
             const result = flag.type === "variant" ? (rule.variant ?? null) : (rule.enabled ?? false);
             if (debug) {
-                api_1.logger.info(`[feature-flags] "${flag.key}" matched rule ${i} → ${JSON.stringify(result)}`);
+                api_1.logger.debug(`[feature-flags] "${flag.key}" matched rule ${i} → ${JSON.stringify(result)}`);
             }
             return result;
         }
@@ -112,7 +113,7 @@ const evaluateFlag = (flag, userId, user, segments) => {
     if (flag.type === "boolean") {
         const result = hash < flag.rolloutPercentage;
         if (debug) {
-            api_1.logger.info(`[feature-flags] "${flag.key}" no rules matched, hash=${hash} rollout=${flag.rolloutPercentage}% → ${result}`);
+            api_1.logger.debug(`[feature-flags] "${flag.key}" no rules matched, hash=${hash} rollout=${flag.rolloutPercentage}% → ${result}`);
         }
         return result;
     }
@@ -122,7 +123,7 @@ const evaluateFlag = (flag, userId, user, segments) => {
         cumulativeWeight += variant.weight;
         if (hash < cumulativeWeight) {
             if (debug) {
-                api_1.logger.info(`[feature-flags] "${flag.key}" no rules matched, hash=${hash} → variant "${variant.key}"`);
+                api_1.logger.debug(`[feature-flags] "${flag.key}" no rules matched, hash=${hash} → variant "${variant.key}"`);
             }
             return variant.key;
         }
@@ -130,7 +131,7 @@ const evaluateFlag = (flag, userId, user, segments) => {
     // Fallback (shouldn't happen if weights sum to 100)
     const fallback = flag.variants.length > 0 ? flag.variants[flag.variants.length - 1].key : null;
     if (debug) {
-        api_1.logger.info(`[feature-flags] "${flag.key}" variant fallback → ${JSON.stringify(fallback)}`);
+        api_1.logger.debug(`[feature-flags] "${flag.key}" variant fallback → ${JSON.stringify(fallback)}`);
     }
     return fallback;
 };
@@ -143,13 +144,13 @@ const evaluateAllFlags = async (flagModel, userId, user, segments) => {
     const flags = await flagModel.find({ archived: { $ne: true }, enabled: true });
     const results = {};
     if (isDebugEnabled()) {
-        api_1.logger.info(`[feature-flags] evaluating ${flags.length} flags for user ${userId}`);
+        api_1.logger.debug(`[feature-flags] evaluating ${flags.length} flags for user ${userId}`);
     }
     for (const flag of flags) {
         results[flag.key] = (0, exports.evaluateFlag)(flag, userId, user, segments);
     }
     if (isDebugEnabled()) {
-        api_1.logger.info(`[feature-flags] results: ${JSON.stringify(results)}`);
+        api_1.logger.debug(`[feature-flags] results: ${JSON.stringify(results)}`);
     }
     return results;
 };

package/package.json

@@ -5,14 +5,14 @@
   },
   "dependencies": {
     "@openfeature/server-sdk": "^1.22.0",
-    "@terreno/api": "57.16.1",
+    "@terreno/api": "57.17.0",
     "express": "^5.2.1",
     "lodash": "^4.18.1"
   },
   "description": "Feature flags and A/B testing plugin for @terreno/api — part of Terreno, the batteries-included TypeScript framework for universal apps.",
   "devDependencies": {
     "@biomejs/biome": "^2.3.6",
-    "@terreno/test": "57.16.1",
+    "@terreno/test": "57.17.0",
     "@types/bun": "^1.4.0",
     "@types/express": "^5.0.6",
     "@types/lodash": "^4.17.17",
@@ -53,5 +53,5 @@
     "test:coverage": "bun run ../scripts/check-coverage.ts"
   },
   "types": "dist/index.d.ts",
-  "version": "57.16.1"
+  "version": "57.17.0"
 }

package/src/evaluate.ts

@@ -7,7 +7,8 @@ import type {
   SegmentFunction,
 } from "./types";
 
-const isDebugEnabled = (): boolean => process.env.FEATURE_FLAGS_DEBUG !== "false";
+// Evaluation diagnostics are opt-in and never include the user's attribute values.
+const isDebugEnabled = (): boolean => process.env.FEATURE_FLAGS_DEBUG === "true";
 
 /**
  * Deterministic hash of a string to a number between 0 and 99.
@@ -63,9 +64,7 @@ const matchesFieldRule = (user: unknown, rule: FeatureFlagRule): boolean => {
   }
 
   if (isDebugEnabled()) {
-    logger.info(
-      `[feature-flags] field rule: user.${rule.field}=${JSON.stringify(fieldValue)} ${rule.operator} ${JSON.stringify(ruleValue)} → ${result}`
-    );
+    logger.debug(`[feature-flags] field rule: user.${rule.field} ${rule.operator} → ${result}`);
   }
 
   return result;
@@ -85,7 +84,7 @@ const matchesRule = (
     try {
       const result = segmentFn(user);
       if (isDebugEnabled()) {
-        logger.info(`[feature-flags] segment rule: "${rule.segment}" → ${result}`);
+        logger.debug(`[feature-flags] segment rule: "${rule.segment}" → ${result}`);
       }
       return result;
     } catch (err) {
@@ -111,7 +110,7 @@ export const evaluateFlag = (
 
   if (!flag.enabled) {
     if (debug) {
-      logger.info(
+      logger.debug(
         `[feature-flags] "${flag.key}" is disabled → ${flag.type === "variant" ? "null" : "false"}`
       );
     }
@@ -125,7 +124,7 @@ export const evaluateFlag = (
     if (matched) {
       const result = flag.type === "variant" ? (rule.variant ?? null) : (rule.enabled ?? false);
       if (debug) {
-        logger.info(`[feature-flags] "${flag.key}" matched rule ${i} → ${JSON.stringify(result)}`);
+        logger.debug(`[feature-flags] "${flag.key}" matched rule ${i} → ${JSON.stringify(result)}`);
       }
       return result;
     }
@@ -137,7 +136,7 @@ export const evaluateFlag = (
   if (flag.type === "boolean") {
     const result = hash < flag.rolloutPercentage;
     if (debug) {
-      logger.info(
+      logger.debug(
         `[feature-flags] "${flag.key}" no rules matched, hash=${hash} rollout=${flag.rolloutPercentage}% → ${result}`
       );
     }
@@ -150,7 +149,7 @@ export const evaluateFlag = (
     cumulativeWeight += variant.weight;
     if (hash < cumulativeWeight) {
       if (debug) {
-        logger.info(
+        logger.debug(
           `[feature-flags] "${flag.key}" no rules matched, hash=${hash} → variant "${variant.key}"`
         );
       }
@@ -161,7 +160,7 @@ export const evaluateFlag = (
   // Fallback (shouldn't happen if weights sum to 100)
   const fallback = flag.variants.length > 0 ? flag.variants[flag.variants.length - 1].key : null;
   if (debug) {
-    logger.info(`[feature-flags] "${flag.key}" variant fallback → ${JSON.stringify(fallback)}`);
+    logger.debug(`[feature-flags] "${flag.key}" variant fallback → ${JSON.stringify(fallback)}`);
   }
   return fallback;
 };
@@ -180,7 +179,7 @@ export const evaluateAllFlags = async (
   const results: EvaluationResult = {};
 
   if (isDebugEnabled()) {
-    logger.info(`[feature-flags] evaluating ${flags.length} flags for user ${userId}`);
+    logger.debug(`[feature-flags] evaluating ${flags.length} flags for user ${userId}`);
   }
 
   for (const flag of flags) {
@@ -188,7 +187,7 @@ export const evaluateAllFlags = async (
   }
 
   if (isDebugEnabled()) {
-    logger.info(`[feature-flags] results: ${JSON.stringify(results)}`);
+    logger.debug(`[feature-flags] results: ${JSON.stringify(results)}`);
   }
 
   return results;

package/src/tests/evaluate.test.ts

@@ -1,4 +1,5 @@
-import {describe, expect, it} from "bun:test";
+import {afterEach, describe, expect, it} from "bun:test";
+import {logger} from "@terreno/api";
 import {deterministicHash, evaluateAllFlags, evaluateFlag} from "../evaluate";
 import type {FeatureFlagDocument, FeatureFlagModel, SegmentFunction} from "../types";
 
@@ -515,6 +516,60 @@ describe("evaluateFlag", () => {
   });
 });
 
+describe("evaluation diagnostics", () => {
+  const originalDebugEnv = process.env.FEATURE_FLAGS_DEBUG;
+  const originalInfo = logger.info;
+  const originalDebug = logger.debug;
+
+  const captureLogs = (): string[] => {
+    const lines: string[] = [];
+    logger.info = ((message: string) => {
+      lines.push(message);
+    }) as typeof logger.info;
+    logger.debug = ((message: string) => {
+      lines.push(message);
+    }) as typeof logger.debug;
+    return lines;
+  };
+
+  const emailRuleFlag = (): FeatureFlagDocument =>
+    createFlag({
+      key: "staff-only",
+      rolloutPercentage: 0,
+      rules: [{enabled: true, field: "email", operator: "contains", value: "@staff.example"}],
+    });
+
+  afterEach(() => {
+    logger.info = originalInfo;
+    logger.debug = originalDebug;
+    if (originalDebugEnv === undefined) {
+      delete process.env.FEATURE_FLAGS_DEBUG;
+    } else {
+      process.env.FEATURE_FLAGS_DEBUG = originalDebugEnv;
+    }
+  });
+
+  it("logs nothing about a user's attributes by default", () => {
+    delete process.env.FEATURE_FLAGS_DEBUG;
+    const lines = captureLogs();
+
+    evaluateFlag(emailRuleFlag(), "user1", {email: "dummy-user@example.com"}, noSegments);
+
+    expect(lines.join("\n")).not.toContain("dummy-user@example.com");
+  });
+
+  it("never logs the user's attribute value when debug logging is on", () => {
+    process.env.FEATURE_FLAGS_DEBUG = "true";
+    const lines = captureLogs();
+
+    evaluateFlag(emailRuleFlag(), "user1", {email: "dummy-user@example.com"}, noSegments);
+
+    const combined = lines.join("\n");
+    expect(combined).not.toContain("dummy-user@example.com");
+    expect(combined).toContain("user.email contains");
+  });
+});
+
 describe("evaluateAllFlags", () => {
   const makeMockModel = (flags: FeatureFlagDocument[]): FeatureFlagModel => {
     return {