🚸 Update HTTP operation sort order (#59)

Author: savannahostrowski

src/test/providers/endpointTreeProvider.test.ts

@@ -159,6 +159,33 @@ suite("EndpointTreeProvider", () => {
     )
   })
 
+  test("routes are sorted by method priority then path", () => {
+    const app = makeApp("app", "main.py")
+    app.routes = [
+      makeRoute("DELETE", "/users"),
+      makeRoute("GET", "/users"),
+      makeRoute("POST", "/items"),
+      makeRoute("PATCH", "/users"),
+      makeRoute("GET", "/items"),
+      makeRoute("POST", "/users"),
+      makeRoute("PUT", "/users"),
+    ]
+    const p = new EndpointTreeProvider([app])
+    const children = p.getChildren(p.getChildren()[0])
+    const labels = children.map((c) =>
+      c.type === "route" ? getRouteLabel(c.route) : "",
+    )
+    assert.deepStrictEqual(labels, [
+      "GET /items",
+      "GET /users",
+      "POST /items",
+      "POST /users",
+      "PUT /users",
+      "PATCH /users",
+      "DELETE /users",
+    ])
+  })
+
   test("getChildren returns routes for router", () => {
     const roots = provider.getChildren()
     const app = roots[0]

src/vscode/endpointTreeProvider.ts

@@ -22,6 +22,17 @@ export type EndpointTreeItem =
   | { type: "route"; route: RouteDefinition }
   | { type: "message"; text: string }
 
+const METHOD_ORDER: Record<RouteMethod, number> = {
+  GET: 0,
+  POST: 1,
+  PUT: 2,
+  PATCH: 3,
+  DELETE: 4,
+  OPTIONS: 5,
+  HEAD: 6,
+  WEBSOCKET: 7,
+}
+
 export const METHOD_ICONS: Record<RouteMethod, string> = {
   GET: "arrow-right",
   POST: "plus",
@@ -92,11 +103,15 @@ function sortedChildren(
       ),
     ...routes
       .map((route) => ({ type: "route" as const, route }))
-      .sort((a, b) =>
-        getRouteLabel(a.route)
+      .sort((a, b) => {
+        // If negative, a comes first. If positive, b comes first. If 0, sort by label.
+        const methodOrder =
+          METHOD_ORDER[a.route.method] - METHOD_ORDER[b.route.method]
+        if (methodOrder !== 0) return methodOrder
+        return getRouteLabel(a.route)
           .toLowerCase()
-          .localeCompare(getRouteLabel(b.route).toLowerCase()),
-      ),
+          .localeCompare(getRouteLabel(b.route).toLowerCase())
+      }),
   ]
 }