added new route for safe experiments

coder · Kira-Pilot · Oct 17, 2023 · Oct 15, 2023 · Oct 15, 2023 · Oct 15, 2023
commit 242231630ec9481b4492140f2b0f73cf066cb843
diff --git a/coderd/experiments_test.go b/coderd/experiments_test.go
@@ -25,7 +25,7 @@ func Test_Experiments(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		experiments, err := client.Experiments(ctx, codersdk.ExperimentOptions{})
+		experiments, err := client.Experiments(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, experiments)
 		require.Empty(t, experiments)
@@ -44,7 +44,7 @@ func Test_Experiments(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		experiments, err := client.Experiments(ctx, codersdk.ExperimentOptions{})
+		experiments, err := client.Experiments(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, experiments)
 		// Should be lower-cased.
@@ -66,7 +66,7 @@ func Test_Experiments(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		experiments, err := client.Experiments(ctx, codersdk.ExperimentOptions{})
+		experiments, err := client.Experiments(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, experiments)
 		require.ElementsMatch(t, codersdk.ExperimentsAll, experiments)
@@ -88,7 +88,7 @@ func Test_Experiments(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		experiments, err := client.Experiments(ctx, codersdk.ExperimentOptions{})
+		experiments, err := client.Experiments(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, experiments)
 		require.ElementsMatch(t, append(codersdk.ExperimentsAll, "danger"), experiments)
@@ -112,26 +112,8 @@ func Test_Experiments(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		_, err := client.Experiments(ctx, codersdk.ExperimentOptions{})
+		_, err := client.Experiments(ctx)
 		require.Error(t, err)
 		require.ErrorContains(t, err, httpmw.SignedOutErrorMessage)
 	})
-
-	t.Run("include_all query param", func(t *testing.T) {
-		t.Parallel()
-		cfg := coderdtest.DeploymentValues(t)
-		cfg.Experiments = []string{"foo", "BAR"}
-		client := coderdtest.New(t, &coderdtest.Options{
-			DeploymentValues: cfg,
-		})
-		_ = coderdtest.CreateFirstUser(t, client)
-
-		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
-		defer cancel()
-
-		experiments, err := client.Experiments(ctx, codersdk.ExperimentOptions{IncludeAll: true})
-		require.NoError(t, err)
-		require.NotNil(t, experiments)
-		require.ElementsMatch(t, codersdk.ExperimentsAll, experiments)
-	})
 }
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -852,11 +852,9 @@ export const getEntitlements = async (): Promise<TypesGen.Entitlements> => {
   }
 };
 
-export const getExperiments = async (
-  params?: TypesGen.ExperimentOptions,
-): Promise<TypesGen.Experiment[]> => {
+export const getExperiments = async (): Promise<TypesGen.Experiment[]> => {
   try {
-    const response = await axios.get("/api/v2/experiments", { params });
+    const response = await axios.get("/api/v2/experiments");
     return response.data;
   } catch (error) {
     if (axios.isAxiosError(error) && error.response?.status === 404) {
@@ -866,6 +864,19 @@ export const getExperiments = async (
   }
 };
 
+export const getAvailableExperiments =
+  async (): Promise<TypesGen.AvailableExperiments> => {
+    try {
+      const response = await axios.get("/api/v2/experiments/available");
+      return response.data;
+    } catch (error) {
+      if (axios.isAxiosError(error) && error.response?.status === 404) {
+        return { safe: [] };
+      }
+      throw error;
+    }
+  };
+
 export const getExternalAuthProvider = async (
   provider: string,
 ): Promise<TypesGen.ExternalAuth> => {

diff --git a/site/src/api/queries/experiments.ts b/site/src/api/queries/experiments.ts
@@ -1,5 +1,5 @@
 import * as API from "api/api";
-import { Experiments, ExperimentOptions } from "api/typesGenerated";
+import { Experiments } from "api/typesGenerated";
 import { getMetadataAsJSON } from "utils/metadata";
 
 export const experiments = () => {
@@ -10,9 +10,9 @@ export const experiments = () => {
   };
 };
 
-export const updatedExperiments = (params?: ExperimentOptions) => {
+export const availableExperiments = () => {
   return {
-    queryKey: ["experiments"],
-    queryFn: async () => API.getExperiments(params),
+    queryKey: ["availableExperiments"],
+    queryFn: async () => API.getAvailableExperiments(),
   };
 };
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPage.tsx b/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPage.tsx
@@ -4,15 +4,15 @@ import { useQuery } from "react-query";
 import { pageTitle } from "utils/page";
 import { deploymentDAUs } from "api/queries/deployment";
 import { entitlements } from "api/queries/entitlements";
-import { updatedExperiments } from "api/queries/experiments";
+import { availableExperiments } from "api/queries/experiments";
 import { useDeploySettings } from "components/DeploySettingsLayout/DeploySettingsLayout";
 import { GeneralSettingsPageView } from "./GeneralSettingsPageView";
 
 const GeneralSettingsPage: FC = () => {
   const { deploymentValues } = useDeploySettings();
   const deploymentDAUsQuery = useQuery(deploymentDAUs());
   const entitlementsQuery = useQuery(entitlements());
-  const experimentsQuery = useQuery(updatedExperiments({ include_all: true }));
+  const experimentsQuery = useQuery(availableExperiments());
 
   return (
     <>
@@ -24,7 +24,7 @@ const GeneralSettingsPage: FC = () => {
         deploymentDAUs={deploymentDAUsQuery.data}
         deploymentDAUsError={deploymentDAUsQuery.error}
         entitlements={entitlementsQuery.data}
-        allExperiments={experimentsQuery.data}
+        safeExperiments={experimentsQuery.data?.safe ?? []}
       />
     </>
   );

diff --git a/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.stories.tsx b/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.stories.tsx
@@ -40,7 +40,7 @@ const meta: Meta<typeof GeneralSettingsPageView> = {
       },
     ],
     deploymentDAUs: MockDeploymentDAUResponse,
-    allExperiments: ["single_tailnet", "deployment_health_page"],
+    safeExperiments: ["single_tailnet", "deployment_health_page"],
   },
 };
 
@@ -102,6 +102,6 @@ export const allExperimentsEnabled: Story = {
         hidden: false,
       },
     ],
-    allExperiments: ["single_tailnet", "deployment_health_page"],
+    safeExperiments: ["single_tailnet", "deployment_health_page"],
   },
 };
diff --git a/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.tsx b/site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.tsx
@@ -22,14 +22,14 @@ export type GeneralSettingsPageViewProps = {
   deploymentDAUs?: DAUsResponse;
   deploymentDAUsError: unknown;
   entitlements: Entitlements | undefined;
-  allExperiments: Experiments | undefined;
+  safeExperiments: Experiments | undefined;
 };
 export const GeneralSettingsPageView = ({
   deploymentOptions,
   deploymentDAUs,
   deploymentDAUsError,
   entitlements,
-  allExperiments,
+  safeExperiments,
 }: GeneralSettingsPageViewProps): JSX.Element => {
   return (
     <>
@@ -64,7 +64,7 @@ export const GeneralSettingsPageView = ({
             "Wildcard Access URL",
             "Experiments",
           )}
-          additionalValues={allExperiments}
+          additionalValues={safeExperiments}
         />
       </Stack>
     </>