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

Migrate graphql playground to graphiQL #2160

Closed
dctalbot opened this issue Feb 14, 2022 · 1 comment · Fixed by #2210
Closed

Migrate graphql playground to graphiQL #2160

dctalbot opened this issue Feb 14, 2022 · 1 comment · Fixed by #2210
Assignees
Labels
enhancement New feature or request

Comments

@dctalbot
Copy link
Contributor

What problem would you like to solve? Please describe:
GraphQL playground is being retired in favor of graphiQL

Describe the solution you'd like:
Replace graphql Playground with graphiQL.

Additional context:

  • We should also implement an SRI check on the resource, a security mechanism that is missing today.
  • It's also possible to bundle the dependency client-side now that we are running everything in one container, but IMO we should only do so if we can split it into its own chunk so it doesn't bloat the main UI.
  • This would be a big change for existing users, so maybe some communication is needed there.
@dctalbot dctalbot added the enhancement New feature or request label Feb 14, 2022
@mastercactapus
Copy link
Member

I think long-term we should build it in as a separate bundle that is within GoAlert, but maybe that step would be better after esbuild -- the UI build already takes too long.

In the interim I think a small PR with the SRI attributes with today's code would be good, and then apply the same with the change to graphiQL. Whenever esbuild or whatever build-speed solution we land on gets in, we'll maybe add this to it.

As for the change to users, I think we're safe as long as:

  • The URL (/api/graphql/explore) remains the same
  • The current user session/auth & endpoint to the current server remains the same
  • There's an editing pane and schema docs available in an obvious way

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants