Files
orca/src/preload/api/telemetry-api.ts
T
Neil 77f23b013f refactor(shared): drop the shared/types barrel and import from the real modules (#14447)
#14397 split `shared/types.ts` into 46 per-domain modules but kept the path as
a re-export barrel so the import sites did not have to change. This removes
the barrel: every consumer now imports from the module that actually declares
the type, and `src/shared/types.ts` is deleted.

Barrels hide where a type lives, make every consumer look like it depends on
the whole domain, and let an unrelated edit invalidate a module that ~2,000
files transitively import.

2,323 import declarations across 2,321 files. Rewritten mechanically: each
specifier was resolved to an absolute path via the TypeScript AST and
recomputed, rather than string-substituted, so alias forms (`@/../../shared/
types`) and per-specifier `type` modifiers survive.

Four cases the mechanical pass had to handle, each found by a gate rather than
by reading the diff:

- Modules inside `src/shared` import the barrel as `./types`, not
  `shared/types`. A pre-filter on the latter string skipped 176 of them and
  left imports dangling at a deleted file, which surfaced as confusing
  `Property 'x' is optional in type 'Repo' but required in Pick<Repo, ...>`
  errors rather than "module not found".
- The barrel RENAMED one type on the way through
  (`WorkspaceSource as WorkspaceCreateTelemetrySource`), so the original name
  in the owning module has to be re-aliased at each consumer.
- Three test files put `;(globalThis as ...)` on the line after the import.
  TypeScript parses that `;` as the import statement's terminator, so
  replacing through `statement.getEnd()` deletes it and breaks ASI. The
  rewrite now stops at the module specifier.
- A file that already imported directly from a module got a SECOND import
  from it, because the barrel re-exported those same names — which trips
  `import/no-duplicates` under `--deny-warnings`. A post-pass merges
  declarations sharing a specifier and type-only-ness; the `import type` plus
  `import` pair from one module is left alone, since that form is allowed.

Splitting one barrel import into several genuinely adds lines, which pushed
`terminal-layout-pty-ownership.ts` to 301 counted lines: its 107-character
import must wrap, and neither local type collapses onto one line (101 and 116
characters). Rather than contort a type declaration to fit a line budget,
`collectLeafIds` and `pruneLeaves` move to `terminal-pane-layout-tree.ts` —
they are pure structural operations on the layout tree and independent of PTY
ownership. `visible-worktrees.ts` similarly loses its own mini-barrel
re-export of `isDefaultBranchWorkspace`, with the four real consumers
repointed at the declaring module. No `max-lines` bypass added.

Verified: cold `tsc --noEmit` green on node, cli, and web (buildinfo deleted
first — these projects are `composite: true` and reuse stale caches); the full
`pnpm lint` green, not just bare oxlint — the narrower local check is what let
the duplicate imports reach CI; max-lines ratchet OK at 344.
2026-08-13 22:48:24 -07:00

64 lines
2.6 KiB
TypeScript

import type { TelemetryConsentState } from '../../shared/telemetry-consent-types'
import type { MemorySnapshot, StatsSummary } from '../../shared/process-stats-types'
export type StatsApi = {
getSummary: () => Promise<StatsSummary>
}
// Diagnostics IPC payloads; mirror the runtime types in `src/main/observability/{index,bundle}.ts`.
export type DiagnosticsStatusPayload = {
readonly localFileEnabled: boolean
readonly bundleEnabled: boolean
readonly traceFilePath: string
readonly traceFamilySize: number
readonly disabledReason?:
| 'do_not_track'
| 'orca_telemetry_disabled'
| 'orca_diagnostics_disabled'
| 'ci'
}
export type DiagnosticsBundlePayload = {
readonly bundleSubmissionId: string
readonly bytes: number
readonly spanCount: number
}
export type DiagnosticsUploadPayload =
| {
readonly ticketId: string
}
| {
readonly canceled: true
}
export type MemoryApi = {
getSnapshot: () => Promise<MemorySnapshot>
}
export type DiagnosticsApi = {
getStatus: () => Promise<DiagnosticsStatusPayload>
collectBundle: (lookbackMinutes?: number) => Promise<DiagnosticsBundlePayload>
openBundlePreview: (bundleSubmissionId: string) => Promise<void>
discardBundlePreview: (bundleSubmissionId: string) => Promise<void>
uploadBundle: (bundleSubmissionId: string) => Promise<DiagnosticsUploadPayload>
deleteBundle: (ticketId: string) => Promise<void>
}
export type TelemetryApi = {
/** Fire-and-forget track. Loose IPC typing on purpose — the main-side validator enforces;
* renderer sites should import `track<N>()` from lib/telemetry.ts, not reach here. */
telemetryTrack: (name: string, props: Record<string, unknown>) => Promise<void>
/** Flip the persisted opt-in preference. Subject to a per-session
* consent-mutation rate limit on the main side (≤5/session). */
telemetrySetOptIn: (optedIn: boolean) => Promise<void>
/** Diagnostic file controls (telemetry-error-tracking.md §User controls). Main does the FS/network
* work and retains upload payloads so the renderer can't read or substitute arbitrary bytes. */
diagnostics: DiagnosticsApi
/** Read-only effective consent state (+ reason if disabled) — env vars are main-side state the renderer can't read directly. */
telemetryGetConsentState: () => Promise<TelemetryConsentState>
/** Banner ✕ — persist `optedIn = true` silently. Separate channel from `telemetrySetOptIn`,
* whose `via` derivation would wrongly fire `telemetry_opted_in`. Same per-session rate limit. */
telemetryAcknowledgeBanner: () => Promise<void>
stats: StatsApi
memory: MemoryApi
}