You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR updates Response Caching to support connectors.
A key thing to understand about the design of this PR is that it is handled as two different steps in 2 different service layers: ConnectorService and ConnectorRequestService.
The reason why is because in order to support partial cache hits on batch entity requests, we have to modify the list of entity ids before the batch http request was constructed, meaning we have to do logic in ConnectorService.
So as a result, there is logic spread across both services.
Additionally, I had to implement a custom de-serializer for the invalidation endpoint because of wanting to support a combination of both subgraph and connector specific attributes on the incoming JSON object.
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices. ↩
Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩
This pull request updates the documentation to align with style guide standards. Key changes include reframing instructions to be reader-centric and imperative, treating Apollo Connectors as a plural subject, and adopting an authoritative, opinionated voice for recommendations. Structural updates involve converting conceptual headings to gerunds or nouns, while linguistic refinements include using active voice, present tense, and code font for technical terms like localhost. Additionally, formatting was improved by removing non-descriptive link text, applying the Oxford comma, and eliminating unnecessary articles before product names.
This review is AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates Response Caching to support connectors.
A key thing to understand about the design of this PR is that it is handled as two different steps in 2 different service layers: ConnectorService and ConnectorRequestService.
The reason why is because in order to support partial cache hits on batch entity requests, we have to modify the list of entity ids before the batch http request was constructed, meaning we have to do logic in
ConnectorService.So as a result, there is logic spread across both services.
Additionally, I had to implement a custom de-serializer for the invalidation endpoint because of wanting to support a combination of both subgraph and connector specific attributes on the incoming JSON object.
None Cached Request Cache Debugger:
Cached Request Cache Debugger:
Invalidating by cache tag:
curl --request POST \ --header 'authorization: my-secret-key' \ --header 'content-type: application/json' \ --url http://localhost:4000/invalidation \ --data '[{"kind":"cache_tag","sources":["connector-graph.random_person_api"],"cache_tag":"test-1"}]' {"count":1}%Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
Exceptions
Note any exceptions here
Notes
Footnotes
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
A lot of (if not most) features benefit from built-in observability and
debug-level logs. Please read this guidance on metrics best-practices. ↩Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩