Unverified Commit 4bfbb8ab authored by vercel-fleet-prod[bot]'s avatar vercel-fleet-prod[bot] Committed by GitHub

test(next): cover Rspack v2 federation interoperability

Co-authored-by: 's avatarTobias Koppers <1365881+sokra@users.noreply.github.com>
parent 4d39d57f
// Run inside the isolated Next.js test install, not the Jest process: the
// repository itself intentionally depends on a different @rspack/core version.
import { createRequire } from 'node:module'
import { pathToFileURL } from 'node:url'
import { join } from 'node:path'
const requireFromApp = createRequire(join(process.cwd(), 'package.json'))
const rspack = await import(
pathToFileURL(requireFromApp.resolve('@rspack/core')).href
)
const { version: rspackVersion } = requireFromApp('@rspack/core/package.json')
const { version: runtimeVersion } = requireFromApp(
'@module-federation/runtime-tools/package.json'
)
if (rspackVersion !== '2.0.4' || runtimeVersion !== '2.9.0') {
throw new Error(
`Unexpected federation toolchain: ${rspackVersion} / ${runtimeVersion}`
)
}
const [kind, context, outputPath, remoteUrl, workerArg] = process.argv.slice(2)
await new Promise((resolve, reject) => {
const isRemote = kind === 'remote'
const worker = workerArg === 'worker'
rspack.rspack(
{
mode: 'development',
context,
target: worker ? 'webworker' : 'web',
entry: isRemote ? {} : './index.js',
output: {
path: outputPath,
publicPath: isRemote
? `${remoteUrl}/${worker ? 'worker' : 'browser'}/`
: 'auto',
uniqueName: isRemote
? worker
? 'rspack-v2-worker-catalog'
: 'rspack-v2-catalog'
: 'rspack-v2-next-host',
...(isRemote
? {
chunkLoading: worker ? 'import-scripts' : 'jsonp',
globalObject: 'globalThis',
}
: {}),
},
plugins: [
new rspack.container.ModuleFederationPlugin(
isRemote
? {
name: worker ? 'workerCatalog' : 'catalog',
filename: 'remoteEntry.js',
exposes: {
'./component': './component.js',
'./message': './message.js',
},
shared: worker
? {}
: {
'shared-value': {
singleton: true,
requiredVersion: '^1.0.0',
},
'remote-shared': {
singleton: true,
version: '2.1.0',
},
},
}
: {
name: 'rspackV2Host',
remotes: { nextRemote: `nextRemote@${remoteUrl}` },
}
),
],
},
(error, stats) => {
if (error) return reject(error)
if (stats?.hasErrors()) {
return reject(new Error(stats.toString({ errors: true })))
}
resolve()
}
)
})
import type { ChildProcess } from 'child_process'
import type { Server } from 'http'
import { mkdir, readFile, rm, symlink, writeFile } from 'fs/promises'
import { join } from 'path'
import execa from 'execa'
import { isNextDeploy, nextTestSetup } from 'e2e-utils'
import {
fetchViaHTTP,
findPort,
killApp,
launchApp,
nextStart,
retry,
startStaticServer,
} from 'next-test-utils'
// A second local server cannot be reached from a deployed Next.js fixture.
// Cache Components does not currently expose the project-global container endpoint.
const describeTurbopack =
process.env.IS_TURBOPACK_TEST &&
!process.env.__NEXT_CACHE_COMPONENTS &&
!isNextDeploy
? describe
: describe.skip
const buildScript = join(__dirname, 'build-rspack.mjs')
async function buildRspack(
testDir: string,
kind: 'remote' | 'host',
context: string,
output: string,
url: string,
worker = false
) {
const target = join(testDir, 'build-rspack.mjs')
await writeFile(target, await readFile(buildScript))
await execa(
'node',
[target, kind, context, output, url, worker ? 'worker' : 'browser'],
{ cwd: testDir }
)
}
describeTurbopack('Turbopack host and Rspack v2 remote', () => {
const { next } = nextTestSetup({
files: join(__dirname, '../turbopack-module-federation-webpack-remote'),
dependencies: {
'@rspack/core': '2.0.4',
'@module-federation/runtime-tools': '2.9.0',
},
skipStart: true,
skipDeployment: true,
})
let remoteServer: Server
let remoteOrigin: string
let remoteOutput: string
let sharedPackage: string
beforeAll(async () => {
const port = await findPort()
remoteOrigin = `http://localhost:${port}`
remoteOutput = join(next.testDir, 'rspack-remote-dist')
sharedPackage = join(next.testDir, 'node_modules', 'default-shared')
await mkdir(sharedPackage, { recursive: true })
await writeFile(
join(sharedPackage, 'package.json'),
JSON.stringify({
name: 'default-shared',
version: '1.0.0',
main: 'index.js',
})
)
await writeFile(
join(sharedPackage, 'index.js'),
`export const value = 'default shared fallback'`
)
const context = join(next.testDir, 'remote')
await buildRspack(
next.testDir,
'remote',
context,
join(remoteOutput, 'browser'),
remoteOrigin
)
await buildRspack(
next.testDir,
'remote',
context,
join(remoteOutput, 'worker'),
remoteOrigin,
true
)
remoteServer = await startStaticServer(remoteOutput, undefined, port)
process.env.MF_REMOTE_ORIGIN = remoteOrigin
process.env.NEXT_PUBLIC_MF_REMOTE_ORIGIN = remoteOrigin
await next.start()
})
afterAll(async () => {
if (remoteServer) {
await new Promise<void>((resolve, reject) => {
remoteServer.close((error) => (error ? reject(error) : resolve()))
})
}
if (sharedPackage) await rm(sharedPackage, { recursive: true, force: true })
delete process.env.MF_REMOTE_ORIGIN
delete process.env.NEXT_PUBLIC_MF_REMOTE_ORIGIN
})
it('loads exposed JS, React and worker modules with shared versions', async () => {
const browser = await next.browser('/')
await retry(async () => {
expect(await browser.elementByCss('#remote-message').text()).toBe(
'hello from Turbopack host sharing'
)
expect(await browser.elementByCss('#remote-react-component').text()).toBe(
'next/dynamic from webpack remote'
)
expect(await browser.elementByCss('#host-shared-message').text()).toBe(
'Turbopack host sharing'
)
expect(await browser.elementByCss('#shared-message').text()).toBe(
'webpack remote sharing'
)
expect(await browser.elementByCss('#remote-shared-message').text()).toBe(
'webpack remote sharing'
)
expect(await browser.elementByCss('#strict-error').text()).toContain(
'No satisfying shared module for remote-shared'
)
expect(await browser.elementByCss('#fallback-message').text()).toBe(
'local fallback sharing'
)
expect(await browser.elementByCss('#default-shared-message').text()).toBe(
'default shared fallback'
)
expect(await browser.elementByCss('#worker-message').text()).toBe(
'hello from webpack fallback'
)
expect(await browser.elementByCss('#remote-script-count').text()).toBe(
'1'
)
expect(await browser.elementByCss('#union-range').text()).toBe(
'range v1.5.0'
)
expect(await browser.elementByCss('#hyphen-range').text()).toBe(
'range v2.3.0'
)
expect(await browser.elementByCss('#caret-range').text()).toBe(
'range v1.5.0'
)
expect(await browser.elementByCss('#prefix-fallback').text()).toBe(
'prefix fallback sharing'
)
expect(await browser.elementByCss('#eager-value').text()).toBe(
'eager local sharing'
)
})
const chunks = await browser.eval(
`performance.getEntriesByType('resource').map((entry) => entry.name).filter((name) => name.startsWith(${JSON.stringify(remoteOrigin + '/browser/')}) && !name.endsWith('remoteEntry.js'))`
)
expect(chunks).not.toEqual([])
})
it('loads a rebuilt Rspack remote after a browser reload', async () => {
const browser = await next.browser('/')
await retry(async () => {
expect(await browser.elementByCss('#remote-message').text()).toBe(
'hello from Turbopack host sharing'
)
})
await next.patchFile(
'remote/message.js',
`import { value } from 'shared-value'
import { value as remoteShared } from 'remote-shared'
export const message = \`updated from \${value}\`
export { remoteShared }
`
)
await buildRspack(
next.testDir,
'remote',
join(next.testDir, 'remote'),
join(remoteOutput, 'browser'),
remoteOrigin
)
await browser.refresh()
await retry(async () => {
expect(await browser.elementByCss('#remote-message').text()).toBe(
'updated from Turbopack host sharing'
)
})
})
it('rejects imports in Node and Edge server code', async () => {
expect((await next.fetch('/server-import')).status).toBe(500)
await retry(() => {
expect(next.cliOutput).toContain(
'External script loading is only supported in browser client code'
)
})
const outputBeforeEdge = next.cliOutput.length
expect((await next.fetch('/edge-import')).status).toBe(500)
await retry(() => {
expect(next.cliOutput.slice(outputBeforeEdge)).toContain(
'Failed to load federated module catalog/message:'
)
})
})
})
describeTurbopack('Rspack v2 host and Turbopack remote', () => {
const { next, isNextDev } = nextTestSetup({
files: join(__dirname, '../turbopack-module-federation-next-remote'),
dependencies: {
'@rspack/core': '2.0.4',
'@module-federation/runtime-tools': '2.9.0',
},
skipStart: true,
skipDeployment: true,
})
let remoteServer: ChildProcess
let remoteOrigin: string
let rspackHostServer: Server
let rspackHostOrigin: string
beforeAll(async () => {
const remotePort = await findPort()
remoteOrigin = `http://localhost:${remotePort}`
const remoteDir = join(next.testDir, 'remote')
await symlink(
join(next.testDir, 'node_modules'),
join(remoteDir, 'node_modules')
)
if (isNextDev) {
remoteServer = await launchApp(remoteDir, remotePort)
} else {
await execa(
'node',
[join(next.testDir, 'node_modules/next/dist/bin/next'), 'build'],
{
cwd: remoteDir,
env: {
...process.env,
NEXT_TEST_MODE: undefined,
NODE_ENV: undefined as NodeJS.ProcessEnv['NODE_ENV'],
__NEXT_SHOW_IGNORE_LISTED: 'true',
},
}
)
remoteServer = await nextStart(remoteDir, remotePort, {
disableAutoSkewProtection: true,
})
}
const response = await fetchViaHTTP(remotePort, '/')
if (response.status !== 200) {
throw new Error(`Remote server returned status ${response.status}`)
}
process.env.MF_REMOTE_URL = `${remoteOrigin}/_next/static/nested/nextRemote.js`
const hostPort = await findPort()
rspackHostOrigin = `http://localhost:${hostPort}`
const hostOutput = join(next.testDir, 'rspack-v2-host-dist')
await buildRspack(
next.testDir,
'host',
join(next.testDir, 'webpack-host'),
hostOutput,
process.env.MF_REMOTE_URL
)
await writeFile(
join(hostOutput, 'index.html'),
'<p id="webpack-message">loading</p><script src="/main.js"></script>'
)
rspackHostServer = await startStaticServer(hostOutput, undefined, hostPort)
await next.start()
})
afterAll(async () => {
if (rspackHostServer) {
await new Promise<void>((resolve, reject) => {
rspackHostServer.close((error) => (error ? reject(error) : resolve()))
})
}
if (remoteServer) await killApp(remoteServer)
delete process.env.MF_REMOTE_URL
})
it('loads a Turbopack expose from an enhanced Rspack host', async () => {
const browser = await next.browser('/', { baseUrl: rspackHostOrigin })
await retry(async () => {
expect(await browser.elementByCss('#webpack-message').text()).toBe(
'hello from Next.js'
)
}, 15_000)
const assets = await browser.eval(
`performance.getEntriesByType('resource').map((entry) => entry.name).filter((name) => name.startsWith(${JSON.stringify(remoteOrigin + '/_next/static/chunks/mf/')}) && !name.endsWith('nextRemote.js'))`
)
expect(assets).not.toEqual([])
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment