feat: ImmuatableConfiguration #231
Open
+355
−12
Conversation
This file contains 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
typotter
commented
Mar 5, 2025
|
|
||
| await requestor.fetchAndStoreConfigurations(); | ||
|
|
||
| const config = requestor.getConfiguration(); |
There was a problem hiding this comment.
Since config is a snapshot, we take it after the fetch&store
typotter
commented
Mar 5, 2025
| @@ -11,6 +11,7 @@ import { BanditVariation, BanditParameters, Flag, BanditReference } from './inte | |||
| export default class ConfigurationRequestor { | |||
| private banditModelVersions: string[] = []; | |||
| private readonly configuration: StoreBackedConfiguration; | |||
| private configurationCopy: IConfiguration; | |||
There was a problem hiding this comment.
save and return the copy only
aarsilv
approved these changes
Mar 7, 2025
Comment on lines
+537
to
+541
| // Attempt to modify the returned data | ||
| flags['feature-a'].enabled = false; | ||
|
|
||
| // Verify original configuration remains unchanged | ||
| expect(originalFlags['feature-a'].enabled).toBeTruthy(); |
Comment on lines
+193
to
+198
| this.flags = JSON.parse(JSON.stringify(flags)); | ||
| this.flagConfigDetails = JSON.parse(JSON.stringify(flagConfigDetails)); | ||
| this.banditVariations = banditVariations | ||
| ? JSON.parse(JSON.stringify(banditVariations)) | ||
| : undefined; | ||
| this.bandits = bandits ? JSON.parse(JSON.stringify(bandits || {})) : undefined; |
There was a problem hiding this comment.
If you want to further inforce immutability, you could look into leveraging Object.freeze()
| @@ -25,14 +26,15 @@ export default class ConfigurationRequestor { | |||
| this.banditVariationConfigurationStore, | |||
| this.banditModelConfigurationStore, | |||
| ); | |||
| this.configurationCopy = this.configuration.copy(); | |||
There was a problem hiding this comment.
This could be large; I wonder if we do the copying just in time when getConfiguration() is called. We could still check this.configurationCopy so that we only do it once.
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.
labels: mergeable
Fixes: #issue
Motivation and Context
In order to isolate the internal configuration from any changes outside a configuration fetch, we want to make available only an immutable version of the
Configuration. In java, for instance, we can leverage immutable maps and objects to prevent changes. Here, we use a copy or a snapshot of the configuration.Description
ImmutableConfigurationclass which creates a deep copy of the payload dataHow has this been tested?