mirror of
https://github.com/stablyai/orca.git
synced 2026-11-16 10:58:10 +00:00
* chore(lint): remove disable directives that suppress nothing
Each was reported unused by the oxlint config that owns its rule (root,
casting, react-doctor, anti-slop, native-plugins), including 17 file-level
react-doctor blanket disables whose rule no longer fires. An unused
react-hooks disable was masking a react/purity finding in
useAgentBucketCounts (compiler rules skip functions with hook
suppressions); suppress that one explicitly where the code explains it.
* test(tab-bar): use typed tab/file fixtures instead of @ts-expect-error partials
* chore(lint): fix misc suppressed lint violations instead of disabling
- consistent-type-imports: the "vi.importActual requires inline import()"
rationale was wrong; use typed vi.mock(import(...), importOriginal) or a
type-only namespace import.
- no-control-regex: source-control commit/push failure summaries, shell PATH
hydration, and ipynb ANSI parsing reuse the shared ansi-escape-sequences
stripper and control-character pattern instead of private copies.
- no-explicit-any / no-useless-spread / no-this-alias: typed `this` in
bridge test mocks, drop blanket file-level disables, drop a this-alias.
* refactor(main): replace avoidable type assertions with checked narrowing
17 production cast suppressions in main/wsl-guest removed: untrusted IPC
and RPC payloads (Jira issue update, WSL guest plugin install, handshake
type) now narrow through isRecord/type guards and build typed results;
redundant casts dropped; hand-rolled object checks and errno casts use the
existing isRecord / hasErrorCode helpers.
* refactor(renderer,mobile): replace avoidable type assertions with checked types
13 production cast suppressions removed: RPC failures read through the
`ok` discriminant instead of casting to RpcFailure; react-native-web host
refs narrowed with instanceof HTMLElement; redundant reply/diff casts
become checked annotations; the TUI agent param uses z.custom(isTuiAgent)
like its sibling schemas; the agent-status slice cast that hid missing
actions is gone so the creator's return type checks the whole slice.
* chore(lint): drop dead tiptap wrapper; scope anti-slop mocking rule to test support
- safe-react-node-view-renderer patched handleSelectionUpdate, which
@tiptap/react 3.31.3 no longer has, so it always returned early. Use the
stock ReactNodeViewRenderer.
- The anti-slop test override only matched *.test.{ts,tsx}, forcing
file-level no-module-mocking disables in test harnesses and fixtures.
Match *-test-harness, *-test-fixture(s), .test-fixture and *.test.mjs,
then drop those disables and the now-redundant per-file exemptions.
* test: replace repeated cast suppressions with typed fixtures (main/shared/e2e)
Net -119 cast directives. Typed fixtures replace recurring casts:
unusedSshConnection/unusedOrcadHostTransport placeholders, a typed
readPersistedState harness read (exposed a test treating optional
httpProxyUrl as always set), real Response objects in fetch spies, an
updater main-window fixture, a CDP webContents adapter, one shared
releaseModuleExport for cross-version tests, and requireOverlayDir in
place of `as string` on possibly-undefined overlay paths.
* fix(runtime): validate loaded device rows and host scope instead of casting
Two cast suppressions claimed checks that did not happen:
- device-registry-file-read: "normalizeLoadedDeviceRow re-validates every
field" was false; deviceId, token, name and timestamps were never
checked. Rows without an identity are now dropped and the file is set
aside through the existing corrupt-file path (registry reads as
doubtful, so no revocation verdicts); a non-string token is stripped
so the row stays listed but cannot authenticate.
- client-ui: "only optionality differs" was false; any string reached
persisted workspaceHostScope. Narrow it with isWorkspaceHostScope and
ignore unknown scopes (wire schema unchanged for mixed versions). The
remaining cast now states what it actually covers.
* test(runtime,ipc): drop redundant cast suppressions; typed runtime store fixture
-98 cast directives across runtime/ipc tests: 61 casts that typecheck
without the assertion; a typed vi.fn for scoped invalidation; a
partialRuntimeStore fixture in place of `store as never` for
OrcaRuntimeService; typed worker terminal/authority builders in the
incarnation-fallback suite (the old stub lacked runtimeId, ptyId,
worktreeId and launchTokenHash) plus removal of stacked duplicate
directives there.
* chore(lint): typed vi.mock imports and explicit listener snapshot in shared-bucket tests
Remaining files from the misc-rule pass that overlapped other buckets:
codex-accounts mocks use the typed vi.mock(import(...)) form instead of
a consistent-type-imports disable; the daemon late-exit fixture copies
its listener set with Array.from instead of a no-useless-spread disable.
* refactor(github,mobile): narrow routing settings type; drop remaining avoidable casts
- work-item-routing cast a one-field object to AppState['settings'] under
a claim that readers only consume activeRuntimeEnvironmentId. Return the
existing RuntimeFocusSettings pick instead and narrow the cache-key
chain's parameters, so the compiler enforces that claim.
- mobile file preview reads refusals through the RpcResponse `ok`
discriminant rather than a cast.
- terminal document host-notify accepts `unknown` errors, removing the
message-bridge cast.
- native chat readability drops a redundant repo-list cast.
* test(renderer): replace repeated cast suppressions with typed fixtures
-140 cast directives (and ~150 unsuppressed casts of the same shapes):
- mockPanePtyArgs owns the connectPanePty fixture casts, so a wrong
argument order or fixture is now a type error; drop binding casts for
members PanePtyBinding already declares.
- Seed AppState tab rows with the typed makeTerminalTab; this exposed a
split direction 'row' that is not a TerminalPaneSplitDirection.
- Partial GlobalSettings use getDefaultSettings overrides; Jira-only
stores use createTestStore; runtime environment rows/statuses come from
a typed paired-runtime-environment fixture.
* chore(lint): drop no-module-mocking disable now covered by the test-fixture glob
* test(e2e): fix all 221 grandfathered e2e type errors; baseline to zero
The e2e typecheck baseline grandfathered 221 errors in 119 files. About a
third were tests drifted from the current API, several of which would
fail or mislead at runtime:
- terminal-shortcuts called a nonexistent xterm buffer method;
- the daemon-lifecycle fake lacked terminateOwnedTree, hidden by importing
its type from a module that does not export it;
- arguments in the wrong position (listProcesses(hostId, opts), a dropped
pty.write inputKind, an extra toWebTerminalSurfaceTabId argument);
- removed enum values ('drawer', 'idle', 'editor',
'session-insecure-origin') and a launch_source the telemetry schema
rejects;
- missing required fields (turnScope, childWorkOpen, providerIdentity,
reviewLookupOutcome, runtimeServiceAccount behind an `as RelayConfig`);
- dead reads (tab.customTitle, bucket.targets, changedPixels).
Also lifts variables that narrowed to `never` after poll-callback
assignment, and adds a typed xterm render-dimensions accessor. Includes
the cross-version suites' shared releaseModuleExport adoption.
* chore(typecheck): gate the now-clean e2e typecheck in local lint
The e2e baseline is empty, so the ratchet now rejects any tests/ type
error. CI already runs it via run-ratchets; add it to pnpm lint's
explicit ratchet list and replace the stale 'not yet clean' note.
* test(mobile): typecheck every mobile test; baseline 105 files -> 0
mobile/tests-typecheck-baseline.txt grandfathered 105 test files (531
errors) whose types CI never checked. Contract changes had landed without
these tests following, and type pins in them silently checked nothing.
- Root cause: salvagedOptional (src/shared/zod-salvage.ts) cast away
zod's optional marker, so every reply type built on it claimed
salvaged fields were always present. Return a real ZodOptional;
runtime is unchanged (the outer optional short-circuits undefined).
- Production now takes the port it uses: RpcOperationSender instead of
RpcClient for send-only callers, a narrow fetch signature, and only the
request fields push-receive reads.
- findAllByHostType/findByHostType replace `'Text' as never` lookups;
stubRpcClient gives tests a typed RpcClient.
- Real test bugs: settings-host-client-lifecycle "relay" hosts were
direct hosts (relayHostId no longer exists); two toEqualTypeOf pins
could never hold; a recovery hook ran with an undefined scope key;
a create-PR test cast to a never-imported type; "no URL" assertions
passed on null; plus stale required props, args and enum values.
* test(e2e): parse workerStart result instead of casting it
* test(runtime): typed partial runtime stores with production-shaped fixture data
Route every partial store passed to OrcaRuntimeService through
partialRuntimeStore with typed row builders, removing 60 cast directives
that hid fixture data production never produces:
- paired-client-navigation-test-harness keyed setWorktreeMeta writes by
`[object Object]` (it took an id where the store takes a target), so
reads never saw them;
- invalid worktree lineage origin/capture and incomplete workspace lineage;
- getWorkspaceSession returning null where the store returns the default
session; getGitHubCache returning undefined;
- orcad migration states missing migrationId/manifest/receipt, with a
toEqual pinned to that incomplete shape;
- partial repos, metadata, folders, project groups and notification rows.
* refactor(renderer): resolve suppressed React hook lint instead of disabling it
109 of 187 react-hooks/react-doctor suppressions fixed:
- ~95 exhaustive-deps disables only hid stable refs and setters passed
through controller objects; list them (identity never changes, so
nothing re-runs), plus a few real stale closures (tabId/worktreeId).
- Effects keyed on one value that read the latest props now use
useEffectEvent (WebConnect, skill freshness, Bitbucket dialog seeding,
Landing preflight, automation catalog, structured-session recovery,
file explorer).
- The conditional layout-owner hook is selected once at module load from
the build constant instead of a rules-of-hooks disable that also hid
the whole controller from compiler and react-doctor rules.
- A hook disable was masking a react/purity Date.now() in the palette's
recent-tabs memo; sample it when the snapshot is captured.
- Three identical debounced-search effects share
useTaskSearchDebouncedApply; layout snapshot merge helpers move out to
stay under max-lines.
Remaining suppressions are mount-once resources, invalidation epochs,
deliberately keyed fields, and test harnesses that mock the dispatcher.
* chore(ratchet): exempt test harnesses and fixtures from the focus-read ratchet
The ratchet skipped *.test-fixture.ts but scanned *-test-harness,
*-test-fixture(s) and *.test-support files. Those seed settings with
getDefaultSettings (which the ratchet discovers as a focus reader) and
never route host work, so 17 baseline entries were false positives, and
replacing a test's `settings: {...} as never` with typed defaults tripped
it. Match the repo's test-support names and prune (which also drops one
stale entry), and rename the frame-ordering harness to *-test-harness like
its siblings. A blanket "-harness" match would also exempt
e2e-terminal-pty-harness, which production imports, so the names stay
explicit.
* test: merge duplicate shared/constants imports
* revert(file-explorer): restore original tree load effects pending SSH e2e investigation
* test(runtime): drop RuntimeStore cast now that the fixture is typed
---------
Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
237 lines
7.5 KiB
TypeScript
237 lines
7.5 KiB
TypeScript
import { spawnProcess } from '@orca/process-host'
|
|
import { mkdtempSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import { dirname, join } from 'node:path'
|
|
import { pathToFileURL } from 'node:url'
|
|
import nacl from 'tweetnacl'
|
|
import { afterEach, describe, expect, it, vi } from 'vitest'
|
|
import { loadOrCreateMockServerKeyPair } from '../scripts/mock-server-key-pair'
|
|
|
|
const temporaryDirectories: string[] = []
|
|
|
|
// Why: this file runs under Node, but the program's RN libs type a timer handle as a number.
|
|
function unrefTimer(timer: unknown): void {
|
|
if (
|
|
typeof timer === 'object' &&
|
|
timer !== null &&
|
|
'unref' in timer &&
|
|
typeof timer.unref === 'function'
|
|
) {
|
|
timer.unref()
|
|
}
|
|
}
|
|
|
|
type ConcurrentCreator = {
|
|
ready: Promise<void>
|
|
locked: Promise<void>
|
|
start: () => void
|
|
stop: () => void
|
|
closed: Promise<void>
|
|
result: Promise<string>
|
|
}
|
|
|
|
function keyFilePath(): string {
|
|
const directory = mkdtempSync(join(tmpdir(), 'orca-mock-key-'))
|
|
temporaryDirectories.push(directory)
|
|
return join(directory, 'server-key')
|
|
}
|
|
|
|
function runConcurrentCreator(keyFile: string): ConcurrentCreator {
|
|
const moduleUrl = pathToFileURL(
|
|
join(import.meta.dirname, '../scripts/mock-server-key-pair.ts')
|
|
).href
|
|
const script = `
|
|
const fs = (await import('node:fs')).default
|
|
const { syncBuiltinESMExports } = await import('node:module')
|
|
const openSync = fs.openSync
|
|
let reportedLock = false
|
|
fs.openSync = (...args) => {
|
|
try {
|
|
return openSync(...args)
|
|
} catch (error) {
|
|
if (!reportedLock && args[0] === process.argv[2] + '.lock' && error.code === 'EEXIST') {
|
|
reportedLock = true
|
|
process.stdout.write('LOCKED\\n')
|
|
}
|
|
throw error
|
|
}
|
|
}
|
|
syncBuiltinESMExports()
|
|
const { loadOrCreateMockServerKeyPair } = await import(process.argv[1])
|
|
process.stdout.write('READY\\n')
|
|
await new Promise((resolve) => process.stdin.once('data', resolve))
|
|
const keyPair = loadOrCreateMockServerKeyPair(process.argv[2], { warn() {} })
|
|
process.stdout.write('KEY:' + Buffer.from(keyPair.secretKey).toString('base64') + '\\n')
|
|
`
|
|
const child = spawnProcess({
|
|
program: process.execPath,
|
|
args: ['--import', 'tsx', '--input-type=module', '--eval', script, moduleUrl, keyFile],
|
|
stdio: 'pipe'
|
|
})
|
|
let stdout = ''
|
|
let stderr = ''
|
|
let resolveReady!: () => void
|
|
let rejectReady!: (error: Error) => void
|
|
let resolveLocked!: () => void
|
|
let rejectLocked!: (error: Error) => void
|
|
const ready = new Promise<void>((resolve, reject) => {
|
|
resolveReady = resolve
|
|
rejectReady = reject
|
|
})
|
|
const locked = new Promise<void>((resolve, reject) => {
|
|
resolveLocked = resolve
|
|
rejectLocked = reject
|
|
})
|
|
let resolveClosed!: () => void
|
|
const closed = new Promise<void>((resolve) => {
|
|
resolveClosed = resolve
|
|
})
|
|
const timeout = setTimeout(() => child.kill(), 5_000)
|
|
unrefTimer(timeout)
|
|
child.stdout.on('data', (chunk) => {
|
|
stdout += chunk.toString()
|
|
if (stdout.includes('READY\n')) {
|
|
resolveReady()
|
|
}
|
|
if (stdout.includes('LOCKED\n')) {
|
|
resolveLocked()
|
|
}
|
|
})
|
|
child.stderr.on('data', (chunk) => {
|
|
stderr += chunk.toString()
|
|
})
|
|
const result = new Promise<string>((resolve, reject) => {
|
|
child.on('error', (error) => {
|
|
rejectReady(error)
|
|
rejectLocked(error)
|
|
reject(error)
|
|
})
|
|
child.on('close', (code) => {
|
|
clearTimeout(timeout)
|
|
resolveClosed()
|
|
const error = new Error(stderr || `Concurrent key creator exited ${code}`)
|
|
if (!stdout.includes('READY\n')) {
|
|
rejectReady(error)
|
|
}
|
|
if (!stdout.includes('LOCKED\n')) {
|
|
rejectLocked(error)
|
|
}
|
|
const key = stdout.match(/KEY:([A-Za-z0-9+/=]+)\n/)?.[1]
|
|
if (code === 0 && key) {
|
|
resolve(key)
|
|
} else {
|
|
reject(error)
|
|
}
|
|
})
|
|
})
|
|
void result.catch(() => {})
|
|
return {
|
|
ready,
|
|
locked,
|
|
start: () => {
|
|
if (!child.stdin.destroyed && !child.stdin.writableEnded) {
|
|
child.stdin.end('go\n')
|
|
}
|
|
},
|
|
stop: () => {
|
|
if (child.exitCode === null && child.signalCode === null) {
|
|
child.kill()
|
|
}
|
|
},
|
|
closed,
|
|
result
|
|
}
|
|
}
|
|
|
|
async function cleanupConcurrentCreators(
|
|
creators: ConcurrentCreator[],
|
|
lockFile: string,
|
|
removeLock: boolean
|
|
): Promise<void> {
|
|
let lockRemovalError: unknown
|
|
if (removeLock) {
|
|
try {
|
|
rmSync(lockFile, { force: true })
|
|
} catch (error) {
|
|
lockRemovalError = error
|
|
}
|
|
}
|
|
creators.forEach((creator) => {
|
|
creator.start()
|
|
creator.stop()
|
|
})
|
|
await Promise.allSettled(creators.flatMap((creator) => [creator.result, creator.closed]))
|
|
if (lockRemovalError) {
|
|
throw lockRemovalError
|
|
}
|
|
}
|
|
|
|
afterEach(() => {
|
|
for (const directory of temporaryDirectories.splice(0)) {
|
|
rmSync(directory, { recursive: true, force: true })
|
|
}
|
|
})
|
|
|
|
describe('mock server key persistence', () => {
|
|
it('persists one private key and reuses it after restart', () => {
|
|
const keyFile = keyFilePath()
|
|
const first = loadOrCreateMockServerKeyPair(keyFile, { warn: vi.fn() })
|
|
const second = loadOrCreateMockServerKeyPair(keyFile)
|
|
|
|
expect(second.secretKey).toEqual(first.secretKey)
|
|
expect(readFileSync(keyFile, 'utf-8')).toBe(Buffer.from(first.secretKey).toString('base64'))
|
|
expect(readdirSync(dirname(keyFile))).toEqual(['server-key'])
|
|
if (process.platform !== 'win32') {
|
|
expect(statSync(keyFile).mode & 0o777).toBe(0o600)
|
|
}
|
|
})
|
|
|
|
it('re-keys canonical-length content with malformed base64', () => {
|
|
const keyFile = keyFilePath()
|
|
const encoded = Buffer.from(nacl.box.keyPair().secretKey).toString('base64')
|
|
const malformed = `${encoded.slice(0, 4)}!${encoded.slice(4)}`
|
|
expect(Buffer.from(malformed, 'base64')).toHaveLength(nacl.box.secretKeyLength)
|
|
writeFileSync(keyFile, malformed)
|
|
const logger = { warn: vi.fn() }
|
|
|
|
const loaded = loadOrCreateMockServerKeyPair(keyFile, logger)
|
|
|
|
expect(logger.warn).toHaveBeenCalledWith(expect.stringContaining('invalid base64'))
|
|
expect(readFileSync(keyFile, 'utf-8')).toBe(Buffer.from(loaded.secretKey).toString('base64'))
|
|
})
|
|
|
|
it('makes concurrent creators converge on the persisted winner', async () => {
|
|
const keyFile = keyFilePath()
|
|
const lockFile = `${keyFile}.lock`
|
|
writeFileSync(lockFile, '', { flag: 'wx', mode: 0o600 })
|
|
const firstCreator = runConcurrentCreator(keyFile)
|
|
const secondCreator = runConcurrentCreator(keyFile)
|
|
const creators = [firstCreator, secondCreator]
|
|
let parentOwnsLock = true
|
|
try {
|
|
await Promise.all(creators.map((creator) => creator.ready))
|
|
creators.forEach((creator) => creator.start())
|
|
await Promise.all(creators.map((creator) => creator.locked))
|
|
expect(readdirSync(dirname(keyFile))).toEqual(['server-key.lock'])
|
|
rmSync(lockFile)
|
|
parentOwnsLock = false
|
|
const [first, second] = await Promise.all(creators.map((creator) => creator.result))
|
|
|
|
expect(second).toBe(first)
|
|
expect(readFileSync(keyFile, 'utf-8')).toBe(first)
|
|
expect(readdirSync(dirname(keyFile))).toEqual(['server-key'])
|
|
} finally {
|
|
await cleanupConcurrentCreators(creators, lockFile, parentOwnsLock)
|
|
}
|
|
})
|
|
|
|
it('does not overwrite an invalid key owned by another creator', () => {
|
|
const keyFile = keyFilePath()
|
|
writeFileSync(keyFile, 'invalid')
|
|
writeFileSync(`${keyFile}.lock`, '', { flag: 'wx', mode: 0o600 })
|
|
|
|
expect(() => loadOrCreateMockServerKeyPair(keyFile)).toThrow('remained busy')
|
|
expect(readFileSync(keyFile, 'utf-8')).toBe('invalid')
|
|
})
|
|
})
|