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

Jump to bottom

replace experimental_defer_support with preview_defer_support and toggle defaults #1673

Closed
abernix opened this issue Sep 1, 2022 · 0 comments · Fixed by #1685
Closed

replace experimental_defer_support with preview_defer_support and toggle defaults #1673

abernix opened this issue Sep 1, 2022 · 0 comments · Fixed by #1685
Assignees
@abernix
Labels
component/defer

Comments

@abernix
Copy link
Member

abernix commented Sep 1, 2022

Now that #1659 and #1648 are in place via #1652, we can relax the requirement that the configuration option be used to enable this functionality in the Router and instead rely on the presence of the accept header from the client as agreement that they are opting into specific behavior defined on a specific date.
@abernix abernix added this to the v1.0.0-alpha.1 milestone Sep 1, 2022
@abernix abernix self-assigned this Sep 1, 2022
@abernix abernix changed the title remove configuration option for experimental_defer_support replace experimental_defer_support with preview_defer_support and toggle defaults Sep 2, 2022
abernix added a commit that referenced this issue Sep 2, 2022
@abernix
Change default and promote experimental_defer_support to `preview_d…
1d88e3a 
…efer_support`

Following up on a tremendous amount of work tracked in
#80 - which brought various
stages of `@defer` support to the Router - this changes our designation of
its status from "Experimental" to "Preview".  It's worth noting that the
specification *just* graduated to "Stage 2 (Draft)" mode in the GraphQL
Working Group, so changes may still be expected and there are two stages
ahead.  To help things progress we've:

- We've lifted the previous requirement that users opt into defer support by
  setting `experimental_defer_support: true` in the `server` section of their
  configuration.  It is now on by default.
- The option is now called `preview_defer_support` and it can be set to
  `false` to _specifically_ opt out of it existing at all.  This might be
  desired if you would prefer that it not even show up in introspection or
  be possible to use even if a client requests it.
- Using `@defer` support _requires_ clients set the appropriate HTTP
  `accept` header to use it.  This puts the burden of understanding the
  risks of an early-preview on the clients who will need to consume the
  Router's responses. This is particularly important for clients who have
  long-lived support requirements (like native mobile apps).

  To see which headers are required, see #1648.

Closes #1673
@abernix abernix mentioned this issue Sep 2, 2022
Merged
@abernix abernix mentioned this issue Sep 2, 2022
Merged
@hwillson hwillson mentioned this issue Jan 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abernix abernix

Labels
component/defer
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Change default and promote experimental_defer_support to preview_defer_support apollographql/router
1 participant
@abernix