Replace url-template and uri-template-router with @fedify/uri-template

CHANGES.md

@@ -91,7 +91,13 @@ To be released.
     operators distinguish a slow-draining queue from a queue that sees
     less traffic.  [[#316], [#740], [#759]]
 
+ -  Replaced Fedify's internal federation routing with
+    *@fedify/uri-template* for stricter RFC 6570 URI Template expansion and
+    matching.  The deprecated `Router` export from *@fedify/fedify* remains
+    available for compatibility.  [[#418], [#758] by ChanHaeng Lee]
+
 [#316]: https://github.com/fedify-dev/fedify/issues/316
+[#418]: https://github.com/fedify-dev/fedify/issues/418
 [#619]: https://github.com/fedify-dev/fedify/issues/619
 [#735]: https://github.com/fedify-dev/fedify/issues/735
 [#736]: https://github.com/fedify-dev/fedify/issues/736
@@ -102,6 +108,7 @@ To be released.
 [#753]: https://github.com/fedify-dev/fedify/pull/753
 [#755]: https://github.com/fedify-dev/fedify/pull/755
 [#757]: https://github.com/fedify-dev/fedify/pull/757
+[#758]: https://github.com/fedify-dev/fedify/pull/758
 [#759]: https://github.com/fedify-dev/fedify/pull/759
 [#769]: https://github.com/fedify-dev/fedify/pull/769
 
@@ -116,6 +123,13 @@ To be released.
  -  Added a `meterProvider` option to `createFederation()` so mock contexts can
     expose a test OpenTelemetry meter provider.  [[#316], [#619], [#755]]
 
+### @fedify/uri-template
+
+ -  Added *@fedify/uri-template*, a dependency-free RFC 6570 URI Template
+    implementation for expansion, variable extraction, and round-trip route
+    matching.  This package replaces Fedify's previous direct use of
+    *url-template* and *uri-template-router*.  [[#418], [#758] by ChanHaeng Lee]
+
 ### @fedify/amqp
 
  -  Added `AmqpMessageQueue.getDepth()` for reporting queued, ready, and

cspell.json

@@ -121,6 +121,11 @@
     "urlpattern",
     "uuidv7",
     "valueparser",
+    "varspec",
+    "varname",
+    "varnames",
+    "varchar",
+    "varchars",
     "Vinxi",
     "vitepress",
     "vtsls",

deno.json

@@ -25,6 +25,7 @@
     "./packages/sqlite",
     "./packages/sveltekit",
     "./packages/testing",
+    "./packages/uri-template",
     "./packages/vocab",
     "./packages/vocab-runtime",
     "./packages/vocab-tools",

mise.toml

@@ -52,14 +52,17 @@ depends = [
 
 [tasks."check:fmt"]
 description = "Check code formatting"
+wait_for = ["install"]
 run = "deno fmt --check"
 
 [tasks."check:lint"]
 description = "Check code linting"
+wait_for = ["install"]
 run = "deno lint"
 
 [tasks."check:types"]
 description = "Check TypeScript types"
+wait_for = ["install"]
 run = "deno check $(deno eval 'import m from \"./deno.json\" with { type: \"json\" }; for (let p of m.workspace) console.log(p)')"
 
 [tasks."check:md"]
@@ -69,6 +72,7 @@ run = "hongdown --check"
 [tasks.check-versions]
 description = "Check that all package versions are consistent across the monorepo"
 usage = 'flag "--fix" help="Automatically fix version mismatches"'
+wait_for = ["install"]
 run = '''
 if [ "${usage_fix}" = "true" ]; then
   deno run --allow-read --allow-write scripts/check_versions.ts --fix
@@ -79,6 +83,7 @@ fi
 
 [tasks."check:fixture-usage"]
 description = "Ensure @fedify/fixture is only used in **/*.test.ts files"
+wait_for = ["install"]
 run = "deno run --allow-read scripts/check_fixture_usage.ts"
 
 [tasks."check:manifest:workspace-protocol"]

packages/fedify/README.md

@@ -123,6 +123,7 @@ Here is the list of packages:
 | [@fedify/sqlite](/packages/sqlite/)               | [JSR][jsr:@fedify/sqlite]        | [npm][npm:@fedify/sqlite]        | SQLite driver                            |
 | [@fedify/sveltekit](/packages/sveltekit/)         | [JSR][jsr:@fedify/sveltekit]     | [npm][npm:@fedify/sveltekit]     | SvelteKit integration                    |
 | [@fedify/testing](/packages/testing/)             | [JSR][jsr:@fedify/testing]       | [npm][npm:@fedify/testing]       | Testing utilities                        |
+| [@fedify/uri-template](/packages/uri-template/)   | [JSR][jsr:@fedify/uri-template]  | [npm][npm:@fedify/uri-template]  | RFC 6570 URI Template library            |
 | [@fedify/vocab](/packages/vocab/)                 | [JSR][jsr:@fedify/vocab]         | [npm][npm:@fedify/vocab]         | Activity Vocabulary library              |
 | [@fedify/vocab-runtime](/packages/vocab-runtime/) | [JSR][jsr:@fedify/vocab-runtime] | [npm][npm:@fedify/vocab-runtime] | Runtime library for code-generated vocab |
 | [@fedify/vocab-tools](/packages/vocab-tools/)     | [JSR][jsr:@fedify/vocab-tools]   | [npm][npm:@fedify/vocab-tools]   | Code generation tools for Activity Vocab |
@@ -176,6 +177,8 @@ Here is the list of packages:
 [npm:@fedify/sveltekit]: https://www.npmjs.com/package/@fedify/sveltekit
 [jsr:@fedify/testing]: https://jsr.io/@fedify/testing
 [npm:@fedify/testing]: https://www.npmjs.com/package/@fedify/testing
+[jsr:@fedify/uri-template]: https://jsr.io/@fedify/uri-template
+[npm:@fedify/uri-template]: https://www.npmjs.com/package/@fedify/uri-template
 [jsr:@fedify/vocab]: https://jsr.io/@fedify/vocab
 [npm:@fedify/vocab]: https://www.npmjs.com/package/@fedify/vocab
 [jsr:@fedify/vocab-runtime]: https://jsr.io/@fedify/vocab-runtime

packages/fedify/deno.json

@@ -22,9 +22,7 @@
     "json-canon": "npm:json-canon@^1.0.1",
     "jsonld": "npm:jsonld@^9.0.0",
     "pkijs": "npm:pkijs@^3.3.3",
-    "structured-field-values": "npm:structured-field-values@^2.0.4",
-    "uri-template-router": "npm:uri-template-router@^1.0.0",
-    "url-template": "npm:url-template@^3.1.1"
+    "structured-field-values": "npm:structured-field-values@^2.0.4"
   },
   "exclude": [
     ".test-report.xml",

packages/fedify/package.json

@@ -139,6 +139,7 @@
     }
   },
   "dependencies": {
+    "@fedify/uri-template": "workspace:*",
     "@fedify/vocab": "workspace:*",
     "@fedify/vocab-runtime": "workspace:*",
     "@fedify/webfinger": "workspace:*",
@@ -153,8 +154,6 @@
     "json-canon": "^1.0.1",
     "jsonld": "^9.0.0",
     "structured-field-values": "^2.0.4",
-    "uri-template-router": "^1.0.0",
-    "url-template": "^3.1.1",
     "urlpattern-polyfill": "catalog:"
   },
   "devDependencies": {

packages/fedify/src/federation/builder.test.ts

@@ -1,4 +1,5 @@
 import { test } from "@fedify/fixture";
+import { RouterError } from "@fedify/uri-template";
 import { Activity, Note, Person } from "@fedify/vocab";
 import { assertEquals, assertExists, assertThrows } from "@std/assert";
 import type { Protocol } from "../nodeinfo/types.ts";
@@ -13,7 +14,6 @@ import type {
 } from "./callback.ts";
 import { MemoryKvStore } from "./kv.ts";
 import type { FederationImpl } from "./middleware.ts";
-import { RouterError } from "./router.ts";
 
 test("FederationBuilder", async (t) => {
   await t.step(
@@ -160,6 +160,31 @@ test("FederationBuilder", async (t) => {
     },
   );
 
+  await t.step("should snapshot router state on build", async () => {
+    const builder = createFederationBuilder<void>();
+    const kv = new MemoryKvStore();
+    const noteRouteName = `object:${Note.typeId.href}`;
+
+    builder.setActorDispatcher("/users/{identifier}", () => null);
+    const federation1 = await builder.build({ kv });
+    const impl1 = federation1 as FederationImpl<void>;
+
+    builder.setObjectDispatcher(Note, "/notes/{id}", () => null);
+    assertEquals(impl1.router.route("/notes/1"), null);
+
+    const federation2 = await builder.build({ kv });
+    const impl2 = federation2 as FederationImpl<void>;
+    assertEquals(impl2.router.route("/notes/1")?.name, noteRouteName);
+
+    impl1.router.add("/leaked/{id}", "leaked");
+    assertEquals(impl1.router.route("/leaked/1")?.name, "leaked");
+    assertEquals(impl2.router.route("/leaked/1"), null);
+
+    const federation3 = await builder.build({ kv });
+    const impl3 = federation3 as FederationImpl<void>;
+    assertEquals(impl3.router.route("/leaked/1"), null);
+  });
+
   await t.step("should build with default options", async () => {
     const builder = createFederationBuilder<void>();
     const kv = new MemoryKvStore();
@@ -211,10 +236,31 @@ test("FederationBuilder", async (t) => {
         ),
       RouterError,
     );
+    assertThrows(
+      () =>
+        builderAfterInvalid.setOutboxListeners(
+          "/users/{identifier:3}/outbox" as `${string}{identifier}${string}`,
+        ),
+      RouterError,
+    );
+    assertThrows(
+      () =>
+        builderAfterInvalid.setOutboxListeners(
+          "/users/{identifier*}/outbox" as `${string}{identifier}${string}`,
+        ),
+      RouterError,
+    );
+    assertThrows(
+      () =>
+        builderAfterInvalid.setOutboxListeners(
+          "/users/{identifier,identifier}/outbox" as `${string}{identifier}${string}`,
+        ),
+      RouterError,
+    );
     builderAfterInvalid.setOutboxListeners("/users/{identifier}/outbox");
 
     const builder2 = createFederationBuilder<void>();
-    builder2.setOutboxListeners("/users{/identifier}/outbox");
+    builder2.setOutboxListeners("/users/{identifier}/outbox");
 
     assertThrows(
       () =>
@@ -231,6 +277,18 @@ test("FederationBuilder", async (t) => {
       RouterError,
     );
 
+    const builder3a = createFederationBuilder<void>();
+    assertThrows(
+      () => builder3a.setOutboxListeners("/users{;identifier}/outbox"),
+      RouterError,
+    );
+
+    const builder3b = createFederationBuilder<void>();
+    assertThrows(
+      () => builder3b.setOutboxListeners("/users{.identifier}/outbox"),
+      RouterError,
+    );
+
     const builder4 = createFederationBuilder<void>();
     assertThrows(
       () =>
@@ -240,8 +298,77 @@ test("FederationBuilder", async (t) => {
         ),
       RouterError,
     );
+
+    const builder5 = createFederationBuilder<void>();
+    assertThrows(
+      () =>
+        builder5.setOutboxDispatcher(
+          "/users/{identifier:3}/outbox" as `${string}{identifier}${string}`,
+          () => ({ items: [] }),
+        ),
+      RouterError,
+    );
   });
 
+  await t.step(
+    "should reject identifier paths that can match without an identifier",
+    () => {
+      // `{/identifier}` is path-style expansion that can match zero
+      // segments, so the route would match with an empty or missing
+      // `identifier`, violating the `identifier: string` callback contract.
+      // See https://github.com/fedify-dev/fedify/pull/758#discussion_r3252548632
+      type IdPath = `${string}{identifier}${string}`;
+
+      assertThrows(
+        () =>
+          createFederationBuilder<void>().setActorDispatcher(
+            "{/identifier}" as IdPath,
+            () => null,
+          ),
+        RouterError,
+        "Path for actor dispatcher must have one variable: {identifier}",
+      );
+      assertThrows(
+        () =>
+          createFederationBuilder<void>().setActorDispatcher(
+            "/users{/identifier}" as IdPath,
+            () => null,
+          ),
+        RouterError,
+      );
+      assertThrows(
+        () =>
+          createFederationBuilder<void>().setInboxListeners(
+            "{/identifier}/inbox" as IdPath,
+          ),
+        RouterError,
+      );
+      assertThrows(
+        () =>
+          createFederationBuilder<void>().setInboxListeners(
+            "/users{/identifier}/inbox" as IdPath,
+          ),
+        RouterError,
+      );
+      assertThrows(
+        () =>
+          createFederationBuilder<void>().setOutboxListeners(
+            "/users{/identifier}/outbox" as IdPath,
+          ),
+        RouterError,
+      );
+
+      // Simple expansion `{identifier}` must keep working.
+      createFederationBuilder<void>().setActorDispatcher(
+        "/users/{identifier}",
+        () => null,
+      );
+      createFederationBuilder<void>().setInboxListeners(
+        "/users/{identifier}/inbox",
+      );
+    },
+  );
+
   await t.step("should pass build options correctly", async () => {
     const builder = createFederationBuilder<number>();
     const kv = new MemoryKvStore();