Move externalauth -> external-auth

coder · kylecarbs · Oct 3, 2023 · Sep 30, 2023 · Oct 2, 2023 · Oct 2, 2023
commit 9ad24b68c434335677fdd797e79bebd43a6a7cc0
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -547,7 +547,7 @@ func New(options *Options) *API {
 
 	// Register callback handlers for each OAuth2 provider.
 	// We must support gitauth and externalauth for backwards compatibility.
-	for _, route := range []string{"gitauth", "externalauth"} {
+	for _, route := range []string{"gitauth", "external-auth"} {
 		r.Route("/"+route, func(r chi.Router) {
 			for _, externalAuthConfig := range options.ExternalAuthConfigs {
 				// We don't need to register a callback handler for device auth.
@@ -616,7 +616,7 @@ func New(options *Options) *API {
 			r.Get("/{fileID}", api.fileByID)
 			r.Post("/", api.postFile)
 		})
-		r.Route("/externalauth/{externalauth}", func(r chi.Router) {
+		r.Route("/external-auth/{externalauth}", func(r chi.Router) {
 			r.Use(
 				apiKeyMiddleware,
 				httpmw.ExtractExternalAuthParam(options.ExternalAuthConfigs),
@@ -689,7 +689,7 @@ func New(options *Options) *API {
 			r.Get("/schema", templateVersionSchemaDeprecated)
 			r.Get("/parameters", templateVersionParametersDeprecated)
 			r.Get("/rich-parameters", api.templateVersionRichParameters)
-			r.Get("/externalauth", api.templateVersionExternalAuth)
+			r.Get("/external-auth", api.templateVersionExternalAuth)
 			r.Get("/variables", api.templateVersionVariables)
 			r.Get("/resources", api.templateVersionResources)
 			r.Get("/logs", api.templateVersionLogs)

diff --git a/coderd/externalauth.go b/coderd/externalauth.go
@@ -23,7 +23,7 @@ import (
 // @Tags Git
 // @Param externalauth path string true "Git Provider ID" format(string)
 // @Success 200 {object} codersdk.ExternalAuth
-// @Router /externalauth/{externalauth} [get]
+// @Router /external-auth/{externalauth} [get]
 func (api *API) externalAuthByID(w http.ResponseWriter, r *http.Request) {
 	config := httpmw.ExternalAuthParam(r)
 	apiKey := httpmw.APIKey(r)
@@ -82,7 +82,7 @@ func (api *API) externalAuthByID(w http.ResponseWriter, r *http.Request) {
 // @Tags Git
 // @Param externalauth path string true "External Provider ID" format(string)
 // @Success 204
-// @Router /externalauth/{externalauth}/device [post]
+// @Router /external-auth/{externalauth}/device [post]
 func (api *API) postExternalAuthDeviceByID(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	apiKey := httpmw.APIKey(r)
@@ -165,7 +165,7 @@ func (api *API) postExternalAuthDeviceByID(rw http.ResponseWriter, r *http.Reque
 // @Tags Git
 // @Param externalauth path string true "Git Provider ID" format(string)
 // @Success 200 {object} codersdk.ExternalAuthDevice
-// @Router /externalauth/{externalauth}/device [get]
+// @Router /external-auth/{externalauth}/device [get]
 func (*API) externalAuthDeviceByID(rw http.ResponseWriter, r *http.Request) {
 	config := httpmw.ExternalAuthParam(r)
 	ctx := r.Context()
@@ -247,7 +247,7 @@ func (api *API) externalAuthCallback(externalAuthConfig *externalauth.Config) ht
 		redirect := state.Redirect
 		if redirect == "" {
 			// This is a nicely rendered screen on the frontend
-			redirect = fmt.Sprintf("/externalauth/%s", externalAuthConfig.ID)
+			redirect = fmt.Sprintf("/external-auth/%s", externalAuthConfig.ID)
 		}
 		http.Redirect(rw, r, redirect, http.StatusTemporaryRedirect)
 	}

diff --git a/coderd/externalauth/externalauth.go b/coderd/externalauth/externalauth.go
@@ -407,9 +407,9 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([
 		}
 		ids[entry.ID] = struct{}{}
 
-		authRedirect, err := accessURL.Parse(fmt.Sprintf("/externalauth/%s/callback", entry.ID))
+		authRedirect, err := accessURL.Parse(fmt.Sprintf("/external-auth/%s/callback", entry.ID))
 		if err != nil {
-			return nil, xerrors.Errorf("parse externalauth callback url: %w", err)
+			return nil, xerrors.Errorf("parse external auth callback url: %w", err)
 		}
 
 		var regex *regexp.Regexp

diff --git a/coderd/externalauth_test.go b/coderd/externalauth_test.go
@@ -268,7 +268,7 @@ func TestGitAuthCallback(t *testing.T) {
 		agentClient.SetSessionToken(authToken)
 		token, err := agentClient.GitAuth(context.Background(), "github.com/asd/asd", false)
 		require.NoError(t, err)
-		require.True(t, strings.HasSuffix(token.URL, fmt.Sprintf("/externalauth/%s", "github")))
+		require.True(t, strings.HasSuffix(token.URL, fmt.Sprintf("/external-auth/%s", "github")))
 	})
 	t.Run("UnauthorizedCallback", func(t *testing.T) {
 		t.Parallel()
@@ -300,7 +300,7 @@ func TestGitAuthCallback(t *testing.T) {
 		require.Equal(t, http.StatusTemporaryRedirect, resp.StatusCode)
 		location, err := resp.Location()
 		require.NoError(t, err)
-		require.Equal(t, "/externalauth/github", location.Path)
+		require.Equal(t, "/external-auth/github", location.Path)
 
 		// Callback again to simulate updating the token.
 		resp = coderdtest.RequestExternalAuthCallback(t, "github", client)

diff --git a/coderd/httpmw/patternmatcher/routepatterns_test.go b/coderd/httpmw/patternmatcher/routepatterns_test.go
@@ -65,9 +65,9 @@ func Test_RoutePatterns(t *testing.T) {
 				"/api/**",
 				"/@*/*/apps/**",
 				"/%40*/*/apps/**",
-				"/externalauth/*/callback",
+				"/external-auth/*/callback",
 			},
-			output: "^(/api/?|/api/.+/?|/@[^/]+/[^/]+/apps/.+/?|/%40[^/]+/[^/]+/apps/.+/?|/externalauth/[^/]+/callback/?)$",
+			output: "^(/api/?|/api/.+/?|/@[^/]+/[^/]+/apps/.+/?|/%40[^/]+/[^/]+/apps/.+/?|/external-auth/[^/]+/callback/?)$",
 		},
 		{
 			name: "Slash",

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -280,7 +280,7 @@ func (api *API) templateVersionRichParameters(rw http.ResponseWriter, r *http.Re
 // @Tags Templates
 // @Param templateversion path string true "Template version ID" format(uuid)
 // @Success 200 {array} codersdk.TemplateVersionExternalAuth
-// @Router /templateversions/{templateversion}/externalauth [get]
+// @Router /templateversions/{templateversion}/external-auth [get]
 func (api *API) templateVersionExternalAuth(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	var (
@@ -307,7 +307,7 @@ func (api *API) templateVersionExternalAuth(rw http.ResponseWriter, r *http.Requ
 		}
 
 		// This is the URL that will redirect the user with a state token.
-		redirectURL, err := api.AccessURL.Parse(fmt.Sprintf("/externalauth/%s", config.ID))
+		redirectURL, err := api.AccessURL.Parse(fmt.Sprintf("/external-auth/%s", config.ID))
 		if err != nil {
 			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
 				Message: "Failed to parse access URL.",

diff --git a/coderd/tracing/httpmw.go b/coderd/tracing/httpmw.go
@@ -26,7 +26,7 @@ func Middleware(tracerProvider trace.TracerProvider) func(http.Handler) http.Han
 		"/api/**",
 		"/@*/*/apps/**",
 		"/%40*/*/apps/**",
-		"/externalauth/*/callback",
+		"/external-auth/*/callback",
 	}.MustCompile()
 
 	var tracer trace.Tracer

diff --git a/coderd/tracing/httpmw_test.go b/coderd/tracing/httpmw_test.go
@@ -59,7 +59,7 @@ func Test_Middleware(t *testing.T) {
 			{"/%40hi/hi/apps/hi", true},
 			{"/%40hi/hi/apps/hi/hi", true},
 			{"/%40hi/hi/apps/hi/hi", true},
-			{"/externalauth/hi/callback", true},
+			{"/external=auth/hi/callback", true},
 
 			// Other routes that should not be collected.
 			{"/index.html", false},

diff --git a/codersdk/externalauth.go b/codersdk/externalauth.go
@@ -50,7 +50,7 @@ type ExternalAuthDeviceExchange struct {
 }
 
 func (c *Client) ExternalAuthDeviceByID(ctx context.Context, provider string) (ExternalAuthDevice, error) {
-	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/externalauth/%s/device", provider), nil)
+	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/external-auth/%s/device", provider), nil)
 	if err != nil {
 		return ExternalAuthDevice{}, err
 	}
@@ -64,7 +64,7 @@ func (c *Client) ExternalAuthDeviceByID(ctx context.Context, provider string) (E
 
 // ExchangeGitAuth exchanges a device code for an external auth token.
 func (c *Client) ExternalAuthDeviceExchange(ctx context.Context, provider string, req ExternalAuthDeviceExchange) error {
-	res, err := c.Request(ctx, http.MethodPost, fmt.Sprintf("/api/v2/externalauth/%s/device", provider), req)
+	res, err := c.Request(ctx, http.MethodPost, fmt.Sprintf("/api/v2/external-auth/%s/device", provider), req)
 	if err != nil {
 		return err
 	}
@@ -77,7 +77,7 @@ func (c *Client) ExternalAuthDeviceExchange(ctx context.Context, provider string
 
 // ExternalAuthByID returns the external auth for the given provider by ID.
 func (c *Client) ExternalAuthByID(ctx context.Context, provider string) (ExternalAuth, error) {
-	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/externalauth/%s", provider), nil)
+	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/external-auth/%s", provider), nil)
 	if err != nil {
 		return ExternalAuth{}, err
 	}

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -136,7 +136,7 @@ func (c *Client) TemplateVersionRichParameters(ctx context.Context, version uuid
 
 // TemplateVersionExternalAuth returns authentication providers for the requested template version.
 func (c *Client) TemplateVersionExternalAuth(ctx context.Context, version uuid.UUID) ([]TemplateVersionExternalAuth, error) {
-	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/externalauth", version), nil)
+	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/external-auth", version), nil)
 	if err != nil {
 		return nil, err
 	}

diff --git a/site/e2e/tests/externalAuth.spec.ts b/site/e2e/tests/externalAuth.spec.ts
@@ -46,7 +46,7 @@ test("external auth device", async ({ page }) => {
     sentPending.done();
   });
 
-  await page.goto(`/externalauth/${gitAuth.deviceProvider}`, {
+  await page.goto(`/external-auth/${gitAuth.deviceProvider}`, {
     waitUntil: "domcontentloaded",
   });
   await page.getByText(device.user_code).isVisible();
@@ -70,11 +70,11 @@ test("external auth web", async ({ baseURL, page }) => {
   });
   srv.use(gitAuth.authPath, (req, res) => {
     res.redirect(
-      `${baseURL}/externalauth/${gitAuth.webProvider}/callback?code=1234&state=` +
+      `${baseURL}/external-auth/${gitAuth.webProvider}/callback?code=1234&state=` +
         req.query.state,
     );
   });
-  await page.goto(`/externalauth/${gitAuth.webProvider}`, {
+  await page.goto(`/external-auth/${gitAuth.webProvider}`, {
     waitUntil: "domcontentloaded",
   });
   // This endpoint doesn't have the installations URL set intentionally!

diff --git a/site/src/AppRouter.tsx b/site/src/AppRouter.tsx
@@ -210,7 +210,7 @@ export const AppRouter: FC = () => {
               <Route path="health" element={<HealthPage />} />
 
               <Route
-                path="externalauth/:provider"
+                path="external-auth/:provider"
                 element={<ExternalAuthPage />}
               />
 

diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -335,7 +335,7 @@ export const getTemplateVersionExternalAuth = async (
   versionId: string,
 ): Promise<TypesGen.TemplateVersionExternalAuth[]> => {
   const response = await axios.get(
-    `/api/v2/templateversions/${versionId}/externalauth`,
+    `/api/v2/templateversions/${versionId}/external-auth`,
   );
   return response.data;
 };
@@ -858,22 +858,22 @@ export const getExperiments = async (): Promise<TypesGen.Experiment[]> => {
 export const getExternalAuthProvider = async (
   provider: string,
 ): Promise<TypesGen.ExternalAuth> => {
-  const resp = await axios.get(`/api/v2/externalauth/${provider}`);
+  const resp = await axios.get(`/api/v2/external-auth/${provider}`);
   return resp.data;
 };
 
 export const getExternalAuthDevice = async (
   provider: string,
 ): Promise<TypesGen.ExternalAuthDevice> => {
-  const resp = await axios.get(`/api/v2/externalauth/${provider}/device`);
+  const resp = await axios.get(`/api/v2/external-auth/${provider}/device`);
   return resp.data;
 };
 
 export const exchangeExternalAuthDevice = async (
   provider: string,
   req: TypesGen.ExternalAuthDeviceExchange,
 ): Promise<void> => {
-  const resp = await axios.post(`/api/v2/externalauth/${provider}/device`, req);
+  const resp = await axios.post(`/api/v2/external-auth/${provider}/device`, req);
   return resp.data;
 };
 

diff --git a/site/src/pages/ExternalAuthPage/ExternalAuthPage.tsx b/site/src/pages/ExternalAuthPage/ExternalAuthPage.tsx
@@ -72,7 +72,7 @@ const ExternalAuthPage: FC = () => {
     !getExternalAuthProviderQuery.data.authenticated &&
     !getExternalAuthProviderQuery.data.device
   ) {
-    window.location.href = `/externalauth/${provider}/callback`;
+    window.location.href = `/external-auth/${provider}/callback`;
 
     return null;
   }

diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -2188,7 +2188,7 @@ export const MockTemplateVersionExternalAuthGithub: TypesGen.TemplateVersionExte
   {
     id: "github",
     type: "github",
-    authenticate_url: "https://example.com/externalauth/github",
+    authenticate_url: "https://example.com/external-auth/github",
     authenticated: false,
     display_icon: "/icon/github.svg",
     display_name: "GitHub",
@@ -2198,7 +2198,7 @@ export const MockTemplateVersionExternalAuthGithubAuthenticated: TypesGen.Templa
   {
     id: "github",
     type: "github",
-    authenticate_url: "https://example.com/externalauth/github",
+    authenticate_url: "https://example.com/external-auth/github",
     authenticated: true,
     display_icon: "/icon/github.svg",
     display_name: "GitHub",

diff --git a/site/src/testHelpers/handlers.ts b/site/src/testHelpers/handlers.ts
@@ -112,7 +112,7 @@ export const handlers = [
     },
   ),
   rest.get(
-    "/api/v2/templateversions/:templateVersionId/externalauth",
+    "/api/v2/templateversions/:templateVersionId/external-auth",
     async (req, res, ctx) => {
       return res(ctx.status(200), ctx.json([]));
     },