@mmstack/resource 20.8.2 → 20.8.3

package/fesm2022/mmstack-resource.mjs

@@ -874,13 +874,46 @@ const SAFE_RAW_HEADERS = new Set([
     'content-language',
     'content-type',
 ]);
+const UNSAFE_HEADER_MESSAGES = new Map([
+    [
+        'cookie',
+        "[@mmstack/resource]: varyHeaders includes 'cookie'. Browser-attached cookies never appear on the request object (so this usually partitions nothing), and manually-set cookie values often rotate per-request (shredding the hit rate). The header IS still honored (digested) — but prefer varying on 'Authorization' or a tenant header.",
+    ],
+    [
+        'set-cookie',
+        "[@mmstack/resource]: varyHeaders includes 'set-cookie'. Browser-attached cookies never appear on the request object (so this usually partitions nothing), and manually-set cookie values often rotate per-request (shredding the hit rate). The header IS still honored (digested) — but prefer varying on 'Authorization' or a tenant header.",
+    ],
+    [
+        'authorization',
+        "[@mmstack/resource]: varyHeaders includes 'Authorization'. If your token rotates frequently (e.g., short-lived JWTs), this will cause 100% cache churn on refresh. Consider adding a namespace prefix with the users sub, not using it as a cache-key or using a custom 'cache.hash' function with a stable session/user ID instead.",
+    ],
+    [
+        'x-request-id',
+        "[@mmstack/resource]: varyHeaders includes 'X-Request-ID'. This header is often set to a unique value per-request, which will cause 100% cache churn. Consider removing it from varyHeaders or using a custom 'cache.hash' function that ignores it.",
+    ],
+    [
+        'x-correlation-id',
+        "[@mmstack/resource]: varyHeaders includes 'X-Correlation-ID'. This header is often set to a unique value per-request, which will cause 100% cache churn. Consider removing it from varyHeaders or using a custom 'cache.hash' function that ignores it.",
+    ],
+    [
+        'if-none-match',
+        "[@mmstack/resource]: varyHeaders includes 'If-None-Match'. This header contains ETags that change whenever the server's resource version changes, which will cause cache misses on every update. Consider removing it from varyHeaders or using a custom 'cache.hash' function that ignores it.",
+    ],
+    [
+        'if-modified-since',
+        "[@mmstack/resource]: varyHeaders includes 'If-Modified-Since'. This header contains timestamps that change whenever the server's resource version changes, which will cause cache misses on every update. Consider removing it from varyHeaders or using a custom 'cache.hash' function that ignores it.",
+    ],
+]);
 function normalizeVaryHeaders(headers, names) {
+    const isDev = isDevMode();
     return names
         .map((n) => n.toLowerCase())
         .toSorted()
         .map((name) => {
-        if (isDevMode() && (name === 'cookie' || name === 'set-cookie')) {
-            console.warn(`[@mmstack/resource]: varyHeaders includes '${name}'. Browser-attached cookies never appear on the request object (so this usually partitions nothing), and manually-set cookie values often rotate per-request (shredding the hit rate). The header IS still honored (digested) — but prefer varying on 'Authorization' or a tenant header.`);
+        if (isDev) {
+            const warning = UNSAFE_HEADER_MESSAGES.get(name);
+            if (warning)
+                console.warn(warning);
         }
         const value = readHeader(headers, name);
         if (value === null)
@@ -894,13 +927,17 @@ function normalizeVaryHeaders(headers, names) {
         .join('&');
 }
 function normalizeParams(params) {
-    const p = params instanceof HttpParams ? params : new HttpParams({ fromObject: params });
+    const p = params instanceof HttpParams
+        ? params
+        : new HttpParams({ fromObject: params });
     return p
         .keys()
         .toSorted()
         .map((key) => {
         const encodedKey = encodeURIComponent(key);
-        return (p.getAll(key) ?? []).map((v) => `${encodedKey}=${encodeURIComponent(v)}`).join('&');
+        return (p.getAll(key) ?? [])
+            .map((v) => `${encodedKey}=${encodeURIComponent(v)}`)
+            .join('&');
     })
         .join('&');
 }
@@ -920,7 +957,8 @@ function hashBody(body) {
         entries.sort(([ak, av], [bk, bv]) => ak.localeCompare(bk) || av.localeCompare(bv));
         return `FormData:${entries.map(([k, v]) => `${k}=${v}`).join('&')}`;
     }
-    if (typeof URLSearchParams !== 'undefined' && body instanceof URLSearchParams) {
+    if (typeof URLSearchParams !== 'undefined' &&
+        body instanceof URLSearchParams) {
         const sp = new URLSearchParams(body);
         sp.sort();
         return `URLSearchParams:${sp.toString()}`;
@@ -1666,6 +1704,57 @@ function hasSlowConnection() {
     return false;
 }
 
+/**
+ * Deep merges multiple circuit breaker options.
+ * The latter options override the former.
+ */
+function mergeCircuitBreakerOptions(global, query, local) {
+    if (!global && !query && !local)
+        return undefined;
+    return {
+        ...(global === true ? {} : global),
+        ...(query === true ? {} : query),
+        ...(local === true ? {} : local),
+    };
+}
+/**
+ * Deep merges multiple retry options.
+ * The latter options override the former.
+ */
+function mergeRetryOptions(global, query, local) {
+    if (global === undefined && query === undefined && local === undefined)
+        return undefined;
+    return {
+        ...(typeof global === 'number' ? { max: global } : global),
+        ...(typeof query === 'number' ? { max: query } : query),
+        ...(typeof local === 'number' ? { max: local } : local),
+    };
+}
+/**
+ * Deep merges multiple cache options.
+ * The latter options override the former.
+ */
+function mergeCacheOptions(query, local) {
+    if (query === undefined && local === undefined)
+        return undefined;
+    return {
+        ...(query === true ? {} : query),
+        ...(local === true ? {} : local),
+    };
+}
+/**
+ * Deep merges multiple refresh options.
+ * The latter options override the former.
+ */
+function mergeRefreshOptions(query, local) {
+    if (query === undefined && local === undefined)
+        return undefined;
+    return {
+        ...(typeof query === 'number' ? { interval: query } : query),
+        ...(typeof local === 'number' ? { interval: local } : local),
+    };
+}
+
 function persistResourceValues(resource, shouldPersist = false, equal) {
     if (!shouldPersist)
         return resource;
@@ -1847,10 +1936,16 @@ function injectQueryResourceOptions(injector) {
 const PAUSED = Symbol('@mmstack/resource:paused');
 function queryResource(request, options0) {
     // Two-layer option injection: per-call > provideQueryResourceOptions > provideResourceOptions.
+    const globalOpts = injectResourceOptions(options0?.injector);
+    const queryOpts = injectQueryResourceOptions(options0?.injector);
     const options = {
-        ...injectResourceOptions(options0?.injector),
-        ...injectQueryResourceOptions(options0?.injector),
+        ...globalOpts,
+        ...queryOpts,
         ...options0,
+        cache: mergeCacheOptions(queryOpts.cache, options0?.cache),
+        circuitBreaker: mergeCircuitBreakerOptions(globalOpts.circuitBreaker, queryOpts.circuitBreaker, options0?.circuitBreaker),
+        retry: mergeRetryOptions(globalOpts.retry, queryOpts.retry, options0?.retry),
+        refresh: mergeRefreshOptions(queryOpts.refresh, options0?.refresh),
     };
     const cache = injectQueryCache(options?.injector);
     const destroyRef = options?.injector
@@ -2369,10 +2464,14 @@ function injectMutationResourceOptions(injector) {
  */
 function mutationResource(request, options0 = {}) {
     // Two-layer option injection: per-call > provideMutationResourceOptions > provideResourceOptions.
+    const globalOpts = injectResourceOptions(options0.injector);
+    const mutOpts = injectMutationResourceOptions(options0.injector);
     const options = {
-        ...injectResourceOptions(options0.injector),
-        ...injectMutationResourceOptions(options0.injector),
+        ...globalOpts,
+        ...mutOpts,
         ...options0,
+        circuitBreaker: mergeCircuitBreakerOptions(globalOpts.circuitBreaker, mutOpts.circuitBreaker, options0?.circuitBreaker),
+        retry: mergeRetryOptions(globalOpts.retry, mutOpts.retry, options0?.retry),
     };
     // `register` is pulled out (and forced off on the inner query below) so the mutation ref is
     // the only thing registered into the transition scope, not its internal query resource.
@@ -2588,5 +2687,5 @@ function mutationResource(request, options0 = {}) {
  * Generated bundle index. Do not edit.
  */
 
-export { Cache, PAUSED, applyResourceRegistration, createCacheInterceptor, createCircuitBreaker, createDedupeRequestsInterceptor, infiniteQueryResource, injectQueryCache, injectResourceOptions, manualQueryResource, mutationResource, noDedupe, provideCircuitBreakerDefaultOptions, provideMutationResourceOptions, provideQueryCache, provideQueryResourceOptions, provideResourceOptions, provideTypedResourceOptions, queryResource };
+export { Cache, PAUSED, applyResourceRegistration, createCacheInterceptor, createCircuitBreaker, createDedupeRequestsInterceptor, hashRequest, infiniteQueryResource, injectQueryCache, injectResourceOptions, manualQueryResource, mutationResource, noDedupe, provideCircuitBreakerDefaultOptions, provideMutationResourceOptions, provideQueryCache, provideQueryResourceOptions, provideResourceOptions, provideTypedResourceOptions, queryResource };
 //# sourceMappingURL=mmstack-resource.mjs.map