fix: Make the workspace URL pretty

kylecarbs · kylecarbs · commit 0b4cdea4da48 · 2022-06-06T21:26:58.000Z
This adds the `@username/workspacename` format to the
workspace page!
diff --git a/site/src/AppRouter.tsx b/site/src/AppRouter.tsx
@@ -65,25 +65,6 @@ export const AppRouter: FC = () => (
             </RequireAuth>
           }
         />
-
-        <Route path=":workspace">
-          <Route
-            index
-            element={
-              <AuthAndFrame>
-                <WorkspacePage />
-              </AuthAndFrame>
-            }
-          />
-          <Route
-            path="schedule"
-            element={
-              <RequireAuth>
-                <WorkspaceSchedulePage />
-              </RequireAuth>
-            }
-          />
-        </Route>
       </Route>
 
       <Route path="templates">
@@ -142,6 +123,23 @@ export const AppRouter: FC = () => (
 
       <Route path="/@:username">
         <Route path=":workspace">
+          <Route
+            index
+            element={
+              <AuthAndFrame>
+                <WorkspacePage />
+              </AuthAndFrame>
+            }
+          />
+          <Route
+            path="schedule"
+            element={
+              <RequireAuth>
+                <WorkspaceSchedulePage />
+              </RequireAuth>
+            }
+          />
+
           <Route
             path="terminal"
             element={
diff --git a/site/src/pages/WorkspacePage/WorkspacePage.test.tsx b/site/src/pages/WorkspacePage/WorkspacePage.test.tsx
@@ -27,7 +27,10 @@ import { WorkspacePage } from "./WorkspacePage"
 
 // It renders the workspace page and waits for it be loaded
 const renderWorkspacePage = async () => {
-  renderWithAuth(<WorkspacePage />, { route: `/workspaces/${MockWorkspace.id}`, path: "/workspaces/:workspace" })
+  renderWithAuth(<WorkspacePage />, {
+    route: `/@${MockWorkspace.owner_name}/${MockWorkspace.name}`,
+    path: "/@:username/:workspace",
+  })
   await screen.findByText(MockWorkspace.name)
 }
 
@@ -47,7 +50,7 @@ const testButton = async (label: string, actionMock: jest.SpyInstance) => {
 
 const testStatus = async (mock: Workspace, label: string) => {
   server.use(
-    rest.get(`/api/v2/workspaces/${MockWorkspace.id}`, (req, res, ctx) => {
+    rest.get(`/api/v2/users/:username/workspace/:workspaceName`, (req, res, ctx) => {
       return res(ctx.status(200), ctx.json(mock))
     }),
   )
@@ -87,7 +90,7 @@ describe("Workspace Page", () => {
   })
   it("requests a start job when the user presses Start", async () => {
     server.use(
-      rest.get(`/api/v2/workspaces/${MockWorkspace.id}`, (req, res, ctx) => {
+      rest.get(`/api/v2/users/:userId/workspace/:workspaceName`, (req, res, ctx) => {
         return res(ctx.status(200), ctx.json(MockStoppedWorkspace))
       }),
     )
@@ -98,7 +101,7 @@ describe("Workspace Page", () => {
   })
   it("requests cancellation when the user presses Cancel", async () => {
     server.use(
-      rest.get(`/api/v2/workspaces/${MockWorkspace.id}`, (req, res, ctx) => {
+      rest.get(`/api/v2/users/:userId/workspace/:workspaceName`, (req, res, ctx) => {
         return res(ctx.status(200), ctx.json(MockStartingWorkspace))
       }),
     )
@@ -110,7 +113,7 @@ describe("Workspace Page", () => {
   it("requests a template when the user presses Update", async () => {
     const getTemplateMock = jest.spyOn(api, "getTemplate").mockResolvedValueOnce(MockTemplate)
     server.use(
-      rest.get(`/api/v2/workspaces/${MockWorkspace.id}`, (req, res, ctx) => {
+      rest.get(`/api/v2/users/:userId/workspace/:workspaceName`, (req, res, ctx) => {
         return res(ctx.status(200), ctx.json(MockOutdatedWorkspace))
       }),
     )
@@ -159,7 +162,10 @@ describe("Workspace Page", () => {
 
   describe("Resources", () => {
     it("shows the status of each agent in each resource", async () => {
-      renderWithAuth(<WorkspacePage />, { route: `/workspaces/${MockWorkspace.id}`, path: "/workspaces/:workspace" })
+      renderWithAuth(<WorkspacePage />, {
+        route: `/@${MockWorkspace.owner_name}/${MockWorkspace.name}`,
+        path: "/@:username/:workspace",
+      })
       const agent1Names = await screen.findAllByText(MockWorkspaceAgent.name)
       expect(agent1Names.length).toEqual(2)
       const agent2Names = await screen.findAllByText(MockWorkspaceAgentDisconnected.name)
diff --git a/site/src/pages/WorkspacePage/WorkspacePage.tsx b/site/src/pages/WorkspacePage/WorkspacePage.tsx
@@ -14,9 +14,10 @@ import { workspaceMachine } from "../../xServices/workspace/workspaceXService"
 import { workspaceScheduleBannerMachine } from "../../xServices/workspaceSchedule/workspaceScheduleBannerXService"
 
 export const WorkspacePage: React.FC = () => {
-  const { workspace: workspaceQueryParam } = useParams()
+  const { username: usernameQueryParam, workspace: workspaceQueryParam } = useParams()
   const navigate = useNavigate()
-  const workspaceId = firstOrItem(workspaceQueryParam, null)
+  const username = firstOrItem(usernameQueryParam, null)
+  const workspaceName = firstOrItem(workspaceQueryParam, null)
 
   const [workspaceState, workspaceSend] = useMachine(workspaceMachine)
   const { workspace, resources, getWorkspaceError, getResourcesError, builds } = workspaceState.context
@@ -28,8 +29,8 @@ export const WorkspacePage: React.FC = () => {
    * workspaceSend should not change.
    */
   useEffect(() => {
-    workspaceId && workspaceSend({ type: "GET_WORKSPACE", workspaceId })
-  }, [workspaceId, workspaceSend])
+    username && workspaceName && workspaceSend({ type: "GET_WORKSPACE", username, workspaceName })
+  }, [username, workspaceName, workspaceSend])
 
   if (workspaceState.matches("error")) {
     return <ErrorSummary error={getWorkspaceError} />
diff --git a/site/src/pages/WorkspacesPage/WorkspacesPageView.tsx b/site/src/pages/WorkspacesPage/WorkspacesPageView.tsx
@@ -74,7 +74,7 @@ export const WorkspacesPageView: FC<WorkspacesPageViewProps> = ({ loading, works
                     <AvatarData
                       title={workspace.name}
                       subtitle={workspace.owner_name}
-                      link={`/workspaces/${workspace.id}`}
+                      link={`/@${workspace.owner_name}/${workspace.name}`}
                     />
                   </TableCell>
                   <TableCell>{workspace.template_name}</TableCell>
diff --git a/site/src/xServices/workspace/workspaceXService.ts b/site/src/xServices/workspace/workspaceXService.ts
@@ -37,7 +37,7 @@ export interface WorkspaceContext {
 }
 
 export type WorkspaceEvent =
-  | { type: "GET_WORKSPACE"; workspaceId: string }
+  | { type: "GET_WORKSPACE"; workspaceName: string; username: string }
   | { type: "START" }
   | { type: "STOP" }
   | { type: "ASK_DELETE" }
@@ -431,7 +431,7 @@ export const workspaceMachine = createMachine(
     },
     services: {
       getWorkspace: async (_, event) => {
-        return await API.getWorkspace(event.workspaceId)
+        return await API.getWorkspaceByOwnerAndName(event.username, event.workspaceName)
       },
       getTemplate: async (context) => {
         if (context.workspace) {
@@ -470,7 +470,7 @@ export const workspaceMachine = createMachine(
       },
       refreshWorkspace: async (context) => {
         if (context.workspace) {
-          return await API.getWorkspace(context.workspace.id)
+          return await API.getWorkspaceByOwnerAndName(context.workspace.owner_name, context.workspace.name)
         } else {
           throw Error("Cannot refresh workspace without id")
         }
diff --git a/site/webpack.dev.ts b/site/webpack.dev.ts
@@ -63,7 +63,7 @@ const config: Configuration = {
     port: process.env.PORT || 8080,
     proxy: {
       "/api": {
-        target: "http://localhost:3000",
+        target: "https://dev.coder.com",
         ws: true,
         secure: false,
       },
