verify-npm-update.mjs 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. import { test } from 'node:test'
  2. import assert from 'node:assert/strict'
  3. import { execFileSync } from 'node:child_process'
  4. import { existsSync, mkdtempSync, mkdirSync, readFileSync, readdirSync, realpathSync, rmSync, writeFileSync } from 'node:fs'
  5. import { tmpdir } from 'node:os'
  6. import { join } from 'node:path'
  7. import { createServer } from 'node:http'
  8. import { createHash, randomUUID } from 'node:crypto'
  9. import { stageNpmRelease, overwriteNpmRelease } from '../bin/hermes-yaoyao-updater.mjs'
  10. import { currentRelease, LaunchAgentService, localRequest, switchRelease } from '../bin/lib/service-update.mjs'
  11. import { writeNpmFixture } from '../tests/fixtures/npm-release.mjs'
  12. for (const global of [true, false]) {
  13. test(`real npm ${global ? 'global' : 'managed local'} updates overwrite the same installation without rollback or retained copies`, { skip: process.platform !== 'darwin', timeout: 90000 }, async () => {
  14. const root = realpathSync(mkdtempSync(join(tmpdir(), 'yaoyao-npm-live-'))), home = join(root, 'data'), releaseRoot = join(root, 'programs')
  15. mkdirSync(home); mkdirSync(join(home, 'updates')); mkdirSync(releaseRoot)
  16. const prefix = global ? join(root, 'global') : join(releaseRoot, 'releases', `0.2.0-npm-${randomUUID()}`)
  17. const packageRoot = join(prefix, ...(global ? ['lib'] : []), 'node_modules/@lsamien/yaoyao')
  18. let archive
  19. const registry = createServer((req, res) => {
  20. if (req.url !== '/release.tgz') { res.statusCode = 404; res.end(); return }
  21. res.setHeader('Content-Length', archive.length); res.end(archive)
  22. })
  23. await new Promise(done => registry.listen(0, '127.0.0.1', done))
  24. const probe = createServer(); await new Promise(done => probe.listen(0, '127.0.0.1', done))
  25. const port = probe.address().port; await new Promise(done => probe.close(done))
  26. const label = `cn.samien.yaoyao.npm-test.${randomUUID()}`
  27. class FixtureService extends LaunchAgentService {
  28. verify(expected) { return super.verify(expected, expected?.version === '0.3.2' ? 1500 : 10000) }
  29. }
  30. const driver = new FixtureService({ home, releaseRoot, port, label, plistPath: join(home, 'updates/service.plist') })
  31. function packageJob(version, broken = false) {
  32. const source = join(root, `package-${version}`), target = writeNpmFixture(source, version, broken)
  33. if (version === '0.2.0') writeFileSync(join(source, 'old-only.txt'), 'must disappear on overwrite')
  34. const [packed] = JSON.parse(execFileSync('npm', ['pack', '--json', '--ignore-scripts', '--pack-destination', root], { cwd: source, encoding: 'utf8' }))
  35. const packedPath = join(root, packed.filename)
  36. archive = readFileSync(packedPath)
  37. const npm = { version, integrity: `sha512-${createHash('sha512').update(archive).digest('base64')}`, tarball: `http://127.0.0.1:${registry.address().port}/release.tgz` }
  38. const id = randomUUID(), jobPath = join(home, 'updates', `${id}.json`)
  39. const job = { id, operation: 'update', state: 'queued', target, plan: { home, releaseRoot, port, previousServiceRoot: packageRoot, source: 'npm:@lsamien/yaoyao', npm, target } }
  40. writeFileSync(jobPath, JSON.stringify(job))
  41. return { job, jobPath, packedPath }
  42. }
  43. const readVersion = () => JSON.parse(readFileSync(join(packageRoot, 'package.json'))).version
  44. const apply = (next, prepared) => overwriteNpmRelease({ ...next.job, plan: { ...next.job.plan, prepared } }, next.jobPath, { driver })
  45. try {
  46. const initial = packageJob('0.2.0')
  47. mkdirSync(prefix, { recursive: true })
  48. execFileSync('npm', ['install', ...(global ? ['--global'] : []), '--prefix', prefix, '--no-save', '--package-lock=false', '--no-audit', '--no-fund', '--allow-file=all', initial.packedPath], { cwd: prefix, stdio: 'pipe' })
  49. const unrelated = join(prefix, ...(global ? ['lib'] : []), 'node_modules/other-tool')
  50. if (global) {
  51. mkdirSync(unrelated); writeFileSync(join(unrelated, 'package.json'), '{"name":"other-tool","version":"1.0.0"}')
  52. writeFileSync(join(unrelated, 'keep.txt'), 'unrelated tool')
  53. }
  54. switchRelease(releaseRoot, packageRoot); await driver.start(packageRoot); await driver.verify()
  55. writeFileSync(join(home, 'user.txt'), 'original data')
  56. const oldDownload = join(home, 'updates/npm', randomUUID()); mkdirSync(oldDownload, { recursive: true }); writeFileSync(join(oldDownload, 'release.tgz'), 'obsolete download')
  57. for (const version of ['0.3.0', '0.3.1']) {
  58. const next = packageJob(version), previousVersion = readVersion(), previousPID = driver.pid()
  59. const prepared = await stageNpmRelease(next.job, next.jobPath)
  60. assert.equal(JSON.parse(readFileSync(next.jobPath)).state, 'prepared')
  61. assert.equal(driver.pid(), previousPID, 'download must leave the old service running')
  62. assert.equal(readVersion(), previousVersion)
  63. assert.equal(readdirSync(join(home, 'updates/npm')).length, 1, 'keep only the current temporary archive')
  64. await apply(next, prepared)
  65. assert.notEqual(driver.pid(), previousPID)
  66. assert.equal(currentRelease(releaseRoot), packageRoot, 'reuse the same installation path')
  67. assert.equal((await localRequest(`http://127.0.0.1:${port}/api/status`)).body.version, version)
  68. assert.equal(readFileSync(join(home, 'user.txt'), 'utf8'), 'original data')
  69. assert.equal(existsSync(join(packageRoot, 'old-only.txt')), false, 'remove obsolete program files')
  70. assert.deepEqual(readdirSync(join(home, 'updates/npm')), [], 'clean the downloaded archive')
  71. assert.equal(existsSync(join(home, 'updates/backups')), false)
  72. assert.equal(existsSync(join(home, 'updates/last-success.json')), false)
  73. assert.equal(existsSync(join(home, 'updates/transition.json')), false)
  74. if (global) assert.equal(readFileSync(join(unrelated, 'keep.txt'), 'utf8'), 'unrelated tool')
  75. assert.equal(global ? existsSync(join(releaseRoot, 'releases')) : readdirSync(join(releaseRoot, 'releases')).length > 1, false, 'do not create additional release directories')
  76. }
  77. const broken = packageJob('0.3.2', true), healthyPID = driver.pid()
  78. const bad = await stageNpmRelease(broken.job, broken.jobPath)
  79. assert.equal(driver.pid(), healthyPID)
  80. await assert.rejects(apply(broken, bad), /未保留旧版本/)
  81. assert.equal(currentRelease(releaseRoot), packageRoot)
  82. assert.equal(readVersion(), '0.3.2', 'a failed health check must not restore old code')
  83. assert.equal((await localRequest(`http://127.0.0.1:${port}/api/status`)).body.version, '0.3.2')
  84. assert.equal(readFileSync(join(home, 'user.txt'), 'utf8'), 'failed update', 'do not restore an old data snapshot')
  85. assert.equal(existsSync(join(home, 'updates/backups')), false)
  86. assert.deepEqual(readdirSync(join(home, 'updates/npm')), [])
  87. const invalid = packageJob('0.3.3'), survivingPID = driver.pid()
  88. invalid.job.plan.npm.integrity = `sha512-${Buffer.alloc(64).toString('base64')}`
  89. await assert.rejects(stageNpmRelease(invalid.job, invalid.jobPath), /完整性校验失败/)
  90. assert.equal(driver.pid(), survivingPID)
  91. assert.equal(readVersion(), '0.3.2')
  92. assert.deepEqual(readdirSync(join(home, 'updates/npm')), [])
  93. console.log(`Verified ${global ? 'global' : 'managed local'} npm overwrite, repeat updates, archive cleanup and failed startup without rollback in an isolated LaunchAgent.`)
  94. } finally {
  95. await driver.stop().catch(() => {})
  96. await new Promise(done => { registry.close(done); registry.closeAllConnections() })
  97. rmSync(root, { recursive: true, force: true })
  98. }
  99. })
  100. }