Files
orca/config/scripts/localization/catalog-validation/protected-copy-keys.test.mjs

100 lines
3.5 KiB
JavaScript

import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
import { tmpdir } from 'node:os'
import path from 'node:path'
import { afterEach, describe, expect, it, vi } from 'vitest'
import { collectProtectedCopyKeys, main, PROTECTED_COPY_KEYS_PATH } from './protected-copy-keys.mjs'
const ENGLISH = new Set([
'trust.title',
'trust.allow',
'trust.copy.warning',
'confirm.delete',
'confirm.count_other',
'native.quit',
'pragma.badge',
'nested.deep',
'trust.reasons.network',
'plain.title'
])
let dirs = []
afterEach(() => {
vi.restoreAllMocks()
for (const dir of dirs) {
rmSync(dir, { recursive: true, force: true })
}
dirs = []
})
function sourcesFrom(files) {
const root = mkdtempSync(path.join(tmpdir(), 'orca-protected-copy-'))
dirs.push(root)
const sources = new Map()
for (const [name, text] of Object.entries(files)) {
const file = path.join(root, ...name.split('/'))
mkdirSync(path.dirname(file), { recursive: true })
writeFileSync(file, text)
sources.set(file, text)
}
return sources
}
describe('collectProtectedCopyKeys', () => {
it('protects every key a marked file or its sibling copy module names', () => {
const sources = sourcesFrom({
'dialogs/TrustDialog.tsx': `import { trustCopy } from './trust-copy'
import { plain } from '../plain/Plain'
<DialogContent surface="security">{translate('trust.title', 'Trust?')}{translate('trust.allow', 'Allow')}`,
'dialogs/trust-copy.ts': `export const trustCopy = () => translate('trust.copy.warning', 'Careful')`,
'plain/Plain.tsx': `export const plain = () => translate('plain.title', 'Title')`,
'confirm/DeleteDialog.tsx': `<DialogContent><Button variant="destructive">{translate('confirm.delete', 'Delete')}{translate('confirm.count', '{{count}}', { count })}</Button>`,
'main/prompt.ts': `dialog.showMessageBox({ buttons: [translateMain('native.quit', 'Quit')] })`,
'badge.ts': `// @protected-copy: badge\nexport const b = () => translate('pragma.badge', 'Official')`,
'other.tsx': `translate('nested.deep', 'Deep')`
})
expect(collectProtectedCopyKeys(sources, ENGLISH)).toEqual({
keys: [
'confirm.count',
'confirm.delete',
'native.quit',
'pragma.badge',
'trust.allow',
'trust.copy.warning',
'trust.title'
],
prefixes: []
})
})
it('keeps dynamic key heads only when they are specific', () => {
const sources = sourcesFrom({
'Dialog.tsx': '<SecuritySurface>{translate(`trust.${id}`)}{translate(`trust.reasons.${x}`)}'
})
expect(collectProtectedCopyKeys(sources, ENGLISH).prefixes).toEqual(['trust.reasons.'])
})
})
describe('protected copy check', () => {
it('fails when a security dialog uses a key the generated list lacks, until synced', async () => {
sourcesFrom({
'src/renderer/src/i18n/locales/en.json': JSON.stringify({ trust: { allow: 'Allow' } }),
'src/renderer/src/Dialog.tsx': `<SecuritySurface>{translate('trust.allow', 'Allow')}`,
'src/main/ready.ts': '',
[PROTECTED_COPY_KEYS_PATH.split(path.sep).join('/')]: '{}'
})
const root = dirs.at(-1)
vi.spyOn(console, 'error').mockImplementation(() => {})
vi.spyOn(console, 'log').mockImplementation(() => {})
expect(await main(root, [])).toBe(1)
expect(await main(root, ['--fix'])).toBe(0)
expect(await main(root, [])).toBe(0)
expect(JSON.parse(readFileSync(path.join(root, PROTECTED_COPY_KEYS_PATH), 'utf8'))).toEqual({
keys: ['trust.allow'],
prefixes: []
})
})
})