Move `__resolveReference` resolvers on to `extensions` #1746

trevor-scheer · 2022-04-19T18:41:15Z

The entity __resolveReference resolver is currently placed directly
on to GraphQL*Type objects. This breaks the API, as the expectation
is to put things like this on to the extensions field of objects
contained within a GraphQLSchema.

This moves the resolver off of the object and into the extensions
where it belongs.

Fixes: #1131
Fixes: ardatan/graphql-tools#2687
Fixes: ardatan/graphql-tools#2857

cc @michael-watson @mandiwise

The entity __resolveReference resolver is currently placed directly on to GraphQL*Type objects. This breaks the API, as the expectation is to put things like this on to the `extensions` field of objects contained within a GraphQLSchema. This moves the resolver off of the object and into the extensions where it belongs. Fixes: #1131 Fixes: ardatan/graphql-tools#2687 Fixes: ardatan/graphql-tools#2857

netlify · 2022-04-19T18:41:21Z

✅ Deploy Preview for apollo-federation-docs canceled.

Name	Link
🔨 Latest commit	`d4f7b7f`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-federation-docs/deploys/626083eccc250900084fc3c8

codesandbox-ci · 2022-04-19T18:42:10Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

benweatherman

🐐

glasser · 2022-04-19T22:59:12Z

Can we make this extensions.apolloSubgraph.resolveReference? See the comments on GraphQLObjectTypeExtensions:

 * Use a unique identifier name for your extension, for example the name of
 * your library or project. Do not use a shortened identifier as this increases
 * the risk of conflicts. We recommend you add at most one extension field,
 * an object which can contain all the values you need.

queerviolet

this looks good, and looks like it would still be straightforward to implement glasser's subgraph proposal, maybe moreso, so 👍

glasser · 2022-04-20T23:05:31Z

gateway-js/src/schema-helper/addResolversToSchema.ts

+              }
+            },
+          };
+        } else if (fieldName.startsWith("__")) {
          (type as any)[fieldName.substring(2)] = fieldConfig;


@trevor-scheer is this basically just for resolveType on abstract types and isTypeOf on object types? wonder if we should just special case them (which lets us drop the type as any).

Also it looks like this entire directory (gateway-js/src/schema-helper, not to be confused with subgraph-js/src/schema-helper) is only used in tests? Can it be moved into gateway-js/src/__tests__, or maybe you can just use the version in subgraph-js directly from the tests?

glasser · 2022-04-20T23:11:25Z

gateway-js/src/typings/graphql.ts

@@ -0,0 +1,31 @@
+import { GraphQLResolveInfo } from 'graphql';
+
+type GraphQLReferenceResolver<TContext> = (


This file isn't imported from anywhere? Is it referenced in some config file that I'm missing? Why is it in gateway-js rather than subgraph-js?

oh, i see, there's a second copy in subgraph-js. well, maybe my other suggestion will let us remove the duplication. and i guess as long as a file is included in the tsconfig'd project, it doesn't have to be imported for its declare module to work?

i do wonder though — if the file's not imported from anywhere, will the declare modules work across package? ie, this file generates a .d.ts that isn't sourced from index.d.ts, will it 'take effect' in the same way that it takes effect when you're actively building the package itself?

i mean maybe it doesn't matter since this is kinda an internal implementation detail of @apollo/subgraph anyway.

Also including relevant work from #1658 to remove uses of __resolveObject

Includes relevant work from #1658 to remove uses of `__resolveObject`

# [2.0.2-alpha.0] - 2022-04-22 ## 🚀 Features - Improve fed1 schema support during composition [PR #1735](#1735) - Add gateway version to schema extensions [PR #1751](#1751) ## 🐛 Fixes - Improve merging of groups during `@require` handling in query planning [PR #1732](#1732) - Move `__resolveReference` resolvers on to `extensions` [PR #1746](#1746) - Honor directive imports when directive name is spec name [PR #1720](#1720) ## 🛠 Maintenance - Improved renovate bot auto-updates for 0.x packages [PR #1736](#1736) and [PR #1730](#1730) - Add missing `@apollo/federation-internals` dependency to gateway [PR #1721](#1721) - Migrate to `@apollo/utils` packages for `createSHA` and `isNodeLike` [PR #1765](#1765) ## 📚 Documentation - Roadmap updates! [PR #1717](#1717) - Clarify separation of concerns in the intro docs [PR #1753](#1753) - Update intro example for fed2 [PR #1741](#1741) - Improve error doc generation, add hints generation, add scrolling style to too-large error tables [PR #1740](#1740) - Update `supergraphSDL` to be a string when creating an `ApolloGateway` [PR #1744](#1744) - Federation subgraph library compatibility updates [PR #1718](#1744)

The location of `resolveReference` was updated in the `@apollo/subgraph` library to live on a type's `extensions` object. Reference: apollographql/federation#1746 apollographql/federation#1747

trevor-scheer added the ↪️ backport-to-0.x landed on 2.x, but needs to be backported to the 0.x series label Apr 19, 2022

trevor-scheer requested review from benweatherman, abernix and clenfest April 19, 2022 18:41

trevor-scheer mentioned this pull request Apr 19, 2022

Move __resolveReference resolvers on to extensions (version-0.x) #1747

Merged

benweatherman approved these changes Apr 19, 2022

View reviewed changes

queerviolet approved these changes Apr 20, 2022

View reviewed changes

trevor-scheer added 2 commits April 20, 2022 11:26

Nest extensions (and fix types accordingly)

e504e27

Namespace with apollo.subgraph

d4f7b7f

trevor-scheer merged commit 4e3c161 into main Apr 20, 2022

trevor-scheer deleted the trevor/rewire-resolveReference branch April 20, 2022 22:18

glasser reviewed Apr 20, 2022

View reviewed changes

trevor-scheer mentioned this pull request Apr 21, 2022

__resolveReference follow-ups #1757

Merged

trevor-scheer added a commit that referenced this pull request Apr 22, 2022

Followups to #1747 (transposed from followups to #1746)

112d397

Also including relevant work from #1658 to remove uses of __resolveObject

trevor-scheer added a commit that referenced this pull request Apr 22, 2022

Followups to #1747 (transposed from followups to #1746) (#1762)

9d7837d

Includes relevant work from #1658 to remove uses of `__resolveObject`

benweatherman mentioned this pull request Apr 23, 2022

Release 2.0.2-alpha.0 #1770

Merged

michael-watson mentioned this pull request Apr 25, 2022

Using @graphql-tools/mock with buildSubgraphSchema breaks _Entity #1772

Closed

benweatherman mentioned this pull request May 3, 2022

Release 2.0.2 #1822

Merged

trevor-scheer mentioned this pull request Jun 14, 2022

fix(apollo): Update resolveReference location nestjs/graphql#2245

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `__resolveReference` resolvers on to `extensions` #1746

Move `__resolveReference` resolvers on to `extensions` #1746

trevor-scheer commented Apr 19, 2022

netlify bot commented Apr 19, 2022 •

edited

Loading

codesandbox-ci bot commented Apr 19, 2022 •

edited

Loading

benweatherman left a comment

glasser commented Apr 19, 2022

queerviolet left a comment

glasser Apr 20, 2022

glasser Apr 20, 2022

glasser Apr 20, 2022

glasser Apr 20, 2022

glasser Apr 20, 2022

		@@ -0,0 +1,31 @@
		import { GraphQLResolveInfo } from 'graphql';

		type GraphQLReferenceResolver<TContext> = (

Move __resolveReference resolvers on to extensions #1746

Move __resolveReference resolvers on to extensions #1746

Conversation

trevor-scheer commented Apr 19, 2022

netlify bot commented Apr 19, 2022 • edited Loading

✅ Deploy Preview for apollo-federation-docs canceled.

codesandbox-ci bot commented Apr 19, 2022 • edited Loading

benweatherman left a comment

Choose a reason for hiding this comment

glasser commented Apr 19, 2022

queerviolet left a comment

Choose a reason for hiding this comment

glasser Apr 20, 2022

Choose a reason for hiding this comment

glasser Apr 20, 2022

Choose a reason for hiding this comment

glasser Apr 20, 2022

Choose a reason for hiding this comment

glasser Apr 20, 2022

Choose a reason for hiding this comment

glasser Apr 20, 2022

Choose a reason for hiding this comment

Move `__resolveReference` resolvers on to `extensions` #1746

Move `__resolveReference` resolvers on to `extensions` #1746

netlify bot commented Apr 19, 2022 •

edited

Loading

codesandbox-ci bot commented Apr 19, 2022 •

edited

Loading