@netlify/cache - npm Package Compare versions

Comparing version 3.3.5 to 3.4.0

dist/main.cjs

@@ -32,2 +32,3 @@ "use strict";
   getCacheStatus: () => getCacheStatus,
+  needsRevalidation: () => needsRevalidation,
   setCacheHeaders: () => setCacheHeaders
@@ -270,2 +271,15 @@ });
 };
+var needsRevalidation = (response) => {
+  const header = response.headers.get(CacheStatus);
+  if (!header) {
+    return false;
+  }
+  for (const value of header.split(",")) {
+    const { attributes, name } = parseCacheStatusValue(value);
+    if (name === CACHE_DURABLE && attributes.detail === "client-revalidate") {
+      return true;
+    }
+  }
+  return false;
+};
 var getCacheStatus = (input) => {
@@ -341,2 +355,15 @@ if (typeof input === "string") {
   if (cached) {
+    if (needsRevalidation(cached)) {
+      const { fetch: fetchFn = globalThis.fetch } = cacheOptions;
+      const revalidation = performBackgroundRevalidation(request, cache, cacheSettings, fetchFn);
+      if (onCachePut) {
+        await onCachePut(revalidation);
+      } else {
+        const netlifyGlobal = globalThis.Netlify;
+        const requestContext = netlifyGlobal?.context;
+        if (requestContext) {
+          requestContext.waitUntil(revalidation);
+        }
+      }
+    }
     return cached;
@@ -368,2 +395,15 @@ }
 };
+var performBackgroundRevalidation = async (request, cache, cacheSettings, fetchFn) => {
+  try {
+    const fresh = await fetchFn(request);
+    if (!fresh.body) {
+      return;
+    }
+    const cacheResponse = new Response(fresh.body, fresh);
+    applyHeaders(cacheResponse.headers, cacheHeaders(cacheSettings));
+    await cache.put(request, cacheResponse);
+  } catch (error) {
+    console.warn("`fetchWithCache` has failed to revalidate a stale response:", error);
+  }
+};
 
@@ -387,3 +427,4 @@ // src/constants.ts
   getCacheStatus,
+  needsRevalidation,
   setCacheHeaders
 });

dist/main.d.cts

@@ -133,2 +133,11 @@ import { N as NetlifyCache } from './cache-B9TsVKLp.cjs';
 /**
+ * Returns whether a cached response includes a signal that the client should
+ * perform a background revalidation. This may happen when using the Cache API
+ * with the `stale-while-revalidate` directive, since unlike the regular cache,
+ * the client is the one responsible for explicitly inserting new entries into
+ * the cache. So when this returns `true`, the caller should fetch the resource
+ * and write the fresh response back to the cache with `cache.put()`.
+ */
+declare const needsRevalidation: (response: Response) => boolean;
+/**
  * Retrieves information about how a response has interacted with Netlify's
@@ -197,2 +206,2 @@ * global caching infrastructure, including whether the response has been
 
-export { DAY, HOUR, MINUTE, WEEK, YEAR, cacheHeaders, caches, fetchWithCache, getCacheStatus, setCacheHeaders };
+export { DAY, HOUR, MINUTE, WEEK, YEAR, cacheHeaders, caches, fetchWithCache, getCacheStatus, needsRevalidation, setCacheHeaders };

dist/main.d.ts

@@ -133,2 +133,11 @@ import { N as NetlifyCache } from './cache-B9TsVKLp.js';
 /**
+ * Returns whether a cached response includes a signal that the client should
+ * perform a background revalidation. This may happen when using the Cache API
+ * with the `stale-while-revalidate` directive, since unlike the regular cache,
+ * the client is the one responsible for explicitly inserting new entries into
+ * the cache. So when this returns `true`, the caller should fetch the resource
+ * and write the fresh response back to the cache with `cache.put()`.
+ */
+declare const needsRevalidation: (response: Response) => boolean;
+/**
  * Retrieves information about how a response has interacted with Netlify's
@@ -197,2 +206,2 @@ * global caching infrastructure, including whether the response has been
 
-export { DAY, HOUR, MINUTE, WEEK, YEAR, cacheHeaders, caches, fetchWithCache, getCacheStatus, setCacheHeaders };
+export { DAY, HOUR, MINUTE, WEEK, YEAR, cacheHeaders, caches, fetchWithCache, getCacheStatus, needsRevalidation, setCacheHeaders };

dist/main.js

@@ -234,2 +234,15 @@ // src/polyfill.ts
 };
+var needsRevalidation = (response) => {
+  const header = response.headers.get(CacheStatus);
+  if (!header) {
+    return false;
+  }
+  for (const value of header.split(",")) {
+    const { attributes, name } = parseCacheStatusValue(value);
+    if (name === CACHE_DURABLE && attributes.detail === "client-revalidate") {
+      return true;
+    }
+  }
+  return false;
+};
 var getCacheStatus = (input) => {
@@ -305,2 +318,15 @@ if (typeof input === "string") {
   if (cached) {
+    if (needsRevalidation(cached)) {
+      const { fetch: fetchFn = globalThis.fetch } = cacheOptions;
+      const revalidation = performBackgroundRevalidation(request, cache, cacheSettings, fetchFn);
+      if (onCachePut) {
+        await onCachePut(revalidation);
+      } else {
+        const netlifyGlobal = globalThis.Netlify;
+        const requestContext = netlifyGlobal?.context;
+        if (requestContext) {
+          requestContext.waitUntil(revalidation);
+        }
+      }
+    }
     return cached;
@@ -332,2 +358,15 @@ }
 };
+var performBackgroundRevalidation = async (request, cache, cacheSettings, fetchFn) => {
+  try {
+    const fresh = await fetchFn(request);
+    if (!fresh.body) {
+      return;
+    }
+    const cacheResponse = new Response(fresh.body, fresh);
+    applyHeaders(cacheResponse.headers, cacheHeaders(cacheSettings));
+    await cache.put(request, cacheResponse);
+  } catch (error) {
+    console.warn("`fetchWithCache` has failed to revalidate a stale response:", error);
+  }
+};
 
@@ -350,3 +389,4 @@ // src/constants.ts
   getCacheStatus,
+  needsRevalidation,
   setCacheHeaders
 };

package.json

 {
   "name": "@netlify/cache",
-  "version": "3.3.5",
+  "version": "3.4.0",
   "description": "TypeScript utilities for interacting with the Netlify cache",
@@ -5,0 +5,0 @@ "type": "module",

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

65554

6.24%

Lines of code

1578

6.05%

Worsened metrics

Number of low supply chain risk alerts

7

40%

Number of medium supply chain risk alerts

30

25%

No dependency changes