fix: make default JSON serializer contract explicit#50
Draft
lan17 wants to merge 1 commit into
Draft
Conversation
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
Make DialCache's default JSON serializer contract honest without adding a validation pass or changing runtime serialization behavior.
The default serializer now advertises
unknownrather than allowing callers to claim arbitrary losslessTround trips. The README documents the exact JSON-compatible domain, representative lossy transformations, native failures, and the custom serializer escape hatch.Architecture and design
JSON.stringify/JSON.parseas the default wire codec.Serializer<T>as a trusted codec boundary: DialCache does not perform an additional serialize/deserialize validation round trip.undefinedsentinel.API impact
JsonSerializeris no longer generic; it implementsSerializer<unknown>.JsonSerializer.load()returnsPromise<unknown>.new JsonSerializer<MyType>()must usenew JsonSerializer()and narrow the decoded value, or provide a typed customSerializer<MyType>.Serializer<T>interface remains available and unchanged for types such asDate.There are no Redis key, frame, Lua, adapter, or stored-payload format changes.
Operational behavior
This adds no runtime validation and no extra serialization pass, so the cache hot path has no new CPU overhead. Existing JSON-compatible cached values remain wire-compatible.
The documented default domain includes JSON-stable primitives, arrays, and plain objects. Values such as
Date,Map,Set, class instances, non-finite numbers, nestedundefined, symbols, functions,bigint, cycles, prototypes, and shared object identity may be rejected or changed by native JSON semantics.Validation
corepack pnpm typecheckgit diff --checkTracking
Closes #16