Skip to content
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

feat: onSchema will be used new hook implmenetation #3209

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+49 −5
Open

feat: onSchema will be used new hook implmenetation #3209

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9cb93
feat: onSchema will be used new hook implementation
kamila-brylewska-zendesk Feb 10, 2025
014bde4
comment fixed
kamila-brylewska-zendesk Feb 10, 2025
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
5 changes: 5 additions & 0 deletions .changeset/metal-colts-begin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@apollo/gateway": minor
---

feat: onSchema will be used new hook implementation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "add onSchemaWillBeUsed hook. Consumers can use this new hook to trigger custom logic just before a new schema is passed to the Gateway executor`

3 changes: 3 additions & 0 deletions gateway-js/src/__tests__/gateway/lifecycle-hooks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ describe('lifecycle hooks', () => {
});

const mockDidUpdate = jest.fn();
const mockOnSchemaWillBeUsed = jest.fn();

const gateway = new ApolloGateway({
experimental_updateServiceDefinitions: mockUpdate,
Expand All @@ -113,6 +114,7 @@ describe('lifecycle hooks', () => {
// for testing purposes, a short pollInterval is ideal so we'll override here
gateway['pollIntervalInMs'] = 100;

gateway.onSchemaWillBeUsed(mockOnSchemaWillBeUsed);
const schemaChangeBlocker1 = resolvable();
const schemaChangeBlocker2 = resolvable();

Expand Down Expand Up @@ -154,6 +156,7 @@ describe('lifecycle hooks', () => {
// second call should have previous info in the second arg
expect(secondCall[1]!.compositionId).toEqual(expectedFirstId);

expect(mockOnSchemaWillBeUsed).toHaveBeenCalledTimes(2);
await gateway.stop();
});

Expand Down
46 changes: 41 additions & 5 deletions gateway-js/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { deprecate } from 'util';
import { createHash } from '@apollo/utils.createhash';
import type { Logger } from '@apollo/utils.logger';
import { QueryPlanCache } from '@apollo/query-planner'
import { QueryPlanCache } from '@apollo/query-planner';
import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache';
import {
GraphQLSchema,
Expand Down Expand Up @@ -47,7 +47,7 @@ import {
requestContextSpanAttributes,
operationContextSpanAttributes,
recordExceptions,
OpenTelemetryAttributeNames
OpenTelemetryAttributeNames,
} from './utilities/opentelemetry';
import { addExtensions } from './schema-helper/addExtensions';
import {
Expand Down Expand Up @@ -141,6 +141,12 @@ export class ApolloGateway implements GatewayInterface {
coreSupergraphSdl: string;
}) => void
>();
private onSchemaWillBeUsedListeners = new Set<
(schemaContext: {
apiSchema: GraphQLSchema;
coreSupergraphSdl: string;
}) => void
>();
private warnedStates: WarnedStates = Object.create(null);
private queryPlanner?: QueryPlanner;
private supergraphSdl?: string;
Expand Down Expand Up @@ -198,8 +204,8 @@ export class ApolloGateway implements GatewayInterface {
}

private initQueryPlanStore(approximateQueryPlanStoreMiB?: number) {
if(this.config.queryPlannerConfig?.cache){
return this.config.queryPlannerConfig?.cache
if (this.config.queryPlannerConfig?.cache) {
return this.config.queryPlannerConfig?.cache;
}
// Create ~about~ a 30MiB InMemoryLRUCache (or 50MiB if the full operation ASTs are
// enabled in query plans as this requires plans to use more memory). This is
Expand Down Expand Up @@ -569,6 +575,23 @@ export class ApolloGateway implements GatewayInterface {
legacyDontNotifyOnSchemaChangeListeners: boolean = false,
): void {
this.queryPlanStore.clear();

// Notify before use of new schema
this.onSchemaWillBeUsedListeners.forEach((listener) => {
try {
listener({
apiSchema: this.schema!,
coreSupergraphSdl: supergraphSdl,
});
} catch (e) {
this.logger.error(
"An error was thrown from an 'onSchemaWillBeUsed' listener. " +
'The schema will still update: ' +
((e && e.message) || e),
);
}
});

this.apiSchema = supergraph.apiSchema();
this.schema = addExtensions(this.apiSchema.toGraphQLJSSchema());

Expand Down Expand Up @@ -681,6 +704,19 @@ export class ApolloGateway implements GatewayInterface {
};
}

public onSchemaWillBeUsed(
callback: (schemaContext: {
apiSchema: GraphQLSchema;
coreSupergraphSdl: string;
}) => void,
): GatewayUnsubscriber {
this.onSchemaWillBeUsedListeners.add(callback);

return () => {
this.onSchemaWillBeUsedListeners.delete(callback);
};
}

private getOrCreateDataSource(
serviceDef: ServiceEndpointDefinition,
): GraphQLDataSource {
Expand Down Expand Up @@ -850,7 +886,7 @@ export class ApolloGateway implements GatewayInterface {
operationContext,
this.supergraphSchema!,
this.apiSchema!,
this.config.telemetry
this.config.telemetry,
);

const shouldShowQueryPlan =
Expand Down