|
| 1 | +import fs from 'fs'; |
| 2 | +import os from 'os'; |
| 3 | +import path from 'path'; |
| 4 | +import * as esbuild from 'esbuild'; |
| 5 | +import { build, type Plugin, type UserConfig } from 'vite'; |
| 6 | +import { afterAll, afterEach, describe, expect, it } from 'vitest'; |
| 7 | + |
| 8 | +import { builtinModulesEsbuildPlugin, isBuiltinModuleId, nativescriptBuiltinModules, resetBuiltinModules, unwrapBuiltinModuleIds } from './builtin-modules.js'; |
| 9 | + |
| 10 | +describe('builtin modules', () => { |
| 11 | + afterEach(() => resetBuiltinModules()); |
| 12 | + |
| 13 | + describe('matching', () => { |
| 14 | + it('matches every ns: specifier by default', () => { |
| 15 | + expect(isBuiltinModuleId('ns:util')).toBe(true); |
| 16 | + expect(isBuiltinModuleId('ns:some_future_module')).toBe(true); |
| 17 | + expect(isBuiltinModuleId('node:worker_threads')).toBe(false); |
| 18 | + expect(isBuiltinModuleId('worker_threads')).toBe(false); |
| 19 | + }); |
| 20 | + |
| 21 | + it('adds the specifiers another plugin instance includes', () => { |
| 22 | + nativescriptBuiltinModules({ include: ['node:worker_threads', /^node:(url|util)$/g] }); |
| 23 | + |
| 24 | + expect(isBuiltinModuleId('node:worker_threads')).toBe(true); |
| 25 | + expect(isBuiltinModuleId('node:url')).toBe(true); |
| 26 | + // a global RegExp must not carry lastIndex between calls |
| 27 | + expect(isBuiltinModuleId('node:url')).toBe(true); |
| 28 | + expect(isBuiltinModuleId('node:fs')).toBe(false); |
| 29 | + }); |
| 30 | + |
| 31 | + it('restores /@id/-wrapped builtin specifiers only', () => { |
| 32 | + nativescriptBuiltinModules({ include: ['node:worker_threads'] }); |
| 33 | + const code = [`import { inspect } from "/@id/ns:util";`, `export * from '/@id/node:worker_threads';`, `import("/@id/ns:runtime");`, `import z from "/@id/ns:util?t=123";`, `import x from "/@id/__x00__virtual";`, `import y from "/@id/node:fs";`].join('\n'); |
| 34 | + |
| 35 | + expect(unwrapBuiltinModuleIds(code)).toBe([`import { inspect } from "ns:util";`, `export * from 'node:worker_threads';`, `import("ns:runtime");`, `import z from "ns:util";`, `import x from "/@id/__x00__virtual";`, `import y from "/@id/node:fs";`].join('\n')); |
| 36 | + }); |
| 37 | + }); |
| 38 | + |
| 39 | + describe('vite build', () => { |
| 40 | + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'ns-builtin-modules-')); |
| 41 | + afterAll(() => fs.rmSync(root, { recursive: true, force: true })); |
| 42 | + |
| 43 | + const write = (file: string, code: string) => { |
| 44 | + fs.mkdirSync(path.dirname(path.join(root, file)), { recursive: true }); |
| 45 | + fs.writeFileSync(path.join(root, file), code); |
| 46 | + }; |
| 47 | + |
| 48 | + const bundle = async (entry: string, plugins: Plugin[] = [nativescriptBuiltinModules()], resolve?: UserConfig['resolve']): Promise<string> => { |
| 49 | + const result: any = await build({ |
| 50 | + root, |
| 51 | + configFile: false, |
| 52 | + logLevel: 'silent', |
| 53 | + plugins, |
| 54 | + resolve, |
| 55 | + build: { |
| 56 | + write: false, |
| 57 | + minify: false, |
| 58 | + rolldownOptions: { input: path.join(root, entry), output: { format: 'es', codeSplitting: false } }, |
| 59 | + }, |
| 60 | + }); |
| 61 | + return (Array.isArray(result) ? result[0] : result).output.map((file: any) => file.code ?? '').join('\n'); |
| 62 | + }; |
| 63 | + |
| 64 | + it('emits runtime builtin imports verbatim', async () => { |
| 65 | + write('esm.js', [`import { inspect } from 'ns:util';`, `import { Worker } from 'worker_threads';`, `console.log(inspect, Worker, import('ns:runtime'));`].join('\n')); |
| 66 | + |
| 67 | + const output = await bundle('esm.js', [nativescriptBuiltinModules(), nativescriptBuiltinModules({ include: ['node:worker_threads'] })], { alias: { worker_threads: 'node:worker_threads' } }); |
| 68 | + |
| 69 | + expect(output).toMatch(/from "ns:util"/); |
| 70 | + expect(output).toMatch(/from "node:worker_threads"/); |
| 71 | + expect(output).toContain('import("ns:runtime")'); |
| 72 | + }); |
| 73 | + |
| 74 | + it('keeps require() of builtins in CommonJS dependencies', async () => { |
| 75 | + write('node_modules/cjs-dep/package.json', JSON.stringify({ name: 'cjs-dep', main: 'index.js' })); |
| 76 | + write('node_modules/cjs-dep/index.js', `module.exports = require('ns:util').inspect;`); |
| 77 | + write('cjs.js', `import inspect from 'cjs-dep';\nconsole.log(inspect);`); |
| 78 | + |
| 79 | + expect(await bundle('cjs.js')).toMatch(/require\("ns:util"\)/); |
| 80 | + }); |
| 81 | + |
| 82 | + it('lets resolve.alias polyfill a builtin', async () => { |
| 83 | + write('url-polyfill.js', `export const URL = 'url-polyfill';`); |
| 84 | + write('polyfill.js', `import { URL } from 'ns:url';\nconsole.log(URL);`); |
| 85 | + |
| 86 | + const output = await bundle('polyfill.js', undefined, { alias: { 'ns:url': path.join(root, 'url-polyfill.js') } }); |
| 87 | + |
| 88 | + expect(output).not.toContain('"ns:url"'); |
| 89 | + expect(output).toContain('url-polyfill'); |
| 90 | + }); |
| 91 | + |
| 92 | + it('fails to resolve ns: specifiers without the plugin', async () => { |
| 93 | + write('plain.js', `import { inspect } from 'ns:util';\nconsole.log(inspect);`); |
| 94 | + |
| 95 | + await expect(bundle('plain.js', [])).rejects.toThrow(/ns:util/); |
| 96 | + }); |
| 97 | + }); |
| 98 | + |
| 99 | + describe('esbuild bundles', () => { |
| 100 | + it('externalizes builtins ahead of other resolvers', async () => { |
| 101 | + nativescriptBuiltinModules({ include: ['node:worker_threads'] }); |
| 102 | + const result = await esbuild.build({ |
| 103 | + stdin: { contents: `import { inspect } from 'ns:util';\nimport { Worker } from 'node:worker_threads';\nconsole.log(inspect, Worker);`, loader: 'js' }, |
| 104 | + bundle: true, |
| 105 | + write: false, |
| 106 | + format: 'esm', |
| 107 | + plugins: [ |
| 108 | + builtinModulesEsbuildPlugin(), |
| 109 | + { |
| 110 | + name: 'stub-everything', |
| 111 | + setup(b) { |
| 112 | + b.onResolve({ filter: /.*/ }, () => ({ path: 'stub', namespace: 'stub' })); |
| 113 | + b.onLoad({ filter: /.*/, namespace: 'stub' }, () => ({ contents: 'throw new Error("stubbed")' })); |
| 114 | + }, |
| 115 | + }, |
| 116 | + ], |
| 117 | + }); |
| 118 | + const output = result.outputFiles[0].text; |
| 119 | + |
| 120 | + expect(output).toContain('from "ns:util"'); |
| 121 | + expect(output).toContain('from "node:worker_threads"'); |
| 122 | + expect(output).not.toContain('stubbed'); |
| 123 | + }); |
| 124 | + }); |
| 125 | +}); |
0 commit comments