feat: LDContext is java.io.Serializable#97
Open
joshfriend wants to merge 1 commit into
Open
Conversation
fa5cb4a to
f198141
Compare
Contributor
|
Hi @joshfriend and thank you for the contribution. I will try to take a look in the next day or two. |
tanderson-ld
left a comment
Contributor
There was a problem hiding this comment.
Thanks for your patience this week.
| * Builder methods are not thread-safe. | ||
| */ | ||
| public final class ArrayBuilder { | ||
| public final class ArrayBuilder implements Serializable { |
Contributor
There was a problem hiding this comment.
It seems a little unusual to me to make a builder serializable. Do you know which structure is leading the default serialization here? I don't see the dependency from LDContext to here.
Contributor
There was a problem hiding this comment.
Is it the ArrayBuilder in LDValue?
Author
There was a problem hiding this comment.
I backed this one out, it doesn't need to be serializable.
f198141 to
f1ed0c7
Compare
Author
|
I rebased this and added a roundtrip serialization test |
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.
Requirements
Describe the solution you've provided
I Added
Serializableto any base classes and interfaces needed to makeLDContextitself serializableDescribe alternatives you've considered
My workaround for this was to manually serialize the LDContext to json because
stringis serializable and deserialize it againAdditional context
I was trying to use launchdarkly sdks inside of some gradle tooling that configures build features based on feature flags. To do this I wrote a
ValueSourcewhich took the following parameters:And gradle threw an error because LDContext is not serializable, and therefore not allowed as a ValueSourceParameters property.
I'm hoping that code will be open source soon, but for now here's a snippet:
Note
Low Risk
Additive API change on marker interfaces and internal types; behavior is covered by new serialization round-trip tests with no runtime path changes for normal SDK usage.
Overview
Enables Java native serialization (
ObjectOutputStream/ObjectInputStream) forLDContext, so it can be used in frameworks that requireSerializableparameters (e.g. GradleValueSourceconfiguration) without JSON workarounds.JsonSerializablenow extendsjava.io.Serializable, which propagates serializability toLDContextand related JSON-modeled SDK types.AttributeMapis also markedSerializabledirectly.LDValueBoolandLDValueNulladdreadResolve()so deserialized values restore the canonical singleton instances—required forequals()to behave correctly after a round trip.New tests in
LDContextTestassert single- and multi-kind contexts survive a Java serialize/deserialize cycle and remainequalTothe original.Reviewed by Cursor Bugbot for commit f1ed0c7. Bugbot is set up for automated code reviews on this repo. Configure here.