@helia/verified-fetch 7.2.14 → 7.2.16

package/src/utils/response-headers.ts

@@ -4,42 +4,60 @@ interface CacheControlHeaderOptions {
   /**
    * This should be seconds as a number.
    *
-   * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#response_directives
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#response_directives
    */
   ttl?: number
+
+  /**
+   * This can represent an IPNS record's EOL validity
+   */
+  expires?: Date
   protocol: string
   response: Response
 }
 
 /**
- * Implementations may place an upper bound on any TTL received, as noted in Section 8 of [rfc2181].
+ * Implementations may place an upper bound on any TTL received, as noted in
+ * Section 8 of [rfc2181].
+ *
  * If TTL value is unknown, implementations should not send a Cache-Control
- * No matter if TTL value is known or not, implementations should always send a Last-Modified header with the timestamp of the record resolution.
+ *
+ * No matter if TTL value is known or not, implementations should always send a
+ * Last-Modified header with the timestamp of the record resolution.
  *
  * @see https://specs.ipfs.tech/http-gateways/path-gateway/#cache-control-response-header
  */
-export function setCacheControlHeader ({ ttl, protocol, response }: CacheControlHeaderOptions): void {
-  if (response.headers.has('cache-control')) {
-    // don't set the header if it's already set by a plugin
-    return
-  }
-
-  let headerValue: string
+export function setCacheControlHeader ({ ttl, expires, protocol, response }: CacheControlHeaderOptions): void {
+  let cacheControl: string
 
   if (protocol === 'ipfs:') {
-    headerValue = 'public, max-age=29030400, immutable'
+    cacheControl = 'public, max-age=29030400, immutable'
   } else if (ttl == null) {
     /**
-     * default limit for unknown TTL: "use 5 minute as default fallback when it is not available."
+     * default limit for unknown TTL: "use 5 minute as default fallback when it
+     * is not available."
      *
      * @see https://github.com/ipfs/boxo/issues/329#issuecomment-1995236409
      */
-    headerValue = 'public, max-age=300'
+    cacheControl = 'public, max-age=300'
   } else {
-    headerValue = `public, max-age=${ttl}`
+    cacheControl = `public, max-age=${ttl}`
+  }
+
+  if (expires != null) {
+    const lifetimeRemaining = Math.max(0, Math.round((expires.getTime() - Date.now()) / 1000))
+    cacheControl += `, stale-while-revalidate=${lifetimeRemaining}, stale-if-error=${lifetimeRemaining}`
+
+    // add the expires header if it's not been set by a plugin
+    if (!response.headers.has('expires')) {
+      response.headers.set('expires', expires.toUTCString())
+    }
   }
 
-  response.headers.set('cache-control', headerValue)
+  if (!response.headers.has('cache-control')) {
+    // don't set the cache-control header if it's already set by a plugin
+    response.headers.set('cache-control', cacheControl)
+  }
 }
 
 /**

package/src/verified-fetch.ts

@@ -198,15 +198,17 @@ export class VerifiedFetch {
           return notAcceptableResponse(resource, requestedMimeTypes, [])
         }
 
-        return this.handleFinalResponse(await ipnsRecordPlugin.handle({
+        const context = {
           ...options,
           range,
           url,
           resource,
-          redirected: false
-        }), withServerTiming, {
+          redirected: false,
           serverTiming
-        })
+        }
+
+        // @ts-expect-error headers type is wrong
+        return this.handleFinalResponse(await ipnsRecordPlugin.handle(context), withServerTiming, context)
       }
 
       const resolveResult = await this.urlResolver.resolve(url, serverTiming, options)
@@ -421,6 +423,7 @@ export class VerifiedFetch {
       setCacheControlHeader({
         response,
         ttl: context.ttl,
+        expires: context.expires,
         protocol: context.url.protocol
       })
     }