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

Add GraphQL API #4540

Merged
merged 368 commits into from Aug 27, 2019
Merged

Add GraphQL API #4540

merged 368 commits into from Aug 27, 2019

Conversation

andris-sevcenko
Copy link
Contributor

Todo list (also in services/Gql.php)

  1. Obviously, docs for everything and every method (including exceptions thrown)
  • services/gql
  • helpers/gql
  • gql/*
  • Description for every field on GQL types. For hard-coded types this goes in type definition files. For actual Craft fields we can reuse the instructions property.
  1. Event for registering interfaces (because they get eager-loaded if prebuildSchema is set to true when building schema.)
  2. Eager-loading currently ignores the passed arguments. Some tests are borked because of that. This includes the limit argument to relation fields currently.
  3. Maybe move out token permissions to a separate service?
  4. Speaking of, maybe put the token settings somewhere else on the Craft settings page and definitely add an icon
  5. Figure out and add query complexity costs per GQL type.
  6. Configurable limits on both query complexity and nesting level.
  7. Sprinkle some cache on top (see if able to integrate with Craft template caching, as similar principles should apply - element changes invalidate a cached response and structural changes (when project config gets updated) invalidates cached responses. Cached by token by query.
  8. Pretty sure the test coverage went down with the last dev iteration - circle back and check.
  9. Tests for disabled and expired tokens.
  10. Tests for matrix blocks returning correct union types.
  11. Expose site structure over GQL as well
  12. Once (12) is in place, get rid of, say, sectionId and sectionUid fields and replace with a section type that has uid and id fields.
  13. MAYBE change all closures to static method and make schema itself cacheable per token per query.

@andris-sevcenko
Pass ResolveInfo object when resolving directives.
68d8b7b
@andris-sevcenko
Don’t attempt to transform anything unless url is asked for.
d4ef396
@andris-sevcenko
A transform fixture.
171ec7b
@andris-sevcenko
Test transforms, streamline directive tests a bit more.
acdb41d
@andris-sevcenko
Cleanup.
db55a47
@andris-sevcenko
Not needed.
de32321
@andris-sevcenko
Merge branch '3.2' into feature/graphql
294582a 
# Conflicts:
#	tests/fixtures/GlobalSetFixture.php
@andris-sevcenko
This actually tests if element type fields resolve to the correct data.
41a58d0
@andris-sevcenko
Namespaces.
08485f2
@andris-sevcenko
No more lies, man.
4836952
@andris-sevcenko
No reason for this to be protected.
a713c84
@andris-sevcenko
Add some text.
f2e41bd
@andris-sevcenko
Test field resolving on an Entry element.
026a8ea
@andris-sevcenko
Streamline and prepare for other elements.
dad1b31
@andris-sevcenko
Gracefully handle missing properties.
0bd5a92
@andris-sevcenko
Asset fields with content.
c663dd7
@andris-sevcenko
More resilience when resolving fields on Asset types.
aa15017
@andris-sevcenko
Test resolving fields on an Asset element.
8ff6426
@andris-sevcenko
Return null on invalid property.
b2078d7
@andris-sevcenko
Global sets with some data.
cd9e218
@andris-sevcenko
Single quotes.
1fc9b24
@andris-sevcenko
Test global set field resolving.
8c135ad
@andris-sevcenko
Return null instead of generic error.
cc4d65f
@andris-sevcenko
Grammar.
fd273b3
@andris-sevcenko
Better fixtures field layout support.
9a20d49
@andris-sevcenko
Better fixture data.
61acb97
@andris-sevcenko
More field resolver tests.
887b4e0
@andris-sevcenko
Keep banging on the tests.
19c6cbc
@andris-sevcenko
No ownerSiteUid property here.
a4022d7
@andris-sevcenko
Silent errors.
c9a79da
brandonkelly and others added 19 commits August 26, 2019 10:01
@brandonkelly
Merge branch 'hotfix/doclinks'
db692ad
@brandonkelly
Merge branch 'master' into develop
15c470b
@brandonkelly
Merge branch 'develop' into feature/graphql
99cfc11
@brandonkelly
More link fixes
6fb5db8
@brandonkelly
Merge branch 'hotfix/fix-docs'
f3ee1db
@angrybrad
Merge pull request #4813 from watarutmnh/patch-10
7478464 
Fix Japanese translations
@brandonkelly
Merge branch 'master' into develop
9f7bd1f 
# Conflicts:
#	docs/testing/testing-craft/testing-tips.md
@brandonkelly
Merge branch 'develop' of github.com:craftcms/cms into develop
621b234
@brandonkelly
Merge branch 'develop' into feature/graphql
ad3e859
@brandonkelly
GqlController => GraphqlController, actionIndex() => actionApi()
5506324
@brandonkelly
Only disable CSRF validation for API requests
e73fbac
@brandonkelly
Merge branch '3.3' into feature/graphql
7c91502
@brandonkelly
Refactor graphql/api + add support for application/graphql
5629d7b
@brandonkelly
Docs
16196a7
@brandonkelly
All graphq/api responses should be JSON
d993510
@brandonkelly
getSchemaByUid() now throws an exception
ce03589
@brandonkelly
getSchemaByAccessToken() now throws an exception
5e7ce42
@brandonkelly
Security enhancements
0c7fb76 
- Stop showing tokens on the Schemas page
- Stop showing tokens by default on the Edit Schema page
- Only show after clicking "Show", and only w/ elevated session
- Require elevated session to make any schema changes
- Add "Regenerate" button for tokens as well
@brandonkelly
Bump the schema version
d36d2fd
@brandonkelly
Copy link
Member

brandonkelly commented Aug 26, 2019 •
edited

For those of you that have been testing against the feature/graphql branch, we pushed a couple breaking changes today to be aware of:

  • The “tokens” concept has been renamed to “schemas”, and they are stored in a different database table now. When you get this change, your old gqltokens table will still be there, but Craft won’t use it anymore. You will need to recreate your schemas, and delete the old gqltokens table when you’re ready.

  • The gql action has been renamed to graphql/api. Update your config/routes.php file accordingly.

  • queryEntries is now entries (et al.).

@brandonkelly brandonkelly merged commit b5c1280 into 3.3 Aug 27, 2019
@brandonkelly brandonkelly deleted the feature/graphql branch August 27, 2019 00:25
brandonkelly added a commit that referenced this pull request Aug 27, 2019
@brandonkelly
Cleanup & changelog for #4540
29c908e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@monachilada monachilada monachilada left review comments

@brandonkelly brandonkelly brandonkelly approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@andris-sevcenko @monachilada @brandonkelly @Saboteur777 @angrybrad @watarutmnh