docs(file-ipc): audit legacy file IPC surface and FileStorage consumption#16735
Draft
EurFelux wants to merge 2 commits into
Draft
docs(file-ipc): audit legacy file IPC surface and FileStorage consumption#16735EurFelux wants to merge 2 commits into
EurFelux wants to merge 2 commits into
Conversation
…tion Add two audits under v2-refactor-temp/docs/file-manager/: - legacy-file-ipc-audit.md: current-state inventory of all legacy File_*/Fs_*/Open_Path channels (FileManager.ts Group A + ipc.ts Group B) with registration points and every renderer consumer (file:line). - filestorage-consumption-audit.md: per-consumer verdict (reroute / abolish / defer) for the 25 v1 FileStorage-backed channels against the target IpcApi (RFC §7.2), with rewrite sketches. Records a BLOCKING prerequisite (§7): unify the branded absolute-path type (FilePath / AbsolutePathSchema) before migrating consumers. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: eurfelux <eurfelux@gmail.com>
58db625 to
ae1326b
Compare
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.
What this PR does
Before this PR:
File_*/Fs_*/Open_Path) was undocumented — no single inventory of which channels exist, where they are registered, or who consumes them, and no assessment of which v1 consumption patterns should be re-routed vs abolished under the new IpcApi.After this PR:
v2-refactor-temp/docs/file-manager/(documentation only — no runtime behavior change):legacy-file-ipc-audit.md— current-state inventory of every legacy file IPC channel (FileManager.tsGroup A +ipc.tsGroup B), its registration point, backing implementation, and every renderer consumer (file:line). Distinguishes already-migrated IpcApi routes and flags renderer-dead channels.filestorage-consumption-audit.md— for the 25 v1FileStorage-backed channels, a per-consumer verdict (reroute / abolish / defer) against the target IpcApi (RFC §7.2), with rewrite sketches and a P1–P5 anti-pattern taxonomy.FileStorage.tsdeprecation notice (9 lines) marking the service for v2 migration.filestorage-consumption-audit.md§7): the absolute-path type is not unified —FilePathis a type-only template literal,AbsolutePathSchemainfers unbrandedstring, and the two are bridged byascasts (per thehandle.ts:59-60TODOs). This type refactor must land before the audited consumer migration proceeds — hence this PR is a draft.Fixes # N/A
Why we need it and why it was done in this way
Groundwork for migrating the legacy file IPC surface onto IpcApi. The migration is not a pure transport swap: several v1 consumption patterns (synthesizing throwaway
FileMetadatafrom a raw path, renderer-side temp-file orchestration, type-probe helpers) should be abolished, not re-implemented. Auditing and classifying consumers first prevents carrying v1 anti-patterns into v2.The following tradeoffs were made:
The following alternatives were considered:
as-cast path-typing debt from ~3 sites to dozens of consumers.Links to places where the discussion took place: N/A
Breaking changes
None. Documentation-only, plus an inert deprecation notice on
FileStorage.ts.Special notes for your reviewer
filestorage-consumption-audit.md§7), handled separately.legacy-file-ipc-audit.md§1/§4 (inventory) andfilestorage-consumption-audit.md§1 (verdict table) + §7 (blocker).Checklist
mainfor active development,v1for v1 maintenance fixes/gh-pr-review,gh pr diff, or GitHub UI) before requesting review from othersRelease note