orca/config/scripts/script-module-dependencies.test.mjs

import {
  existsSync,
  mkdirSync,
  mkdtempSync,
  readdirSync,
  readFileSync,
  rmSync,
  writeFileSync
} from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { afterAll, describe, expect, it } from 'vitest'
import { copyScriptWithLocalModules } from './script-module-dependencies.mjs'

const fixtureDir = mkdtempSync(join(tmpdir(), 'script-module-dependencies-'))

afterAll(() => {
  rmSync(fixtureDir, { recursive: true, force: true })
})

function sourceTree(files) {
  const sourceDir = mkdtempSync(join(fixtureDir, 'source-'))
  for (const [name, contents] of Object.entries(files)) {
    writeFileSync(join(sourceDir, name), contents)
  }
  return sourceDir
}

function copiedNames(files, entryName) {
  const sourceDir = sourceTree(files)
  const destinationDir = join(mkdtempSync(join(fixtureDir, 'dest-')), 'scripts')
  copyScriptWithLocalModules(join(sourceDir, entryName), destinationDir)
  const names = readdirSync(destinationDir).sort()
  for (const name of names) {
    expect(readFileSync(join(destinationDir, name), 'utf8'), name).toBe(files[name])
  }
  return names
}

describe('copyScriptWithLocalModules', () => {
  it('preserves parent paths for modules shared with the runtime', () => {
    const sourceDir = sourceTree({ 'runtime.ts': 'export const value = 42\n' })
    mkdirSync(join(sourceDir, 'scripts'))
    writeFileSync(
      join(sourceDir, 'scripts', 'entry.mjs'),
      "export { value } from '../runtime.ts'\n"
    )
    const destinationRoot = mkdtempSync(join(fixtureDir, 'dest-'))
    copyScriptWithLocalModules(
      join(sourceDir, 'scripts', 'entry.mjs'),
      join(destinationRoot, 'scripts')
    )
    expect(readFileSync(join(destinationRoot, 'runtime.ts'), 'utf8')).toBe(
      'export const value = 42\n'
    )
  })

  it('takes the entry script itself', () => {
    expect(copiedNames({ 'entry.mjs': 'export const a = 1\n' }, 'entry.mjs')).toEqual(['entry.mjs'])
  })

  it('follows a co-located import', () => {
    expect(
      copiedNames(
        { 'entry.mjs': "import { a } from './dep.mjs'\n", 'dep.mjs': 'export const a = 1\n' },
        'entry.mjs'
      )
    ).toEqual(['dep.mjs', 'entry.mjs'])
  })

  // The Windows addon gates are .cjs and reach each other by require. A module
  // pulled in only that way used to be left behind, and the subprocess then
  // failed with a resolution error that looks nothing like the defect it hides.
  it('follows a co-located require, not only an import', () => {
    expect(
      copiedNames(
        {
          'entry.cjs': "const { a } = require('./dep.cjs')\nmodule.exports = { a }\n",
          'dep.cjs': 'module.exports = { a: 1 }\n'
        },
        'entry.cjs'
      )
    ).toEqual(['dep.cjs', 'entry.cjs'])
  })

  it('follows a require reached only through an imported module', () => {
    const names = copiedNames(
      {
        'entry.mjs': "import './middle.cjs'\n",
        'middle.cjs': "require('./leaf.cjs')\n",
        'leaf.cjs': 'module.exports = {}\n'
      },
      'entry.mjs'
    )
    expect(names).toContain('leaf.cjs')
  })

  it('leaves package and builtin specifiers alone', () => {
    const sourceDir = sourceTree({
      'entry.mjs': "import { join } from 'node:path'\nimport x from 'some-package'\n"
    })
    const destinationDir = join(mkdtempSync(join(fixtureDir, 'dest-')), 'scripts')
    copyScriptWithLocalModules(join(sourceDir, 'entry.mjs'), destinationDir)
    expect(readdirSync(destinationDir)).toEqual(['entry.mjs'])
  })

  it('terminates on a cycle rather than recursing forever', () => {
    expect(
      copiedNames({ 'a.mjs': "import './b.mjs'\n", 'b.mjs': "import './a.mjs'\n" }, 'a.mjs')
    ).toEqual(['a.mjs', 'b.mjs'])
  })

  it('creates the destination directory it was handed', () => {
    const sourceDir = sourceTree({ 'entry.mjs': 'export const a = 1\n' })
    const destinationDir = join(mkdtempSync(join(fixtureDir, 'dest-')), 'nested', 'scripts')
    copyScriptWithLocalModules(join(sourceDir, 'entry.mjs'), destinationDir)
    expect(existsSync(join(destinationDir, 'entry.mjs'))).toBe(true)
  })
})