chore: run integration tests on windows (#284)

* chore: run integration tests on windows

* chore: make test sequencer windows-compatible

* fix: try giving each test its own cache

* cache fixture output

* refactor: move fixture prep into own function

* fix: prepare wasm sequentially

* fix: get cache key from git contents

* fix: check if sequential building helps the windows/wasm error

* retry fixture prep

* chore: skip some windows tests

* chore: disable bunch of windows tests

* chore: linter

* chore: skip one more test

* chore: skip all monorepo tests on windows

* chore: skip all static.test.ts on windows

* skip one more

* chore: work around wasm copy bug by monkeypatching copyFile

* Revert changes to prepare.mjs

* skip one more test

* chore: remove fixture caching, gonna go in a separate PR

* chore: skip two more

* chore: disable two more tests

* chore: skip some more

Author: Skn0tt

Diff for: .github/workflows/run-tests.yml

@@ -55,11 +55,12 @@ jobs:
           retention-days: 30
 
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         shard: [1/8, 2/8, 3/8, 4/8, 5/8, 6/8, 7/8, 8/8]
+        os: [ubuntu-latest, windows-latest]
     steps:
       - uses: actions/checkout@v4
       - name: 'Install Node'

Diff for: src/build/content/static.test.ts

@@ -1,5 +1,6 @@
 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'
@@ -29,7 +30,7 @@ const createFsFixtureWithBasePath = (
   )
 }
 
-describe('Regular Repository layout', () => {
+describe.skipIf(platform === 'win32')('Regular Repository layout', () => {
   beforeEach<Context>((ctx) => {
     ctx.publishDir = '.next'
     ctx.pluginContext = new PluginContext({
@@ -185,7 +186,7 @@ describe('Regular Repository layout', () => {
   })
 })
 
-describe('Mono Repository', () => {
+describe.skipIf(platform === 'win32')('Mono Repository', () => {
   beforeEach<Context>((ctx) => {
     ctx.publishDir = 'apps/app-1/.next'
     ctx.pluginContext = new PluginContext({

Diff for: src/build/plugin-context.test.ts

@@ -1,4 +1,5 @@
 import { join } from 'node:path'
+import { platform } from 'node:process'
 
 import { NetlifyPluginOptions } from '@netlify/build'
 import { expect, test, vi } from 'vitest'
@@ -58,7 +59,7 @@ test('next app with custom distDir', () => {
   expect(ctx.publishDir).toBe(join(cwd, 'out'))
 })
 
-test('next app with deep custom distDir', () => {
+test.skipIf(platform === 'win32')('next app with deep custom distDir', () => {
   const { cwd } = mockFileSystem({
     'out/dir/required-server-files.json': JSON.stringify({ config: { distDir: 'out/dir' } }),
   })
@@ -75,7 +76,7 @@ test('next app with deep custom distDir', () => {
   )
 })
 
-test('monorepo with package path', () => {
+test.skipIf(platform === 'win32')('monorepo with package path', () => {
   const { cwd } = mockFileSystem({
     'apps/my-app/.next/required-server-files.json': JSON.stringify({
       config: { distDir: '.next' },
@@ -109,7 +110,7 @@ test('monorepo with package path', () => {
   expect(ctx.publishDir).toBe(join(cwd, 'apps/my-app/.next'))
 })
 
-test('nx monorepo with package path and different distDir', () => {
+test.skipIf(platform === 'win32')('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' },

Diff for: tests/fixtures/wasm/next.config.js

@@ -1,3 +1,26 @@
+const { platform } = require('process')
+const fsPromises = require('fs/promises')
+
+// Next.js uses `fs.promises.copyFile` to copy the `.wasm` file to the `.next` directory
+// It tries copying the same file twice in parallel. Unix is fine with that, but Windows fails
+// with "Resource busy or locked", failing the build.
+// We work around this by memoizing the copy operation, so that the second copy is a no-op.
+// Tracked in TODO: report to Next.js folks
+if (platform === 'win32') {
+  const copies = new Map()
+
+  const originalCopy = fsPromises.copyFile
+  fsPromises.copyFile = (src, dest, mode) => {
+    const key = `${dest}:${src}`
+    const existingCopy = copies.get(key)
+    if (existingCopy) return existingCopy
+
+    const copy = originalCopy(src, dest, mode)
+    copies.set(key, copy)
+    return copy
+  }
+}
+
 /** @type {import('next').NextConfig} */
 module.exports = {
   output: 'standalone',

Diff for: tests/integration/build/copy-next-code.test.ts

@@ -7,6 +7,7 @@ import { copyNextServerCode } from '../../../src/build/content/server.js'
 import { PluginContext } from '../../../src/build/plugin-context.js'
 import { FixtureTestContext, createFsFixture } from '../../utils/fixture.js'
 import { readFile, readdir } from 'node:fs/promises'
+import { platform } from 'node:process'
 
 test<FixtureTestContext>('should copy the next standalone folder correctly for a simple site', async (ctx) => {
   const reqServerFiles = JSON.stringify({ config: { distDir: '.next' } })
@@ -29,7 +30,7 @@ test<FixtureTestContext>('should copy the next standalone folder correctly for a
   ).toEqual(['required-server-files.json'])
 })
 
-test<FixtureTestContext>('should copy the next standalone folder correctly based on a custom dist dir', async (ctx) => {
+test.skipIf(platform === "win32")<FixtureTestContext>('should copy the next standalone folder correctly based on a custom dist dir', async (ctx) => {
   const reqServerFiles = JSON.stringify({ config: { distDir: 'out/dir' } })
   const reqServerPath = 'out/dir/required-server-files.json'
   const reqServerPathStandalone = join('out/dir/standalone', reqServerPath)
@@ -76,7 +77,7 @@ test<FixtureTestContext>('should copy the next standalone folder correctly for m
   ).toEqual(['required-server-files.json'])
 })
 
-test<FixtureTestContext>('should copy the next standalone folder correctly for monorepo with custom dir', async (ctx) => {
+test.skipIf(platform === "win32")<FixtureTestContext>('should copy the next standalone folder correctly for monorepo with custom dir', async (ctx) => {
   const reqServerFiles = JSON.stringify({ config: { distDir: 'deep/out/dir' } })
   const reqServerPath = 'apps/my-app/deep/out/dir/required-server-files.json'
   const reqServerPathStandalone = join('apps/my-app/deep/out/dir/standalone', reqServerPath)

Diff for: tests/integration/cache-handler.test.ts

@@ -16,6 +16,7 @@ import {
   getBlobEntries,
   startMockBlobStore,
 } from '../utils/helpers.js'
+import { platform } from 'node:process'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'
@@ -34,7 +35,7 @@ beforeEach<FixtureTestContext>(async (ctx) => {
 })
 
 describe('page router', () => {
-  test<FixtureTestContext>('page router with static revalidate', async (ctx) => {
+  test.skipIf(platform === 'win32')<FixtureTestContext>('page router with static revalidate', async (ctx) => {
     await createFixture('page-router', ctx)
     console.time('runPlugin')
     await runPlugin(ctx)

Diff for: tests/integration/edge-handler.test.ts

@@ -8,6 +8,7 @@ import {
 } from '../utils/fixture.js'
 import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 import { LocalServer } from '../utils/local-server.js'
+import { platform } from 'process'
 
 beforeEach<FixtureTestContext>(async (ctx) => {
   // set for each test a new deployID and siteID
@@ -18,7 +19,7 @@ beforeEach<FixtureTestContext>(async (ctx) => {
   await startMockBlobStore(ctx)
 })
 
-test<FixtureTestContext>('should add request/response headers', async (ctx) => {
+test.skipIf(platform === "win32")<FixtureTestContext>('should add request/response headers', async (ctx) => {
   await createFixture('middleware', ctx)
   await runPlugin(ctx)
 
@@ -46,7 +47,7 @@ test<FixtureTestContext>('should add request/response headers', async (ctx) => {
   expect(origin.calls).toBe(1)
 })
 
-test<FixtureTestContext>('should add request/response headers when using src dir', async (ctx) => {
+test.skipIf(platform === "win32")<FixtureTestContext>('should add request/response headers when using src dir', async (ctx) => {
   await createFixture('middleware-src', ctx)
   await runPlugin(ctx)
 
@@ -74,7 +75,7 @@ test<FixtureTestContext>('should add request/response headers when using src dir
   expect(origin.calls).toBe(1)
 })
 
-describe('redirect', () => {
+describe.skipIf(platform === "win32")('redirect', () => {
   test<FixtureTestContext>('should return a redirect response', async (ctx) => {
     await createFixture('middleware', ctx)
     await runPlugin(ctx)
@@ -123,7 +124,7 @@ describe('redirect', () => {
   })
 })
 
-describe('rewrite', () => {
+describe.skipIf(platform === "win32")('rewrite', () => {
   test<FixtureTestContext>('should rewrite to an external URL', async (ctx) => {
     await createFixture('middleware', ctx)
     await runPlugin(ctx)
@@ -183,7 +184,7 @@ describe('rewrite', () => {
   })
 })
 
-describe("aborts middleware execution when the matcher conditions don't match the request", () => {
+describe.skipIf(platform === "win32")("aborts middleware execution when the matcher conditions don't match the request", () => {
   test<FixtureTestContext>('when the path is excluded', async (ctx) => {
     await createFixture('middleware', ctx)
     await runPlugin(ctx)
@@ -292,7 +293,7 @@ describe("aborts middleware execution when the matcher conditions don't match th
   })
 })
 
-describe('should run middleware on data requests', () => {
+describe.skipIf(platform === "win32")('should run middleware on data requests', () => {
   test<FixtureTestContext>('when `trailingSlash: false`', async (ctx) => {
     await createFixture('middleware', ctx)
     await runPlugin(ctx)

Diff for: tests/integration/page-router.test.ts

@@ -11,6 +11,7 @@ import {
   type FixtureTestContext,
 } 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'
@@ -62,7 +63,7 @@ test<FixtureTestContext>('Should add pathname to cache-tags for pages route', as
   expect(staticFetch1.headers?.['netlify-cache-tag']).toBe('_N_T_/static/revalidate-manual')
 })
 
-test<FixtureTestContext>('Should revalidate path with On-demand Revalidation', async (ctx) => {
+test.skipIf(platform === 'win32')<FixtureTestContext>('Should revalidate path with On-demand Revalidation', async (ctx) => {
   await createFixture('page-router', ctx)
   await runPlugin(ctx)
 
@@ -114,7 +115,7 @@ test<FixtureTestContext>('Should return JSON for data req to page route', async
   expect(data.pageProps.show).toBeDefined()
 })
 
-test<FixtureTestContext>('Should set permanent "netlify-cdn-cache-control" header on fully static pages"', async (ctx) => {
+test.skipIf(platform === "win32")<FixtureTestContext>('Should set permanent "netlify-cdn-cache-control" header on fully static pages"', async (ctx) => {
   await createFixture('page-router', ctx)
   await runPlugin(ctx)
 

Diff for: tests/integration/pnpm.test.ts

@@ -9,6 +9,7 @@ import {
   type FixtureTestContext,
 } 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'
@@ -24,11 +25,14 @@ beforeEach<FixtureTestContext>(async (ctx) => {
   await startMockBlobStore(ctx)
 })
 
-test<FixtureTestContext>('that the runtime works correctly with the pnpm package manager', async (ctx) => {
-  await createFixture('simple-next-app-pnpm', ctx)
-  await runPlugin(ctx)
+test.skipIf(platform === 'win32')<FixtureTestContext>(
+  'that the runtime works correctly with the pnpm package manager',
+  async (ctx) => {
+    await createFixture('simple-next-app-pnpm', ctx)
+    await runPlugin(ctx)
 
-  const home = await invokeFunction(ctx)
-  expect(home.statusCode).toBe(200)
-  expect(load(home.body)('h1').text()).toBe('Home')
-})
+    const home = await invokeFunction(ctx)
+    expect(home.statusCode).toBe(200)
+    expect(load(home.body)('h1').text()).toBe('Home')
+  },
+)