graphql-tools

graphql-tools copied to clipboard

🚨 IMPORTANT: Please do not create a Pull Request without creating an issue first.

Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.

Description

When using batchDelegateToSchema, the cacheKey for fetching a memoized loader is created using either the requested field name (for fields returning scalars) or the field name + selection set (for fields returning composites). When using this in conjunction with non-key arguments (for instance via argsFromKeys), those arguments do not effect the cacheKey. Thus, delegating the same field multiple times with different arguments only ever result in one delegation.

The proposed fix changes the cacheKey construction. Instead of using only the selectionSet of a composite field node, it uses the entire field node (with the alias redacted). This goes for composite fields as well as scalar fields since both of them could be delegating with non-key arguments.

It seems to solve the issue (see cacheByArguments.test.ts for a test that fails using the old cacheKey construction method, that now passes). However, there might be nuances to delegation that I am missing (for instance, when would there ever be more than one field node in fieldNodes?).

Please have a look and see if my proposal makes sense to you.

Related to #5188

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• [ ] packages/batch-delegate/tests/cacheByArguments.test.ts (bug resolution)
• [ ] packages/batch-delegate/tests/basic.example.test.ts (new test to verify that resolver function call amount for batch delegations without non-key arguments is still 1, even if the same field is used multiple times with different aliases)

Test Environment:

• OS:
• @graphql-tools/batch-delegate: 8.4.25
• NodeJS: v16.13.2

Checklist:

• [x] I have followed the CONTRIBUTING doc and the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests and linter rules pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules

⚠️ No Changeset found

Latest commit: 071ac34c8dc0645e9e5f1de729c616ae7a96dddc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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