docs(dash): [PKG-DASH-01] freeze released SDK v4 and workspace v5 contracts

This commit is contained in:
Harvey Zhao committed 2026-09-12 04:23:52 +08:00
1 parent e0d47ea74b
commit 3d4c636101
11 files changed
+431 -15

No files matched your search

+61
View File
@@ -0,0 +1,61 @@
import assert from 'node:assert/strict'
import { execFileSync } from 'node:child_process'
import fs from 'node:fs'
import path from 'node:path'
import process from 'node:process'
import { fileURLToPath } from 'node:url'
import { transform } from 'esbuild'
import ts from 'typescript'
import { archiveFiles, ensureArchive, hash, readMember, refactorDir } from './releases.mjs'
const root = path.resolve(refactorDir, '..')
export const normalizeLF = value => value.toString().replace(/\r\n/g, '\n')
export async function dashFunctionHash(code) {
const source = ts.createSourceFile('dash.js', code, ts.ScriptTarget.Latest, true, ts.ScriptKind.JS)
assert.equal(source.parseDiagnostics.length, 0, 'Invalid DASH source')
const functions = ['uniqBy', 'artplayerPluginDashControl'].map((name) => {
const matches = source.statements.filter(item => ts.isFunctionDeclaration(item) && item.name?.text === name)
assert.equal(matches.length, 1, `Expected one function: ${name}`)
return matches[0].getText(source).replace(/^export\s+default\s+/, '')
})
const normalized = await transform(functions.join('\n'), { loader: 'js', target: 'es2020', minifySyntax: true, minifyWhitespace: true })
return hash(normalized.code)
}
export async function verifyDashContract() {
const baseline = JSON.parse(fs.readFileSync(path.join(refactorDir, 'baselines/dash-control-release.json'), 'utf8'))
const { release } = baseline
const archive = await ensureArchive(release)
assert.deepEqual(archiveFiles(archive), Object.keys(release.files).sort())
for (const [member, expected] of Object.entries(release.files))
assert.equal(hash(readMember(archive, member)), expected, `Changed release member: ${member}`)
const manifest = JSON.parse(readMember(archive, 'package/package.json'))
assert.deepEqual(manifest, release.manifest)
for (const entry of [manifest.main, manifest.module, manifest.types, manifest.legacy])
assert(Object.hasOwn(release.files, `package/${entry.replace(/^\.\//, '')}`))
assert(/^[a-f\d]{40}$/.test(baseline.sourceCommit))
const historical = new Map()
for (const [file, expected] of Object.entries(baseline.source)) {
const content = normalizeLF(execFileSync('git', ['show', `${baseline.sourceCommit}:${file}`], { cwd: root }))
assert.equal(hash(content), expected, `Changed historical source: ${file}`)
historical.set(file, content)
}
for (const comparison of baseline.comparisons) {
const published = hash(normalizeLF(readMember(archive, `package/${comparison.file}`)))
const workspace = hash(historical.get(`packages/${release.name}/${comparison.file}`))
assert.equal(published, comparison.publishedLF)
assert.equal(workspace, comparison.workspaceLF)
assert.equal(published === workspace, comparison.equal)
}
const published = await dashFunctionHash(readMember(archive, `package/${manifest.module.replace(/^\.\//, '')}`).toString())
const workspace = await dashFunctionHash(historical.get(`packages/${release.name}/src/index.js`))
assert.equal(published, baseline.functionComparison.published)
assert.equal(workspace, baseline.functionComparison.workspace)
assert.equal(published === workspace, baseline.functionComparison.equal)
console.log(`Verified ${release.name}@${release.version}: archive, ${Object.keys(release.files).length} members, historical source and explicit v4/v5 factory difference`)
return { baseline, archive }
}
if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url))
await verifyDashContract()
+14
View File
@@ -0,0 +1,14 @@
import assert from 'node:assert/strict'
// eslint-disable-next-line test/no-import-node-test -- Frozen release checks use the built-in runner.
import test from 'node:test'
import { dashFunctionHash, verifyDashContract } from './dash-contract.mjs'
test('DASH Control release and its pre-refactor v4/v5 difference remain immutable', verifyDashContract)
test('DASH function comparison ignores formatting but detects changed SDK calls', async () => {
const original = 'function uniqBy(a) { return a } export default function artplayerPluginDashControl(dash) { return dash.getQualityFor("video") }'
const formatted = original.replace('export default ', '').replaceAll(' }', ';\n }')
assert.equal(await dashFunctionHash(original), await dashFunctionHash(formatted))
assert.notEqual(await dashFunctionHash(original), await dashFunctionHash(original.replace('getQualityFor', 'getCurrentRepresentationForType')))
await assert.rejects(dashFunctionHash('function unrelated() {}'), /Expected one function/)
})