@flink-app/flink 2.0.0-alpha.71 → 2.0.0-alpha.73

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @flink-app/flink
 
+## 2.0.0-alpha.73
+
+### Patch Changes
+
+-   fix(flink): register static routes before parameterized routes to prevent e.g. GET /jobs/by-tags being matched by GET /jobs/:id
+
+## 2.0.0-alpha.72
+
+### Patch Changes
+
+-   fix(test-utils): accept typed FlinkApp instances in init() by casting internally
+
 ## 2.0.0-alpha.71
 
 ## 2.0.0-alpha.70

package/dist/src/FlinkApp.js

@@ -797,7 +797,17 @@ var FlinkApp = /** @class */ (function () {
                 schemaManifest = this.loadSchemaManifest();
                 schemaCount = schemaManifest.version === "2.0" ? Object.keys(schemaManifest.schemas || {}).length : Object.keys(schemaManifest.definitions || {}).length;
                 FlinkLog_1.log.debug("Registering ".concat(schemaCount, " schemas with AJV (manifest version: ").concat(schemaManifest.version || "1.0", ")"));
-                for (_i = 0, _a = exports.autoRegisteredHandlers.sort(function (a, b) { var _a, _b; return (((_a = a.handler.Route) === null || _a === void 0 ? void 0 : _a.order) || 0) - (((_b = b.handler.Route) === null || _b === void 0 ? void 0 : _b.order) || 0); }); _i < _a.length; _i++) {
+                for (_i = 0, _a = exports.autoRegisteredHandlers.sort(function (a, b) {
+                    var _a, _b, _c, _d, _e, _f;
+                    var orderDiff = (((_a = a.handler.Route) === null || _a === void 0 ? void 0 : _a.order) || 0) - (((_b = b.handler.Route) === null || _b === void 0 ? void 0 : _b.order) || 0);
+                    if (orderDiff !== 0)
+                        return orderDiff;
+                    // Static segments must be registered before parameterized ones to avoid
+                    // Express matching e.g. GET /jobs/by-tags with the /jobs/:id route.
+                    var aHasParam = ((_d = (_c = a.handler.Route) === null || _c === void 0 ? void 0 : _c.path) === null || _d === void 0 ? void 0 : _d.includes("/:")) ? 1 : 0;
+                    var bHasParam = ((_f = (_e = b.handler.Route) === null || _e === void 0 ? void 0 : _e.path) === null || _f === void 0 ? void 0 : _f.includes("/:")) ? 1 : 0;
+                    return aHasParam - bHasParam;
+                }); _i < _a.length; _i++) {
                     _b = _a[_i], handler = _b.handler, assumedHttpMethod = _b.assumedHttpMethod, __file = _b.__file;
                     if (!handler.Route) {
                         FlinkLog_1.log.error("Missing Props in handler ".concat(__file));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/flink",
-  "version": "2.0.0-alpha.71",
+  "version": "2.0.0-alpha.73",
   "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",
@@ -56,7 +56,7 @@
     "ts-morph": "24.0.0",
     "uuid": "^8.3.2",
     "zod": "^4.3.6",
-    "@flink-app/ts-source-to-json-schema": "^0.1.6"
+    "@flink-app/ts-source-to-json-schema": "^0.1.7"
   },
   "devDependencies": {
     "@swc/core": "^1.15.17",

package/spec/FlinkApp.routeOrdering.spec.ts

@@ -0,0 +1,61 @@
+import { FlinkApp, autoRegisteredHandlers } from "../src/FlinkApp";
+import { FlinkContext } from "../src/FlinkContext";
+import { GetHandler, HttpMethod } from "../src/FlinkHttpHandler";
+
+const request = require("supertest");
+
+interface TestContext extends FlinkContext {}
+
+describe("Route ordering", () => {
+    let app: FlinkApp<TestContext>;
+
+    afterEach(async () => {
+        // Clean up auto-registered handlers between tests
+        autoRegisteredHandlers.length = 0;
+
+        if (app && app.started) {
+            await app.stop();
+        }
+    });
+
+    it("should match static segment before parameterized segment when parameterized handler is registered first", async () => {
+        const byTagsHandler: GetHandler<TestContext, any> = async () => {
+            return { status: 200, data: { route: "by-tags" } };
+        };
+
+        const byIdHandler: GetHandler<TestContext, any> = async ({ req }) => {
+            return { status: 200, data: { route: "by-id", id: req.params.id } };
+        };
+
+        // Register parameterized route first (simulates bad file discovery order)
+        autoRegisteredHandlers.push({
+            handler: {
+                default: byIdHandler,
+                Route: { method: HttpMethod.get, path: "/jobs/:id" },
+            },
+            assumedHttpMethod: HttpMethod.get,
+            __file: "GetJobById.ts",
+        });
+
+        autoRegisteredHandlers.push({
+            handler: {
+                default: byTagsHandler,
+                Route: { method: HttpMethod.get, path: "/jobs/by-tags" },
+            },
+            assumedHttpMethod: HttpMethod.get,
+            __file: "GetJobsByTags.ts",
+        });
+
+        app = new FlinkApp<TestContext>({ name: "test-route-order", port: 4050 });
+        await app.start();
+
+        const byTagsRes = await request(app.expressApp).get("/jobs/by-tags");
+        expect(byTagsRes.status).toBe(200);
+        expect(byTagsRes.body.data.route).toBe("by-tags");
+
+        const byIdRes = await request(app.expressApp).get("/jobs/abc123");
+        expect(byIdRes.status).toBe(200);
+        expect(byIdRes.body.data.route).toBe("by-id");
+        expect(byIdRes.body.data.id).toBe("abc123");
+    });
+});

package/src/FlinkApp.ts

@@ -1068,9 +1068,15 @@ export class FlinkApp<C extends FlinkContext> {
 
         log.debug(`Registering ${schemaCount} schemas with AJV (manifest version: ${schemaManifest.version || "1.0"})`);
 
-        for (const { handler, assumedHttpMethod, __file } of autoRegisteredHandlers.sort(
-            (a, b) => (a.handler.Route?.order || 0) - (b.handler.Route?.order || 0)
-        )) {
+        for (const { handler, assumedHttpMethod, __file } of autoRegisteredHandlers.sort((a, b) => {
+            const orderDiff = (a.handler.Route?.order || 0) - (b.handler.Route?.order || 0);
+            if (orderDiff !== 0) return orderDiff;
+            // Static segments must be registered before parameterized ones to avoid
+            // Express matching e.g. GET /jobs/by-tags with the /jobs/:id route.
+            const aHasParam = a.handler.Route?.path?.includes("/:") ? 1 : 0;
+            const bHasParam = b.handler.Route?.path?.includes("/:") ? 1 : 0;
+            return aHasParam - bHasParam;
+        })) {
             if (!handler.Route) {
                 log.error(`Missing Props in handler ${__file}`);
                 continue;