@oxy.so/federation 2.2.1 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +31 -0
  2. package/dist/cjs/.tsbuildinfo +1 -1
  3. package/dist/cjs/apUri.js +4 -2
  4. package/dist/cjs/httpSignature.js +1 -1
  5. package/dist/cjs/index.js +2 -2
  6. package/dist/cjs/networkIdentity.js +3 -2
  7. package/dist/cjs/node/actorResolver.js +24 -20
  8. package/dist/cjs/node/actorRouter.js +16 -6
  9. package/dist/cjs/node/delivery.js +35 -10
  10. package/dist/cjs/node/httpCacheControl.js +11 -0
  11. package/dist/cjs/node/inboundDispatch.js +4 -3
  12. package/dist/cjs/node/index.js +8 -1
  13. package/dist/cjs/node/tcoLinks.js +97 -0
  14. package/dist/cjs/node/webfingerRouter.js +6 -4
  15. package/dist/esm/.tsbuildinfo +1 -1
  16. package/dist/esm/apUri.js +4 -2
  17. package/dist/esm/httpSignature.js +1 -1
  18. package/dist/esm/index.js +3 -3
  19. package/dist/esm/networkIdentity.js +3 -2
  20. package/dist/esm/node/actorResolver.js +24 -20
  21. package/dist/esm/node/actorRouter.js +16 -6
  22. package/dist/esm/node/delivery.js +33 -10
  23. package/dist/esm/node/httpCacheControl.js +8 -0
  24. package/dist/esm/node/inboundDispatch.js +4 -3
  25. package/dist/esm/node/index.js +6 -1
  26. package/dist/esm/node/tcoLinks.js +94 -0
  27. package/dist/esm/node/webfingerRouter.js +6 -4
  28. package/dist/types/.tsbuildinfo +1 -1
  29. package/dist/types/httpSignature.d.ts +1 -1
  30. package/dist/types/index.d.ts +3 -3
  31. package/dist/types/node/actorRouter.d.ts +2 -0
  32. package/dist/types/node/delivery.d.ts +23 -4
  33. package/dist/types/node/httpCacheControl.d.ts +2 -0
  34. package/dist/types/node/index.d.ts +6 -1
  35. package/dist/types/node/tcoLinks.d.ts +41 -0
  36. package/dist/types/node/webfingerRouter.d.ts +2 -0
  37. package/package.json +2 -3
  38. package/src/__tests__/actorCollectionCounts.test.ts +27 -18
  39. package/src/__tests__/actorObject.test.ts +27 -7
  40. package/src/__tests__/actorResolver.test.ts +37 -22
  41. package/src/__tests__/actorResolverNetworkIdentity.test.ts +73 -36
  42. package/src/__tests__/apUri.test.ts +9 -5
  43. package/src/__tests__/delivery.test.ts +165 -25
  44. package/src/__tests__/federationHost.test.ts +13 -3
  45. package/src/__tests__/httpSignature.test.ts +1 -3
  46. package/src/__tests__/inboundDispatch.test.ts +80 -30
  47. package/src/__tests__/networkIdentity.test.ts +240 -113
  48. package/src/__tests__/routers.test.ts +157 -27
  49. package/src/__tests__/tcoLinks.test.ts +21 -0
  50. package/src/actorObject.ts +8 -3
  51. package/src/apUri.ts +6 -2
  52. package/src/httpSignature.ts +1 -1
  53. package/src/index.ts +8 -3
  54. package/src/networkIdentity.ts +14 -5
  55. package/src/node/actorResolver.ts +91 -50
  56. package/src/node/actorRouter.ts +44 -14
  57. package/src/node/delivery.ts +112 -30
  58. package/src/node/httpCacheControl.ts +8 -0
  59. package/src/node/identityBridge.ts +38 -18
  60. package/src/node/inboundDispatch.ts +33 -13
  61. package/src/node/index.ts +13 -0
  62. package/src/node/signedFetch.ts +3 -1
  63. package/src/node/tcoLinks.ts +114 -0
  64. package/src/node/webfingerRouter.ts +8 -4
@@ -13,11 +13,12 @@
13
13
  */
14
14
 
15
15
  import { Router, type Request, type Response } from 'express';
16
+ import { discoveryCacheControl } from './httpCacheControl';
16
17
  import { isSameFederationHost } from '../apUri';
17
18
  import type { UrlBuilders } from '../urls';
18
19
  import { INSTANCE_ACTOR_USERNAME, normalizeActorUsername } from '../urls';
19
20
 
20
- /** 1 hour, in seconds — the WebFinger JRD cache TTL + response `max-age`. */
21
+ /** Default HTTP response max-age. The injected JRD cache has its own policy. */
21
22
  const WEBFINGER_CACHE_TTL = 3600;
22
23
  /** 24h — host-meta is effectively static. */
23
24
  const HOST_META_CACHE_CONTROL = `max-age=${60 * 60 * 24}`;
@@ -64,6 +65,8 @@ export interface WebfingerRouterConfig {
64
65
  get(username: string): Promise<WebfingerJrd | null>;
65
66
  set(username: string, jrd: WebfingerJrd): void;
66
67
  };
68
+ /** HTTP response TTL in whole seconds, 0..86400. Defaults to 3600; 0 sends no-store. */
69
+ httpCacheTtlSeconds?: number;
67
70
  /** Diagnostics sink. */
68
71
  logger: WebfingerLogger;
69
72
  }
@@ -72,6 +75,7 @@ export interface WebfingerRouterConfig {
72
75
  export function createWebfingerRouter(config: WebfingerRouterConfig): Router {
73
76
  const router = Router();
74
77
  const { domain } = config;
78
+ const httpCacheControl = discoveryCacheControl(config.httpCacheTtlSeconds, WEBFINGER_CACHE_TTL);
75
79
  const webfingerTemplate = `https://${domain}/.well-known/webfinger?resource={uri}`;
76
80
 
77
81
  router.get('/webfinger', async (req: Request, res: Response) => {
@@ -130,7 +134,7 @@ export function createWebfingerRouter(config: WebfingerRouterConfig): Router {
130
134
  ],
131
135
  };
132
136
  res.set('Content-Type', 'application/jrd+json; charset=utf-8');
133
- res.set('Cache-Control', `max-age=${WEBFINGER_CACHE_TTL}`);
137
+ res.set('Cache-Control', httpCacheControl);
134
138
  return res.json(instanceJrd);
135
139
  }
136
140
 
@@ -138,7 +142,7 @@ export function createWebfingerRouter(config: WebfingerRouterConfig): Router {
138
142
  const cached = await config.cache.get(username);
139
143
  if (cached) {
140
144
  res.set('Content-Type', 'application/jrd+json; charset=utf-8');
141
- res.set('Cache-Control', `max-age=${WEBFINGER_CACHE_TTL}`);
145
+ res.set('Cache-Control', httpCacheControl);
142
146
  return res.json(cached);
143
147
  }
144
148
 
@@ -183,7 +187,7 @@ export function createWebfingerRouter(config: WebfingerRouterConfig): Router {
183
187
  config.cache.set(username, response);
184
188
 
185
189
  res.set('Content-Type', 'application/jrd+json; charset=utf-8');
186
- res.set('Cache-Control', `max-age=${WEBFINGER_CACHE_TTL}`);
190
+ res.set('Cache-Control', httpCacheControl);
187
191
  return res.json(response);
188
192
  } catch (err) {
189
193
  config.logger.error('WebFinger error:', err);