Merge branch 'buc-3227-dogfooding-dont-require-satisfaction-score-when-asking-for' of https://github.com/bucketco/bucket-javascript-sdk into buc-3227-dogfooding-dont-require-satisfaction-score-when-asking-for

Author: laander

packages/node-sdk/README.md

@@ -54,22 +54,6 @@ Other supported languages/frameworks are in the [Supported languages](https://do
 
 You can also [use the HTTP API directly](https://docs.reflag.com/api/http-api)
 
-## Migrating from Bucket SDK
-
-If you have been using the Bucket SDKs, the following list will help you migrate to Reflag SDK:
-
-- `Bucket*` classes, and types have been renamed to `Reflag*` (e.g. `BucketClient` is now `ReflagClient`)
-- `Feature*` classes, and types have been renamed to `Feature*` (e.g. `Feature` is now `Flag`, `RawFeatures` is now `RawFlags`)
-- When using strongly-typed flags, the new `Flags` interface replaced `Features` interface
-- All methods that contained `feature` in the name have been renamed to use the `flag` terminology (e.g. `getFeature` is `getFlag`)
-- All environment variables that were prefixed with `BUCKET_` are now prefixed with `REFLAG_`
-- The `BUCKET_HOST` environment variable and `host` option have been removed from `ReflagClient` constructor, use `REFLAG_API_BASE_URL` instead
-- The `BUCKET_FEATURES_ENABLED` and `BUCKET_FEATURES_DISABLED` have been renamed to `REFLAG_FLAGS_ENABLED` and `REFLAG_FLAGS_DISABLED`
-- The default configuration file has been renamed from `bucketConfig.json` to `reflag.config.json`
-- The `fallbackFeatures` property in client constructor and configuration files has been renamed to `fallbackFlags`
-- `featureKey` has been renamed to `flagKey` in all methods that accepts that argument
-- The SDKs will not emit `evaluate` and `evaluate-config` events anymore
-
 ## Basic usage
 
 To get started you need to obtain your secret key from the [environment settings](https://app.reflag.com/env-current/settings/app-environments)
@@ -98,9 +82,9 @@ export const reflagClient = new ReflagClient();
 // Initialize the client and begin fetching flag targeting definitions.
 // You must call this method prior to any calls to `getFlags()`,
 // otherwise an empty object will be returned.
-reflagClient.initialize().then({
-  console.log("Reflag initialized!")
-})
+reflagClient.initialize().then(() => {
+  console.log("Reflag initialized!");
+});
 ```
 
 Once the client is initialized, you can obtain flags along with the `isEnabled`
@@ -255,7 +239,7 @@ export default {
 };
 ```
 
-See [examples/cloudflare-worker](examples/cloudflare-worker/src/index.ts) for a deployable example.
+See [examples/cloudflare-worker](https://github.com/reflagcom/javascript/tree/main/packages/node-sdk/examples/cloudflare-worker/src/index.ts) for a deployable example.
 
 Reflag maintains a cached set of flag definitions in the memory of your worker which it uses to decide which flags to turn on for which users/companies.
 
@@ -277,14 +261,11 @@ fallback behavior:
 
    ```typescript
    // Network errors during tracking are logged but don't affect your application
-   const { track } = client.getFlag("my-flag");
+   const { isEnabled, track } = client.getFlag("my-flag");
    if (isEnabled) {
-     try {
-       await track();
-     } catch (error) {
-       // The SDK already logged this error
-       // Your application can continue normally
-     }
+     // network errors are caught internally and logged and never bubbled up to your application
+     // no need to try/catch around "track" or "getFlag"
+     await track();
    }
    ```
 
@@ -633,12 +614,12 @@ app.use((req, res, next) => {
   // mechanism in a real-world application
   const user = {
     id: req.user?.id,
-    name: req.user?.name
+    name: req.user?.name,
     email: req.user?.email
   }
 
   const company = {
-    id: req.user?.companyId
+    id: req.user?.companyId,
     name: req.user?.companyName
   }
 
@@ -655,7 +636,7 @@ app.use((req, res, next) => {
 
 // Now use res.locals.boundReflagClient in your handlers
 app.get("/todos", async (_req, res) => {
-  const { track, isEnabled } = res.locals.reflagUser.getFlag("show-todos");
+  const { track, isEnabled } = res.locals.boundReflagClient.getFlag("show-todos");
 
   if (!isEnabled) {
     res.status(403).send({"error": "flag inaccessible"})
@@ -835,6 +816,22 @@ import { sha256 } from 'crypto-hash';
 client.updateUser({ userId: await sha256("john_doe"), ... });
 ```
 
+## Migrating from Bucket SDK
+
+If you have been using the Bucket SDKs previously, the following list will help you migrate to Reflag SDK:
+
+- `Bucket*` classes, and types have been renamed to `Reflag*` (e.g. `BucketClient` is now `ReflagClient`)
+- `Feature*` classes, and types have been renamed to `Flag*` (e.g. `Feature` is now `Flag`, `RawFeatures` is now `RawFlags`)
+- When using strongly-typed flags, the new `Flags` interface replaced `Features` interface
+- All methods that contained `feature` in the name have been renamed to use the `flag` terminology (e.g. `getFeature` is `getFlag`)
+- All environment variables that were prefixed with `BUCKET_` are now prefixed with `REFLAG_`
+- The `BUCKET_HOST` environment variable and `host` option have been removed from `ReflagClient` constructor, use `REFLAG_API_BASE_URL` instead
+- The `BUCKET_FEATURES_ENABLED` and `BUCKET_FEATURES_DISABLED` have been renamed to `REFLAG_FLAGS_ENABLED` and `REFLAG_FLAGS_DISABLED`
+- The default configuration file has been renamed from `bucketConfig.json` to `reflag.config.json`
+- The `fallbackFeatures` property in client constructor and configuration files has been renamed to `fallbackFlags`
+- `featureKey` has been renamed to `flagKey` in all methods that accepts that argument
+- The SDKs will not emit `evaluate` and `evaluate-config` events anymore
+
 ## Typescript
 
 Types are bundled together with the library and exposed automatically when importing

packages/react-sdk/README.md

@@ -14,32 +14,6 @@ Install via npm:
 npm i @reflag/react-sdk
 ```
 
-## Migrating from Bucket SDK
-
-If you have been using the Bucket SDKs, the following list will help you migrate to Reflag SDK:
-
-- `Bucket*` classes, and types have been renamed to `Reflag*` (e.g. `BucketClient` is now `ReflagClient`)
-- `Feature*` classes, and types have been renamed to `Feature*` (e.g. `Feature` is now `Flag`, `RawFeatures` is now `RawFlags`)
-- When using strongly-typed flags, the new `Flags` interface replaced `Features` interface
-- All methods that contained `feature` in the name have been renamed to use the `flag` terminology (e.g. `getFeature` is `getFlag`)
-- The `fallbackFeatures` property in client constructor and configuration files has been renamed to `fallbackFlags`
-- `featureKey` has been renamed to `flagKey` in all methods that accepts that argument
-- The SDKs will not emit `evaluate` and `evaluate-config` events anymore
-- The new cookies that are stored in the client's browser are now `reflag-*` prefixed instead og `bucket-*`
-- The `featuresUpdated` hook has been renamed to `flagsUpdated`
-- The `checkIsEnabled` and `checkConfig` hooks have been removed, use `check` from now on
-
-To ease in transition to Reflag SDK, some of the old methods have been preserved as aliases to the new methods:
-
-- `getFeature` method is an alias for `getFlag`
-- `getFeatures` method is an alias for `getFlags`
-- `useFeature` method is an alias for `useFlag`
-- `featuresUpdated` hook is an alias for `flagsUpdated`
-
-If you are running with strict Content Security Policies active on your website, you will need change them as follows:
-
-- `connect-src https://front.bucket.co` to `connect-src https://front.reflag.com`
-
 ## Get started
 
 ### 1. Add the `ReflagProvider` context provider
@@ -133,16 +107,16 @@ A number of special attributes exist:
 - `avatar` -- the URL for `user`/`company` avatar image.
 
 ```tsx
- <ReflagProvider
-    publishableKey={YOUR_PUBLISHABLE_KEY}
-    user={{ id: "user_123", name: "John Doe", email: "john@acme.com" }}
-    company={{ id: "company_123", name: "Acme, Inc" }}
-    otherContext={{ completedSteps: [1, 4, 7] }}
-  >
-    <LoadingReflag>
+<ReflagProvider
+  publishableKey={YOUR_PUBLISHABLE_KEY}
+  user={{ id: "user_123", name: "John Doe", email: "john@acme.com" }}
+  company={{ id: "company_123", name: "Acme, Inc" }}
+  otherContext={{ completedSteps: [1, 4, 7] }}
+>
+  <LoadingReflag>
     {/* children here are shown when loading finishes */}
-    </LoadingReflag>
-  <ReflagProvider>
+  </LoadingReflag>
+</ReflagProvider>
 ```
 
 To retrieve flags along with their targeting information, use `useFlag(key: string)` hook (described in a section below).
@@ -229,20 +203,20 @@ The `<ReflagProvider>` initializes the Reflag SDK, fetches flags and starts list
 
   ```tsx
   function LoadingReflag({ children }) {
-    const { isLoading } = useFlag("myFlag")
+    const { isLoading } = useFlag("myFlag");
     if (isLoading) {
-      return <Spinner />
+      return <Spinner />;
     }
 
-    return children
+    return children;
   }
 
   //-- Initialize the Reflag provider
   <ReflagProvider publishableKey={YOUR_PUBLISHABLE_KEY} /*...*/>
     <LoadingReflag>
-    {/* children here are shown when loading finishes */}
+      {/* children here are shown when loading finishes */}
     </LoadingReflag>
-  <ReflagProvider>
+  </ReflagProvider>;
   ```
 
 - `enableTracking`: Set to `false` to stop sending tracking events and user/company updates to Reflag. Useful when you're impersonating a user (defaults to `true`),
@@ -306,13 +280,13 @@ function StartHuddleButton() {
 
 ### `useTrack()`
 
-`useTrack()` lets you send custom events to Reflag. Use this whenever a user _uses_ a feature. Create [features](https://docs.reflag.com/introduction/concepts/feature) in Reflag based off of these events to analyze feature usage.
-Returns a function to send custom events to Reflag. Use this whenever a user _uses_ a feature. These events can be used to analyze feature usage and create new flags in Reflag.
+`useTrack()` lets you send custom events to Reflag. Use this whenever a user _uses_ a feature. These events can be used to analyze feature usage in Reflag.
 
 ```tsx
 import { useTrack } from "@reflag/react-sdk";
 
 function StartHuddle() {
+  const { track } = useTrack();
   <div>
     <button onClick={() => track("Huddle Started", { huddleType: "voice" })}>
       Start voice huddle!
@@ -323,10 +297,7 @@ function StartHuddle() {
 
 ### `useRequestFeedback()`
 
-Returns a function that lets you open up a dialog to ask for feedback on a specific feature. This is useful for collecting targeted feedback about specific features.
-
-`useRequestFeedback()` returns a function that lets you open up a dialog to ask for feedback on a specific feature.
-See [Automated Feedback Surveys](https://docs.reflag.com/product-handbook/live-satisfaction) for how to do this automatically, without code.
+`useRequestFeedback()` returns a function that lets you open up a dialog to ask for feedback on a specific feature. This is useful for collecting targeted feedback about specific features as part of roll out. See [Automated Feedback Surveys](https://docs.reflag.com/product-handbook/live-satisfaction) for how to do this automatically, without code.
 
 When using the `useRequestFeedback` you must pass the flag key to `requestFeedback`.
 The example below shows how to use `position` to ensure the popover appears next to the "Give feedback!" button.
@@ -454,6 +425,32 @@ function LoggingWrapper({ children }: { children: ReactNode }) {
 }
 ```
 
+## Migrating from Bucket SDK
+
+If you have been using the Bucket SDKs, the following list will help you migrate to Reflag SDK:
+
+- `Bucket*` classes, and types have been renamed to `Reflag*` (e.g. `BucketClient` is now `ReflagClient`)
+- `Feature*` classes, and types have been renamed to `Flag*` (e.g. `Feature` is now `Flag`, `RawFeatures` is now `RawFlags`)
+- When using strongly-typed flags, the new `Flags` interface replaced `Features` interface
+- All methods that contained `feature` in the name have been renamed to use the `flag` terminology (e.g. `getFeature` is `getFlag`)
+- The `fallbackFeatures` property in client constructor and configuration files has been renamed to `fallbackFlags`
+- `featureKey` has been renamed to `flagKey` in all methods that accepts that argument
+- The SDKs will not emit `evaluate` and `evaluate-config` events anymore
+- The new cookies that are stored in the client's browser are now `reflag-*` prefixed instead of `bucket-*`
+- The `featuresUpdated` hook has been renamed to `flagsUpdated`
+- The `checkIsEnabled` and `checkConfig` hooks have been removed, use `check` from now on
+
+To ease in transition to Reflag SDK, some of the old methods have been preserved as aliases to the new methods:
+
+- `getFeature` method is an alias for `getFlag`
+- `getFeatures` method is an alias for `getFlags`
+- `useFeature` method is an alias for `useFlag`
+- `featuresUpdated` hook is an alias for `flagsUpdated`
+
+If you are running with strict Content Security Policies active on your website, you will need change them as follows:
+
+- `connect-src https://front.bucket.co` to `connect-src https://front.reflag.com`
+
 ## Content Security Policy (CSP)
 
 See [CSP](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/README.md#content-security-policy-csp) for info on using Reflag React SDK with CSP