feat: use mutate context hook #1031

wichopy · 2024-10-06T18:16:20Z

This PR

New hook for mutating context instead of using the global object

Related Issues

Fixes #968

Notes

Follow-up Tasks

How to test

packages/react/src/provider/use-context-mutator.ts

beeme1mr · 2024-10-07T19:38:07Z

Could you please sign off on your commits? It's basically a way to tell the CNCF that you're willing and able to donate this code.

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by checking out the pull request locally via command line.
In your local branch, run: git rebase HEAD~5 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin wichopy/968

For future commits, you can add -s when running git commit.

I'll look into the licensing issue.

Signed-off-by: Will Chou <w.chou06@gmail.com>

beeme1mr · 2024-10-09T19:32:20Z

packages/react/test/provider.spec.tsx

@@ -136,5 +139,74 @@ describe('OpenFeatureProvider', () => {
        await waitFor(() => expect(screen.queryByText('👍')).toBeInTheDocument(), { timeout: DELAY * 2 });
      });
    });
+
+    describe('useMutateContext', () => {


These tests look great but could you please add one more for the following setup?

<OpenFeatureProvider domain={DOMAIN1}> <React.Suspense fallback={<div>{FALLBACK}</div>}> <TestComponent name="Will" /> <OpenFeatureProvider> <React.Suspense fallback={<div>{FALLBACK}</div>}> <TestComponent name="Todd" /> </React.Suspense> </OpenFeatureProvider> </React.Suspense> </OpenFeatureProvider>

The nested component should update the global context.

@beeme1mr I have set this up. In this scenario, it will update both <TestComponents />. Is that the expected behaviour?

I'd like a test that ensures that updating context in the nested component updates the global context and not the domain scoped context. The other component probably isn't necessary in the test.

The reason I'm asking is it seems like something is wrong, shouldn't domain scoped children be unchanged even if the global context changes?

Yes, you're correct. Is there something wrong with my example?

See: https://github.com/open-feature/js-sdk/pull/1031/files#r1801753490

@toddbaert adding a property to set global or not doesn't solve the issue I brought up though.

I've added a test with the global context having a different flag key and variants than the domain scoped one. The domain and global provider context evaluators both listen to user === 'bob@flags.com', but now only the global context flag variant changes instead of both global and domain scoped.

When the providers are the same (same flag keys and variants) they both update when global context is nested under domain context. Did I find a bug or is this desired behaviour?

I'm not 100% sure I understand your last comment. But I can confirm what @beeme1mr said here:

Basically, domain-scoped context is only managed separately if it's explicitly set for the domain.

Basically, if you don't set a context for domain X, it will use the default context. If you DO set a context for domain X, it uses that context (this is analogous to how providers are bound to domains as well. Does that clear things up?

My point about the option was somewhat separate: just that users might want to update either of these from their component, and either is valid.

i think you cleared it up! i think testing is all set then unless we need more cases.

Yes, looks that way to me.

packages/react/src/provider/use-context-mutator.ts

lukas-reining

Looks good, thank you! :)
I left one comment to be considered.

packages/react/src/provider/use-context-mutator.ts

…ange Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Will C. <iam@willchou.dev>

Signed-off-by: Will Chou <w.chou06@gmail.com>

packages/react/src/provider/use-context-mutator.ts

Signed-off-by: Will Chou <w.chou06@gmail.com>

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>

toddbaert

LGTM @wichopy ! Thanks so much! I might make some additional small doc changes before we release, and we have some other features soon ready so I'll wait until they are all done, but this will be released soon.

Minor refactors, but mostly adding js-doc after #1031. --------- Signed-off-by: Todd Baert <todd.baert@dynatrace.com>

🤖 I have created a release *beep* *boop* --- ## [0.4.7](react-sdk-v0.4.6...react-sdk-v0.4.7) (2024-10-29) ### ✨ New Features * avoid re-resolving flags unaffected by a change event ([#1024](#1024)) ([b8f9b4e](b8f9b4e)) * implement tracking as per spec ([#1020](#1020)) ([80f182e](80f182e)) * use mutate context hook ([#1031](#1031)) ([ec3d967](ec3d967)) ### 🧹 Chore * add js docs for context mutator hook ([#1045](#1045)) ([def3fe8](def3fe8)) * import type lint rule and fixes ([#1039](#1039)) ([01fcb93](01fcb93)) --- 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>

wichopy requested a review from a team as a code owner October 6, 2024 18:16

beeme1mr reviewed Oct 7, 2024

View reviewed changes

packages/react/src/provider/use-context-mutator.ts Outdated Show resolved Hide resolved

wichopy commented Oct 7, 2024

View reviewed changes

packages/react/src/provider/use-context-mutator.ts Outdated Show resolved Hide resolved

wichopy force-pushed the wichopy/968 branch from 49cbc59 to 0c14d8f Compare October 8, 2024 01:52

wichopy added 6 commits October 9, 2024 14:55

feat: use mutate context hook

286ddb7

Signed-off-by: Will Chou <w.chou06@gmail.com>

js doc

83836bc

Signed-off-by: Will Chou <w.chou06@gmail.com>

handle domain and global

b360c23

Signed-off-by: Will Chou <w.chou06@gmail.com>

commets, reuse domain from context value

9c10f55

Signed-off-by: Will Chou <w.chou06@gmail.com>

set in provider

c8991f5

Signed-off-by: Will Chou <w.chou06@gmail.com>

test: the hook

f438017

Signed-off-by: Will Chou <w.chou06@gmail.com>

wichopy force-pushed the wichopy/968 branch from a7090f0 to f438017 Compare October 9, 2024 18:56

beeme1mr reviewed Oct 9, 2024

View reviewed changes

lukas-reining reviewed Oct 12, 2024

View reviewed changes

packages/react/src/provider/use-context-mutator.ts Outdated Show resolved Hide resolved

wichopy and others added 2 commits October 12, 2024 15:21

memoize the function and dont run if the object reference does not ch…

ba9081f

…ange Co-authored-by: Lukas Reining <lukas.reining@codecentric.de> Signed-off-by: Will C. <iam@willchou.dev>

fix commit

2bab15a

Signed-off-by: Will Chou <w.chou06@gmail.com>

wichopy force-pushed the wichopy/968 branch from 420c9f7 to 2bab15a Compare October 13, 2024 01:48

toddbaert reviewed Oct 15, 2024

View reviewed changes

packages/react/src/provider/use-context-mutator.ts Outdated Show resolved Hide resolved

wichopy added 2 commits October 15, 2024 22:58

apply PR comments

097e1c3

Signed-off-by: Will Chou <w.chou06@gmail.com>

test globally nested context

ed35f05

Signed-off-by: Will Chou <w.chou06@gmail.com>

beeme1mr approved these changes Oct 17, 2024

View reviewed changes

Merge branch 'main' into wichopy/968

5f9449b

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>

toddbaert requested review from lukas-reining and toddbaert October 17, 2024 16:05

toddbaert added 2 commits October 17, 2024 12:07

Update use-context-mutator.ts

57b5cb6

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>

Merge branch 'main' into wichopy/968

232c174

toddbaert approved these changes Oct 17, 2024

View reviewed changes

toddbaert merged commit ec3d967 into open-feature:main Oct 17, 2024
6 of 8 checks passed

openfeaturebot mentioned this pull request Oct 17, 2024

chore(main): release react-sdk 0.4.7 #1028

Merged

toddbaert mentioned this pull request Oct 17, 2024

chore: add js docs for context mutator hook #1045

Merged

beeme1mr mentioned this pull request Oct 17, 2024

chore: add wichopy to org open-feature/community#400

Merged

toddbaert added a commit that referenced this pull request Oct 17, 2024

chore: add js docs for context mutator hook (#1045)

def3fe8

Minor refactors, but mostly adding js-doc after #1031. --------- Signed-off-by: Todd Baert <todd.baert@dynatrace.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: use mutate context hook #1031

feat: use mutate context hook #1031

wichopy commented Oct 6, 2024

beeme1mr commented Oct 7, 2024

beeme1mr Oct 9, 2024

wichopy Oct 11, 2024 •

edited

Loading

beeme1mr Oct 11, 2024

wichopy Oct 12, 2024 •

edited

Loading

beeme1mr Oct 13, 2024

toddbaert Oct 15, 2024

wichopy Oct 16, 2024 •

edited

Loading

toddbaert Oct 16, 2024

wichopy Oct 16, 2024

toddbaert Oct 17, 2024

lukas-reining left a comment

toddbaert left a comment

feat: use mutate context hook #1031

feat: use mutate context hook #1031

Conversation

wichopy commented Oct 6, 2024

This PR

Related Issues

Notes

Follow-up Tasks

How to test

beeme1mr commented Oct 7, 2024

beeme1mr Oct 9, 2024

Choose a reason for hiding this comment

wichopy Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

beeme1mr Oct 11, 2024

Choose a reason for hiding this comment

wichopy Oct 12, 2024 • edited Loading

Choose a reason for hiding this comment

beeme1mr Oct 13, 2024

Choose a reason for hiding this comment

toddbaert Oct 15, 2024

Choose a reason for hiding this comment

wichopy Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

toddbaert Oct 16, 2024

Choose a reason for hiding this comment

wichopy Oct 16, 2024

Choose a reason for hiding this comment

toddbaert Oct 17, 2024

Choose a reason for hiding this comment

lukas-reining left a comment

Choose a reason for hiding this comment

toddbaert left a comment

Choose a reason for hiding this comment

wichopy Oct 11, 2024 •

edited

Loading

wichopy Oct 12, 2024 •

edited

Loading

wichopy Oct 16, 2024 •

edited

Loading