added new option table type for experiments

coder · Kira-Pilot · Oct 17, 2023 · Oct 15, 2023 · Oct 15, 2023 · Oct 15, 2023
commit ebe2d93e6eea222cedc65630f4132a706303eb8d
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/experiments.go b/coderd/experiments.go
@@ -4,16 +4,25 @@ import (
 	"net/http"
 
 	"github.com/coder/coder/v2/coderd/httpapi"
+	"github.com/coder/coder/v2/codersdk"
 )
 
 // @Summary Get experiments
 // @ID get-experiments
 // @Security CoderSessionToken
 // @Produce json
 // @Tags General
+// @Param include_all query bool false "All available experiments"
 // @Success 200 {array} codersdk.Experiment
 // @Router /experiments [get]
 func (api *API) handleExperimentsGet(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
-	httpapi.Write(ctx, rw, http.StatusOK, api.Experiments)
+	all := r.URL.Query().Has("include_all")
+
+	if !all {
+		httpapi.Write(ctx, rw, http.StatusOK, api.Experiments)
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, codersdk.ExperimentsAll)
 }
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -2028,8 +2028,26 @@ func (e Experiments) Enabled(ex Experiment) bool {
 	return false
 }
 
-func (c *Client) Experiments(ctx context.Context) (Experiments, error) {
-	res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments", nil)
+type ExperimentOptions struct {
+	// All signifies that all experiments - rather than just those that are enabled -
+	// should be returned
+	IncludeAll bool `json:"include_all,omitempty"`
+}
+
+// asRequestOption returns a function that can be used in (*Client).Request.
+// It modifies the request query parameters.
+func (o ExperimentOptions) asRequestOption() RequestOption {
+	return func(r *http.Request) {
+		q := r.URL.Query()
+		if o.IncludeAll {
+			q.Set("include_all", "true")
+		}
+		r.URL.RawQuery = q.Encode()
+	}
+}
+
+func (c *Client) Experiments(ctx context.Context, opts ExperimentOptions) (Experiments, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments", nil, opts.asRequestOption())
 	if err != nil {
 		return nil, err
 	}

diff --git a/docs/api/general.md b/docs/api/general.md
@@ -852,9 +852,11 @@ export const getEntitlements = async (): Promise<TypesGen.Entitlements> => {
   }
 };
 
-export const getExperiments = async (): Promise<TypesGen.Experiment[]> => {
+export const getExperiments = async (
+  params?: TypesGen.ExperimentOptions,
+): Promise<TypesGen.Experiment[]> => {
   try {
-    const response = await axios.get("/api/v2/experiments");
+    const response = await axios.get("/api/v2/experiments", { params });
     return response.data;
   } catch (error) {
     if (axios.isAxiosError(error) && error.response?.status === 404) {

@@ -1,5 +1,5 @@
 import * as API from "api/api";
-import { Experiments } from "api/typesGenerated";
+import { Experiments, ExperimentOptions } from "api/typesGenerated";
 import { getMetadataAsJSON } from "utils/metadata";
 
 export const experiments = () => {
@@ -9,3 +9,10 @@ export const experiments = () => {
       getMetadataAsJSON<Experiments>("experiments") ?? API.getExperiments(),
   };
 };
+
+export const updatedExperiments = (params?: ExperimentOptions) => {
+  return {
+    queryKey: ["experiments"],
+    queryFn: async () => API.getExperiments(params),
+  };
+};
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts