Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: Context APIs changes and documentation/onboarding #180

Merged
merged 11 commits into from
Dec 10, 2024

Conversation

fabriziodemaria
Copy link
Member

@fabriziodemaria fabriziodemaria commented Nov 28, 2024

Breaking changes:

  • Awaitable putContextAndWait added
    • putContext calls are executed in a serial fashion, and override existing calls for performance
    • putContext triggers fetchAndActivate directly, and not as a side-effect
  • Removes contextChanges() observable API

Fixes and improvements:

  • Bug fix for the initialization strategies in the OpenFeature layer
  • Access to in-memory context is wrapped in serial queue

Docs and onboarding:

  • Demo app shows examples of how integrate the SDK in different scenarios
  • Documentation update

@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 19 times, most recently from 6e17a84 to e4b588a Compare December 2, 2024 14:11
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 3 times, most recently from ef29aa2 to 7d808f3 Compare December 3, 2024 10:37
@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 2 times, most recently from 93211b7 to fff6bd6 Compare December 3, 2024 15:35
@fabriziodemaria fabriziodemaria marked this pull request as ready for review December 3, 2024 15:55
@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 7 times, most recently from 0a9657e to 77f68a5 Compare December 9, 2024 18:00
@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 2 times, most recently from 2b988a8 to f88f8d9 Compare December 9, 2024 18:28
Comment on lines 27 to 31
didSet {
if let oldTask = oldValue {
oldTask.cancel()
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

@fabriziodemaria fabriziodemaria force-pushed the api-adjustments branch 5 times, most recently from a7ab0f3 to d268518 Compare December 10, 2024 12:15
/**
Ensures all the already-started context changes prior to this function have been reconciliated
*/
public func awaitReconciliation() async {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest awaitReady() instead...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep the same name used in Kotlin, i.e. awaitReconciliation

I'd be happy to create a pair of "renaming PRs" for both repos after this though, if we want to reach proper alignment (this would make sense especially now that the APIs between platforms are much more similar!)

@fabriziodemaria fabriziodemaria merged commit 6eb5dc7 into main Dec 10, 2024
6 checks passed
@fabriziodemaria fabriziodemaria deleted the api-adjustments branch December 10, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants