fix: rename root vendor directory when creating tarball bundle (#6985)

Author: pieh

packages/edge-bundler/node/bundler.test.ts

@@ -1193,6 +1193,65 @@ describe.skipIf(lt(denoVersion, '2.4.2'))(
 
       await cleanup()
     })
+
+    test('Importing from root vendor directory is handled', async () => {
+      const systemLogger = vi.fn()
+      const { basePath, cleanup, distPath } = await useFixture('imports_vendor', { copyDirectory: true })
+      const declarations: Declaration[] = [
+        {
+          function: 'func1',
+          path: '/func1',
+        },
+      ]
+
+      await bundle([join(basePath, 'netlify/edge-functions')], distPath, declarations, {
+        basePath,
+        configPath: join(basePath, '.netlify/edge-functions/config.json'),
+        importMapPaths: [resolve(basePath, 'import_map.json')],
+        featureFlags: {
+          edge_bundler_generate_tarball: true,
+        },
+        systemLogger,
+      })
+
+      expect(
+        systemLogger.mock.calls.find((call) => call[0] === 'Could not track dependencies in edge function:'),
+      ).toBeUndefined()
+
+      const expectedOutput = {
+        func1: 'hello hello',
+      }
+
+      const manifestFile = await readFile(resolve(distPath, 'manifest.json'), 'utf8')
+      const manifest = JSON.parse(manifestFile)
+
+      expect(manifest.bundling_timing).toEqual({ tarball_ms: expect.any(Number) })
+
+      const tarballPath = join(distPath, manifest.bundles[0].asset)
+      const tarballResult = await runTarball(tarballPath)
+      expect(tarballResult).toStrictEqual(expectedOutput)
+
+      const entries: string[] = []
+
+      await tar.list({
+        file: tarballPath,
+        onReadEntry: (entry) => {
+          entries.push(entry.path)
+        },
+      })
+
+      expect(entries).toContain('./___netlify-edge-functions.json')
+      expect(entries).toContain('./deno.json')
+      expect(entries).toContain('./netlify/edge-functions/func1.ts')
+      // vendor directory content was moved
+      expect(entries).toContain('./.root-vendor/hello.ts')
+
+      const eszipPath = join(distPath, manifest.bundles[1].asset)
+      const eszipResult = await runESZIP(eszipPath)
+      expect(eszipResult).toStrictEqual(expectedOutput)
+
+      await cleanup()
+    })
   },
   10_000,
 )

packages/edge-bundler/node/formats/tarball.ts

@@ -61,6 +61,7 @@ export const bundle = async ({
   // Build prefix mappings to transform file:// URLs to relative paths
   const npmVendorDir = '.netlify-npm-vendor'
   const prefixes: Record<string, string> = {}
+  const additionalImportMapEntries: Record<string, string> = {}
 
   // Copy pre-bundled npm modules from vendorDirectory if present.
   // This supports the legacy approach where npm packages are pre-bundled and mapped
@@ -99,7 +100,17 @@ export const bundle = async ({
   }
 
   for (const sourceFile of sourceFilesSet) {
-    const relativePath = path.relative(commonPath, sourceFile)
+    let relativePath = path.relative(commonPath, sourceFile)
+
+    if (relativePath.startsWith('vendor' + path.sep)) {
+      // root vendor directory is reserved directory and can't be imported directly from with `vendor: true` or `--vendor` flag
+      // move from vendor/ to .root-vendor/
+      relativePath = relativePath.replace(/vendor[\\/]/, `.root-vendor/`)
+      // and import map rewrite so imports remain resolvable
+      additionalImportMapEntries['./vendor/'] = `./.root-vendor/`
+      prefixes[pathToFileURL(path.join(commonPath, 'vendor') + path.sep).href] = './.root-vendor/'
+    }
+
     const destPath = path.join(bundleDir.path, relativePath)
 
     await fs.mkdir(path.dirname(destPath), { recursive: true })
@@ -112,7 +123,7 @@ export const bundle = async ({
   prefixes[pathToFileURL(commonPath + path.sep).href] = './'
 
   // Get import map contents with file:// URLs transformed to relative paths
-  const importMapContents = importMap.getContents(prefixes)
+  const importMapContents = importMap.getContents(prefixes, additionalImportMapEntries)
 
   // Create deno.json with import map contents for runtime resolution
   const denoConfigPath = path.join(bundleDir.path, 'deno.json')

packages/edge-bundler/node/import_map.ts

@@ -167,8 +167,7 @@ export class ImportMap {
   // to full URLs. It takes an optional `prefixes` object that specifies a list
   // of prefixes to replace path prefixes (see `applyPrefixesToPath`). Prefixes
   // will be applied on both `imports` and `scopes`.
-  getContents(prefixes: Record<string, string> = {}) {
-    let imports: Imports = {}
+  getContents(prefixes: Record<string, string> = {}, imports: Imports = {}) {
     let scopes: Record<string, Imports> = {}
 
     this.sources.forEach((file) => {

packages/edge-bundler/test/fixtures/imports_vendor/import_map.json

@@ -0,0 +1,5 @@
+{
+  "imports": {
+    "aliased_vendor": "./vendor/hello.ts"
+  }
+}

packages/edge-bundler/test/fixtures/imports_vendor/netlify/edge-functions/func1.ts

@@ -0,0 +1,7 @@
+import hello from '../../vendor/hello.ts'
+import hello2 from 'aliased_vendor'
+
+
+export default async () => {
+  return new Response(`${hello()} ${hello2()}`)
+}

packages/edge-bundler/test/fixtures/imports_vendor/vendor/hello.ts

@@ -0,0 +1,3 @@
+export default function hello() {
+    return 'hello'
+}