feat(ipc): define safe error envelope#898
Closed
luoye520ww wants to merge 2 commits into
Closed
Conversation
Collaborator
Author
|
Superseded by consolidated IPC/SSE reliability PR #945, which passed Typecheck, Linux, macOS, and Windows packaged checks. Closing this duplicate to keep the review surface focused. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
IPC handlers currently have no shared, bounded error envelope. Main-process errors can therefore be serialized inconsistently, and future handlers may accidentally expose stacks or arbitrary objects to the renderer.
Root cause
RuntimeErrorcovers Kun HTTP responses, but it is not a contract for Electron IPC boundaries and does not constrain detail payloads.Scope
This PR defines the shared IPC error contract only. It does not change existing handler behavior; follow-up PRs will adopt it per IPC domain.
Changes
AppIpcErrorSchemaandAppIpcErrorinsrc/shared.Safety
Errorstack or arbitrary object can satisfy the contract.Typecheck
Result: passed.
Tests
npm.cmd exec vitest run src/shared/ipc-error.test.tsResult: 1 file, 3 tests passed.
Actual validation
The targeted test parses a real envelope and rejects stack fields, nested objects, unknown fields, oversized identifiers, and oversized detail maps.
npm.cmd run lintandnpm.cmd run buildalso passed.Review performed
PR size
Follow-ups
Adopt this envelope in individual main/preload/renderer IPC domains with cancellation and contract snapshot tests.