Support Apollo Federation 2 #2251

greguintow · 2022-06-16T21:43:24Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

What is the current behavior?

Issue Number: #2141

This also fixes:

Federation Directive on Entity class means fields are missing when using recent graphql dependencies. #2231

What is the new behavior?

Allows to add a property called useFed2 inside autoSchemaFile that will make the necessary schema changes to be considered a federation 2 schema:
https://github.com/greguintow/nestjs-graphql/blob/cb6090d766c78af96a628358c10d7efaca61ba9e/packages/apollo/tests/code-first-graphql-federation2/users-service/federation-users.module.ts#L12-L14

By default will add:

extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])

But that can be customized as useFed2 type is boolean | Federation2Config

Does this PR introduce a breaking change?

Yes
No

cc @trevor-scheer @hwillson

ChrisBates · 2022-06-17T10:42:42Z

As a suggestion, get rid of useFed2 and turn autoSchemaFile into boolean | SchemaFileConfig

Then SchemaFileConfig can be configurable to the role of the server - standard GQL, Federation Gateway, Subgraph, version, and whatever else might appear in the future.

Handle a autoShemaFile: true to default to the current standard functionality, and now there's a proper way to handle future changes.

kamilmysliwiec · 2022-06-23T08:29:34Z

Thanks for your contribution @greguintow. I think @ChrisBates suggestion about using the autoSchemaFile makes sense & is more future-proof. Could you apply this change? 🤞

greguintow · 2022-06-23T17:05:48Z

Thanks for your contribution @greguintow. I think @ChrisBates suggestion about using the autoSchemaFile makes sense & is more future-proof. Could you apply this change? 🤞

Thanks @kamilmysliwiec and @ChrisBates , I'll make the changes shortly

greguintow · 2022-06-23T17:45:11Z

@kamilmysliwiec @ChrisBates I've finished the changes, please review it!

Teagan42 · 2022-06-25T06:42:08Z

packages/graphql/lib/interfaces/schema-file-config.interface.ts

+      extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])
+   * ```
+  */
+  useFed2?: UseFed2Value;


Not to be pedantic- but wouldn't federationVersion?: FederationVersion (an enum or similar) be more flexible to future changes?

@Teagan42 I think that we wouldn't have such a big change as we had with apollo federation 2 vs 1 in any near future. Due to to how is setup, I think would be best to just be like that

I agree with @Teagan42 - we don't know what the future brings, but we know for certain that Fed V2 won't be the latest version forever and we'll eventually need to deprecate a useFed2 property. At least federationVersion can have the default updated to adopt the current version, and overwritten for backward compatibility (where people need it).

In order to accommodate future changes, using a scalable/flexible pattern will shield the project from having to do deep refactoring. I added comments to your PR with some suggestions, future contributors will be thankful if you use a factory or provider pattern instead of rigid checks.

@greguintow Let me know if you're interested in making these changes, otherwise, I'll take over! 🙌

@kamilmysliwiec I'd have time for it this weekend, if that's okay

Teagan42 · 2022-06-27T04:43:37Z

packages/apollo/tests/code-first-graphql-federation2/users-service/federation-users.module.ts

+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloFederationDriver,
+      autoSchemaFile: {
+        useFed2: true,


[Change Request] federationVersion: 2

Teagan42 · 2022-06-27T04:45:28Z

packages/apollo/tests/jest-e2e.ts

@@ -10,6 +10,7 @@ const config: Config.InitialOptions = {
  moduleFileExtensions: ['js', 'json', 'ts'],
  rootDir: '../.',
  testRegex: '.spec.ts$',
+  testPathIgnorePatterns: ['.fed2-spec.ts$'],


[Change Request] .fed.$versions-spec.ts

Teagan42 · 2022-06-27T04:48:32Z

packages/graphql/lib/federation/graphql-federation.factory.ts


+    const isApolloSubgraph2 = Number(apolloSubgraphVersion.split('.')[0]) >= 2;


[Change Request]
const apolloSubgraphVersion = Number(...)

[Suggestion]
const apolloSubgraphVersion = Number(/^(\d+)\..*/)

Teagan42 · 2022-06-27T04:49:51Z

packages/graphql/lib/federation/graphql-federation.factory.ts

@@ -105,9 +114,49 @@ export class GraphQLFederationFactory {
      options,
      this.resolversExplorerService.getAllCtors(),
    );
+    let typeDefs = isApolloSubgraph2


[Suggestion] SchemaPrinterFactory(version: number)

Teagan42 · 2022-06-27T04:51:10Z

packages/graphql/lib/federation/graphql-federation.factory.ts

+
+    const useFed2 = getFederation2Info(options.autoSchemaFile);
+
+    if (useFed2 && isApolloSubgraph2) {


[Change Request] Pattern does not scale, implement a factory or mapping

Teagan42 · 2022-06-27T04:52:03Z

packages/graphql/lib/federation/graphql-federation.factory.ts

    options: T,
    resolvers: Function[],
  ) {
    const scalarsMap = this.scalarsExplorerService.getScalarsMap();
    try {
      const buildSchemaOptions = options.buildSchemaOptions || {};
+      const useFed2 = getFederation2Info(options.autoSchemaFile);


[Change Request] FederatedDirectivesProvider(version: number)

Teagan42 · 2022-06-27T04:59:31Z

packages/graphql/lib/interfaces/schema-file-config.interface.ts

+  as: string;
+}
+
+export interface Federation2Config {


[Change Request] Utilize type composition

type FederationConfig1 = boolean type FederationConfig2 = { ... } type FederationConfig = FederationConfig1 | FederationConfig2

Teagan42 · 2022-06-27T05:00:10Z

packages/graphql/lib/interfaces/schema-file-config.interface.ts

+      extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])
+   * ```
+  */
+  useFed2?: UseFed2Value;


[Change Request] federationConfig: FederationConfig

Teagan42 · 2022-06-27T05:00:34Z

packages/graphql/lib/utils/auto-schema-file.util.ts

+import { isString, isObject } from '@nestjs/common/utils/shared.utils';
+import { AutoSchemaFileValue, UseFed2Value } from '../interfaces';
+
+export function getPathForAutoSchemaFile(


[Change Request] Factory or Provider pattern

cristian-moreno-ruiz · 2022-07-14T16:58:21Z

Can't get a federation working currently, are there any news on this PR? Which are the latest versions I can use to make a federated graph work with nestjs otherwise?

NeutronScott12 · 2022-07-15T12:26:20Z

Can't get a federation working currently, are there any news on this PR? Which are the latest versions I can use to make a federated graph work with nestjs otherwise?

I use "@apollo/federation": "^0.36.1", "@nestjs/graphql": "^10.0.18", "graphql": "^15.7.2", you have to avoid apollo federation 2 packages and not go above 15.7 in graphql.

cristian-moreno-ruiz · 2022-07-15T13:17:53Z

Can't get a federation working currently, are there any news on this PR? Which are the latest versions I can use to make a federated graph work with nestjs otherwise?

I use "@apollo/federation": "^0.36.1", "@nestjs/graphql": "^10.0.18", "graphql": "^15.7.2", you have to avoid apollo federation 2 packages and not go above 15.7 in graphql.

Turns out I was using @apollo/subgraph: 2.0.5, looks like this was the issue, thanks!

hwillson · 2022-07-18T10:15:11Z

@NeutronScott12 @cristian-moreno-ruiz just to note, @apollo/federation is an older package and doesn't support Federation 2. It will work for now as along as you aren't using Federation 2 specific features. @apollo/subgraph is the new Federation 2 package which this PR will add support for.

kamilmysliwiec · 2022-07-19T06:55:12Z

@greguintow Let me know if you're busy and if so, I'll take over & address the proposed changes! 🙌

greguintow · 2022-07-19T16:58:21Z

@greguintow Let me know if you're busy and if so, I'll take over & address the proposed changes! 🙌

@kamilmysliwiec Yeah, I'm busy at the moment, please take over

ProductOfAmerica · 2023-03-05T18:50:02Z

I'm so confused... is this working or not? Documentation says it should "just work" by using federation: 2, yet I'm getting this error: ERROR GraphQLSchemaValidationError: Unknown directive "@link".

Edit: Fixed by adding the @apollo/subgraph package. Whoops!

greguintow added 13 commits June 15, 2022 12:15

feat: add support for federation 2

03eb37e

fix: always print federated schema with directives

dc10a21

fix: check if subgraph is version 2 before generating type defs

6d46d0e

chore: update package version

df1f85e

fix: apollo subgraph version import

1c1898b

feat: check if is trying to use fed2 without apollo subgraph 2

d873051

feat: create util func to stringify object without quotes in props

68405e8

feat: allow to use alias directives for import in federation 2

6c360b9

fix: resolve reference not working for federation 2

60ccd20

feat: create e2e tests for federation 2

a4be311

chore: remove fed2 tests from jest-e2e

787f443

Merge branch 'nestjs:master' into feat/add-fed2-support

93d206c

chore: revert package changes

87cdb1c

This was referenced Jun 16, 2022

Support for Apollo Federation 2 #2141

Closed

Federation Directive on Entity class means fields are missing when using recent graphql dependencies. #2231

Closed

greguintow added 4 commits June 23, 2022 14:38

feat: create schema file config interface and migrate use fed2 to it

d6b77b9

feat: create util functions for auto schema file config

d9f7446

refactor: use fed2 implementation due to changes

14f97bc

refactor: federation 2 tests due to use fed2 changes

cb6090d

Teagan42 reviewed Jun 25, 2022

View reviewed changes

Teagan42 suggested changes Jun 27, 2022

View reviewed changes

kamilmysliwiec merged commit c4d1123 into nestjs:master Jul 20, 2022

kamilmysliwiec added enhancement apollo feature and removed enhancement labels Jul 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Apollo Federation 2 #2251

Support Apollo Federation 2 #2251

greguintow commented Jun 16, 2022 •

edited

ChrisBates commented Jun 17, 2022

kamilmysliwiec commented Jun 23, 2022

greguintow commented Jun 23, 2022

greguintow commented Jun 23, 2022

Teagan42 Jun 25, 2022 •

edited

greguintow Jun 25, 2022

ChrisBates Jun 27, 2022

Teagan42 Jun 27, 2022 •

edited

kamilmysliwiec Jul 8, 2022

greguintow Jul 11, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022 •

edited

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

Teagan42 Jun 27, 2022

cristian-moreno-ruiz commented Jul 14, 2022

NeutronScott12 commented Jul 15, 2022

cristian-moreno-ruiz commented Jul 15, 2022

hwillson commented Jul 18, 2022

kamilmysliwiec commented Jul 19, 2022

greguintow commented Jul 19, 2022

ProductOfAmerica commented Mar 5, 2023 •

edited


		const isApolloSubgraph2 = Number(apolloSubgraphVersion.split('.')[0]) >= 2;


		const useFed2 = getFederation2Info(options.autoSchemaFile);

		if (useFed2 && isApolloSubgraph2) {

Support Apollo Federation 2 #2251

Support Apollo Federation 2 #2251

Conversation

greguintow commented Jun 16, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

ChrisBates commented Jun 17, 2022

kamilmysliwiec commented Jun 23, 2022

greguintow commented Jun 23, 2022

greguintow commented Jun 23, 2022

Teagan42 Jun 25, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Teagan42 Jun 27, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Teagan42 Jun 27, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cristian-moreno-ruiz commented Jul 14, 2022

NeutronScott12 commented Jul 15, 2022

cristian-moreno-ruiz commented Jul 15, 2022

hwillson commented Jul 18, 2022

kamilmysliwiec commented Jul 19, 2022

greguintow commented Jul 19, 2022

ProductOfAmerica commented Mar 5, 2023 • edited

greguintow commented Jun 16, 2022 •

edited

Teagan42 Jun 25, 2022 •

edited

Teagan42 Jun 27, 2022 •

edited

Teagan42 Jun 27, 2022 •

edited

ProductOfAmerica commented Mar 5, 2023 •

edited