fix: don't use windows path separators for path templating in monorepo (#293)

* fix: always use posix paths in JS imports

* chore: teach windows paths to test

* chore: reenable some fixed tests

* chore: add comment about path conversion

* revert changes to integration tests

Author: Skn0tt

src/build/content/static.test.ts

@@ -1,6 +1,5 @@
 import { Buffer } from 'node:buffer'
 import { join } from 'node:path'
-import { platform } from 'node:process'
 
 import type { NetlifyPluginOptions } from '@netlify/build'
 import glob from 'fast-glob'
@@ -30,7 +29,15 @@ const createFsFixtureWithBasePath = (
   )
 }
 
-describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
+async function readDirRecursive(dir: string) {
+  const posixPaths = await glob('**/*', { cwd: dir, dot: true, absolute: true })
+  // glob always returns unix-style paths, even on Windows!
+  // To compare them more easily in our tests running on Windows, we convert them to the platform-specific paths.
+  const paths = posixPaths.map((posixPath) => join(posixPath))
+  return paths
+}
+
+describe('Regular Repository layout', () => {
   beforeEach<Context>((ctx) => {
     ctx.publishDir = '.next'
     ctx.pluginContext = new PluginContext({
@@ -64,7 +71,7 @@ describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, '.next/static/test.js'),
         join(cwd, '.next/static/sub-dir/test2.js'),
@@ -88,7 +95,7 @@ describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, '.next/static/test.js'),
         join(cwd, '.next/static/sub-dir/test2.js'),
@@ -111,7 +118,7 @@ describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'public/another-asset.json'),
         join(cwd, 'public/fake-image.svg'),
@@ -135,7 +142,7 @@ describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'public/another-asset.json'),
         join(cwd, 'public/fake-image.svg'),
@@ -186,7 +193,7 @@ describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
   })
 })
 
-describe.skipIf(platform === 'win32')('Mono Repository', () => {
+describe('Mono Repository', () => {
   beforeEach<Context>((ctx) => {
     ctx.publishDir = 'apps/app-1/.next'
     ctx.pluginContext = new PluginContext({
@@ -211,7 +218,7 @@ describe.skipIf(platform === 'win32')('Mono Repository', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'apps/app-1/.next/static/test.js'),
         join(cwd, 'apps/app-1/.next/static/sub-dir/test2.js'),
@@ -235,7 +242,7 @@ describe.skipIf(platform === 'win32')('Mono Repository', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'apps/app-1/.next/static/test.js'),
         join(cwd, 'apps/app-1/.next/static/sub-dir/test2.js'),
@@ -258,7 +265,7 @@ describe.skipIf(platform === 'win32')('Mono Repository', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'apps/app-1/public/another-asset.json'),
         join(cwd, 'apps/app-1/public/fake-image.svg'),
@@ -282,7 +289,7 @@ describe.skipIf(platform === 'win32')('Mono Repository', () => {
     )
 
     await copyStaticAssets(pluginContext)
-    expect(await glob('**/*', { cwd, dot: true, absolute: true })).toEqual(
+    expect(await readDirRecursive(cwd)).toEqual(
       expect.arrayContaining([
         join(cwd, 'apps/app-1/public/another-asset.json'),
         join(cwd, 'apps/app-1/public/fake-image.svg'),

src/build/functions/server.ts

@@ -1,6 +1,6 @@
 import { cp, mkdir, readFile, rm, writeFile } from 'fs/promises'
-import { join } from 'node:path'
-import { relative } from 'path'
+import { join, relative } from 'node:path'
+import { join as posixJoin } from 'node:path/posix'
 
 import { glob } from 'fast-glob'
 
@@ -83,8 +83,8 @@ const getHandlerFile = async (ctx: PluginContext): Promise<string> => {
     const template = await readFile(join(templatesDir, 'handler-monorepo.tmpl.js'), 'utf-8')
 
     return template
-      .replaceAll('{{cwd}}', ctx.lambdaWorkingDirectory)
-      .replace('{{nextServerHandler}}', ctx.nextServerHandler)
+      .replaceAll('{{cwd}}', posixJoin(ctx.lambdaWorkingDirectory))
+      .replace('{{nextServerHandler}}', posixJoin(ctx.nextServerHandler))
   }
 
   return await readFile(join(templatesDir, 'handler.tmpl.js'), 'utf-8')

src/build/plugin-context.test.ts

@@ -1,5 +1,4 @@
 import { join } from 'node:path'
-import { platform } from 'node:process'
 
 import { NetlifyPluginOptions } from '@netlify/build'
 import { expect, test, vi } from 'vitest'
@@ -59,14 +58,14 @@ test('next app with custom distDir', () => {
   expect(ctx.publishDir).toBe(join(cwd, 'out'))
 })
 
-test.skipIf(platform === 'win32')('next app with deep custom distDir', () => {
+test('next app with deep custom distDir', () => {
   const { cwd } = mockFileSystem({
     'out/dir/required-server-files.json': JSON.stringify({ config: { distDir: 'out/dir' } }),
   })
   const ctx = new PluginContext({ constants: { PUBLISH_DIR: 'out/dir' } } as NetlifyPluginOptions)
   expect(ctx.standaloneDir).toBe(join(cwd, 'out/dir/standalone/out'))
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'out/dir/standalone'))
-  expect(ctx.distDir).toBe('out/dir')
+  expect(ctx.distDir).toBe(join('out', 'dir'))
   expect(ctx.distDirParent).toBe('out')
   expect(ctx.nextDistDir).toBe('dir')
   expect(ctx.relPublishDir).toBe('out/dir')
@@ -76,7 +75,7 @@ test.skipIf(platform === 'win32')('next app with deep custom distDir', () => {
   )
 })
 
-test.skipIf(platform === 'win32')('monorepo with package path', () => {
+test('monorepo with package path', () => {
   const { cwd } = mockFileSystem({
     'apps/my-app/.next/required-server-files.json': JSON.stringify({
       config: { distDir: '.next' },
@@ -91,8 +90,10 @@ test.skipIf(platform === 'win32')('monorepo with package path', () => {
   expect(ctx.edgeHandlerDir).toBe(
     join(cwd, 'apps/my-app/.netlify/edge-functions/___netlify-edge-handler'),
   )
-  expect(ctx.lambdaWorkingDirectory).toBe('/var/task/apps/my-app')
-  expect(ctx.nextServerHandler).toBe('/var/task/apps/my-app/.netlify/dist/run/handlers/server.js')
+  expect(ctx.lambdaWorkingDirectory).toBe(join('/var/task/apps/my-app'))
+  expect(ctx.nextServerHandler).toBe(
+    join('/var/task/apps/my-app/.netlify/dist/run/handlers/server.js'),
+  )
   expect(ctx.serverFunctionsDir).toBe(join(cwd, 'apps/my-app/.netlify/functions-internal'))
   expect(ctx.serverHandlerDir).toBe(
     join(cwd, 'apps/my-app/.netlify/functions-internal/___netlify-server-handler/apps/my-app'),
@@ -103,14 +104,14 @@ test.skipIf(platform === 'win32')('monorepo with package path', () => {
   expect(ctx.standaloneDir).toBe(join(cwd, 'apps/my-app/.next/standalone/apps/my-app'))
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'apps/my-app/.next/standalone'))
   expect(ctx.staticDir).toBe(join(cwd, 'apps/my-app/.netlify/static'))
-  expect(ctx.distDir).toBe('apps/my-app/.next')
-  expect(ctx.distDirParent).toBe('apps/my-app')
+  expect(ctx.distDir).toBe(join('apps/my-app/.next'))
+  expect(ctx.distDirParent).toBe(join('apps/my-app'))
   expect(ctx.nextDistDir).toBe('.next')
-  expect(ctx.relPublishDir).toBe('apps/my-app/.next')
+  expect(ctx.relPublishDir).toBe(join('apps/my-app/.next'))
   expect(ctx.publishDir).toBe(join(cwd, 'apps/my-app/.next'))
 })
 
-test.skipIf(platform === 'win32')('nx monorepo with package path and different distDir', () => {
+test('nx monorepo with package path and different distDir', () => {
   const { cwd } = mockFileSystem({
     'dist/apps/my-app/.next/required-server-files.json': JSON.stringify({
       config: { distDir: '../../dist/apps/my-app/.next' },
@@ -128,9 +129,9 @@ test.skipIf(platform === 'win32')('nx monorepo with package path and different d
   expect(ctx.edgeHandlerDir).toBe(
     join(cwd, 'apps/my-app/.netlify/edge-functions/___netlify-edge-handler'),
   )
-  expect(ctx.lambdaWorkingDirectory).toBe('/var/task/dist/apps/my-app')
+  expect(ctx.lambdaWorkingDirectory).toBe(join('/var/task/dist/apps/my-app'))
   expect(ctx.nextServerHandler).toBe(
-    '/var/task/dist/apps/my-app/.netlify/dist/run/handlers/server.js',
+    join('/var/task/dist/apps/my-app/.netlify/dist/run/handlers/server.js'),
   )
   expect(ctx.serverFunctionsDir).toBe(join(cwd, 'apps/my-app/.netlify/functions-internal'))
   expect(ctx.serverHandlerDir).toBe(
@@ -142,9 +143,9 @@ test.skipIf(platform === 'win32')('nx monorepo with package path and different d
   expect(ctx.standaloneDir).toBe(join(cwd, 'dist/apps/my-app/.next/standalone/dist/apps/my-app'))
   expect(ctx.standaloneRootDir).toBe(join(cwd, 'dist/apps/my-app/.next/standalone'))
   expect(ctx.staticDir).toBe(join(cwd, 'apps/my-app/.netlify/static'))
-  expect(ctx.distDir).toBe('dist/apps/my-app/.next')
-  expect(ctx.distDirParent).toBe('dist/apps/my-app')
-  expect(ctx.nextDistDir).toBe('.next')
+  expect(ctx.distDir).toBe(join('dist/apps/my-app/.next'))
+  expect(ctx.distDirParent).toBe(join('dist/apps/my-app'))
+  expect(ctx.nextDistDir).toBe(join('.next'))
   expect(ctx.relPublishDir).toBe('dist/apps/my-app/.next')
   expect(ctx.publishDir).toBe(join(cwd, 'dist/apps/my-app/.next'))
 })