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

Operational/tooling work for GraphQL #952

Closed
awilcoxa opened this issue Feb 25, 2019 · 0 comments · Fixed by #1004
Closed

Operational/tooling work for GraphQL #952

awilcoxa opened this issue Feb 25, 2019 · 0 comments · Fixed by #1004
Assignees
Labels
m2 > 2.3.0 Requires Magento > 2.3.0 functionality.

Comments

@awilcoxa
Copy link

awilcoxa commented Feb 25, 2019

As a developer working with PWA Studio, I want to know when breaking changes occur with GraphQL in order to address any incompatibility or breaking changes. We should provide clear messaging/errors to developers regarding where and how to resolve.

possible solution: migrate Magento version aware query validation tools into buildpack.

Acceptance Criteria:

  1. Build includes validation step which displays schema problems
  2. Smart error message detects when schema breakage is probably from Magento upgrades
  3. Ditto ditto ditto from custom attributes

Out of Scope:

  1. Run-time messaging / validation (we should open a new ticket)
@cherdman cherdman added this to the Magento 2.3.1 Release milestone Feb 26, 2019
@awilcoxa awilcoxa added the m2 > 2.3.0 Requires Magento > 2.3.0 functionality. label Feb 27, 2019
@supernova-at supernova-at assigned supernova-at and unassigned zetlen Mar 1, 2019
supernova-at added a commit that referenced this issue Mar 8, 2019
Created a new project / repository called graphql-cli-validate-queries that - based on configuration - goes through all of a project's
GraphQL queries and runs them against an endpoint's schema.

Updates venia-concept to use this new extension and the graphql-cli tool in general.

Resolves #952.
supernova-at pushed a commit that referenced this issue Mar 13, 2019
Creates a compatibility definition file and script to generate markdown from it

Creates a graphql-cli extension to validate a project's queries

Created a new project / repository called graphql-cli-validate-queries that - based on configuration - goes through all of a project's
GraphQL queries and runs them against an endpoint's schema.

Updates venia-concept to use this new extension and the graphql-cli tool in general.

Resolves #952.

Fixes the format of the graphql/template-strings eslint rule

Adds script to dev-docs to auto-generate the magento compatibility table

Adds a README to the graphql-cli-validate-queries  project

Adds unit tests to graphql-cli-validate-queries plugin.

Installs and wires up Jest for unit testing the validate-queries plugin.

Fixed typo mistakes. (#993)

* Fixed typo mistakes

* Fixed typo mistakes

chore: remove duplicate padding property (#941)

[BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear (#961)

* [BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear

Removes invalid TODO in graphql-cli-validate-queries/index.js

Adds a JSDoc comment block to the getValidator function in graphql-cli-validate-queries

Cleans up the devdoc draft for validate-queries plugin

Adds a PWA-specific summarization to the end of the validate-queries command.

Adds a new script summarize-validate-queries.js to venia-concept
Runs this script at the end of the validate-queries script
This script uses the compatibility table to clue developers to compatibility issues and how to resolve them

Runs prettier

Removes use of reserved word in summarize-validate-queries.js

Create compatibility table page (#1016)

* Fix auto-generated table markdown and re-order versions to list the latest version first

* Incorporate build-compatibility table script into build process

* Create a page to display the compatibility table

* Update pwa-devdocs/src/technologies/magento-compatibility/index.md

Co-Authored-By: jcalcaben <jcalcaben@users.noreply.github.com>

Updates the path to the compatibility table on the docs site

Updates the wording around the reporting of version specifics and compatibility in the summarize-validate-queries script

Runs prettier and updates summarize-validate-queries.

Fixes dependencies and includes plugin in root jest test.

The graphql-cli-validate-magento-pwa-queries plugins tests are now run as part of the root test command.
This ensures that breaking tests in this project will fail the prepush check.

Cleans up yarn.lock changes by selectively installing dependencies via yarn workspace add commands.

Renames plugin to be more magento and pwa specific.

Runs prettier

Removes unneeded summary script file

Updates the dev docs for the graphql-cli plugin
supernova-at pushed a commit that referenced this issue Mar 13, 2019
Creates a compatibility definition file and script to generate markdown from it

Creates a graphql-cli extension to validate a project's queries

Created a new project / repository called graphql-cli-validate-queries that - based on configuration - goes through all of a project's
GraphQL queries and runs them against an endpoint's schema.

Updates venia-concept to use this new extension and the graphql-cli tool in general.

Resolves #952.

Fixes the format of the graphql/template-strings eslint rule

Adds script to dev-docs to auto-generate the magento compatibility table

Adds a README to the graphql-cli-validate-queries  project

Adds unit tests to graphql-cli-validate-queries plugin.

Installs and wires up Jest for unit testing the validate-queries plugin.

Fixed typo mistakes. (#993)

* Fixed typo mistakes

* Fixed typo mistakes

chore: remove duplicate padding property (#941)

[BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear (#961)

* [BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear

Removes invalid TODO in graphql-cli-validate-queries/index.js

Adds a JSDoc comment block to the getValidator function in graphql-cli-validate-queries

Cleans up the devdoc draft for validate-queries plugin

Adds a PWA-specific summarization to the end of the validate-queries command.

Adds a new script summarize-validate-queries.js to venia-concept
Runs this script at the end of the validate-queries script
This script uses the compatibility table to clue developers to compatibility issues and how to resolve them

Runs prettier

Removes use of reserved word in summarize-validate-queries.js

Create compatibility table page (#1016)

* Fix auto-generated table markdown and re-order versions to list the latest version first

* Incorporate build-compatibility table script into build process

* Create a page to display the compatibility table

* Update pwa-devdocs/src/technologies/magento-compatibility/index.md

Co-Authored-By: jcalcaben <jcalcaben@users.noreply.github.com>

Updates the path to the compatibility table on the docs site

Updates the wording around the reporting of version specifics and compatibility in the summarize-validate-queries script

Runs prettier and updates summarize-validate-queries.

Fixes dependencies and includes plugin in root jest test.

The graphql-cli-validate-magento-pwa-queries plugins tests are now run as part of the root test command.
This ensures that breaking tests in this project will fail the prepush check.

Cleans up yarn.lock changes by selectively installing dependencies via yarn workspace add commands.

Renames plugin to be more magento and pwa specific.

Runs prettier

Removes unneeded summary script file

Updates the dev docs for the graphql-cli plugin
zetlen pushed a commit that referenced this issue Mar 15, 2019
* Creates a graphql-cli plugin package called validate-magento-pwa-queries

Creates a compatibility definition file and script to generate markdown from it

Creates a graphql-cli extension to validate a project's queries

Created a new project / repository called graphql-cli-validate-queries that - based on configuration - goes through all of a project's
GraphQL queries and runs them against an endpoint's schema.

Updates venia-concept to use this new extension and the graphql-cli tool in general.

Resolves #952.

Fixes the format of the graphql/template-strings eslint rule

Adds script to dev-docs to auto-generate the magento compatibility table

Adds a README to the graphql-cli-validate-queries  project

Adds unit tests to graphql-cli-validate-queries plugin.

Installs and wires up Jest for unit testing the validate-queries plugin.

[BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear (#961)

* [BUGFIX] [ISSUE-958] Autocomplete renders loading component on clear

Removes invalid TODO in graphql-cli-validate-queries/index.js

Adds a JSDoc comment block to the getValidator function in graphql-cli-validate-queries

Cleans up the devdoc draft for validate-queries plugin

Adds a PWA-specific summarization to the end of the validate-queries command.

Adds a new script summarize-validate-queries.js to venia-concept
Runs this script at the end of the validate-queries script
This script uses the compatibility table to clue developers to compatibility issues and how to resolve them

Runs prettier

Removes use of reserved word in summarize-validate-queries.js

Create compatibility table page (#1016)

* Fix auto-generated table markdown and re-order versions to list the latest version first

* Incorporate build-compatibility table script into build process

* Create a page to display the compatibility table

* Update pwa-devdocs/src/technologies/magento-compatibility/index.md

Co-Authored-By: jcalcaben <jcalcaben@users.noreply.github.com>

Updates the path to the compatibility table on the docs site

Updates the wording around the reporting of version specifics and compatibility in the summarize-validate-queries script

Runs prettier and updates summarize-validate-queries.

Fixes dependencies and includes plugin in root jest test.

The graphql-cli-validate-magento-pwa-queries plugins tests are now run as part of the root test command.
This ensures that breaking tests in this project will fail the prepush check.

Cleans up yarn.lock changes by selectively installing dependencies via yarn workspace add commands.

Renames plugin to be more magento and pwa specific.

Runs prettier

Removes unneeded summary script file

Updates the dev docs for the graphql-cli plugin

* Updates graphql-cli-validate-magento-pwa-queries README with supported options

* Bumps GraphQL plugin to version 1.0.0, updates dependencies

* Updates version error messaging in graphql-cli plugin for clarity

* Updates Venia dependencies to install graphql-cli-validate-magento-pwa-queries from the registry instead of the local file system

* Fixes markdown table formatting in graphql-cli-validate-magento-pwa-queries README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
m2 > 2.3.0 Requires Magento > 2.3.0 functionality.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants