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

Move GraphQL Playground plugin to another package in this repo #6109

Closed
glasser opened this issue Feb 11, 2022 · 4 comments
Closed

Move GraphQL Playground plugin to another package in this repo #6109

glasser opened this issue Feb 11, 2022 · 4 comments
Assignees
Milestone

Comments

@glasser
Copy link
Member

glasser commented Feb 11, 2022

In AS3 we kept around a landing page plugin for GraphQL Playground to help with the migration from AS2. However, GraphQL Playground has been retired and continuing to maintain a wrapper around it doesn't seem like the best priority. We should certainly keep the flexible landing page API that we introduced in AS3, but perhaps we should change from "the apollo-server repo has a dependency on our fork of Playground and exports a plugin" to "we do a one-time publish of a separate package providing an AS4-compatible Playground landing page plugin".

@glasser glasser added this to the Release 4.0 milestone Feb 11, 2022
@glasser glasser changed the title Consider removing GraphQL Playground plugin from the main apollo-server package Move GraphQL Playground plugin to another package in this repo Jun 21, 2022
@glasser
Copy link
Member Author

glasser commented Jun 21, 2022

@apollo/server-plugin-legacy-graphql-playground ?

glasser added a commit that referenced this issue Aug 16, 2022
GraphQL Playground was unmaintained when we released Apollo Server 3,
and the Apollo Server team has had to put significant work into fixing
security issues in GraphQL Playground. While we will still publish a
landing page plugin to enable folks upgrading from AS2 to not have to
immediately retrain their users on how to use Apollo Sandbox or another
interface, we remove it from the main `@apollo/server` package and move
it to its own `@apollo/server-plugin-landing-page-graphql-playground`
package. This lets us remove the Playground HTML package's dependencies
(like `xss`) from Apollo Server's main package.

Fixes #6109.
glasser added a commit that referenced this issue Aug 16, 2022
…6817)

GraphQL Playground was unmaintained when we released Apollo Server 3,
and the Apollo Server team has had to put significant work into fixing
security issues in GraphQL Playground. While we will still publish a
landing page plugin to enable folks upgrading from AS2 to not have to
immediately retrain their users on how to use Apollo Sandbox or another
interface, we remove it from the main `@apollo/server` package and move
it to its own `@apollo/server-plugin-landing-page-graphql-playground`
package. This lets us remove the Playground HTML package's dependencies
(like `xss`) from Apollo Server's main package.

Fixes #6109.
@glasser
Copy link
Member Author

glasser commented Aug 16, 2022

Fixed on version-4 in #6109. Decided to leave 'legacy' out of the package name.

@glasser glasser closed this as completed Aug 16, 2022
@trevor-scheer
Copy link
Member

Revisit:

  • Update plugin README.
  • Don't support it.
  • Mention it in migration guide, but nowhere else.
  • Publish once only.

@trevor-scheer trevor-scheer reopened this Sep 19, 2022
trevor-scheer added a commit that referenced this issue Sep 20, 2022
Playground will be published for AS4 only as a means to facilitate
migration, but we will not promise any support for it after its initial
post-alpha/rc publish. Let's make this messaging extra clear for users.

Leaving it in the migration guide (as is its purpose) but removed it
from our API docs. I could be convinced to restore that portion but I
think I'd rather users have to jump through at least one hoop and look
at the types if they want to use it that badly.

Closes #6109
<!--
First, 🌠 thank you 🌠 for taking the time to consider a contribution to
Apollo!

Here are some important details to follow:

* ⏰ Your time is important
To save your precious time, if the contribution you are making will take
more
than an hour, please make sure it has been discussed in an issue first.
          This is especially true for feature requests!
* 💡 Features
Feature requests can be created and discussed within a GitHub Issue. Be
sure to search for existing feature requests (and related issues!) prior
to
opening a new request. If an existing issue covers the need, please
upvote
that issue by using the 👍 emote, rather than opening a new issue.
* 🔌 Integrations
Apollo Server has many web-framework integrations including Express,
Koa,
Hapi and more. When adding a new feature, or fixing a bug, please take a
peak and see if other integrations are also affected. In most cases, the
fix can be applied to the other frameworks as well. Please note that,
since new web-frameworks have a high maintenance cost, pull-requests for
new web-frameworks should be discussed with a project maintainer first.
* 🕷 Bug fixes
These can be created and discussed in this repository. When fixing a
bug,
please _try_ to add a test which verifies the fix. If you cannot, you
should
still submit the PR but we may still ask you (and help you!) to create a
test.
* 📖 Contribution guidelines
Follow
https://github.com/apollographql/apollo-server/blob/main/CONTRIBUTING.md
when submitting a pull request. Make sure existing tests still pass, and
add
          tests for all new behavior.
* ✏️ Explain your pull request
Describe the big picture of your changes here to communicate to what
your
pull request is meant to accomplish. Provide 🔗 links 🔗 to associated
issues!

We hope you will find this to be a positive experience! Open source
contribution can be intimidating and we hope to alleviate that pain as
much as possible. Without following these guidelines, you may be missing
context that can help you succeed with your contribution, which is why
we encourage discussion first. Ultimately, there is no guarantee that we
will be able to merge your pull-request, but by following these
guidelines we can try to avoid disappointment.
-->

Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@trevor-scheer
Copy link
Member

Closed via #6925

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants