Ability to dynamically match mocks #6701

prowe · 2020-07-26T02:43:47Z

This PR provides the functionality outlined in apollographql/apollo-feature-requests#245

It adds support for a new property MockedResponse.variableMatcher that is a function that takes variables and returns if they should match for this mock. A user cannot specify both this property as well as response.variables in the same mock.

It also passes the variables into the ResultFunction so that a function is able to use them to dynamically build a response. Passing these parameters also allows for the use of a mock for the result function and then asserting that specific variables were passed. This testing strategy results in a cleaner error message for mutations if the correct data is not passed and allows for partial matches using jests "objectContaining" and others.

My team found testing using the MockProvider to be difficult in several situations and these small changes would have greatly improved our ability to test with the ApolloClient.

apollo-cla · 2020-07-26T02:43:49Z

@prowe: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

prowe · 2020-08-24T20:12:47Z

Are there any additional steps I should take beyond reporting a feature request and opening a PR to have this looked at/discussed. This is my first Pull Request to this project so I may not be following the right process and just want to make sure i'm doing the best I can.

Thanks

brycefranzen · 2021-09-27T05:57:48Z

Is there any progress on reviewing/merging this? This would greatly help with my needs for mocking in my application.

brycefranzen

I have not ran the code, but the changes seem reasonable to me according to my knowledge of the codebase (which is minimal). Additionally, this feature is greatly needed for one of my projects, so I approve.

benjaminpearson

Agree this PR would be very helpful. Would help on a project I'm on at the moment too.

docs/source/development-testing/testing.mdx

hwillson · 2022-08-11T00:02:09Z

Thanks for this @prowe - would you or anyone else in the community be interested in rebasing this against main? This is a great change. We're revisiting our entire testing story (tracked in #9738) but until that happens, this is definitely an improvement.

Co-authored-by: Benjamin Pearson <benjaminpearson@users.noreply.github.com>

prowe · 2022-08-11T04:11:16Z

Thanks for this @prowe - would you or anyone else in the community be interested in rebasing this against main? This is a great change. We're revisiting our entire testing story (tracked in #9738) but until that happens, this is definitely an improvement.

Rebased and should be good. Let me know if there is anything else I can do to be of assistance.

eltonio450 · 2022-10-20T12:31:28Z

whoa this PR looks great! Can we already start using it ? Do you think it will land in master ?

Thank you !

jerelmiller · 2022-11-28T17:36:17Z

I think this is a solid PR and would love to get this in our 3.8 release! I've updated the base branch to our release-3.8 branch. I'll take a crack at getting the conflicts resolved.

jerelmiller · 2022-11-28T18:01:22Z

Hey @prowe! Would you be willing to rebase this against our release-3.8 branch? I've attempted to do this myself, but there are enough changes that I'm afraid I'd butcher your PR in doing so. I'd be happy to get this approved/merged once we are able to get this PR up-to-date and passing tests!

…into dynamic-mock-filters

changeset-bot · 2023-08-17T04:12:17Z

🦋 Changeset detected

Latest commit: de539a0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@apollo/client	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

bignimbus · 2023-08-17T04:14:21Z

I attempted to resolve the merge conflicts here. I'll self-review this later in the week and add a changeset file as well.

src/testing/react/__tests__/MockedProvider.test.tsx

bignimbus · 2023-08-20T02:42:35Z

docs/source/development-testing/testing.mdx

@@ -150,6 +150,42 @@ it("renders without error", async () => {

 </ExpansionPanel>

+### Dynamic variables


This file has been updated several times since this PR was first opened. Some updates were warranted, I tried not to take too many liberties. Critical feedback is welcome 🙏🏻

bignimbus · 2023-08-20T02:44:33Z

src/testing/core/mocking/mockLink.ts

@@ -94,6 +97,9 @@ export class MockLink extends ApolloLink {
      if (equal(requestVariables, mockedResponseVars)) {
        return true;
      }
+      if (res.variableMatcher && res.variableMatcher(operation.variables)) {


This was one of the conflict areas that was a bit murkier to resolve. I believe this logic is correct since we still want to return true on an exact match first. The tests pass, but a skeptical eye would be helpful here.

alessbell · 2023-08-24T18:50:56Z

/release:pr

github-actions · 2023-08-24T18:52:36Z

A new release has been made for this PR. You can install it with npm i @apollo/client@0.0.0-pr-6701-20230824185144.

brycefranzen · 2023-09-13T16:45:01Z

How are things looking here? I see we have a PR release we can use now 🙌🏼 ... Any progress on getting this reviewed/merged so it can be released with v3.9?

alessbell · 2023-09-15T19:48:59Z

How are things looking here? I see we have a PR release we can use now 🙌🏼 ... Any progress on getting this reviewed/merged so it can be released with v3.9?

This is very close to being merged :) Hopefully next week, though I'll be out for a few days at a conference. The final to do item is fixing a TS error these changes have caused that's not being reported on CI since it's occurring in test files (we have a separate to do item to fix that). Thanks for your patience!

alessbell

Excited to get this released in our first 3.9 alpha, thanks @prowe! 🙌

…ilters

alessbell · 2023-09-19T17:40:45Z

This has been released in v3.9.0-alpha.0 🎉

prowe added 4 commits July 25, 2020 21:01

some tests

2093668

all green

2fc758a

result function is now taking variables

51d9deb

adding documentation

6528142

prowe requested a review from StephenBarlow as a code owner July 26, 2020 02:43

prowe and others added 3 commits July 25, 2020 21:45

Merge branch 'master' into dynamic-mock-filters

96087ef

Merge branch 'master' into dynamic-mock-filters

dbc13c7

reverting a settings file

e750ed0

Merge branch 'master' into dynamic-mock-filters

511b981

brycefranzen approved these changes Sep 27, 2021

View reviewed changes

benjaminpearson reviewed Jan 14, 2022

View reviewed changes

docs/source/development-testing/testing.mdx Outdated Show resolved Hide resolved

jpvajda added 🏓 awaiting-contributor-response requires input from a contributor 🔬 testing-utilities 🏓 awaiting-team-response requires input from the apollo team and removed 🏓 awaiting-contributor-response requires input from a contributor labels May 3, 2022

Update docs/source/development-testing/testing.mdx

66fbfb4

Co-authored-by: Benjamin Pearson <benjaminpearson@users.noreply.github.com>

jerelmiller changed the base branch from master to main November 22, 2022 20:39

jerelmiller changed the base branch from main to release-3.8 November 28, 2022 17:35

jerelmiller force-pushed the release-3.8 branch from ccbe0ad to 4a0bbb8 Compare December 8, 2022 17:47

alessbell force-pushed the release-3.8 branch 3 times, most recently from 8211fa6 to b863dc1 Compare December 8, 2022 21:51

bignimbus added 3 commits August 16, 2023 11:50

Merge branch 'release-3.9' of github.com:apollographql/apollo-client …

cdd8146

…into dynamic-mock-filters

Remove unintentionally re-added dead code paths

eed8127

Finish resolving test conflicts

2405722

Changeset for dynamic variable mock matching

4211375

bignimbus removed the 🏓 awaiting-contributor-response requires input from a contributor label Aug 17, 2023

bignimbus reviewed Aug 20, 2023

View reviewed changes

bignimbus requested review from jerelmiller and alessbell and removed request for StephenBarlow August 21, 2023 13:51

alessbell self-assigned this Sep 15, 2023

alessbell added 2 commits September 15, 2023 10:56

chore: fix merge conflicts

acf2da5

chore: fix type errors

a60bdd0

alessbell added 4 commits September 18, 2023 17:17

chore: fix merge conflicts

9e1242c

chore: update .api-reports/*

4ba85c0

chore: use TS in docs example

7300422

chore: update api-report-testing_core.md

0736062

alessbell approved these changes Sep 19, 2023

View reviewed changes

Merge remote-tracking branch 'origin/release-3.9' into dynamic-mock-f…

de539a0

…ilters

alessbell merged commit 8d2b4e1 into apollographql:release-3.9 Sep 19, 2023
17 checks passed

github-actions bot mentioned this pull request Sep 19, 2023

Version Packages (alpha) #11210

Merged

alessbell mentioned this pull request Sep 19, 2023

Release 3.9.0 #11220

Merged

alessbell mentioned this pull request Sep 19, 2023

Feature request 241: reuse mocks in MockLink / MockedProvider #11178

Merged

github-actions bot locked as resolved and limited conversation to collaborators Oct 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ability to dynamically match mocks #6701

Ability to dynamically match mocks #6701

prowe commented Jul 26, 2020

apollo-cla commented Jul 26, 2020

prowe commented Aug 24, 2020

brycefranzen commented Sep 27, 2021

brycefranzen left a comment

benjaminpearson left a comment

hwillson commented Aug 11, 2022

prowe commented Aug 11, 2022

eltonio450 commented Oct 20, 2022

jerelmiller commented Nov 28, 2022

jerelmiller commented Nov 28, 2022

changeset-bot bot commented Aug 17, 2023 •

edited

bignimbus commented Aug 17, 2023

bignimbus Aug 20, 2023

bignimbus Aug 20, 2023

alessbell commented Aug 24, 2023

github-actions bot commented Aug 24, 2023

brycefranzen commented Sep 13, 2023

alessbell commented Sep 15, 2023

alessbell left a comment

alessbell commented Sep 19, 2023

		@@ -150,6 +150,42 @@ it("renders without error", async () => {

		</ExpansionPanel>

		### Dynamic variables

Ability to dynamically match mocks #6701

Ability to dynamically match mocks #6701

Conversation

prowe commented Jul 26, 2020

apollo-cla commented Jul 26, 2020

prowe commented Aug 24, 2020

brycefranzen commented Sep 27, 2021

brycefranzen left a comment

Choose a reason for hiding this comment

benjaminpearson left a comment

Choose a reason for hiding this comment

hwillson commented Aug 11, 2022

prowe commented Aug 11, 2022

eltonio450 commented Oct 20, 2022

jerelmiller commented Nov 28, 2022

jerelmiller commented Nov 28, 2022

changeset-bot bot commented Aug 17, 2023 • edited

🦋 Changeset detected

bignimbus commented Aug 17, 2023

bignimbus Aug 20, 2023

Choose a reason for hiding this comment

bignimbus Aug 20, 2023

Choose a reason for hiding this comment

alessbell commented Aug 24, 2023

github-actions bot commented Aug 24, 2023

brycefranzen commented Sep 13, 2023

alessbell commented Sep 15, 2023

alessbell left a comment

Choose a reason for hiding this comment

alessbell commented Sep 19, 2023

changeset-bot bot commented Aug 17, 2023 •

edited