fix: set user agent for purge requests (#2730)

Author: pieh

package-lock.json

@@ -54,7 +54,7 @@
     "@netlify/edge-bundler": "^12.2.3",
     "@netlify/edge-functions": "^2.11.0",
     "@netlify/eslint-config-node": "^7.0.1",
-    "@netlify/functions": "^2.8.2",
+    "@netlify/functions": "^3.0.0",
     "@netlify/serverless-functions-api": "^1.30.1",
     "@netlify/zip-it-and-ship-it": "^9.41.0",
     "@opentelemetry/api": "^1.8.0",

package.json

@@ -11,6 +11,7 @@ import { type Span } from '@opentelemetry/api'
 import type { PrerenderManifest } from 'next/dist/build/index.js'
 import { NEXT_CACHE_TAGS_HEADER } from 'next/dist/lib/constants.js'
 
+import { name as nextRuntimePkgName, version as nextRuntimePkgVersion } from '../../../package.json'
 import {
   type CacheHandlerContext,
   type CacheHandlerForMultipleVersions,
@@ -30,6 +31,8 @@ type TagManifest = { revalidatedAt: number }
 
 type TagManifestBlobCache = Record<string, Promise<TagManifest>>
 
+const purgeCacheUserAgent = `${nextRuntimePkgName}@${nextRuntimePkgVersion}`
+
 export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
   options: CacheHandlerContext
   revalidatedTags: string[]
@@ -347,12 +350,14 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
           const tag = `_N_T_${key === '/index' ? '/' : encodeURI(key)}`
           getLogger().debug(`Purging CDN cache for: [${tag}]`)
           requestContext.trackBackgroundWork(
-            purgeCache({ tags: tag.split(/,|%2c/gi) }).catch((error) => {
-              // TODO: add reporting here
-              getLogger()
-                .withError(error)
-                .error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`)
-            }),
+            purgeCache({ tags: tag.split(/,|%2c/gi), userAgent: purgeCacheUserAgent }).catch(
+              (error) => {
+                // TODO: add reporting here
+                getLogger()
+                  .withError(error)
+                  .error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`)
+              },
+            ),
           )
         }
       }
@@ -393,7 +398,7 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
       }),
     )
 
-    await purgeCache({ tags }).catch((error) => {
+    await purgeCache({ tags, userAgent: purgeCacheUserAgent }).catch((error) => {
       // TODO: add reporting here
       getLogger()
         .withError(error)