feat: Update to latest blob client (7.3.0) (#398)

* chore: Add buildVersion and useRegionalBlobs to PluginContext

* chore: Centralize deploy store configuration

* chore: Extract FixtureTestContext and BLOB_TOKEN into their own files

* chore: Prepare getBlobServerGets to handle regions

* chore: Set and make use of shared build/run USE_REGIONAL_BLOBS environment variable

* chore: Use latest @netlify/blobs version

* chore: Pin regional blob functionality to a higher version of the cli

* chore: mark all runtime modules as external

* fix: Ensure ts files are compiled in unit tests

* chore: linting

* maybe win slash?

* test: add fixture using CLI before regional blobs support

* test: use createRequestContext in tests instead of manually creating request context objects

* Update tests/e2e/page-router.test.ts

Co-authored-by: Philippe Serhal <philippe.serhal@gmail.com>

* test: rename unit test for blobs directory

---------

Co-authored-by: Michal Piechowiak <misiek.piechowiak@gmail.com>
Co-authored-by: Philippe Serhal <philippe.serhal@gmail.com>

Author: 3 people

package-lock.json

@@ -49,7 +49,7 @@
   "homepage": "https://github.com/netlify/next-runtime-minimal#readme",
   "devDependencies": {
     "@fastly/http-compute-js": "1.1.4",
-    "@netlify/blobs": "^7.0.1",
+    "@netlify/blobs": "^7.3.0",
     "@netlify/build": "^29.37.2",
     "@netlify/edge-bundler": "^11.4.0",
     "@netlify/edge-functions": "^2.5.1",

package.json

@@ -7,7 +7,8 @@ import glob from 'fast-glob'
 import { Mock, beforeEach, describe, expect, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../../tests/index.js'
-import { FixtureTestContext, createFsFixture } from '../../../tests/utils/fixture.js'
+import { type FixtureTestContext } from '../../../tests/utils/contexts.js'
+import { createFsFixture } from '../../../tests/utils/fixture.js'
 import { PluginContext, RequiredServerFilesManifest } from '../plugin-context.js'
 
 import { copyStaticAssets, copyStaticContent } from './static.js'

src/build/content/static.test.ts

@@ -97,6 +97,7 @@ const getHandlerFile = async (ctx: PluginContext): Promise<string> => {
     return template
       .replaceAll('{{cwd}}', posixJoin(ctx.lambdaWorkingDirectory))
       .replace('{{nextServerHandler}}', posixJoin(ctx.nextServerHandler))
+      .replace('{{useRegionalBlobs}}', ctx.useRegionalBlobs.toString())
   }
 
   return await readFile(join(templatesDir, 'handler.tmpl.js'), 'utf-8')

src/build/functions/server.ts

@@ -195,3 +195,18 @@ test('nx monorepo with package path and different distDir', () => {
   expect(ctx.relPublishDir).toBe('dist/apps/my-app/.next')
   expect(ctx.publishDir).toBe(join(cwd, 'dist/apps/my-app/.next'))
 })
+
+test('should use deploy configuration blobs directory when @netlify/build version supports regional blob awareness', () => {
+  const { cwd } = mockFileSystem({
+    '.next/required-server-files.json': JSON.stringify({
+      config: { distDir: '.next' },
+      relativeAppDir: '',
+    } as RequiredServerFilesManifest),
+  })
+
+  const ctx = new PluginContext({
+    constants: { NETLIFY_BUILD_VERSION: '29.39.1' },
+  } as NetlifyPluginOptions)
+
+  expect(ctx.blobDir).toBe(join(cwd, '.netlify/deploy/v1/blobs/deploy'))
+})

src/build/plugin-context.test.ts

@@ -13,6 +13,7 @@ import type {
 import type { PrerenderManifest, RoutesManifest } from 'next/dist/build/index.js'
 import type { MiddlewareManifest } from 'next/dist/build/webpack/plugins/middleware-plugin.js'
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
+import { satisfies } from 'semver'
 
 const MODULE_DIR = fileURLToPath(new URL('.', import.meta.url))
 const PLUGIN_DIR = join(MODULE_DIR, '../..')
@@ -135,12 +136,27 @@ export class PluginContext {
 
   /**
    * Absolute path of the directory that will be deployed to the blob store
-   * `.netlify/blobs/deploy`
+   * region aware: `.netlify/deploy/v1/blobs/deploy`
+   * default: `.netlify/blobs/deploy`
    */
   get blobDir(): string {
+    if (this.useRegionalBlobs) {
+      return this.resolveFromPackagePath('.netlify/deploy/v1/blobs/deploy')
+    }
+
     return this.resolveFromPackagePath('.netlify/blobs/deploy')
   }
 
+  get buildVersion(): string {
+    return this.constants.NETLIFY_BUILD_VERSION || 'v0.0.0'
+  }
+
+  get useRegionalBlobs(): boolean {
+    // Region-aware blobs are only available as of CLI v17.22.1 (i.e. Build v29.39.1)
+    const REQUIRED_BUILD_VERSION = '>=29.39.1'
+    return satisfies(this.buildVersion, REQUIRED_BUILD_VERSION, { includePrerelease: true })
+  }
+
   /**
    * Absolute path of the directory containing the files for the serverless lambda function
    * `.netlify/functions-internal`

src/build/plugin-context.ts

@@ -7,6 +7,9 @@ import tracing from '{{cwd}}/.netlify/dist/run/handlers/tracing.js'
 
 process.chdir('{{cwd}}')
 
+// Set feature flag for regional blobs
+process.env.USE_REGIONAL_BLOBS = '{{useRegionalBlobs}}'
+
 let cachedHandler
 export default async function (req, context) {
   if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL) {

src/build/templates/handler-monorepo.tmpl.js

@@ -6,6 +6,9 @@ import serverHandler from './.netlify/dist/run/handlers/server.js'
 import { getTracer } from './.netlify/dist/run/handlers/tracer.cjs'
 import tracing from './.netlify/dist/run/handlers/tracing.js'
 
+// Set feature flag for regional blobs
+process.env.USE_REGIONAL_BLOBS = '{{useRegionalBlobs}}'
+
 export default async function handler(req, context) {
   if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL) {
     tracing.start()

src/build/templates/handler.tmpl.js

@@ -3,7 +3,7 @@
 //
 import { Buffer } from 'node:buffer'
 
-import { getDeployStore, Store } from '@netlify/blobs'
+import { Store } from '@netlify/blobs'
 import { purgeCache } from '@netlify/functions'
 import { type Span } from '@opentelemetry/api'
 import { NEXT_CACHE_TAGS_HEADER } from 'next/dist/lib/constants.js'
@@ -16,6 +16,7 @@ import type {
   NetlifyCacheHandlerValue,
   NetlifyIncrementalCacheValue,
 } from '../../shared/cache-types.cjs'
+import { getRegionalBlobStore } from '../regional-blob-store.cjs'
 
 import { getRequestContext } from './request-context.cjs'
 import { getTracer } from './tracer.cjs'
@@ -24,8 +25,6 @@ type TagManifest = { revalidatedAt: number }
 
 type TagManifestBlobCache = Record<string, Promise<TagManifest>>
 
-const fetchBeforeNextPatchedIt = globalThis.fetch
-
 export class NetlifyCacheHandler implements CacheHandler {
   options: CacheHandlerContext
   revalidatedTags: string[]
@@ -36,7 +35,7 @@ export class NetlifyCacheHandler implements CacheHandler {
   constructor(options: CacheHandlerContext) {
     this.options = options
     this.revalidatedTags = options.revalidatedTags
-    this.blobStore = getDeployStore({ fetch: fetchBeforeNextPatchedIt, consistency: 'strong' })
+    this.blobStore = getRegionalBlobStore({ consistency: 'strong' })
     this.tagManifestsFetchedFromBlobStoreInCurrentRequest = {}
   }
 

src/run/handlers/cache.cts

@@ -1,11 +1,12 @@
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
 import { v4 } from 'uuid'
-import { afterEach, describe, expect, test, vi, beforeEach } from 'vitest'
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
 
-import { FixtureTestContext } from '../../tests/utils/fixture.js'
+import { type FixtureTestContext } from '../../tests/utils/contexts.js'
 import { generateRandomObjectID, startMockBlobStore } from '../../tests/utils/helpers.js'
 
-import { setVaryHeaders, setCacheControlHeaders } from './headers.js'
+import { createRequestContext } from './handlers/request-context.cjs'
+import { setCacheControlHeaders, setVaryHeaders } from './headers.js'
 
 beforeEach<FixtureTestContext>(async (ctx) => {
   // set for each test a new deployID and siteID
@@ -198,7 +199,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenCalledTimes(0)
     })
@@ -208,7 +209,10 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, { usedFsRead: true })
+      const requestContext = createRequestContext()
+      requestContext.usedFsRead = true
+
+      setCacheControlHeaders(headers, request, requestContext)
 
       expect(headers.set).toHaveBeenNthCalledWith(
         1,
@@ -231,7 +235,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenCalledTimes(0)
     })
@@ -245,7 +249,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenCalledTimes(0)
     })
@@ -258,7 +262,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenNthCalledWith(
         1,
@@ -280,7 +284,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl, { method: 'HEAD' })
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenNthCalledWith(
         1,
@@ -302,7 +306,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl, { method: 'POST' })
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenCalledTimes(0)
     })
@@ -315,7 +319,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenNthCalledWith(1, 'cache-control', 'public')
       expect(headers.set).toHaveBeenNthCalledWith(
@@ -333,7 +337,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenNthCalledWith(1, 'cache-control', 'max-age=604800')
       expect(headers.set).toHaveBeenNthCalledWith(
@@ -351,7 +355,7 @@ describe('headers', () => {
       const request = new Request(defaultUrl)
       vi.spyOn(headers, 'set')
 
-      setCacheControlHeaders(headers, request, {})
+      setCacheControlHeaders(headers, request, createRequestContext())
 
       expect(headers.set).toHaveBeenNthCalledWith(
         1,

src/run/headers.test.ts

@@ -1,4 +1,3 @@
-import { getDeployStore } from '@netlify/blobs'
 import type { Span } from '@opentelemetry/api'
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
 
@@ -7,6 +6,7 @@ import { encodeBlobKey } from '../shared/blobkey.js'
 import type { TagsManifest } from './config.js'
 import type { RequestContext } from './handlers/request-context.cjs'
 import type { RuntimeTracer } from './handlers/tracer.cjs'
+import { getRegionalBlobStore } from './regional-blob-store.cjs'
 
 const ALL_VARIATIONS = Symbol.for('ALL_VARIATIONS')
 interface NetlifyVaryValues {
@@ -121,8 +121,6 @@ export const setVaryHeaders = (
   headers.set(`netlify-vary`, generateNetlifyVaryValues(netlifyVaryValues))
 }
 
-const fetchBeforeNextPatchedIt = globalThis.fetch
-
 /**
  * Change the date header to be the last-modified date of the blob. This means the CDN
  * will use the correct expiry time for the response. e.g. if the blob was last modified
@@ -173,8 +171,8 @@ export const adjustDateHeader = async ({
       warning: true,
     })
 
+    const blobStore = getRegionalBlobStore({ consistency: 'strong' })
     const blobKey = await encodeBlobKey(key)
-    const blobStore = getDeployStore({ fetch: fetchBeforeNextPatchedIt, consistency: 'strong' })
 
     // TODO: use metadata for this
     lastModified = await tracer.withActiveSpan(

src/run/headers.ts

@@ -1,12 +1,12 @@
 import fs from 'fs/promises'
 import { relative, resolve } from 'path'
 
-import { getDeployStore } from '@netlify/blobs'
 // @ts-expect-error no types installed
 import { patchFs } from 'fs-monkey'
 
 import { getRequestContext } from './handlers/request-context.cjs'
 import { getTracer } from './handlers/tracer.cjs'
+import { getRegionalBlobStore } from './regional-blob-store.cjs'
 
 console.time('import next server')
 
@@ -17,8 +17,6 @@ console.timeEnd('import next server')
 
 type FS = typeof import('fs')
 
-const fetchBeforeNextPatchedIt = globalThis.fetch
-
 export async function getMockedRequestHandlers(...args: Parameters<typeof getRequestHandlers>) {
   const tracer = getTracer()
   return tracer.withActiveSpan('mocked request handler', async () => {
@@ -35,7 +33,7 @@ export async function getMockedRequestHandlers(...args: Parameters<typeof getReq
       } catch (error) {
         // only try to get .html files from the blob store
         if (typeof path === 'string' && path.endsWith('.html')) {
-          const store = getDeployStore({ fetch: fetchBeforeNextPatchedIt })
+          const store = getRegionalBlobStore()
           const relPath = relative(resolve('.next/server/pages'), path)
           const file = await store.get(await encodeBlobKey(relPath))
           if (file !== null) {

src/run/next.cts

@@ -0,0 +1,12 @@
+import { getDeployStore, Store } from '@netlify/blobs'
+
+const fetchBeforeNextPatchedIt = globalThis.fetch
+
+export const getRegionalBlobStore = (args: Parameters<typeof getDeployStore>[0] = {}): Store => {
+  return getDeployStore({
+    ...args,
+    fetch: fetchBeforeNextPatchedIt,
+    experimentalRegion:
+      process.env.USE_REGIONAL_BLOBS?.toUpperCase() === 'TRUE' ? 'context' : undefined,
+  })
+}

src/run/regional-blob-store.cts

@@ -0,0 +1,25 @@
+import { expect } from '@playwright/test'
+import { test } from '../utils/playwright-helpers.js'
+
+test('should serve 404 page when requesting non existing page (no matching route) if site is deployed with CLI not supporting regional blobs', async ({
+  page,
+  cliBeforeRegionalBlobsSupport,
+}) => {
+  // 404 page is built and uploaded to blobs at build time
+  // when Next.js serves 404 it will try to fetch it from the blob store
+  // if request handler function is unable to get from blob store it will
+  // fail request handling and serve 500 error.
+  // This implicitly tests that request handler function is able to read blobs
+  // that are uploaded as part of site deploy.
+
+  const response = await page.goto(new URL('non-existing', cliBeforeRegionalBlobsSupport.url).href)
+  const headers = response?.headers() || {}
+  expect(response?.status()).toBe(404)
+
+  expect(await page.textContent('h1')).toBe('404')
+
+  expect(headers['netlify-cdn-cache-control']).toBe(
+    'no-cache, no-store, max-age=0, must-revalidate',
+  )
+  expect(headers['cache-control']).toBe('no-cache,no-store,max-age=0,must-revalidate')
+})

tests/e2e/cli-before-regional-blobs-support.test.ts

@@ -230,10 +230,17 @@ test.describe('Simple Page Router (no basePath, no i18n)', () => {
     expect(data3?.pageProps?.time).toBe(date3)
   })
 
-  test('requesting a non existing page route that needs to be fetched from the blob store like 404.html', async ({
+  test('should serve 404 page when requesting non existing page (no matching route)', async ({
     page,
     pageRouter,
   }) => {
+    // 404 page is built and uploaded to blobs at build time
+    // when Next.js serves 404 it will try to fetch it from the blob store
+    // if request handler function is unable to get from blob store it will
+    // fail request handling and serve 500 error.
+    // This implicitly tests that request handler function is able to read blobs
+    // that are uploaded as part of site deploy.
+
     const response = await page.goto(new URL('non-existing', pageRouter.url).href)
     const headers = response?.headers() || {}
     expect(response?.status()).toBe(404)
@@ -246,7 +253,7 @@ test.describe('Simple Page Router (no basePath, no i18n)', () => {
     expect(headers['cache-control']).toBe('no-cache,no-store,max-age=0,must-revalidate')
   })
 
-  test('requesting a non existing page route that needs to be fetched from the blob store like 404.html (notFound: true)', async ({
+  test('should serve 404 page when requesting non existing page (marked with notFound: true in getStaticProps)', async ({
     page,
     pageRouter,
   }) => {

tests/e2e/page-router.test.ts

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+}
+
+module.exports = nextConfig

tests/fixtures/cli-before-regional-blobs-support/next.config.js

@@ -0,0 +1,16 @@
+{
+  "name": "old-cli",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "postinstall": "next build",
+    "dev": "next dev",
+    "build": "next build"
+  },
+  "dependencies": {
+    "next": "latest",
+    "netlify-cli": "17.21.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}

tests/fixtures/cli-before-regional-blobs-support/package.json

@@ -0,0 +1,15 @@
+export default function Home({ ssr }) {
+  return (
+    <main>
+      <div data-testid="smoke">SSR: {ssr ? 'yes' : 'no'}</div>
+    </main>
+  )
+}
+
+export const getServerSideProps = async () => {
+  return {
+    props: {
+      ssr: true,
+    },
+  }
+}

tests/fixtures/cli-before-regional-blobs-support/pages/index.js

@@ -3,10 +3,11 @@ import { join } from 'node:path'
 import { NetlifyPluginOptions } from '@netlify/build'
 import { expect, test } from 'vitest'
 
+import { readFile, readdir } from 'node:fs/promises'
 import { copyNextServerCode } from '../../../src/build/content/server.js'
 import { PluginContext, RequiredServerFilesManifest } from '../../../src/build/plugin-context.js'
-import { FixtureTestContext, createFsFixture } from '../../utils/fixture.js'
-import { readFile, readdir } from 'node:fs/promises'
+import { type FixtureTestContext } from '../../utils/contexts.js'
+import { createFsFixture } from '../../utils/fixture.js'
 
 test<FixtureTestContext>('should copy the next standalone folder correctly for a simple site', async (ctx) => {
   const reqServerFiles = JSON.stringify({

tests/integration/build/copy-next-code.test.ts

@@ -2,12 +2,8 @@ import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
 import { v4 } from 'uuid'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import {
   countOfBlobServerGetsForKey,
   decodeBlobKey,

tests/integration/cache-handler.test.ts

@@ -1,11 +1,7 @@
 import { v4 } from 'uuid'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeEdgeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeEdgeFunction, runPlugin } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 import { LocalServer } from '../utils/local-server.js'
 

tests/integration/edge-handler.test.ts

@@ -4,13 +4,8 @@ import { HttpResponse, http, passthrough } from 'msw'
 import { setupServer } from 'msw/node'
 import { v4 } from 'uuid'
 import { afterAll, beforeAll, beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  runPluginStep,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin, runPluginStep } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 
 // Disable the verbose logging of the lambda-local runtime

tests/integration/fetch-handler.test.ts

@@ -2,16 +2,12 @@ import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
 import { HttpResponse, http, passthrough } from 'msw'
 import { setupServer } from 'msw/node'
+import { platform } from 'node:process'
 import { v4 } from 'uuid'
 import { afterAll, afterEach, beforeAll, beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import { encodeBlobKey, generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
-import { platform } from 'node:process'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'

tests/integration/page-router.test.ts

@@ -1,15 +1,11 @@
 import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
+import { platform } from 'node:process'
 import { v4 } from 'uuid'
 import { beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
-import { platform } from 'node:process'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'

tests/integration/pnpm.test.ts

@@ -1,23 +1,19 @@
 import { getLogger } from 'lambda-local'
+import cjsMock from 'mock-require'
+import type { CacheHandler } from 'next/dist/server/lib/incremental-cache/index.js'
+import { realpathSync } from 'node:fs'
+import { join } from 'node:path'
 import { v4 } from 'uuid'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { SERVER_HANDLER_NAME } from '../../src/build/plugin-context.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import {
   countOfBlobServerGetsForKey,
   encodeBlobKey,
   generateRandomObjectID,
   startMockBlobStore,
 } from '../utils/helpers.js'
-import cjsMock from 'mock-require'
-import type { CacheHandler } from 'next/dist/server/lib/incremental-cache/index.js'
-import { SERVER_HANDLER_NAME } from '../../src/build/plugin-context.js'
-import { realpathSync } from 'node:fs'
-import { join } from 'node:path'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'

tests/integration/request-context.test.ts

@@ -2,12 +2,8 @@ import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
 import { v4 } from 'uuid'
 import { beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import {
   encodeBlobKey,
   generateRandomObjectID,

tests/integration/revalidate-path.test.ts

@@ -2,12 +2,8 @@ import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
 import { v4 } from 'uuid'
 import { beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin } from '../utils/fixture.js'
 import {
   encodeBlobKey,
   generateRandomObjectID,

tests/integration/revalidate-tags.test.ts

@@ -7,20 +7,20 @@ import { gunzipSync } from 'node:zlib'
 import { gt, prerelease } from 'semver'
 import { v4 } from 'uuid'
 import { Mock, afterAll, beforeAll, beforeEach, describe, expect, test, vi } from 'vitest'
+import { getPatchesToApply } from '../../src/build/content/server.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
 import {
   createFixture,
+  getFixtureSourceDirectory,
   invokeFunction,
   runPlugin,
-  getFixtureSourceDirectory,
-  type FixtureTestContext,
 } from '../utils/fixture.js'
 import {
   decodeBlobKey,
   generateRandomObjectID,
   getBlobEntries,
   startMockBlobStore,
 } from '../utils/helpers.js'
-import { getPatchesToApply } from '../../src/build/content/server.js'
 
 const mockedCp = cp as Mock<
   Parameters<(typeof import('node:fs/promises'))['cp']>,

tests/integration/simple-app.test.ts

@@ -5,13 +5,8 @@ import { existsSync } from 'node:fs'
 import { join } from 'node:path'
 import { v4 } from 'uuid'
 import { beforeEach, expect, test, vi } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  runPluginStep,
-  type FixtureTestContext,
-} from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeFunction, runPlugin, runPluginStep } from '../utils/fixture.js'
 import {
   decodeBlobKey,
   generateRandomObjectID,

tests/integration/static.test.ts

@@ -1,12 +1,12 @@
 import { getLogger } from 'lambda-local'
+import { existsSync } from 'node:fs'
+import { rm } from 'node:fs/promises'
+import { join } from 'node:path'
 import { v4 } from 'uuid'
 import { beforeEach, expect, test, vi } from 'vitest'
-import { createFixture, runPlugin, type FixtureTestContext } from '../utils/fixture.js'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, runPlugin } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
-import { glob } from 'fast-glob'
-import { existsSync } from 'node:fs'
-import { join } from 'node:path'
-import { rm } from 'node:fs/promises'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'

tests/integration/turborepo.test.ts

@@ -1,14 +1,8 @@
-import { load } from 'cheerio'
 import { getLogger } from 'lambda-local'
 import { v4 } from 'uuid'
-import { beforeEach, expect, test, vi, describe } from 'vitest'
-import {
-  createFixture,
-  invokeFunction,
-  runPlugin,
-  type FixtureTestContext,
-  invokeEdgeFunction,
-} from '../utils/fixture.js'
+import { beforeEach, describe, expect, test, vi } from 'vitest'
+import { type FixtureTestContext } from '../utils/contexts.js'
+import { createFixture, invokeEdgeFunction, invokeFunction, runPlugin } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 import { LocalServer } from '../utils/local-server.js'
 

tests/integration/wasm.test.ts

@@ -1,6 +1,6 @@
-import { afterEach, vi } from 'vitest'
-import { FixtureTestContext } from './utils/fixture'
 import fs from 'node:fs'
+import { afterEach } from 'vitest'
+import { type FixtureTestContext } from './utils/contexts'
 
 // cleanup after each test as a fallback if someone forgot to call it
 afterEach<FixtureTestContext>(async ({ cleanup }) => {

tests/test-setup.ts

@@ -0,0 +1 @@
+export const BLOB_TOKEN = 'secret-token'

tests/utils/constants.ts

@@ -0,0 +1,19 @@
+import { type getStore } from '@netlify/blobs'
+import { BlobsServer } from '@netlify/blobs/server'
+import { type WriteStream } from 'node:fs'
+import { MockInstance, TestContext } from 'vitest'
+
+export interface FixtureTestContext extends TestContext {
+  cwd: string
+  siteID: string
+  deployID: string
+  blobStoreHost: string
+  blobStorePort: number
+  blobServer: BlobsServer
+  blobServerGetSpy: MockInstance<Parameters<BlobsServer['get']>, ReturnType<BlobsServer['get']>>
+  blobStore: ReturnType<typeof getStore>
+  functionDist: string
+  edgeFunctionPort: number
+  edgeFunctionOutput: WriteStream
+  cleanup?: (() => Promise<void>)[]
+}

tests/utils/contexts.ts

@@ -35,6 +35,10 @@ interface E2EConfig {
    * If runtime should be installed in a custom location and not in cwd / packagePath
    */
   runtimeInstallationPath?: string
+  /**
+   * Some fixtures might pin to non-latest CLI versions. This is used to verify the used CLI version matches expected one
+   */
+  expectedCliVersion?: string
 }
 
 /**
@@ -71,6 +75,8 @@ export const createE2EFixture = async (fixture: string, config: E2EConfig = {})
       await setNextVersionInFixture(isolatedFixtureRoot, NEXT_VERSION)
     }
     await installRuntime(packageName, isolatedFixtureRoot, config)
+    await verifyFixture(isolatedFixtureRoot, config)
+
     const result = await deploySite(isolatedFixtureRoot, config)
 
     console.log(`🌍 Deployed site is live: ${result.url}`)
@@ -226,14 +232,38 @@ async function installRuntime(
   }
 }
 
+async function verifyFixture(isolatedFixtureRoot: string, { expectedCliVersion }: E2EConfig) {
+  if (expectedCliVersion) {
+    const { stdout } = await execaCommand('npx ntl --version', { cwd: isolatedFixtureRoot })
+
+    const match = stdout.match(/netlify-cli\/(?<version>\S+)/)
+
+    if (!match) {
+      throw new Error(`Could not extract the Netlify CLI version from the build logs`)
+    }
+
+    const extractedVersion = match.groups?.version
+
+    if (!extractedVersion) {
+      throw new Error(`Could not extract the Netlify CLI version from the build logs`)
+    }
+
+    if (extractedVersion !== expectedCliVersion) {
+      throw new Error(
+        `Using unexpected CLI version "${extractedVersion}". Expected "${expectedCliVersion}"`,
+      )
+    }
+  }
+}
+
 async function deploySite(
   isolatedFixtureRoot: string,
   { packagePath, cwd = '' }: E2EConfig,
 ): Promise<DeployResult> {
   console.log(`🚀 Building and deploying site...`)
 
   const outputFile = 'deploy-output.txt'
-  let cmd = `ntl deploy --build --site ${SITE_ID}`
+  let cmd = `npx ntl deploy --build --site ${SITE_ID}`
 
   if (packagePath) {
     cmd += ` --filter ${packagePath}`
@@ -319,6 +349,10 @@ export const fixtureFactories = {
       buildCommand: 'nx run custom-dist-dir:build',
       publishDirectory: 'dist/apps/custom-dist-dir/dist',
     }),
+  cliBeforeRegionalBlobsSupport: () =>
+    createE2EFixture('cli-before-regional-blobs-support', {
+      expectedCliVersion: '17.21.1',
+    }),
   yarnMonorepoWithPnpmLinker: () =>
     createE2EFixture('yarn-monorepo-with-pnpm-linker', {
       packageManger: 'berry',

tests/utils/create-e2e-fixture.ts

@@ -1,6 +1,4 @@
-import { type getStore } from '@netlify/blobs'
-import { BlobsServer } from '@netlify/blobs/server'
-import { TestContext, assert, vi, MockInstance } from 'vitest'
+import { assert, vi } from 'vitest'
 
 import { type NetlifyPluginConstants, type NetlifyPluginOptions } from '@netlify/build'
 import { bundle, serve } from '@netlify/edge-bundler'
@@ -9,7 +7,7 @@ import { zipFunctions } from '@netlify/zip-it-and-ship-it'
 import { execaCommand } from 'execa'
 import getPort from 'get-port'
 import { execute } from 'lambda-local'
-import { createWriteStream, existsSync, type WriteStream } from 'node:fs'
+import { createWriteStream, existsSync } from 'node:fs'
 import { cp, mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
 import { basename, dirname, join, parse, relative } from 'node:path'
@@ -25,25 +23,11 @@ import {
   PluginContext,
   SERVER_HANDLER_NAME,
 } from '../../src/build/plugin-context.js'
+import { BLOB_TOKEN } from './constants.js'
+import { type FixtureTestContext } from './contexts.js'
+import { createBlobContext } from './helpers.js'
 import { setNextVersionInFixture } from './next-version-helpers.mjs'
 
-export interface FixtureTestContext extends TestContext {
-  cwd: string
-  siteID: string
-  deployID: string
-  blobStoreHost: string
-  blobStorePort: number
-  blobServer: BlobsServer
-  blobServerGetSpy: MockInstance<Parameters<BlobsServer['get']>, ReturnType<BlobsServer['get']>>
-  blobStore: ReturnType<typeof getStore>
-  functionDist: string
-  edgeFunctionPort: number
-  edgeFunctionOutput: WriteStream
-  cleanup?: (() => Promise<void>)[]
-}
-
-export const BLOB_TOKEN = 'secret-token'
-
 const bootstrapURL = 'https://edge.netlify.com/bootstrap/index-combined.ts'
 const actualCwd = await vi.importActual<typeof import('process')>('process').then((p) => p.cwd())
 const eszipHelper = join(actualCwd, 'tools/deno/eszip.ts')
@@ -373,15 +357,7 @@ export async function invokeFunction(
     // The environment variables available during execution
     const environment = {
       NODE_ENV: 'production',
-      NETLIFY_BLOBS_CONTEXT: Buffer.from(
-        JSON.stringify({
-          edgeURL: `http://${ctx.blobStoreHost}`,
-          uncachedEdgeURL: `http://${ctx.blobStoreHost}`,
-          token: BLOB_TOKEN,
-          siteID: ctx.siteID,
-          deployID: ctx.deployID,
-        }),
-      ).toString('base64'),
+      NETLIFY_BLOBS_CONTEXT: createBlobContext(ctx),
       ...(env || {}),
     }
     const response = (await execute({

tests/utils/fixture.ts

@@ -1,5 +1,4 @@
 import getPort from 'get-port'
-import { BLOB_TOKEN, type FixtureTestContext } from './fixture.js'
 
 import { getDeployStore } from '@netlify/blobs'
 import { BlobsServer } from '@netlify/blobs/server'
@@ -10,6 +9,8 @@ import { mkdtemp } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
 import { join } from 'node:path'
 import { assert, vi } from 'vitest'
+import { BLOB_TOKEN } from './constants'
+import { type FixtureTestContext } from './contexts'
 
 /**
  * Uses next.js incremental cache to compute the same cache key for a URL that is automatically generated
@@ -48,6 +49,7 @@ export const createBlobContext = (ctx: FixtureTestContext) =>
       token: BLOB_TOKEN,
       siteID: ctx.siteID,
       deployID: ctx.deployID,
+      primaryRegion: 'us-test-1',
     }),
   ).toString('base64')
 
@@ -74,6 +76,7 @@ export const startMockBlobStore = async (ctx: FixtureTestContext) => {
     deployID: ctx.deployID,
     siteID: ctx.siteID,
     token: BLOB_TOKEN,
+    experimentalRegion: 'context',
   })
 }
 
@@ -88,6 +91,7 @@ export const getBlobEntries = async (ctx: FixtureTestContext) => {
         deployID: ctx.deployID,
         siteID: ctx.siteID,
         token: BLOB_TOKEN,
+        experimentalRegion: 'context',
       })
 
   const { blobs } = await ctx.blobStore.list()
@@ -101,14 +105,17 @@ export function getBlobServerGets(ctx: FixtureTestContext, predicate?: (key: str
       if (typeof request.url !== 'string') {
         return undefined
       }
-      // request url is /:siteID/:deployID/:key for get
-      //                /:siteID/:deployID for list
-      // we only want gets
-      const urlSegments = request.url.split('/')
-      if (urlSegments.length === 4) {
-        return decodeBlobKey(urlSegments[3])
+
+      let urlSegments = request.url.split('/').slice(1)
+
+      // ignore region url component when using `experimentalRegion`
+      const REGION_PREFIX = 'region:'
+      if (urlSegments[0].startsWith(REGION_PREFIX)) {
+        urlSegments = urlSegments.slice(1)
       }
-      return undefined
+
+      const [_siteID, _deployID, key] = urlSegments
+      return key && decodeBlobKey(key)
     })
     .filter(isString)
     .filter((key) => !predicate || predicate(key))

tests/utils/helpers.ts

@@ -27,8 +27,22 @@ async function bundle(entryPoints, format, watch) {
     platform: 'node',
     target: 'node18',
     format,
-    external: ['next', '*.cjs'], // don't try to bundle the cjs files as we are providing them separately
+    external: ['next'], // don't try to bundle next
     allowOverwrite: watch,
+    plugins: [
+      {
+        // runtime modules are all entrypoints, so importing them should mark them as external
+        // to avoid duplicating them in the bundle (which also can cause import path issues)
+        name: 'mark-runtime-modules-as-external',
+        setup(pluginBuild) {
+          pluginBuild.onResolve({ filter: /^\..*\.c?js$/ }, (args) => {
+            if (args.importer.includes(join('next-runtime-minimal', 'src'))) {
+              return { path: args.path, external: true }
+            }
+          })
+        },
+      },
+    ],
   }
 
   if (format === 'esm') {

tools/build.js

@@ -76,4 +76,7 @@ export default defineConfig({
       sequencer: Sequencer,
     },
   },
+  esbuild: {
+    include: ['**/*.ts', '**/*.cts'],
+  },
 })