Merge branch 'browser-react-3.0.alpha' into extent-check-events-browser

Author: pavkam

packages/browser-sdk/src/client.ts

@@ -1,7 +1,7 @@
 import {
   CheckEvent,
+  FallbackFeatureOverride,
   FeaturesClient,
-  FeaturesOptions,
   RawFeatures,
 } from "./feature/features";
 import {
@@ -185,7 +185,7 @@ export type FeatureDefinitions = Readonly<Array<string>>;
 /**
  * BucketClient initialization options.
  */
-export interface InitOptions {
+export type InitOptions = {
   /**
    * Publishable key for authentication
    */
@@ -218,12 +218,6 @@ export interface InitOptions {
    */
   logger?: Logger;
 
-  /**
-   * @deprecated
-   * Use `apiBaseUrl` instead.
-   */
-  host?: string;
-
   /**
    * Base URL of Bucket servers. You can override this to use your mocked server.
    */
@@ -235,10 +229,32 @@ export interface InitOptions {
   appBaseUrl?: string;
 
   /**
-   * @deprecated
-   * Use `sseBaseUrl` instead.
+   * Feature keys for which `isEnabled` should fallback to true
+   * if SDK fails to fetch features from Bucket servers. If a record
+   * is supplied instead of array, the values of each key represent the
+   * configuration values and `isEnabled` is assume `true`.
+   */
+  fallbackFeatures?: string[] | Record<string, FallbackFeatureOverride>;
+
+  /**
+   * Timeout in milliseconds when fetching features
+   */
+  timeoutMs?: number;
+
+  /**
+   * If set to true stale features will be returned while refetching features
+   */
+  staleWhileRevalidate?: boolean;
+
+  /**
+   * If set, features will be cached between page loads for this duration
+   */
+  expireTimeMs?: number;
+
+  /**
+   * Stale features will be returned if staleWhileRevalidate is true if no new features can be fetched
    */
-  sseHost?: string;
+  staleTimeMs?: number;
 
   /**
    * Base URL of Bucket servers for SSE connections used by AutoFeedback.
@@ -250,11 +266,6 @@ export interface InitOptions {
    */
   feedback?: FeedbackOptions;
 
-  /**
-   * Feature flag specific configuration
-   */
-  features?: FeaturesOptions;
-
   /**
    * Version of the SDK
    */
@@ -266,17 +277,15 @@ export interface InitOptions {
   enableTracking?: boolean;
 
   /**
-   * Toolbar configuration (alpha)
-   * @ignore
+   * Toolbar configuration
    */
   toolbar?: ToolbarOptions;
 
   /**
-   * Local-first definition of features (alpha)
-   * @ignore
+   * Local-first definition of features
    */
-  featureList?: FeatureDefinitions;
-}
+  features?: FeatureDefinitions;
+};
 
 const defaultConfig: Config = {
   apiBaseUrl: API_BASE_URL,
@@ -335,7 +344,7 @@ function shouldShowToolbar(opts: InitOptions) {
   if (typeof toolbarOpts?.show === "boolean") return toolbarOpts.show;
 
   return (
-    opts.featureList !== undefined && window?.location?.hostname === "localhost"
+    opts.features !== undefined && window?.location?.hostname === "localhost"
   );
 }
 
@@ -369,9 +378,9 @@ export class BucketClient {
     };
 
     this.config = {
-      apiBaseUrl: opts?.apiBaseUrl ?? opts?.host ?? defaultConfig.apiBaseUrl,
-      appBaseUrl: opts?.appBaseUrl ?? opts?.host ?? defaultConfig.appBaseUrl,
-      sseBaseUrl: opts?.sseBaseUrl ?? opts?.sseHost ?? defaultConfig.sseBaseUrl,
+      apiBaseUrl: opts?.apiBaseUrl ?? defaultConfig.apiBaseUrl,
+      appBaseUrl: opts?.appBaseUrl ?? defaultConfig.appBaseUrl,
+      sseBaseUrl: opts?.sseBaseUrl ?? defaultConfig.sseBaseUrl,
       enableTracking: opts?.enableTracking ?? defaultConfig.enableTracking,
     };
 
@@ -395,9 +404,13 @@ export class BucketClient {
         company: this.context.company,
         other: this.context.otherContext,
       },
-      opts?.featureList || [],
       this.logger,
-      opts?.features,
+      {
+        expireTimeMs: opts.expireTimeMs,
+        staleTimeMs: opts.staleTimeMs,
+        fallbackFeatures: opts.fallbackFeatures,
+        timeoutMs: opts.timeoutMs,
+      },
     );
 
     if (

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

@@ -90,36 +90,6 @@ export type FallbackFeatureOverride =
     }
   | true;
 
-export type FeaturesOptions = {
-  /**
-   * Feature keys for which `isEnabled` should fallback to true
-   * if SDK fails to fetch features from Bucket servers. If a record
-   * is supplied instead of array, the values of each key represent the
-   * configuration values and `isEnabled` is assume `true`.
-   */
-  fallbackFeatures?: string[] | Record<string, FallbackFeatureOverride>;
-
-  /**
-   * Timeout in milliseconds when fetching features
-   */
-  timeoutMs?: number;
-
-  /**
-   * If set to true stale features will be returned while refetching features
-   */
-  staleWhileRevalidate?: boolean;
-
-  /**
-   * If set, features will be cached between page loads for this duration
-   */
-  expireTimeMs?: number;
-
-  /**
-   * Stale features will be returned if staleWhileRevalidate is true if no new features can be fetched
-   */
-  staleTimeMs?: number;
-};
-
 type Config = {
   fallbackFeatures: Record<string, FallbackFeatureOverride>;
   timeoutMs: number;
@@ -252,9 +222,12 @@ export class FeaturesClient {
   constructor(
     private httpClient: HttpClient,
     private context: context,
-    private featureDefinitions: Readonly<string[]>,
     logger: Logger,
-    options?: FeaturesOptions & {
+    options?: {
+      fallbackFeatures?: Record<string, FallbackFeatureOverride> | string[];
+      timeoutMs?: number;
+      staleTimeMs?: number;
+      expireTimeMs?: number;
       cache?: FeatureCache;
       rateLimiter?: RateLimiter;
     },
@@ -296,9 +269,7 @@ export class FeaturesClient {
     try {
       const storedFeatureOverrides = getOverridesCache();
       for (const key in storedFeatureOverrides) {
-        if (this.featureDefinitions.includes(key)) {
-          this.featureOverrides[key] = storedFeatureOverrides[key];
-        }
+        this.featureOverrides[key] = storedFeatureOverrides[key];
       }
     } catch (e) {
       this.logger.warn("error getting feature overrides from cache", e);
@@ -356,7 +327,7 @@ export class FeaturesClient {
     const params = this.fetchParams();
     try {
       const res = await this.httpClient.get({
-        path: "/features/enabled",
+        path: "/features/evaluated",
         timeoutMs: this.config.timeoutMs,
         params,
       });
@@ -438,17 +409,6 @@ export class FeaturesClient {
       };
     }
 
-    // add any features that aren't in the fetched features
-    for (const key of this.featureDefinitions) {
-      if (!mergedFeatures[key]) {
-        mergedFeatures[key] = {
-          key,
-          isEnabled: false,
-          isEnabledOverride: this.featureOverrides[key] ?? null,
-        };
-      }
-    }
-
     this.features = mergedFeatures;
 
     this.eventTarget.dispatchEvent(new Event(FEATURES_UPDATED_EVENT));

packages/browser-sdk/src/index.ts

@@ -6,7 +6,6 @@ export type { BucketContext, CompanyContext, UserContext } from "./context";
 export type {
   CheckEvent,
   FallbackFeatureOverride,
-  FeaturesOptions,
   RawFeature,
   RawFeatures,
 } from "./feature/features";

packages/browser-sdk/test/e2e/acceptance.browser.spec.ts

@@ -11,7 +11,7 @@ test("Acceptance", async ({ page }) => {
   const successfulRequests: string[] = [];
 
   // Mock API calls with assertions
-  await page.route(`${API_BASE_URL}/features/enabled*`, async (route) => {
+  await page.route(`${API_BASE_URL}/features/evaluated*`, async (route) => {
     successfulRequests.push("FEATURES");
     await route.fulfill({
       status: 200,

packages/browser-sdk/test/e2e/feedback-widget.browser.spec.ts

@@ -33,7 +33,7 @@ async function getOpenedWidgetContainer(
     await route.fulfill({ status: 200 });
   });
 
-  await page.route(`${API_HOST}/features/enabled*`, async (route) => {
+  await page.route(`${API_HOST}/features/evaluated*`, async (route) => {
     await route.fulfill({
       status: 200,
       body: JSON.stringify({
@@ -70,7 +70,7 @@ async function getGiveFeedbackPageContainer(
     await route.fulfill({ status: 200 });
   });
 
-  await page.route(`${API_HOST}/features/enabled*`, async (route) => {
+  await page.route(`${API_HOST}/features/evaluated*`, async (route) => {
     await route.fulfill({
       status: 200,
       body: JSON.stringify({

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

@@ -1,11 +1,9 @@
 import { afterAll, beforeEach, describe, expect, test, vi } from "vitest";
 
 import { version } from "../package.json";
-import { FeatureDefinitions } from "../src/client";
 import {
   FEATURES_EXPIRE_MS,
   FeaturesClient,
-  FeaturesOptions,
   FetchedFeature,
   RawFeature,
 } from "../src/feature/features";
@@ -37,9 +35,8 @@ function featuresClientFactory() {
     cache,
     httpClient,
     newFeaturesClient: function newFeaturesClient(
-      options?: FeaturesOptions,
-      context?: any,
-      featureList: FeatureDefinitions = [],
+      context?: Record<string, any>,
+      options?: { staleWhileRevalidate?: boolean; fallbackFeatures?: any },
     ) {
       return new FeaturesClient(
         httpClient,
@@ -49,7 +46,6 @@ function featuresClientFactory() {
           other: { eventId: "big-conference1" },
           ...context,
         },
-        featureList,
         testLogger,
         {
           cache,
@@ -92,7 +88,7 @@ describe("FeaturesClient", () => {
       publishableKey: "pk",
     });
 
-    expect(path).toEqual("/features/enabled");
+    expect(path).toEqual("/features/evaluated");
     expect(timeoutMs).toEqual(5000);
   });
 
@@ -121,14 +117,11 @@ describe("FeaturesClient", () => {
 
   test("ignores undefined context", async () => {
     const { newFeaturesClient, httpClient } = featuresClientFactory();
-    const featuresClient = newFeaturesClient(
-      {},
-      {
-        user: undefined,
-        company: undefined,
-        other: undefined,
-      },
-    );
+    const featuresClient = newFeaturesClient({
+      user: undefined,
+      company: undefined,
+      other: undefined,
+    });
     await featuresClient.initialize();
     expect(featuresClient.getFeatures()).toEqual(featuresResult);
 
@@ -142,7 +135,7 @@ describe("FeaturesClient", () => {
       publishableKey: "pk",
     });
 
-    expect(path).toEqual("/features/enabled");
+    expect(path).toEqual("/features/evaluated");
     expect(timeoutMs).toEqual(5000);
   });
 
@@ -153,7 +146,7 @@ describe("FeaturesClient", () => {
       new Error("Failed to fetch features"),
     );
 
-    const featuresClient = newFeaturesClient({
+    const featuresClient = newFeaturesClient(undefined, {
       fallbackFeatures: ["huddle"],
     });
 
@@ -174,7 +167,7 @@ describe("FeaturesClient", () => {
     vi.mocked(httpClient.get).mockRejectedValue(
       new Error("Failed to fetch features"),
     );
-    const featuresClient = newFeaturesClient({
+    const featuresClient = newFeaturesClient(undefined, {
       fallbackFeatures: {
         huddle: {
           key: "john",
@@ -373,7 +366,7 @@ describe("FeaturesClient", () => {
     const { newFeaturesClient } = featuresClientFactory();
 
     // localStorage.clear();
-    const client = newFeaturesClient(undefined, undefined, ["featureB"]);
+    const client = newFeaturesClient(undefined);
     await client.initialize();
 
     let updated = false;

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

@@ -40,7 +40,7 @@ describe("init", () => {
 
     server.use(
       http.get(
-        "https://example.com/features/enabled",
+        "https://example.com/features/evaluated",
         ({ request }: { request: StrictRequest<DefaultBodyType> }) => {
           usedSpecialHost = true;
           return getFeatures({ request });

packages/browser-sdk/test/mocks/handlers.ts

@@ -155,6 +155,7 @@ export const handlers = [
     });
   }),
   http.get("https://front.bucket.co/features/enabled", getFeatures),
+  http.get("https://front.bucket.co/features/evaluated", getFeatures),
   http.post(
     "https://front.bucket.co/feedback/prompting-init",
     ({ request }) => {

packages/node-sdk/example/serve.ts

@@ -4,8 +4,6 @@ import app from "./app";
 // Initialize Bucket SDK before starting the server,
 // so that features are available when the server starts.
 bucket.initialize().then(() => {
-  console.log("Bucket initialized");
-
   // Start listening for requests only after Bucket is initialized,
   // which guarantees that features are available.
   app.listen(process.env.PORT ?? 3000, () => {

packages/react-sdk/dev/nextjs-flag-demo/components/Providers.tsx

@@ -14,7 +14,7 @@ export const Providers = ({ publishableKey, children }: Props) => {
       publishableKey={publishableKey}
       company={{ id: "acme_inc" }}
       user={{ id: "john doe" }}
-      featureOptions={{ fallbackFeatures: ["fallback-feature"] }}
+      fallbackFeatures={["fallback-feature"]}
     >
       {children}
     </BucketProvider>