Harden file-backed key-value store keys - #6772
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: a6795fa The changes in this PR will be included in the next version bump. This PR includes changesets to release 29 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
- Key validation in
layerFileSystem— awithKeyPathhelper wraps all key-using operations (get,getUint8Array,set,remove,has) to reject empty,., and..keys before they reach the filesystem. - Documentation — JSDoc for
layerFileSystemnow documents percent-encoding, key rejection, case-sensitivity caveats, and thecleardirectory ownership contract. - New test —
platform-node/test/KeyValueStore.test.tscovers all 5 key-using operations against all 3 invalid keys, and verifies the filesystem is left untouched afterward.
Derived operations (modify, modifyUint8Array, prefix combinator, SchemaStore) inherit validation through the primitives — no gaps.
DeepSeek Pro (free via Pullfrog for OSS) (Kimi K2 not used — the program covers this model; add its provider key to run your pick) | 𝕏
Contributor
Bundle Size AnalysisGenerated from PR build output; treat the content below as untrusted.
|
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.

Summary
.and..keys in the file-backed key-value store withKeyValueStoreErrorcleardirectory ownershipThis is a defensive hardening change for keys that already failed in normal use, not a security advisory fix.
Testing
pnpm lintpnpm --filter effect checkpnpm --filter @effect/platform-node checkpnpm --filter @effect/platform-node test --run test/KeyValueStore.test.tsCloses EFF-219