Skip to content

feat!: Spec v0.8 adherence #46

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 12 commits into from
Jan 30, 2025
Merged

feat!: Spec v0.8 adherence #46

merged 12 commits into from
Jan 30, 2025

Conversation

@fabriziodemaria
Copy link
Contributor

@fabriziodemaria fabriziodemaria commented Sep 4, 2024 •
edited
Loading

Spec v0.8 adherence

  • Created "ProviderStatus.swift" according to Specification.
    • ProviderState is now maintained by the SDK, and not by the Provider implementations
  • Align "ProviderEvent.swift" with Specification
    • 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: 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 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

@fabriziodemaria fabriziodemaria force-pushed the fatal-state branch 3 times, most recently from 203e8da to 40d0812 Compare September 6, 2024 14:41
@fabriziodemaria fabriziodemaria changed the title feat: Add ProviderState feat!: Add ProviderState Sep 6, 2024
@fabriziodemaria fabriziodemaria force-pushed the fatal-state branch 3 times, most recently from 16499c7 to 78a30e5 Compare December 17, 2024 14:53
@fabriziodemaria fabriziodemaria marked this pull request as ready for review December 17, 2024 14:53
@fabriziodemaria fabriziodemaria force-pushed the fatal-state branch 3 times, most recently from ba7c072 to ac15098 Compare December 18, 2024 16:30
@fabriziodemaria fabriziodemaria changed the title feat!: Add ProviderState feat!: Start adoption of Spec v0.8 Dec 18, 2024
@fabriziodemaria fabriziodemaria force-pushed the fatal-state branch 2 times, most recently from 76cd647 to eacbb12 Compare December 19, 2024 09:46
@fabriziodemaria fabriziodemaria changed the title feat!: Start adoption of Spec v0.8 feat!: Spec v0.8 adherence Dec 19, 2024
beeme1mr
beeme1mr approved these changes Dec 19, 2024
View reviewed changes
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Hey @fabriziodemaria, the change looks good from what I can tell (limited experience with Swift). Since this is a breaking change, it may be a good time to update the afterAll stage in the hooks to comply with a recent update to the spec.

https://openfeature.dev/specification/sections/hooks#requirement-438

This will make it easy to support more sophisticated telemetry use cases.

fabriziodemaria and others added 4 commits December 20, 2024 14:25
@fabriziodemaria @beeme1mr
refactor: Rename queue label
1e5e42e 
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Fabrizio Demaria <[email protected]>
@fabriziodemaria @beeme1mr
docs: Fix typo
613f27d 
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Fabrizio Demaria <[email protected]>
@fabriziodemaria @beeme1mr
docs: Fix typo
176accf 
Co-authored-by: Michael Beemer <[email protected]>
Signed-off-by: Fabrizio Demaria <[email protected]>
@fabriziodemaria
refactor: Remove todos
2c7886b 
Signed-off-by: Fabrizio Demaria <[email protected]>
fabriziodemaria
fabriziodemaria commented Dec 20, 2024
View reviewed changes
This was referenced Dec 21, 2024
Closed
Merged
@beeme1mr
Copy link
Member

beeme1mr commented Jan 2, 2025

@nicklasl, any concerns with the PR?

nicklasl
nicklasl reviewed Jan 13, 2025
View reviewed changes
nicklasl
nicklasl reviewed Jan 13, 2025
View reviewed changes
nicklasl
nicklasl reviewed Jan 14, 2025
View reviewed changes
@beeme1mr beeme1mr merged commit b6457f6 into main Jan 30, 2025
6 checks passed
@github-actions github-actions bot mentioned this pull request Jan 30, 2025
Merged
@beeme1mr beeme1mr deleted the fatal-state branch January 30, 2025 19:18
@fabriziodemaria fabriziodemaria mentioned this pull request Jan 31, 2025
Merged
fabriziodemaria added a commit that referenced this pull request Jan 31, 2025
@fabriziodemaria
docs: Fix spec version label in README (#54)
3e1ec5b 
Just a minor README fix following up #46

Signed-off-by: Fabrizio Demaria <[email protected]>
@nicklasl nicklasl mentioned this pull request Jan 31, 2025
Merged
fabriziodemaria pushed a commit that referenced this pull request Jan 31, 2025
@github-actions
chore(main): release 0.3.0 (#53)
e2be585 
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](0.2.1...0.3.0)
(2025-01-31)


### ⚠ BREAKING CHANGES

* Spec v0.8 adherence
([#46](#46))

### ✨ New Features

* Spec v0.8 adherence
([#46](#46))
([b6457f6](b6457f6))


### 📚 Documentation

* Fix spec version label in README
([#54](#54))
([3e1ec5b](3e1ec5b))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@beeme1mr beeme1mr beeme1mr approved these changes

@nicklasl nicklasl nicklasl approved these changes

@thomaspoignant thomaspoignant thomaspoignant approved these changes

@kinyoklion kinyoklion Awaiting requested review from kinyoklion

@toddbaert toddbaert Awaiting requested review from toddbaert

@lukas-reining lukas-reining Awaiting requested review from lukas-reining

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@fabriziodemaria @beeme1mr @nicklasl @thomaspoignant