Merge branch 'main' into dependabot/npm_and_yarn/packages/openfeature-browser-provider/example/next-14.2.25

Author: pavkam

README.md

@@ -23,6 +23,7 @@ Browser SDK for use in non-React web applications
 ## Node.js SDK
 
 Node.js SDK for use on the server side.
+Use this for Cloudflare Workers as well.
 
 [Read the docs](packages/node-sdk/README.md)
 

packages/browser-sdk/README.md

@@ -109,6 +109,7 @@ type Configuration = {
   staleWhileRevalidate?: boolean; // Revalidate in the background when cached features turn stale to avoid latency in the UI (default: false)
   staleTimeMs?: number; // at initialization time features are loaded from the cache unless they have gone stale. Defaults to 0 which means the cache is disabled. Increase this in the case of a non-SPA
   expireTimeMs?: number; // In case we're unable to fetch features from Bucket, cached/stale features will be used instead until they expire after `expireTimeMs`. Default is 30 days
+  offline?: boolean; // Use the SDK in offline mode. Offline mode is useful during testing and local development
 };
 ```
 
@@ -282,7 +283,7 @@ Feedback can be submitted to Bucket using the SDK:
 
 ```ts
 bucketClient.feedback({
-  featureId: "my_feature_id", // String (required), copy from Feature feedback tab
+  featureKey: "my-feature-key", // String (required), copy from Feature feedback tab
   score: 5, // Number: 1-5 (optional)
   comment: "Absolutely stellar work!", // String (optional)
 });
@@ -292,7 +293,7 @@ bucketClient.feedback({
 
 If you are not using the Bucket Browser SDK, you can still submit feedback using the HTTP API.
 
-See details in [Feedback HTTP API](https://docs.bucket.co/reference/http-tracking-api#feedback)
+See details in [Feedback HTTP API](https://docs.bucket.co/api/http-api#post-feedback)
 
 ## Tracking feature usage
 

packages/browser-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/browser-sdk",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "packageManager": "yarn@4.1.1",
   "license": "MIT",
   "repository": {

packages/browser-sdk/src/client.ts

@@ -165,6 +165,11 @@ export interface Config {
    * Whether to enable tracking.
    */
   enableTracking: boolean;
+
+  /**
+   * Whether to enable offline mode.
+   */
+  offline: boolean;
 }
 
 /**
@@ -228,6 +233,11 @@ export type InitOptions = {
    */
   appBaseUrl?: string;
 
+  /**
+   * Whether to enable offline mode. Defaults to `false`.
+   */
+  offline?: boolean;
+
   /**
    * Feature keys for which `isEnabled` should fallback to true
    * if SDK fails to fetch features from Bucket servers. If a record
@@ -294,6 +304,7 @@ const defaultConfig: Config = {
   appBaseUrl: APP_BASE_URL,
   sseBaseUrl: SSE_REALTIME_BASE_URL,
   enableTracking: true,
+  offline: false,
 };
 
 /**
@@ -396,6 +407,7 @@ export class BucketClient {
       appBaseUrl: opts?.appBaseUrl ?? defaultConfig.appBaseUrl,
       sseBaseUrl: opts?.sseBaseUrl ?? defaultConfig.sseBaseUrl,
       enableTracking: opts?.enableTracking ?? defaultConfig.enableTracking,
+      offline: opts?.offline ?? defaultConfig.offline,
     };
 
     this.requestFeedbackOptions = {
@@ -423,10 +435,12 @@ export class BucketClient {
         staleTimeMs: opts.staleTimeMs,
         fallbackFeatures: opts.fallbackFeatures,
         timeoutMs: opts.timeoutMs,
+        offline: this.config.offline,
       },
     );
 
     if (
+      !this.config.offline &&
       this.context?.user &&
       !isNode && // do not prompt on server-side
       opts?.feedback?.enableAutoFeedback !== false // default to on
@@ -470,6 +484,7 @@ export class BucketClient {
    * Must be called before calling other SDK methods.
    */
   async initialize() {
+    const start = Date.now();
     if (this.autoFeedback) {
       // do not block on automated feedback surveys initialization
       this.autoFeedbackInit = this.autoFeedback.initialize().catch((e) => {
@@ -489,6 +504,13 @@ export class BucketClient {
         this.logger.error("error sending company", e);
       });
     }
+
+    this.logger.info(
+      "Bucket initialized in " +
+        Math.round(Date.now() - start) +
+        "ms" +
+        (this.config.offline ? " (offline mode)" : ""),
+    );
   }
 
   /**
@@ -607,6 +629,10 @@ export class BucketClient {
       return;
     }
 
+    if (this.config.offline) {
+      return;
+    }
+
     const payload: TrackedEvent = {
       userId: String(this.context.user.id),
       event: eventName,
@@ -634,9 +660,14 @@ export class BucketClient {
    * @returns The server response.
    */
   async feedback(payload: Feedback) {
+    if (this.config.offline) {
+      return;
+    }
+
     const userId =
       payload.userId ||
       (this.context.user?.id ? String(this.context.user?.id) : undefined);
+
     const companyId =
       payload.companyId ||
       (this.context.company?.id ? String(this.context.company?.id) : undefined);
@@ -833,6 +864,10 @@ export class BucketClient {
       return;
     }
 
+    if (this.config.offline) {
+      return;
+    }
+
     const { id, ...attributes } = this.context.user;
     const payload: User = {
       userId: String(id),
@@ -863,6 +898,10 @@ export class BucketClient {
       return;
     }
 
+    if (this.config.offline) {
+      return;
+    }
+
     const { id, ...attributes } = this.context.company;
     const payload: Company = {
       userId: String(this.context.user.id),

packages/browser-sdk/src/feature/features.ts

@@ -97,12 +97,14 @@ type Config = {
   fallbackFeatures: Record<string, FallbackFeatureOverride>;
   timeoutMs: number;
   staleWhileRevalidate: boolean;
+  offline: boolean;
 };
 
 export const DEFAULT_FEATURES_CONFIG: Config = {
   fallbackFeatures: {},
   timeoutMs: 5000,
   staleWhileRevalidate: false,
+  offline: false,
 };
 
 export function validateFeaturesResponse(response: any) {
@@ -235,6 +237,7 @@ export class FeaturesClient {
       expireTimeMs?: number;
       cache?: FeatureCache;
       rateLimiter?: RateLimiter;
+      offline?: boolean;
     },
   ) {
     this.fetchedFeatures = {};
@@ -265,7 +268,11 @@ export class FeaturesClient {
       fallbackFeatures = options?.fallbackFeatures ?? {};
     }
 
-    this.config = { ...DEFAULT_FEATURES_CONFIG, ...options, fallbackFeatures };
+    this.config = {
+      ...DEFAULT_FEATURES_CONFIG,
+      ...options,
+      fallbackFeatures,
+    };
 
     this.rateLimiter =
       options?.rateLimiter ??
@@ -456,6 +463,10 @@ export class FeaturesClient {
   }
 
   private async maybeFetchFeatures(): Promise<FetchedFeatures | undefined> {
+    if (this.config.offline) {
+      return;
+    }
+
     const cacheKey = this.fetchParams().toString();
     const cachedItem = this.cache.get(cacheKey);
 

packages/browser-sdk/test/client.test.ts

@@ -9,6 +9,7 @@ import { featuresResult } from "./mocks/handlers";
 describe("BucketClient", () => {
   let client: BucketClient;
   const httpClientPost = vi.spyOn(HttpClient.prototype as any, "post");
+  const httpClientGet = vi.spyOn(HttpClient.prototype as any, "get");
 
   const featureClientSetContext = vi.spyOn(
     FeaturesClient.prototype,
@@ -21,6 +22,8 @@ describe("BucketClient", () => {
       user: { id: "user1" },
       company: { id: "company1" },
     });
+
+    vi.clearAllMocks();
   });
 
   describe("updateUser", () => {
@@ -161,4 +164,26 @@ describe("BucketClient", () => {
       expect(featuresUpdated).not.toHaveBeenCalled();
     });
   });
+
+  describe("offline mode", () => {
+    it("should not make HTTP calls when offline", async () => {
+      client = new BucketClient({
+        publishableKey: "test-key",
+        user: { id: "user1" },
+        company: { id: "company1" },
+        offline: true,
+        feedback: { enableAutoFeedback: true },
+      });
+
+      await client.initialize();
+      await client.track("offline-event");
+      await client.feedback({ featureKey: "featureA", score: 5 });
+      await client.updateUser({ name: "New User" });
+      await client.updateCompany({ name: "New Company" });
+      await client.stop();
+
+      expect(httpClientPost).not.toHaveBeenCalled();
+      expect(httpClientGet).not.toHaveBeenCalled();
+    });
+  });
 });

packages/flag-evaluation/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/flag-evaluation",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "license": "MIT",
   "repository": {
     "type": "git",

packages/flag-evaluation/src/index.ts

@@ -203,25 +203,43 @@ export interface Rule<T extends RuleValue> {
  * @return {Record<string, string>} A flattened JSON object with "stringified" keys and values.
  */
 export function flattenJSON(data: object): Record<string, string> {
-  if (Object.keys(data).length === 0) return {};
-  const result: Record<string, any> = {};
-  function recurse(cur: any, prop: string) {
-    if (Object(cur) !== cur) {
-      result[prop] = cur;
-    } else if (Array.isArray(cur)) {
-      const l = cur.length;
-      for (let i = 0; i < l; i++)
-        recurse(cur[i], prop ? prop + "." + i : "" + i);
-      if (l == 0) result[prop] = [];
+  const result: Record<string, string> = {};
+
+  if (Object.keys(data).length === 0) {
+    return result;
+  }
+
+  function recurse(value: any, prop: string) {
+    if (value === undefined) {
+      return;
+    }
+
+    if (value === null) {
+      result[prop] = "";
+    } else if (typeof value !== "object") {
+      result[prop] = String(value);
+    } else if (Array.isArray(value)) {
+      if (value.length === 0) {
+        result[prop] = "";
+      }
+
+      for (let i = 0; i < value.length; i++) {
+        recurse(value[i], prop ? prop + "." + i : "" + i);
+      }
     } else {
       let isEmpty = true;
-      for (const p in cur) {
+
+      for (const p in value) {
         isEmpty = false;
-        recurse(cur[p], prop ? prop + "." + p : p);
+        recurse(value[p], prop ? prop + "." + p : p);
+      }
+
+      if (isEmpty) {
+        result[prop] = "";
       }
-      if (isEmpty) result[prop] = {};
     }
   }
+
   recurse(data, "");
   return result;
 }
@@ -325,9 +343,9 @@ export function evaluate(
         : fieldValueDate < daysAgo.getTime();
     }
     case "SET":
-      return fieldValue != "";
+      return fieldValue !== "";
     case "NOT_SET":
-      return fieldValue == "";
+      return fieldValue === "";
     case "IS":
       return fieldValue === value;
     case "IS_NOT":
@@ -357,13 +375,17 @@ function evaluateRecursively(
     case "constant":
       return filter.value;
     case "context":
-      if (!(filter.field in context)) {
+      if (
+        !(filter.field in context) &&
+        filter.operator !== "SET" &&
+        filter.operator !== "NOT_SET"
+      ) {
         missingContextFieldsSet.add(filter.field);
         return false;
       }
 
       return evaluate(
-        context[filter.field],
+        context[filter.field] ?? "",
         filter.operator,
         filter.values || [],
         filter.valueSet,