load the new featureFlags into global state and allow updating via qu…

…ery params (prefix: `pinboardFeatureFlag_`)
guardian · Nov 5, 2024 · 4e2ee67 · 4e2ee67
1 parent a4c4519
commit 4e2ee67
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 52 deletions.
diff --git a/cdk/lib/__snapshots__/stack.test.ts.snap b/cdk/lib/__snapshots__/stack.test.ts.snap
@@ -2491,9 +2491,13 @@ type Subscription {
     pinboardId: String!
   ): LastItemSeenByUser @aws_subscribe(mutations: [\\"seenItem\\"])
 
-  onManuallyOpenedPinboardIdsChanged(
+  onMyUserChanges(
     email: String! # unfortunately this can't be done via 'identity' in the resolver
-  ): MyUser @aws_subscribe(mutations: [\\"addManuallyOpenedPinboardIds\\", \\"removeManuallyOpenedPinboardIds\\"])
+  ): MyUser @aws_subscribe(mutations: [
+    \\"addManuallyOpenedPinboardIds\\",
+    \\"removeManuallyOpenedPinboardIds\\",
+    \\"changeFeatureFlag\\"
+  ])
 }
 
 type MentionHandle {
@@ -2671,7 +2675,7 @@ type PinboardIdWithItemCounts {
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "addManuallyOpenedPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2692,7 +2696,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "changeFeatureFlag",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2713,7 +2717,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "claimItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2734,7 +2738,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "createItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2755,7 +2759,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "deleteItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2776,7 +2780,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "editItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2797,7 +2801,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "removeManuallyOpenedPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2818,7 +2822,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "seenItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2839,7 +2843,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "setWebPushSubscriptionForUser",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2860,7 +2864,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "visitTourStep",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2881,7 +2885,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getGroupPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2902,7 +2906,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getItemCounts",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2923,7 +2927,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getMyUser",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2944,7 +2948,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2965,7 +2969,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "listItems",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2986,7 +2990,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "listLastItemSeenByUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3007,7 +3011,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "searchMentionableUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3136,7 +3140,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "grid_bridge_lambda_ds",
         "FieldName": "asGridPayload",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3157,7 +3161,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "grid_bridge_lambda_ds",
         "FieldName": "getGridSearchSummary",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3286,7 +3290,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "getPinboardByComposerId",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3307,7 +3311,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "getPinboardsByIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3328,7 +3332,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "listPinboards",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : 7988db64c71d520310206ab1f55f3ca3
+        "ResponseMappingTemplate": "## schema checksum : 117bac3c96ba985bef3ad1486ee0eb07
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },

diff --git a/client/gql.ts b/client/gql.ts
@@ -180,9 +180,9 @@ export const gqlRemoveManuallyOpenedPinboardIds = gql`
     }
 `;
 
-export const gqlOnManuallyOpenedPinboardIdsChanged = (userEmail: string) => gql`
-    subscription OnManuallyOpenedPinboardIdsChanged {
-        onManuallyOpenedPinboardIdsChanged(email: "${userEmail}") {
+export const gqlOnMyUserChanges = (userEmail: string) => gql`
+    subscription onMyUserChanges {
+        onMyUserChanges(email: "${userEmail}") {
             ${myUserReturnFields}
         }
     }
@@ -275,3 +275,11 @@ export const gqlVisitTourStep = gql`
         }
     }
 `;
+
+export const gqlChangeFeatureFlag = gql`
+    mutation changeFeatureFlag($flagId: String!, $newValue: Boolean!) {
+        changeFeatureFlag(flagId: $flagId, newValue: $newValue) {
+            ${myUserReturnFields}
+        }
+    }
+`;
diff --git a/client/src/app.tsx b/client/src/app.tsx
@@ -18,7 +18,7 @@ import {
   gqlVisitTourStep,
   gqlGetMyUser,
   gqlGetUsers,
-  gqlOnManuallyOpenedPinboardIdsChanged,
+  gqlOnMyUserChanges,
   gqlSetWebPushSubscriptionForUser,
 } from "../gql";
 import { Item, MyUser, User } from "shared/graphql/graphql";
@@ -45,6 +45,10 @@ import { getAgateFontFaceIfApplicable } from "../fontNormaliser";
 import { Global } from "@emotion/react";
 import { TourStateProvider } from "./tour/tourState";
 import { demoMentionableUsers, demoUser } from "./tour/tourConstants";
+import {
+  consumeFeatureFlagQueryParamsAndUpdateAccordingly,
+  extractFeatureFlags,
+} from "./featureFlags";
 
 const PRESELECT_PINBOARD_HTML_TAG = "pinboard-preselect";
 const PRESET_UNREAD_NOTIFICATIONS_COUNT_HTML_TAG = "pinboard-bubble-preset";
@@ -206,7 +210,7 @@ export const PinBoardApp = ({
   const me = meQuery.data?.getMyUser;
 
   const manuallyOpenedPinboardIds = me?.manuallyOpenedPinboardIds;
-  const setManuallyOpenedPinboardIds = (newMyUser: MyUser) => {
+  const updateUserWithChanges = (newMyUser: MyUser) => {
     meQuery.updateQuery(() => ({ getMyUser: newMyUser }));
   };
 
@@ -225,18 +229,13 @@ export const PinBoardApp = ({
           meQuery.updateQuery(() => ({ getMyUser: data.visitTourStep }));
       });
 
-  useSubscription<{ onManuallyOpenedPinboardIdsChanged: MyUser }>(
-    gqlOnManuallyOpenedPinboardIdsChanged(userEmail),
-    {
-      client: apolloClient,
-      onSubscriptionData: ({ subscriptionData }) => {
-        subscriptionData.data &&
-          setManuallyOpenedPinboardIds(
-            subscriptionData.data?.onManuallyOpenedPinboardIdsChanged
-          );
-      },
-    }
-  );
+  useSubscription<{ onMyUserChanges: MyUser }>(gqlOnMyUserChanges(userEmail), {
+    client: apolloClient,
+    onSubscriptionData: ({ subscriptionData }) => {
+      subscriptionData.data &&
+        updateUserWithChanges(subscriptionData.data?.onMyUserChanges);
+    },
+  });
 
   const rawHasWebPushSubscription = me?.hasWebPushSubscription;
 
@@ -357,6 +356,16 @@ export const PinBoardApp = ({
 
   const hasApolloAuthError = useReactiveVar(hasApolloAuthErrorVar);
 
+  const featureFlags = useMemo(
+    () => extractFeatureFlags(me?.featureFlags),
+    [me?.featureFlags]
+  );
+  consumeFeatureFlagQueryParamsAndUpdateAccordingly(apolloClient);
+
+  useEffect(() => {
+    console.log("test feature flag:", featureFlags["test"]);
+  }, [featureFlags]);
+
   return (
     <TelemetryContext.Provider value={sendTelemetryEvent}>
       <ApolloProvider client={apolloClient}>
@@ -373,13 +382,14 @@ export const PinBoardApp = ({
           addEmailsToLookup={addEmailsToLookup}
           hasWebPushSubscription={hasWebPushSubscription}
           manuallyOpenedPinboardIds={manuallyOpenedPinboardIds || []}
-          setManuallyOpenedPinboardIds={setManuallyOpenedPinboardIds}
+          updateUserWithChanges={updateUserWithChanges}
           showNotification={showDesktopNotification}
           clearDesktopNotificationsForPinboardId={
             clearDesktopNotificationsForPinboardId
           }
           hasEverUsedTour={me?.hasEverUsedTour}
           visitTourStep={visitTourStep}
+          featureFlags={featureFlags}
         >
           <TourStateProvider>
             <Global styles={agateFontFaceIfApplicable} />

diff --git a/client/src/featureFlags.ts b/client/src/featureFlags.ts
@@ -0,0 +1,34 @@
+import { readAndThenSilentlyDropQueryParamFromURL } from "./util";
+import { ApolloClient } from "@apollo/client";
+import { gqlChangeFeatureFlag } from "../gql";
+
+export const ALLOWED_FEATURE_FLAGS = ["test"] as const;
+export type AllowedFeatureFlags = (typeof ALLOWED_FEATURE_FLAGS)[number];
+
+export type FeatureFlags = Partial<Record<AllowedFeatureFlags, boolean>>;
+
+export const extractFeatureFlags = (
+  featureFlagsStr: string | null | undefined
+): FeatureFlags =>
+  featureFlagsStr ? (JSON.parse(featureFlagsStr) as FeatureFlags) : {};
+
+export const consumeFeatureFlagQueryParamsAndUpdateAccordingly = (
+  apolloClient: ApolloClient<unknown>
+) =>
+  ALLOWED_FEATURE_FLAGS.forEach((flagId) => {
+    const flagStringValue = readAndThenSilentlyDropQueryParamFromURL(
+      `pinboardFeatureFlag_${flagId}`
+    );
+    if (flagStringValue !== null) {
+      apolloClient
+        .mutate({
+          mutation: gqlChangeFeatureFlag,
+          variables: {
+            flagId,
+            newValue: flagStringValue === "true",
+          },
+        })
+        .catch(console.error);
+      // we rely on the subscription 'updateUserWithChanges'
+    }
+  });