Support document, variables and headers in AS Landing Page config #5711
Conversation
|
@glasser not sure how to add you here |
| @@ -37,6 +37,9 @@ interface LandingPageConfig { | |||
| graphRef?: string | undefined; | |||
| isProd?: boolean; | |||
| apolloStudioEnv?: 'staging' | 'prod'; | |||
| document?: string; | |||
There was a problem hiding this comment.
@mayakoneval Oh I think this isn't complete. You've added to the interface of "what we put in the JSON blob" but not the other interfaces above that are the actual options passed by the user to the plugin.
| <tr> | ||
| <td> | ||
|
|
||
| ###### `document` |
There was a problem hiding this comment.
This should also be documented in the production plugin section right? Probably OK to say that they have the same semantics as in this section and only take effect when graphRef is set rather than fully describing them again.
There was a problem hiding this comment.
Folks can specify a document, variables and headers for prod graphs regardless of whether they have a graphRef. If they don't pass a graphRef, the document, variables and headers will populate their Sandbox that the landing page links to rather than their registered graph.
Could you clarify this part please?
Probably OK to say that they have the same semantics as in this section and only take effect when graphRef is set rather than fully describing them again.
There was a problem hiding this comment.
Folks can specify a document, variables and headers for prod graphs regardless of whether they have a graphRef. If they don't pass a graphRef, the document, variables and headers will populate their Sandbox that the landing page links to rather than their registered graph.
I thought that if you're using the "prod graph" version of the plugin but have no graph ref then there won't be any link to Studio (Sandbox or otherwise)?
Folks can specify a document, variables and headers for prod graphs regardless of whether they have a graphRef. If they don't pass a graphRef, the document, variables and headers will populate their Sandbox that the landing page links to rather than their registered graph.
Could you clarify this part please?
Probably OK to say that they have the same semantics as in this section and only take effect when graphRef is set rather than fully describing them again.
Just saying that if you want, you don't have to repeat the same text twice in the two sections but can have the second one refer to the first. Either way's ok though.
| @@ -30,13 +30,23 @@ export interface ApolloServerPluginLandingPageProductionDefaultOptions | |||
| * accessible you may not want to display the graph ref publicly.) | |||
| */ | |||
| graphRef?: string; | |||
| /** | |||
There was a problem hiding this comment.
This is the production options but it's needed in the local options too? up at line 22?
| @@ -14,6 +14,13 @@ export interface ApolloServerPluginLandingPageDefaultBaseOptions { | |||
| * landing page. | |||
| */ | |||
| footer?: boolean; | |||
| /** | |||
| * Folks can configure their landing page to link to Studio Explorer with a | |||
There was a problem hiding this comment.
I think it might be a little confusing that this does nothing if you're in production without graph ref. Could do something fancy with & in the production options to make that work. But meh this seems fine :)
This PR supports sending a
document,variable, orheadersto Sandbox (if this is a local graph) or your graph (if this is production), and will populate them. Here is an example URL:https://studio.apollographql.com/graph/Apollo-Fullstack-Demo-o3tsz8/explorer?variant=current&document=query%20ExampleQuery%20%7B%0A%20%20me%20%7B%0A%20%20%20%20email%0A%20%20%7D%0A%20%20tripsBooked%0A%7D%0A&variables=%7B%22test1%22%3A%22hello%22%7D
Headers has a bug in studio-ui, I have a PR up for it here