Use idiomatic Effect for workspace file reads#3404
Draft
cursor[bot] wants to merge 3 commits into
Draft
Conversation
Co-authored-by: Julius Marminge <juliusmarminge@users.noreply.github.com>
Co-authored-by: Julius Marminge <juliusmarminge@users.noreply.github.com>
Co-authored-by: Julius Marminge <juliusmarminge@users.noreply.github.com>
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 Changed
node:fs/promisesread path inWorkspaceFileSystem.readFilewith Effect platformFileSystemAPIs (realPath, scopedopen, handlestat/read).Schema.TaggedErrorClasscauses for workspace read safety failures.assertstyle and added coverage for truncation and binary-file rejection.Why
This keeps workspace file reads inside Effect services end-to-end, avoids direct Node filesystem APIs, and makes read failures more structured and testable while preserving existing read behavior.
Checklist
Verification
pnpm run test src/workspace/WorkspaceFileSystem.test.ts(fromapps/server) — 8 tests passedpnpm exec vp check— 0 errors, existing unrelated lint warningspnpm exec vp run typecheck— passedNote
Refactor
WorkspaceFileSystem.readFileto use idiomatic Effect APIs with typed error causesnode:fs/promisescalls with EffectFileSystemAPIs (realPath,open, stat) in WorkspaceFileSystem.ts.WorkspaceReadFileResolvedOutsideRootError,WorkspaceReadFileNotFileError, andWorkspaceReadFileBinaryFileError— as structured causes insideWorkspaceFileSystemError.@effect/vitestassertions and adds coverage for truncation and binary file rejection.Macroscope summarized 201f654.