Skip to content

Add tests validating minimum join spec version given subgraph federation version #3110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add tests validating minimum join spec version given subgraph federation version #3110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b48d864
add test cases to show min join version is used for various fed versions
trevor-scheer Aug 7, 2024
b28555e
cover all fed versions
trevor-scheer Aug 8, 2024
5384448
add a comment about why join v0.3 for fed 2.0
trevor-scheer Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions composition-js/src/__tests__/compose.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4655,6 +4655,43 @@ describe('composition', () => {
const authenticatedDirectiveExists = schema.directives().find(d => d.name === 'authenticated');
expect(authenticatedDirectiveExists).toBeUndefined();
});

describe('uses minimum required spec versions', () => {
function subgraphWithFederationSpecVersion(version: string) {
const schemaString = `
extend schema @link(url: "https://specs.apollo.dev/federation/v${version}", import: ["@key"])

type Query {
a: A
}

type A @key(fields: "id") {
id: ID!
}
`;
return {
typeDefs: gql`${schemaString}`,
name: 'subgraphA',
};
}

it.each([
{ subgraphFedVersion: "2.0", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.1", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.2", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.3", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.4", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.5", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.6", expectedJoinVersion: "0.3" },
{ subgraphFedVersion: "2.7", expectedJoinVersion: "0.4" },
{ subgraphFedVersion: "2.8", expectedJoinVersion: "0.5" },
])("federation -> join versions", ({ subgraphFedVersion, expectedJoinVersion }) => {
const subgraph = subgraphWithFederationSpecVersion(subgraphFedVersion);
const result = composeServices([subgraph]);
assertCompositionSuccess(result);
expect(result.supergraphSdl).toContain(`join/v${expectedJoinVersion}`);
});
});
});

describe('@source* directives', () => {
Expand Down
4 changes: 4 additions & 0 deletions internals-js/src/specs/joinSpec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,10 @@ export class JoinSpecDefinition extends FeatureDefinition {
export const JOIN_VERSIONS = new FeatureDefinitions<JoinSpecDefinition>(joinIdentity)
.add(new JoinSpecDefinition(new FeatureVersion(0, 1)))
.add(new JoinSpecDefinition(new FeatureVersion(0, 2)))
// Though join v0.2 supports federation v2.0 as mentioned above, we should
// still prefer join v0.3 as a minimum for all of federation v2.0-2.6 since
// v0.3 offers improvements around union members and enum values that we're
// interested in.
.add(new JoinSpecDefinition(new FeatureVersion(0, 3), new FeatureVersion(2, 0)))
.add(new JoinSpecDefinition(new FeatureVersion(0, 4), new FeatureVersion(2, 7)))
.add(new JoinSpecDefinition(new FeatureVersion(0, 5), new FeatureVersion(2, 8)));
Expand Down