.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
   extends: '@netlify/eslint-config-node',
   rules: {
     'max-statements': 'off',
+    'max-lines': 'off',
   },
   overrides: [
     ...overrides,

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [3.0.2](https://github.com/netlify/functions/compare/v3.0.1...v3.0.2) (2025-03-17)
+
+
+### Bug Fixes
+
+* if the purge api call fails, include the api response body in the thrown error's message ([#571](https://github.com/netlify/functions/issues/571)) ([e01516d](https://github.com/netlify/functions/commit/e01516df909fc0e9ba9c553655cb7df8b5b27e51))
+* only purge alias by default if the purgeCache function is called within a deployed function ([#576](https://github.com/netlify/functions/issues/576)) ([964b0a2](https://github.com/netlify/functions/commit/964b0a27ee092f9cc5fd6726adb15439e3b9e74e))
+
 ## [3.0.1](https://github.com/netlify/functions/compare/v3.0.0...v3.0.1) (2025-03-04)
 
 

package.json

@@ -25,7 +25,7 @@
       }
     }
   },
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "JavaScript utilities for Netlify Functions",
   "files": [
     "dist/**/*.js",
@@ -88,7 +88,7 @@
     "semver": "^7.5.4",
     "tsd": "^0.31.0",
     "tsup": "^8.0.2",
-    "typescript": "^4.4.4",
+    "typescript": "^5.0.0",
     "vitest": "^2.1.8"
   },
   "engines": {

src/lib/purge_cache.test.ts

@@ -58,9 +58,111 @@ test('Calls the purge API endpoint and returns `undefined` if the operation was
   expect(mockAPI.fulfilled).toBeTruthy()
 })
 
-test('Throws if the API response does not have a successful status code', async () => {
+test('Does not default the deploy_alias field to process.env.NETLIFY_BRANCH if supplied in the options', async () => {
+  const mockSiteID = '123456789'
+  const mockToken = '1q2w3e4r5t6y7u8i9o0p'
+
+  process.env.NETLIFY_PURGE_API_TOKEN = mockToken
+  process.env.SITE_ID = mockSiteID
+  process.env.NETLIFY_BRANCH = 'main'
+
+  const mockAPI = new MockFetch().post({
+    body: (payload: string) => {
+      const data = JSON.parse(payload)
+
+      expect(data.site_id).toBe(mockSiteID)
+      expect(data.deploy_alias).toBe('test')
+    },
+    headers: { Authorization: `Bearer ${mockToken}` },
+    method: 'post',
+    response: new Response(null, { status: 202 }),
+    url: `https://api.netlify.com/api/v1/purge`,
+  })
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  const myFunction = async () => {
+    await purgeCache({ deployAlias: 'test' })
+  }
+
+  globalThis.fetch = mockAPI.fetcher
+
+  const response = await invokeLambda(myFunction)
+
+  expect(response).toBeUndefined()
+  expect(mockAPI.fulfilled).toBeTruthy()
+})
+
+test('Defaults the deploy_alias field to process.env.NETLIFY_BRANCH if not running locally', async () => {
+  const mockSiteID = '123456789'
+  const mockToken = '1q2w3e4r5t6y7u8i9o0p'
+
+  process.env.NETLIFY_PURGE_API_TOKEN = mockToken
+  process.env.SITE_ID = mockSiteID
+  process.env.NETLIFY_BRANCH = 'main'
+
+  const mockAPI = new MockFetch().post({
+    body: (payload: string) => {
+      const data = JSON.parse(payload)
+
+      expect(data.site_id).toBe(mockSiteID)
+      expect(data.deploy_alias).toBe(process.env.NETLIFY_BRANCH)
+    },
+    headers: { Authorization: `Bearer ${mockToken}` },
+    method: 'post',
+    response: new Response(null, { status: 202 }),
+    url: `https://api.netlify.com/api/v1/purge`,
+  })
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  const myFunction = async () => {
+    await purgeCache()
+  }
+
+  globalThis.fetch = mockAPI.fetcher
+
+  const response = await invokeLambda(myFunction)
+
+  expect(response).toBeUndefined()
+  expect(mockAPI.fulfilled).toBeTruthy()
+})
+
+test('Does not default the deploy_alias field to process.env.NETLIFY_BRANCH when running locally', async () => {
+  const mockSiteID = '123456789'
+  const mockToken = '1q2w3e4r5t6y7u8i9o0p'
+
+  process.env.NETLIFY_PURGE_API_TOKEN = mockToken
+  process.env.SITE_ID = mockSiteID
+  process.env.NETLIFY_LOCAL = 'true'
+  process.env.NETLIFY_BRANCH = 'main'
+
+  const mockAPI = new MockFetch().post({
+    body: (payload: string) => {
+      const data = JSON.parse(payload)
+
+      expect(data.site_id).toBe(mockSiteID)
+      expect(data.deploy_alias).toBeUndefined()
+    },
+    headers: { Authorization: `Bearer ${mockToken}` },
+    method: 'post',
+    response: new Response(null, { status: 202 }),
+    url: `https://api.netlify.com/api/v1/purge`,
+  })
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  const myFunction = async () => {
+    await purgeCache()
+  }
+
+  globalThis.fetch = mockAPI.fetcher
+
+  const response = await invokeLambda(myFunction)
+
+  expect(response).toBeUndefined()
+  expect(mockAPI.fulfilled).toBeTruthy()
+})
+
+test('Throws an error if the API response does not have a successful status code, using the response body as part of the error message', async () => {
   if (!hasFetchAPI) {
     console.warn('Skipping test requires the fetch API')
+
+    return
   }
 
   const mockSiteID = '123456789'
@@ -77,7 +179,7 @@ test('Throws if the API response does not have a successful status code', async
     },
     headers: { Authorization: `Bearer ${mockToken}` },
     method: 'post',
-    response: new Response(null, { status: 500 }),
+    response: new Response('site not found', { status: 404 }),
     url: `https://api.netlify.com/api/v1/purge`,
   })
   // eslint-disable-next-line unicorn/consistent-function-scoping
@@ -90,14 +192,54 @@ test('Throws if the API response does not have a successful status code', async
   try {
     await invokeLambda(myFunction)
 
-    throw new Error('Invocation should have failed')
+    expect.fail('Invocation should have failed')
   } catch (error) {
     expect((error as NodeJS.ErrnoException).message).toBe(
-      'Cache purge API call returned an unexpected status code: 500',
+      'Cache purge API call was unsuccessful.\nStatus: 404\nBody: site not found',
     )
   }
 })
 
+test('Throws if the API response does not have a successful status code, does not include the response body if it is not text', async () => {
+  if (!hasFetchAPI) {
+    console.warn('Skipping test requires the fetch API')
+
+    return
+  }
+
+  const mockSiteID = '123456789'
+  const mockToken = '1q2w3e4r5t6y7u8i9o0p'
+
+  process.env.NETLIFY_PURGE_API_TOKEN = mockToken
+  process.env.SITE_ID = mockSiteID
+
+  const mockAPI = new MockFetch().post({
+    body: (payload: string) => {
+      const data = JSON.parse(payload)
+
+      expect(data.site_id).toBe(mockSiteID)
+    },
+    headers: { Authorization: `Bearer ${mockToken}` },
+    method: 'post',
+    response: new Response(null, { status: 500 }),
+    url: `https://api.netlify.com/api/v1/purge`,
+  })
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  const myFunction = async () => {
+    await purgeCache()
+  }
+
+  globalThis.fetch = mockAPI.fetcher
+
+  try {
+    await invokeLambda(myFunction)
+
+    throw new Error('Invocation should have failed')
+  } catch (error) {
+    expect((error as NodeJS.ErrnoException).message).toBe('Cache purge API call was unsuccessful.\nStatus: 500')
+  }
+})
+
 test('Ignores purgeCache if in local dev with no token or site', async () => {
   if (!hasFetchAPI) {
     console.warn('Skipping test requires the fetch API')