feat: Amplitude Experiment - add support for feature flags (#4078)

contentful · Jan 15, 2025 · 17a3ba8 · 17a3ba8
1 parent 73a6de2
commit 17a3ba8
Show file tree

Hide file tree

Showing 6 changed files with 178 additions and 291 deletions.
diff --git a/apps/amplitude-experiment/README.md b/apps/amplitude-experiment/README.md
@@ -12,7 +12,7 @@ Run
 yarn install && yarn start
 ```
 
-To test locally, create an app definition that points to `localhost:3000` for the App URL and register the `App configuration screen`, `Entry sidebar`, and `Entry editor` locations.
+To test locally, create an app definition that points to `localhost:5173` for the App URL and register the `App configuration screen`, `Entry sidebar`, and `Entry editor` locations.
 
 ## [Privacy Policy](https://amplitude.com/privacy)
 

diff --git a/apps/amplitude-experiment/package.json b/apps/amplitude-experiment/package.json
@@ -2,6 +2,10 @@
   "name": "amplitude-contentful",
   "version": "1.0.6",
   "private": true,
+  "engines": {
+    "node": ">=18.0.0 < 20.0.0",
+    "npm": ">= 9.0.0 < 11.0.0"
+  },
   "dependencies": {
     "@contentful/app-sdk": "^4.29.1",
     "@contentful/f36-components": "4.70.0",

diff --git a/apps/amplitude-experiment/src/contexts/ExperimentContext.tsx b/apps/amplitude-experiment/src/contexts/ExperimentContext.tsx
@@ -1,6 +1,6 @@
-import { createContext, useEffect, useMemo, useState } from "react";
-import { AmplitudeExperimentApi } from "../utils/amplitude";
-import { useSDK } from "@contentful/react-apps-toolkit";
+import { createContext, useEffect, useMemo, useState } from 'react';
+import { AmplitudeExperimentApi } from '../utils/amplitude';
+import { useSDK } from '@contentful/react-apps-toolkit';
 
 export interface Variant {
   [key: string]: string;
@@ -15,6 +15,7 @@ export interface TargetSegmentCondition {
   type: string;
   values: Array<string>;
 }
+
 export interface TargetSegment {
   bucketingKey: string;
   conditions: Array<TargetSegmentCondition>;
@@ -24,9 +25,9 @@ export interface TargetSegment {
 }
 
 export declare enum ExperimentDecision {
-  ROLLOUT = "rollout",
-  ROLLBACK = "rollback",
-  CONTINUE_RUNNING = "continue-running",
+  ROLLOUT = 'rollout',
+  ROLLBACK = 'rollback',
+  CONTINUE_RUNNING = 'continue-running',
 }
 
 export interface Experiment {
@@ -53,8 +54,31 @@ export interface Experiment {
   rolloutWeights: RolloutWeights;
 }
 
+export interface Flag {
+  bucketingKey: string;
+  bucketingSalt: string;
+  bucketingUnit: string;
+  decision: ExperimentDecision | null;
+  deleted: boolean;
+  description: string;
+  evaluationMode: string;
+  enabled: boolean;
+  id: string;
+  projectId: string;
+  deployments: Array<string>;
+  key: string;
+  name: string;
+  variants: Array<Variant>;
+  targetSegments: Array<TargetSegment>;
+  rolloutPercentage: number;
+  stickyBucketing: boolean;
+  tags: Array<string>;
+  rolledOutVariant: string | null; // variant key
+  rolloutWeights: RolloutWeights;
+}
+
 interface ExperimentContextProps {
-  experiments: Array<Experiment>;
+  experiments: Array<Experiment | Flag>;
   loading: boolean;
   amplitudeExperimentApi: AmplitudeExperimentApi | null;
 }
@@ -65,40 +89,26 @@ export const ExperimentContext = createContext<ExperimentContextProps>({
   amplitudeExperimentApi: null,
 });
 
-export const ExperimentProvider = ({
-  children,
-}: {
-  children: React.ReactElement;
-}) => {
+export const ExperimentProvider = ({ children }: { children: React.ReactElement }) => {
   const sdk = useSDK();
-  const [experiments, setExperiments] = useState<Experiment[]>([]);
+  const [experiments, setExperiments] = useState<(Experiment | Flag)[]>([]);
   const [loading, setLoading] = useState<boolean>(false);
   const amplitudeExperimentApi = useMemo(
-    () =>
-      new AmplitudeExperimentApi(
-        sdk.parameters.installation.managementApiKey,
-        sdk.parameters.installation.datacenter
-      ),
-    [
-      sdk.parameters.installation.managementApiKey,
-      sdk.parameters.installation.datacenter,
-    ]
+    () => new AmplitudeExperimentApi(sdk.parameters.installation.managementApiKey, sdk.parameters.installation.datacenter),
+    [sdk.parameters.installation.managementApiKey, sdk.parameters.installation.datacenter]
   );
 
   useEffect(() => {
     const fetchExperiments = async () => {
       setLoading(true);
-      const experiments = await amplitudeExperimentApi.listAllExperiments();
-      return experiments;
+      const experiments = await amplitudeExperimentApi.listAllResources(true);
+      const flags = await amplitudeExperimentApi.listAllResources();
+      return [...experiments, ...flags];
     };
     fetchExperiments().then((experiments) => {
       setExperiments(experiments);
       setLoading(false);
     });
   }, [amplitudeExperimentApi]);
-  return (
-    <ExperimentContext.Provider value={{ experiments, loading, amplitudeExperimentApi }}>
-      {children}
-    </ExperimentContext.Provider>
-  );
+  return <ExperimentContext.Provider value={{ experiments, loading, amplitudeExperimentApi }}>{children}</ExperimentContext.Provider>;
 };