chore: don't require an organization to read starter templates

coder · aslilac · Aug 6, 2024 · Aug 6, 2024 · Aug 6, 2024 · Aug 6, 2024
commit e82a8743c3773f8c70e64a2b1b520c415685c781
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -871,7 +871,7 @@ func New(options *Options) *API {
 				r.Route("/templates", func(r chi.Router) {
 					r.Post("/", api.postTemplateByOrganization)
 					r.Get("/", api.templatesByOrganization())
-					r.Get("/examples", api.templateExamples)
+					r.Get("/examples", api.templateExamplesByOrganization)
 					r.Route("/{templatename}", func(r chi.Router) {
 						r.Get("/", api.templateByOrganizationAndName)
 						r.Route("/versions/{templateversionname}", func(r chi.Router) {
@@ -915,6 +915,7 @@ func New(options *Options) *API {
 				apiKeyMiddleware,
 			)
 			r.Get("/", api.fetchTemplates(nil))
+			r.Get("/examples", api.templateExamples)
 			r.Route("/{template}", func(r chi.Router) {
 				r.Use(
 					httpmw.ExtractTemplateParam(options.Database),

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -821,7 +821,8 @@ func (api *API) templateDAUs(rw http.ResponseWriter, r *http.Request) {
 // @Param organization path string true "Organization ID" format(uuid)
 // @Success 200 {array} codersdk.TemplateExample
 // @Router /organizations/{organization}/templates/examples [get]
-func (api *API) templateExamples(rw http.ResponseWriter, r *http.Request) {
+// @Deprecated Use /templates/examples instead
+func (api *API) templateExamplesByOrganization(rw http.ResponseWriter, r *http.Request) {
 	var (
 		ctx          = r.Context()
 		organization = httpmw.OrganizationParam(r)
@@ -844,6 +845,33 @@ func (api *API) templateExamples(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusOK, ex)
 }
 
+// @Summary Get template examples
+// @ID get-template-examples
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Templates
+// @Success 200 {array} codersdk.TemplateExample
+// @Router /templates/examples [get]
+func (api *API) templateExamples(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+
+	if !api.Authorize(r, policy.ActionRead, rbac.ResourceTemplate.AnyOrganization()) {
+		httpapi.ResourceNotFound(rw)
+		return
+	}
+
+	ex, err := examples.List()
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching examples.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, ex)
+}
+
 func (api *API) convertTemplates(templates []database.Template) []codersdk.Template {
 	apiTemplates := make([]codersdk.Template, 0, len(templates))
 

diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -1097,17 +1097,17 @@ func TestPreviousTemplateVersion(t *testing.T) {
 	})
 }
 
-func TestTemplateExamples(t *testing.T) {
+func TestStarterTemplates(t *testing.T) {
 	t.Parallel()
 	t.Run("OK", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, nil)
-		user := coderdtest.CreateFirstUser(t, client)
+		_ = coderdtest.CreateFirstUser(t, client)
 
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		ex, err := client.TemplateExamples(ctx, user.OrganizationID)
+		ex, err := client.StarterTemplates(ctx)
 		require.NoError(t, err)
 		ls, err := examples.List()
 		require.NoError(t, err)

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -472,9 +472,16 @@ type AgentStatsReportResponse struct {
 	TxBytes int64 `json:"tx_bytes"`
 }
 
-// TemplateExamples lists example templates embedded in coder.
-func (c *Client) TemplateExamples(ctx context.Context, organizationID uuid.UUID) ([]TemplateExample, error) {
-	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/templates/examples", organizationID), nil)
+// TemplateExamples lists example templates available in Coder.
+//
+// Deprecated: Use StarterTemplates instead.
+func (c *Client) TemplateExamples(ctx context.Context, _ uuid.UUID) ([]TemplateExample, error) {
+	return c.StarterTemplates(ctx)
+}
+
+// StarterTemplates lists example templates available in Coder.
+func (c *Client) StarterTemplates(ctx context.Context) ([]TemplateExample, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/templates/examples", nil)
 	if err != nil {
 		return nil, err
 	}

diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -483,7 +483,7 @@ class ApiMethods {
   };
 
   deleteToken = async (keyId: string): Promise<void> => {
-    await this.axios.delete("/api/v2/users/me/keys/" + keyId);
+    await this.axios.delete(`/api/v2/users/me/keys/${keyId}`);
   };
 
   createToken = async (
@@ -1754,12 +1754,8 @@ class ApiMethods {
   /**
    * @param organization Can be the organization's ID or name
    */
-  getTemplateExamples = async (
-    organization: string,
-  ): Promise<TypesGen.TemplateExample[]> => {
-    const response = await this.axios.get(
-      `/api/v2/organizations/${organization}/templates/examples`,
-    );
+  getTemplateExamples = async (): Promise<TypesGen.TemplateExample[]> => {
+    const response = await this.axios.get(`/api/v2/templates/examples`);
 
     return response.data;
   };

diff --git a/site/src/api/queries/templates.ts b/site/src/api/queries/templates.ts
@@ -112,13 +112,10 @@ export const setGroupRole = (
   };
 };
 
-export const templateExamples = (organizationId: string) => {
+export const templateExamples = () => {
   return {
-    queryKey: [
-      ...getTemplatesByOrganizationQueryKey(organizationId),
-      "examples",
-    ],
-    queryFn: () => API.getTemplateExamples(organizationId),
+    queryKey: ["templates", "examples"],
+    queryFn: () => API.getTemplateExamples(),
   };
 };
 

diff --git a/site/src/pages/CreateTemplatePage/ImportStarterTemplateView.tsx b/site/src/pages/CreateTemplatePage/ImportStarterTemplateView.tsx
@@ -31,7 +31,7 @@ export const ImportStarterTemplateView: FC<CreateTemplatePageViewProps> = ({
   const { multiple_organizations: organizationsEnabled } =
     useFeatureVisibility();
   const [searchParams] = useSearchParams();
-  const templateExamplesQuery = useQuery(templateExamples("default"));
+  const templateExamplesQuery = useQuery(templateExamples());
   const templateExample = templateExamplesQuery.data?.find(
     (e) => e.id === searchParams.get("exampleId")!,
   );

diff --git a/site/src/pages/CreateTemplatesGalleryPage/CreateTemplatesGalleryPage.tsx b/site/src/pages/CreateTemplatesGalleryPage/CreateTemplatesGalleryPage.tsx
@@ -11,7 +11,7 @@ import { StarterTemplatesPageView } from "./StarterTemplatesPageView";
 
 const CreateTemplatesGalleryPage: FC = () => {
   const { experiments } = useDashboard();
-  const templateExamplesQuery = useQuery(templateExamples("default"));
+  const templateExamplesQuery = useQuery(templateExamples());
   const starterTemplatesByTag = templateExamplesQuery.data
     ? // Currently, the scratch template should not be displayed on the starter templates page.
       getTemplatesByTag(removeScratchExample(templateExamplesQuery.data))

diff --git a/site/src/pages/StarterTemplatePage/StarterTemplatePage.tsx b/site/src/pages/StarterTemplatePage/StarterTemplatePage.tsx
@@ -8,7 +8,7 @@ import { StarterTemplatePageView } from "./StarterTemplatePageView";
 
 const StarterTemplatePage: FC = () => {
   const { exampleId } = useParams() as { exampleId: string };
-  const templateExamplesQuery = useQuery(templateExamples("default"));
+  const templateExamplesQuery = useQuery(templateExamples());
   const starterTemplate = templateExamplesQuery.data?.find(
     (example) => example.id === exampleId,
   );

diff --git a/site/src/pages/TemplatesPage/TemplatesPage.tsx b/site/src/pages/TemplatesPage/TemplatesPage.tsx
@@ -11,7 +11,7 @@ export const TemplatesPage: FC = () => {
 
   const templatesQuery = useQuery(templates());
   const examplesQuery = useQuery({
-    ...templateExamples("default"),
+    ...templateExamples(),
     enabled: permissions.createTemplates,
   });
   const error = templatesQuery.error || examplesQuery.error;