feat: add helpers to retrieve a list of all feature flags / remote co… (

#108)
tryabby · Mar 18, 2024 · ed7d158 · ed7d158
1 parent add0fbf
commit ed7d158
Show file tree

Hide file tree

Showing 23 changed files with 323 additions and 16 deletions.
diff --git a/apps/angular-example/CHANGELOG.md b/apps/angular-example/CHANGELOG.md
@@ -1,5 +1,12 @@
 # angular-example
 
+## 0.0.17
+
+### Patch Changes
+
+- @tryabby/angular@2.0.7
+- @tryabby/devtools@5.0.0
+
 ## 0.0.16
 
 ### Patch Changes

diff --git a/apps/angular-example/package.json b/apps/angular-example/package.json
@@ -1,6 +1,6 @@
 {
   "name": "angular-example",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "private": true,
   "scripts": {
     "ng": "ng",

diff --git a/apps/docs/pages/reference/nextjs.mdx b/apps/docs/pages/reference/nextjs.mdx
@@ -111,6 +111,18 @@ The name of the flag, needs to be one of the defined flags.
 
 The value of the flag _Type: `boolean`_
 
+#### useFeatureFlags
+
+`useFeatureFlags` is a React hook that is used to access all existing feature flags.
+
+##### Parameters
+
+The name of the flag, needs to be one of the defined flags.
+
+##### Return Value
+
+An Array of all feature flags. Includes the name and the value. The value will be a boolean.
+
 #### useRemoteConfig
 
 `useRemotConfig` is a React hook that is used to access the value of a Remote Configuration variable.
@@ -123,6 +135,18 @@ The name of the Remote Configuration variable, which needs to be one of the keys
 
 The current value of the Remote Configuration variable. The type will be according to the specified type in the `abby.config.ts`
 
+#### useRemoteConfigVariables
+
+`useRemoteConfigVariables` is a React hook that is used to access all existing Remote Configuration variables.
+
+##### Parameters
+
+None
+
+##### Return Value
+
+An Array of all remote config variables. Includes the name and the value. The type will be according to the specified type in the `abby.config.ts`
+
 #### AbbyProvider
 
 A react component to wrap your application.

diff --git a/apps/docs/pages/reference/react.mdx b/apps/docs/pages/reference/react.mdx
@@ -111,9 +111,21 @@ The name of the flag, needs to be one of the defined flags.
 
 The value of the flag _Type: `boolean`_
 
+#### useFeatureFlags
+
+`useFeatureFlags` is a React hook that is used to access all existing feature flags.
+
+##### Parameters
+
+The name of the flag, needs to be one of the defined flags.
+
+##### Return Value
+
+An Array of all feature flags. Includes the name and the value. The value will be a boolean.
+
 #### useRemoteConfig
 
-`useRemotConfig` is a React hook that is used to access the value of a Remote Configuration variable.
+`useRemoteConfig` is a React hook that is used to access the value of a Remote Configuration variable.
 
 ##### Parameters
 
@@ -123,6 +135,18 @@ The name of the Remote Configuration variable, which needs to be one of the keys
 
 The current value of the Remote Configuration variable. The type will be according to the specified type in the `abby.config.ts`
 
+#### useRemoteConfigVariables
+
+`useRemoteConfigVariables` is a React hook that is used to access all existing Remote Configuration variables.
+
+##### Parameters
+
+None
+
+##### Return Value
+
+An Array of all remote config variables. Includes the name and the value. The type will be according to the specified type in the `abby.config.ts`
+
 #### AbbyProvider
 
 A react component to wrap your application.

diff --git a/apps/web/CHANGELOG.md b/apps/web/CHANGELOG.md
@@ -1,5 +1,14 @@
 # web
 
+## 0.2.35
+
+### Patch Changes
+
+- Updated dependencies
+  - @tryabby/core@5.2.0
+  - @tryabby/next@5.1.0
+  - @tryabby/devtools@5.0.0
+
 ## 0.2.34
 
 ### Patch Changes

diff --git a/apps/web/package.json b/apps/web/package.json
@@ -1,6 +1,6 @@
 {
   "name": "web",
-  "version": "0.2.34",
+  "version": "0.2.35",
   "private": true,
   "scripts": {
     "build": "next build",

diff --git a/packages/angular/CHANGELOG.md b/packages/angular/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @tryabby/angular
 
+## 2.0.7
+
+### Patch Changes
+
+- Updated dependencies
+  - @tryabby/core@5.2.0
+
 ## 2.0.6
 
 ### Patch Changes

diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tryabby/angular",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",

diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @tryabby/core
 
+## 5.2.0
+
+### Minor Changes
+
+- add helper to retrieve all flags/config variables
+
 ## 5.1.4
 
 ### Patch Changes

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tryabby/core",
-  "version": "5.1.4",
+  "version": "5.2.0",
   "description": "",
   "main": "dist/index.js",
   "files": [

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -13,7 +13,7 @@ import {
   ABBY_WINDOW_KEY,
 } from "./shared/";
 import { HttpService } from "./shared";
-import { F } from "ts-toolbelt";
+import { F, O } from "ts-toolbelt";
 import { getWeightedRandomVariant } from "./mathHelpers";
 import { parseCookies } from "./helpers";
 
@@ -581,4 +581,27 @@ export class Abby<
     }
     return stringifyRemoteConfigValue(value);
   }
+
+  /**
+   * Retruns an Array of all flags with their name and value
+   */
+  getFeatureFlags() {
+    return (Object.keys(this.#data.flags) as Array<FlagName>).map((flagName) => ({
+      name: flagName,
+      value: this.getFeatureFlag(flagName),
+    }));
+  }
+
+  /**
+   * Retruns an Array of all remote config variables with their name and value
+   */
+  getRemoteConfigVariables() {
+    return (Object.keys(this.#data.remoteConfig) as Array<RemoteConfigName>).map((configName) => ({
+      name: configName,
+      value: this.getRemoteConfig(configName),
+    })) as Array<{
+      name: RemoteConfigName;
+      value: RemoteConfigValueStringToType<RemoteConfig[RemoteConfigName]>;
+    }>;
+  }
 }
diff --git a/packages/core/tests/base.test.ts b/packages/core/tests/base.test.ts
@@ -270,6 +270,72 @@ describe("Abby", () => {
 
     expect(abby.getRemoteConfig("remoteConfig1")).toBe("bar");
   });
+
+  it("returns the correct list of all flags", () => {
+    const flagInit = [
+      {
+        name: "a",
+        value: true,
+      },
+      {
+        name: "b",
+        value: true,
+      },
+      {
+        name: "c",
+        value: false,
+      },
+    ];
+    const abby = new Abby({
+      environments: ["test"],
+      currentEnvironment: "test",
+      projectId: "",
+      flags: ["a", "b", "c"],
+    });
+
+    abby.init({
+      flags: flagInit,
+      tests: [],
+      remoteConfig: [],
+    });
+    expect(abby.getFeatureFlags()).toEqual(flagInit);
+  });
+
+  it("returns the correct list of all remote config variables", () => {
+    const configInit = [
+      {
+        name: "a",
+        value: "test",
+      },
+      {
+        name: "b",
+        value: 123,
+      },
+      {
+        name: "c",
+        value: { a: true },
+      },
+    ];
+    const abby = new Abby({
+      environments: ["test"],
+      currentEnvironment: "test",
+      projectId: "",
+      remoteConfig: {
+        a: "String",
+        b: "Number",
+        c: "JSON",
+      },
+    });
+
+    abby.init({
+      flags: [],
+      tests: [],
+      remoteConfig: configInit,
+    });
+    expect(abby.getRemoteConfigVariables()).toEqual(configInit);
+
+    const d = abby.getRemoteConfigVariables();
+  });
 });
 
 describe("Math helpers", () => {

diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @tryabby/next
 
+## 5.1.0
+
+### Minor Changes
+
+- add helper to retrieve all flags/config variables
+
+### Patch Changes
+
+- Updated dependencies
+  - @tryabby/react@5.1.0
+
 ## 5.0.6
 
 ### Patch Changes

diff --git a/packages/next/package.json b/packages/next/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tryabby/next",
-  "version": "5.0.6",
+  "version": "5.1.0",
   "description": "",
   "main": "dist/index.js",
   "files": [

diff --git a/packages/next/src/index.tsx b/packages/next/src/index.tsx
@@ -41,6 +41,8 @@ export function createAbby<
     __abby__,
     getVariants,
     withDevtools,
+    useFeatureFlags,
+    useRemoteConfigVariables,
   } = baseCreateAbby<FlagName, TestName, Tests, RemoteConfig, RemoteConfigName, ConfigType>(config);
 
   const abbyApiHandler =
@@ -78,6 +80,8 @@ export function createAbby<
     withAbby: withAbby(config as AbbyConfig<FlagName, Tests>, __abby__),
     getFeatureFlagValue,
     useRemoteConfig,
+    useFeatureFlags,
+    useRemoteConfigVariables,
     getRemoteConfig,
     __abby__,
     getVariants,
@@ -101,8 +105,8 @@ export function createAbby<
       ResponseType extends NextResponse | NextApiResponse = RequestType extends NextRequest
         ? NextResponse
         : RequestType extends NextApiRequest
-        ? NextApiResponse
-        : never,
+          ? NextApiResponse
+          : never,
     >(
       name: T,
       req?: RequestType,
@@ -111,8 +115,8 @@ export function createAbby<
       Lookup extends undefined
         ? TestVariant
         : TestVariant extends keyof Lookup
-        ? Lookup[TestVariant]
-        : never,
+          ? Lookup[TestVariant]
+          : never,
       RequestType extends NextRequest | NextApiRequest ? (res: ResponseType) => void : () => void,
     ] {
       const cookies = getIsomorphicCookies(req);
@@ -170,8 +174,8 @@ export function createAbby<
       ResponseType extends NextResponse | NextApiResponse = RequestType extends NextRequest
         ? NextResponse
         : RequestType extends NextApiRequest
-        ? NextApiResponse
-        : never,
+          ? NextApiResponse
+          : never,
     >(
       name: T,
       req?: RequestType

diff --git a/packages/node/CHANGELOG.md b/packages/node/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @tryabby/node
 
+## 5.1.5
+
+### Patch Changes
+
+- Updated dependencies
+  - @tryabby/core@5.2.0
+
 ## 5.1.4
 
 ### Patch Changes

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tryabby/node",
-  "version": "5.1.4",
+  "version": "5.1.5",
   "description": "",
   "main": "dist/index.js",
   "files": [

diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @tryabby/react
 
+## 5.1.0
+
+### Minor Changes
+
+- add helper to retrieve all flags/config variables
+
+### Patch Changes
+
+- Updated dependencies
+  - @tryabby/core@5.2.0
+
 ## 5.0.6
 
 ### Patch Changes

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tryabby/react",
-  "version": "5.0.6",
+  "version": "5.1.0",
   "description": "",
   "main": "dist/index.js",
   "files": [