Files
orca/src/shared/plugins/plugin-language-pack-artifact.test.ts
T
Neil 231e805b1e fix(lint): enable anti-slop/no-shape-in-symbol-names (#20785)
Flip `anti-slop/no-shape-in-symbol-names` from "off" to "error" and clear
every violation under src, config, tests and mobile.

What the rule bans
------------------
The case-insensitive substring "shape" in any JS/TS identifier: variables,
functions, parameters, types, type parameters, class members, private names,
object-literal keys and JSX identifiers. The one exemption is a statically
accessed member read owned by another value (`zodObject.shape` is fine), so
third-party APIs stay readable without a suppression.

"Shape" names a value's structure rather than its domain role. `UserShape`,
`validateArgShape` and `errorShape` all tell you the symbol is "an object
with some fields" -- which is already what a type says -- while saying
nothing about what the value is for or who owns it. The rule forces the
name to carry the domain instead.

Violations fixed
----------------
689 violations across 109 files at baseline (verified by re-running the
audit against the pre-change tree with the rule set to "error").

Fix pattern
-----------
Rename for the domain role, not the structure:

  -type FieldShape = 'list' | 'map' | 'whole'
  -const FIELD_SHAPES = { ... } satisfies Record<keyof Observation, FieldShape>
  +type FieldEncoding = 'list' | 'map' | 'whole'
  +const FIELD_ENCODINGS = { ... } satisfies Record<keyof Observation, FieldEncoding>

  -function assertGitPushTargetShape(target: unknown): void
  +function assertValidGitPushTarget(target: unknown): void

  -function describeReadDirPathShape(p: string): ReadDirPathKind
  +function classifyReadDirPath(p: string): ReadDirPathKind

Predicates became statements about the value (`isDeltaShapedProviderFrameKind`
-> `isDeltaProviderFrameKind`, `isDeleteShapedDiscardEntry` ->
`discardDeletesEntryFile`, `isSkillsCliAgentKeyShaped` ->
`isUsableSkillsCliAgentKey`). Type aliases dropped the suffix where the
remaining name was already unambiguous (`GhGraphqlErrorShape` ->
`GhGraphqlError`).

No wire-visible name was renamed: no IPC or RPC channel, stream opcode,
request/response param, persisted field, or i18n key. The `--shape=symlink|copy`
CLI flag read by .github/workflows/skill-update-roundtrip.yml is unchanged --
only the local variable holding it was renamed.

Exemptions
----------
They are file-scoped entries in config/oxlint-anti-slop.json, not inline
`oxlint-disable` comments. An inline directive naming an anti-slop rule reads
back as an UNUSED directive under the root lint scan, which does not load this
plugin -- the changed-code quality gate counts that warning, so the comment form
cannot be used for a rule that lives only in this config.

* src/renderer/src/components/browser-pane/annotate/**:
  in the screenshot annotator a "shape" is the drawn geometry -- pen, arrow,
  rect, ellipse, highlight. That is a genuine domain noun, and it pervades
  every symbol in the module.
* repo-icon.tsx, repo-header-project-actions.tsx, mobile MobileRepoIcon.tsx:
  lucide exports the icon component as `Shapes`. The name is theirs, and the
  matching REPO_LUCIDE_ICONS key is the persisted icon name shared with the
  desktop picker -- renaming it would orphan saved repo icons.
* src/shared/onboarding-state-types.ts, src/shared/constants.ts:
  `shapedSidebar` is a persisted onboarding-checklist field and a telemetry
  enum member; renaming it would orphan saved state.
* src/shared/rpc-contract/rpc-send-params.ts: matching zod's own literal `shape`
  property is what selects the ZodObject branch of the conditional type.

No exemption was added merely to avoid a rename. Eight symbols initially
suppressed as "a cross-module refactor outside this change" were proven to have
zero non-TypeScript references repo-wide and renamed instead.

Zod's `ZodRawShape` needed no exemption at all: `Readonly<Record<string,
z.ZodType>>` is its definition, so repo-update-params.ts and
ui-update-value-tolerance-params.ts spell it out instead. Likewise
telemetry-event-classification.ts now reads `.shape` through an `in` narrowing,
which also retires two pre-existing type assertions; three more assertions the
rename had dragged onto changed lines (two `JSON.parse` sites, one node:sqlite
row read) became annotations and an explicit row mapping.

Verified
--------
* Audit reports zero violations; confirmed the rule genuinely fires by
  planting a probe violation.
* node config/scripts/run-typecheck-projects-in-parallel.mjs exits 0.
* Vitest over src/shared, src/main/github/project-view, the annotate module,
  the repo-icon components and the Chromium SameSite electron spec: all green.
* All 66 removed "shape" identifiers grepped repo-wide across every file type;
  none survive.
* node config/scripts/generate-rpc-params-catalog.mjs --check exits 0.
* node --check on every changed .mjs; oxfmt clean on all changed files.
* `pnpm run check:code-quality:changed` reports 0 findings.

Not machine-verified: the 3 mobile/ files (its Vitest run cannot resolve
`expo/tsconfig.base.json` in this worktree), and the WSL- and Playwright-gated
specs. All are rename- or comment-only hunks, read in full.
2026-09-15 02:00:27 -07:00

215 lines
6.9 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import {
isPluginLanguagePackRegistration,
parsePluginLanguagePackArtifact,
PLUGIN_LANGUAGE_CATALOG_MAX_DEPTH,
PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES,
validatePluginLanguagePackCatalog,
checkPluginLanguagePackCatalog,
pluginLanguageResourceId
} from './plugin-language-pack-artifact'
describe('plugin language-pack artifacts', () => {
it('maps qualified IDs to distinct alphanumeric i18next resource languages', () => {
const first = pluginLanguageResourceId('plugin:a.bc/d-ef')
const second = pluginLanguageResourceId('plugin:ab.c/de-f')
expect(first).toMatch(/^plugin[0-9a-f]+$/)
expect(second).toMatch(/^plugin[0-9a-f]+$/)
expect(first).not.toBe(second)
})
it('accepts nested string catalogs and reports their bounded entry count', () => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
settings: { appearance: { title: 'Aparência' } },
common: { save: 'Salvar' }
})
)
).toEqual({
ok: true,
catalog: {
settings: { appearance: { title: 'Aparência' } },
common: { save: 'Salvar' }
},
entries: 5
})
})
it.each([
'PluginConsentDialog',
// The provenance badge and install-error copy carry the trust decision.
'PluginConsentProvenance',
'pluginError',
'PluginKeybindingConsentPreview',
'PluginMarketplaceListingRow',
'PluginMarketplacePreviewDialog',
'PluginMarketplaceSourceDialog',
'PluginVmRecipeConsentPreview'
])('prevents language packs from rewriting %s security copy', (component) => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: {
components: {
settings: { [component]: { disclaimer: 'This plugin is perfectly safe.' } }
}
}
})
)
).toMatchObject({ ok: false, error: expect.stringContaining('protected security copy') })
})
it.each([
['PluginsSettingsSection', 'title', 'Плагины'],
['PluginMarketplaceBrowser', 'refresh', 'Обновить'],
['PluginDevelopmentSection', 'title', 'Разработка']
])('lets a language pack translate %s.%s, which asserts nothing', (component, key, value) => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: { components: { settings: { [component]: { [key]: value } } } }
})
).ok
).toBe(true)
})
// Why: the chrome exemption must not leak into the copy that carries a claim
// about what plugins may do — that copy is the whole reason the prefix is broad.
it.each([
['description', 'Plugins are sandboxed and cannot read your files.'],
['systemDescription', 'Every plugin here has been reviewed by Orca.'],
['featureOff', 'Installed plugins keep running while the system is off.']
])('still refuses PluginsSettingsSection.%s', (key, value) => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: { components: { settings: { PluginsSettingsSection: { [key]: value } } } }
})
)
).toMatchObject({ ok: false, error: expect.stringContaining('protected security copy') })
})
it('still refuses the development-plugin permission promise', () => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: {
components: {
settings: {
PluginDevelopmentSection: { help: 'Dev plugins skip permission review.' }
}
}
}
})
)
).toMatchObject({ ok: false, error: expect.stringContaining('protected security copy') })
})
it('still refuses install failure copy that reports a trust event', () => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: {
components: {
settings: { PluginMarketplaceBrowser: { installFailed: 'Installed successfully.' } }
}
}
})
)
).toMatchObject({ ok: false, error: expect.stringContaining('protected security copy') })
})
it('forges no trust badge: the community→Official swap is refused', () => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: {
components: {
settings: { PluginConsentProvenance: { community: 'Official' } }
}
}
})
)
).toMatchObject({
ok: false,
error: expect.stringContaining('auto.components.settings.PluginConsentProvenance')
})
})
it('still lets language packs translate non-plugin settings copy', () => {
expect(
parsePluginLanguagePackArtifact(
JSON.stringify({
auto: { components: { settings: { AppearanceSection: { title: 'Apariencia' } } } }
})
).ok
).toBe(true)
})
it.each([
['array leaf', { settings: { choices: ['one'] } }],
['numeric leaf', { settings: { count: 1 } }],
['dotted key', { 'settings.title': 'Title' }],
['prototype key', JSON.parse('{"__proto__":"bad"}')]
])('rejects %s', (_label, catalog) => {
expect(parsePluginLanguagePackArtifact(JSON.stringify(catalog)).ok).toBe(false)
})
it('rejects excessive nesting without recursive validation', () => {
let catalog: Record<string, unknown> = { value: 'deep' }
for (let index = 0; index <= PLUGIN_LANGUAGE_CATALOG_MAX_DEPTH; index += 1) {
catalog = { nested: catalog }
}
expect(parsePluginLanguagePackArtifact(JSON.stringify(catalog))).toMatchObject({
ok: false,
error: expect.stringContaining('depth')
})
})
it('accepts the entry limit and rejects one additional entry', () => {
const catalog = Object.fromEntries(
Array.from({ length: PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES }, (_, index) => [
`key${index}`,
'value'
])
)
expect(validatePluginLanguagePackCatalog(catalog)).toMatchObject({
ok: true,
entries: PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES
})
catalog.overflow = 'value'
expect(validatePluginLanguagePackCatalog(catalog)).toMatchObject({
ok: false,
error: expect.stringContaining(`${PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES} entries`)
})
})
it('shape-validates 16 maximum-entry registrations without returning catalog copies', () => {
const catalog = Object.fromEntries(
Array.from({ length: PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES }, (_, index) => [
`key${index}`,
'value'
])
)
const packs = Array.from({ length: 16 }, (_, index) => {
const id = `plugin:maximum-${index}` as const
return {
id,
resourceLanguage: pluginLanguageResourceId(id),
pluginKey: `maximum-${index}`,
locale: 'en',
catalog
}
})
expect(checkPluginLanguagePackCatalog(catalog)).toEqual({
ok: true,
entries: PLUGIN_LANGUAGE_CATALOG_MAX_ENTRIES
})
expect(packs.filter(isPluginLanguagePackRegistration)).toHaveLength(16)
})
})