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.

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/qp dry run #6656

Merged
merged 8 commits into from
Jan 28, 2025
Merged

Feat/qp dry run #6656

merged 8 commits into from
Jan 28, 2025

Conversation

lleadbet
Copy link
Contributor

Description

Duplicating #5826 (and #6635 as it's acting odd due to being a fork) to more easily rebase. This just copies the code needed for the change (specifically the plugin changes). All work done by @lennyburdette and @aaronArinder - I'm just helping get this across the line.

This PR adds a new dry-run option to the Apollo-Expose-Query-Plan header value that emits the query plans back to Studio for visualizations. This new value will only emit the query plan, and abort execution. This can be helpful for tools like rover, where query plan generation is needed but not full runtime, or for potentially prewarming query plan caches out of band.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

None; this is net new functionality.

Notes

Footnotes

  1. 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.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@lleadbet lleadbet requested review from a team as code owners January 27, 2025 21:18
Copy link
Contributor

mergify bot commented Jan 27, 2025

⚠️ The sha of the head commit of this PR conflicts with #6635. Mergify cannot evaluate rules on this PR. ⚠️

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jan 27, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed
* graphos/reference/migration/from-router-v1.mdx

Build ID: fdc6e7bef873059e2b2fe904

URL: https://www.apollographql.com/docs/deploy-preview/fdc6e7bef873059e2b2fe904

@lleadbet lleadbet mentioned this pull request Jan 27, 2025
6 tasks
Copy link
Contributor

@lennyburdette lennyburdette left a comment

Choose a reason for hiding this comment

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

LGTM! i'll refrain from approving since I wrote most of this tho

@lleadbet lleadbet changed the title Feat/qp dry un Feat/qp dry run Jan 28, 2025
@lleadbet lleadbet merged commit 3a50abb into dev Jan 28, 2025
15 checks passed
@lleadbet lleadbet deleted the feat/qp-dry-un branch January 28, 2025 17:01
@BrynCooke BrynCooke added the backport-1.x Backport this PR to 1.x label Jan 28, 2025
@BrynCooke
Copy link
Contributor

@Mergifyio refresh

Copy link
Contributor

mergify bot commented Jan 28, 2025

refresh

✅ Pull request refreshed

@BrynCooke
Copy link
Contributor

@Mergifyio backport 1.x

Copy link
Contributor

mergify bot commented Jan 28, 2025

backport 1.x

✅ Backports have been created

@mergify mergify bot mentioned this pull request Jan 28, 2025
6 tasks
lleadbet added a commit that referenced this pull request Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-1.x Backport this PR to 1.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants