Skip to content

feat: add evaluation details to finally hook#1087

Merged
beeme1mr merged 5 commits intomainfrom
expand-finally-hook-stage
Dec 12, 2024
Merged

feat: add evaluation details to finally hook#1087
beeme1mr merged 5 commits intomainfrom
expand-finally-hook-stage

Conversation

@beeme1mr
Copy link
Member

@beeme1mr beeme1mr commented Nov 21, 2024 •
edited
Loading

This PR

  • adds evaluation details to the finally stage in hooks.

Notes

This breaks the signature of the finally stages based on this spec enhancement. It is not considered a breaking change to the SDK because hooks are marked as experimental in the spec, and the change has no impact on known hooks.

The noteworthy change to the interface is:

- finally?(hookContext: Readonly<HookContext<T>>, hookHints?: HookHints): HooksReturn;
+ finally?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: HookHints): HooksReturn;

Follow-up Tasks

  • Update the JS contribs repo

@beeme1mr
feat: add evaluation details to finally hook
bfd150d 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr beeme1mr mentioned this pull request Nov 21, 2024
Merged
@beeme1mr
add tests
9310ccf 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr beeme1mr marked this pull request as ready for review December 9, 2024 14:38
@beeme1mr beeme1mr requested a review from a team as a code owner December 9, 2024 14:38
toddbaert
toddbaert reviewed Dec 10, 2024
View reviewed changes
lukas-reining
lukas-reining approved these changes Dec 11, 2024
View reviewed changes
Copy link
Member

@lukas-reining lukas-reining left a comment

Choose a reason for hiding this comment

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

The change looks good to me!
I am with @toddbaert regarding the IIFEs, and I could live with duplicated lines or mutations.

@beeme1mr
remove iife ito reduce memory allocations
10f557f 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr
add missing changes
9346463 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@toddbaert toddbaert self-requested a review December 11, 2024 20:14
@beeme1mr beeme1mr linked an issue Dec 11, 2024 that may be closed by this pull request
Add evaluation details to finally hook stage #1109
Closed
lukas-reining
lukas-reining approved these changes Dec 11, 2024
View reviewed changes
Copy link
Member

@lukas-reining lukas-reining left a comment

Choose a reason for hiding this comment

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

Yes, looks good @beeme1mr :)

@beeme1mr beeme1mr added this pull request to the merge queue Dec 12, 2024
Merged via the queue into main with commit 2135254 Dec 12, 2024
@beeme1mr beeme1mr deleted the expand-finally-hook-stage branch December 12, 2024 13:50
This was referenced Dec 11, 2024
Merged
Merged
Merged
github-merge-queue bot pushed a commit that referenced this pull request Dec 18, 2024
@openfeaturebot @beeme1mr
chore(main): release core 1.6.0 (#1107)
bd26d0a 
🤖 I have created a release *beep* *boop*
---


##
[1.6.0](core-v1.5.0...core-v1.6.0)
(2024-12-12)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))

### ✨ New Features

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))


### 🔄 Refactoring

* improve track interface for providers
([#1100](#1100))
([5e5b160](5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
beeme1mr added a commit that referenced this pull request Dec 18, 2024
@openfeaturebot @beeme1mr
chore(main): release web-sdk 1.4.0 (#1106)
79de7ca 
🤖 I have created a release *beep* *boop*
---


##
[1.4.0](web-sdk-v1.3.2...web-sdk-v1.4.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))

### ✨ New Features

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))


### 📚 Documentation

* fix comment in README for Hook’s after method
([#1102](#1102))
([ba8d1ae](ba8d1ae))


### 🔄 Refactoring

* improve track interface for providers
([#1100](#1100))
([5e5b160](5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
beeme1mr added a commit that referenced this pull request Dec 18, 2024
@openfeaturebot @beeme1mr
chore(main): release server-sdk 1.17.0 (#1104)
edab970 
🤖 I have created a release *beep* *boop*
---


##
[1.17.0](server-sdk-v1.16.2...server-sdk-v1.17.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))

### ✨ New Features

* add evaluation details to finally hook
([#1087](#1087))
([2135254](2135254))


### 📚 Documentation

* fix comment in README for Hook’s after method
([#1103](#1103))
([e335615](e335615))


### 🔄 Refactoring

* improve track interface for providers
([#1100](#1100))
([5e5b160](5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr beeme1mr mentioned this pull request Dec 19, 2024
Draft
kevinmlong pushed a commit to kevinmlong/openfeature-js-sdk that referenced this pull request Dec 21, 2024
@beeme1mr @kevinmlong
feat: add evaluation details to finally hook (open-feature#1087)
ae87eeb 
## This PR

- adds evaluation details to the `finally` stage in hooks.

### Notes

This breaks the signature of the `finally` stages based on [this spec
enhancement](open-feature/spec#280). It is
**not** considered a breaking change to the SDK because hooks are marked
as experimental in the spec, and the change has no impact on known
hooks.

The noteworthy change to the interface is:

```diff
- finally?(hookContext: Readonly<HookContext<T>>, hookHints?: HookHints): HooksReturn;
+ finally?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: HookHints): HooksReturn;
```

### Follow-up Tasks

- Update the JS contribs repo

---------

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
kevinmlong pushed a commit to kevinmlong/openfeature-js-sdk that referenced this pull request Dec 21, 2024
@openfeaturebot @beeme1mr @kevinmlong
chore(main): release core 1.6.0 (open-feature#1107)
8d6a353 
🤖 I have created a release *beep* *boop*
---


##
[1.6.0](open-feature/js-sdk@core-v1.5.0...core-v1.6.0)
(2024-12-12)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))


### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
kevinmlong pushed a commit to kevinmlong/openfeature-js-sdk that referenced this pull request Dec 21, 2024
@openfeaturebot @beeme1mr @kevinmlong
chore(main): release web-sdk 1.4.0 (open-feature#1106)
64cc2ff 
🤖 I have created a release *beep* *boop*
---


##
[1.4.0](open-feature/js-sdk@web-sdk-v1.3.2...web-sdk-v1.4.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))


### 📚 Documentation

* fix comment in README for Hook’s after method
([open-feature#1102](open-feature#1102))
([ba8d1ae](open-feature@ba8d1ae))


### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
kevinmlong pushed a commit to kevinmlong/openfeature-js-sdk that referenced this pull request Dec 21, 2024
@openfeaturebot @beeme1mr @kevinmlong
chore(main): release server-sdk 1.17.0 (open-feature#1104)
97f4eb7 
🤖 I have created a release *beep* *boop*
---


##
[1.17.0](open-feature/js-sdk@server-sdk-v1.16.2...server-sdk-v1.17.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))


### 📚 Documentation

* fix comment in README for Hook’s after method
([open-feature#1103](open-feature#1103))
([e335615](open-feature@e335615))


### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
wichopy pushed a commit to wichopy/openfeature-js-sdk that referenced this pull request Dec 31, 2024
@beeme1mr @wichopy
feat: add evaluation details to finally hook (open-feature#1087)
3cccae1 
## This PR

- adds evaluation details to the `finally` stage in hooks.

### Notes

This breaks the signature of the `finally` stages based on [this spec
enhancement](open-feature/spec#280). It is
**not** considered a breaking change to the SDK because hooks are marked
as experimental in the spec, and the change has no impact on known
hooks.

The noteworthy change to the interface is:

```diff
- finally?(hookContext: Readonly<HookContext<T>>, hookHints?: HookHints): HooksReturn;
+ finally?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: HookHints): HooksReturn;
```

### Follow-up Tasks

- Update the JS contribs repo

---------

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Will Chou <w.chou06@gmail.com>
wichopy pushed a commit to wichopy/openfeature-js-sdk that referenced this pull request Dec 31, 2024
@openfeaturebot @beeme1mr @wichopy
chore(main): release core 1.6.0 (open-feature#1107)
942fa63 
🤖 I have created a release *beep* *boop*
---

##
[1.6.0](open-feature/js-sdk@core-v1.5.0...core-v1.6.0)
(2024-12-12)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Will Chou <w.chou06@gmail.com>
wichopy pushed a commit to wichopy/openfeature-js-sdk that referenced this pull request Dec 31, 2024
@openfeaturebot @beeme1mr @wichopy
chore(main): release web-sdk 1.4.0 (open-feature#1106)
eb16294 
🤖 I have created a release *beep* *boop*
---

##
[1.4.0](open-feature/js-sdk@web-sdk-v1.3.2...web-sdk-v1.4.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### 📚 Documentation

* fix comment in README for Hook’s after method
([open-feature#1102](open-feature#1102))
([ba8d1ae](open-feature@ba8d1ae))

### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Will Chou <w.chou06@gmail.com>
wichopy pushed a commit to wichopy/openfeature-js-sdk that referenced this pull request Dec 31, 2024
@openfeaturebot @beeme1mr @wichopy
chore(main): release server-sdk 1.17.0 (open-feature#1104)
db8e4bd 
🤖 I have created a release *beep* *boop*
---

##
[1.17.0](open-feature/js-sdk@server-sdk-v1.16.2...server-sdk-v1.17.0)
(2024-12-18)

### ⚠ BREAKING CHANGES

The signature of the `finally` hook stage has been changed. The
signature now includes the `evaluation details`, as per the [OpenFeature
specification](https://openfeature.dev/specification/sections/hooks#requirement-438).
Note that since hooks are still `experimental,` this does not constitute
a change requiring a new major version. To migrate, update any hook that
implements the `finally` stage to accept `evaluation details` as the
second argument.

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### ✨ New Features

* add evaluation details to finally hook
([open-feature#1087](open-feature#1087))
([2135254](open-feature@2135254))

### 📚 Documentation

* fix comment in README for Hook’s after method
([open-feature#1103](open-feature#1103))
([e335615](open-feature@e335615))

### 🔄 Refactoring

* improve track interface for providers
([open-feature#1100](open-feature#1100))
([5e5b160](open-feature@5e5b160))

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

---------

Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Will Chou <w.chou06@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kinyoklion kinyoklion kinyoklion approved these changes

@toddbaert toddbaert toddbaert approved these changes

@lukas-reining lukas-reining lukas-reining approved these changes

@thomaspoignant thomaspoignant Awaiting requested review from thomaspoignant

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add evaluation details to finally hook stage

4 participants

@beeme1mr @kinyoklion @toddbaert @lukas-reining