feat: Adopt latest OF SDK #184
Merged
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
fabriziodemaria
force-pushed
the
of-sdk-bump
branch
2 times, most recently
from
8005890 to
0ce146b
Compare
beeme1mr
added a commit
to open-feature/swift-sdk
that referenced
this pull request
Jan 30, 2025
<!-- Please use this template for your pull request. --> <!-- Please use the sections that you need and delete other sections --> ## Spec v0.8 adherence - Created "ProviderStatus.swift" according to [Specification](https://github.com/open-feature/spec/blob/634f2b52f990232b0b1c54c38f422cbff2c507bc/specification/types.md#provider-status). - ProviderState is now maintained by the SDK, and not by the Provider implementations - Align "ProviderEvent.swift" with [Specification](https://github.com/open-feature/spec/blob/634f2b52f990232b0b1c54c38f422cbff2c507bc/specification/types.md#provider-events) - Basic events like `Ready`, `Error` or `Fatal` are emitted by the SDK and are not expected by the Provider implementations. - Makes `initialize` and `onContextChange` protocols throwing, allowing for the OpenFeatureAPI layer to detect cases where `Error` events should be emitted - Makes `initialize` and `onContextChange` protocols async for an easier Provider implementation (in most cases) ### Missing parts - From the [Specification](https://openfeature.dev/specification/sections/events#conditional-requirement-5342): `It's possible that the on context changed function is invoked simultaneously or in quick succession; in this case the SDK will only run the PROVIDER_CONTEXT_CHANGED handlers after all reentrant invocations have terminated, and the last to terminate was successful (terminated normally)` - This is not part of this PR: subsequent calls are serialized and executed in sequence, each returning from its execution even if more same functions are queued - Handling of [spontaneous Provider events](https://openfeature.dev/specification/sections/events#requirement-535) missing in this PR ## Changes unrelated to Spec v0.8 - Added `setEvaluationContextAndWait` to provide the same better ergonomics that `setProviderAndWait` already offers - Evaluation returns early if provider state is not "ready" - Refactor `afterAll` hook to adhere to latest conventions ## Notes on backwards compatibility - A backwards incompatible aspect of this change is that the `initialize()` implementation needs to throw in case of errors, rather than emitting the `ERROR` event. The latter is now responsibility of the SDK. This is also valid for `onContextChange`. - This change in semantics is not enforced with code, and it might be easy for the Provider implementer to make mistakes when adopting this new version of the SDK (e.g. forget to remove `ERROR` emission from the Provider side) ## Example Adoption The Confidence OpenFeature Provider adopting this version of the SDK is in the works here: spotify/confidence-sdk-swift#184 --------- Signed-off-by: Fabrizio Demaria <[email protected]> Co-authored-by: Michael Beemer <[email protected]>
fabriziodemaria
force-pushed
the
of-sdk-bump
branch
3 times, most recently
from
8372fdf to
c842ba5
Compare
fabriziodemaria
changed the title
fabriziodemaria
force-pushed
the
of-sdk-bump
branch
from
c842ba5 to
30dca28
Compare
fabriziodemaria
requested review from
mfranberg,
vahidlazio,
nicklasl and
nickybondarenko
as code owners
Signed-off-by: Fabrizio Demaria <[email protected]>
fabriziodemaria
force-pushed
the
of-sdk-bump
branch
from
30dca28 to
46ddc4c
Compare
fabriziodemaria
commented
Feb 7, 2025
| @@ -18,7 +18,7 @@ let package = Package( | |||
| targets: ["Confidence"]) | |||
| ], | |||
| dependencies: [ | |||
| .package(url: "[email protected]:open-feature/swift-sdk.git", from: "0.1.0"), | |||
There was a problem hiding this comment.
Interestingly, builds from main started failing since the dependency is "from" and not "exact". Maybe ok to keep it like this, forces us to keep things up to date :)
nicklasl
previously approved these changes
Feb 7, 2025
Signed-off-by: Fabrizio Demaria <[email protected]>
Signed-off-by: Fabrizio Demaria <[email protected]>
Signed-off-by: Fabrizio Demaria <[email protected]>
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.
Events are removed, since now handled automatically by the underlying SDK. onContextSet is now awaiting, returning on success or throwing on failure, as expected by the new SDK version.