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

Server: Remote relationships permissions #6125

Closed
wants to merge 123 commits into from
Closed

Server: Remote relationships permissions #6125

wants to merge 123 commits into from

Conversation

codingkarthik
Copy link
Contributor

@codingkarthik codingkarthik commented Nov 3, 2020 •
edited
Loading

Description

This PR implements the feature of remote relationship permissions. The permissions of a remote relationship is derived from the remote permissions configured of the said role.

This is an incremental PR on top of #6079 and should only be merged after #6079 is merged.

This PR also implements deep parsing of a remote relationship query.

Changelog

  • CHANGELOG.md is updated with user-facing content relevant to this PR. If no changelog is required, then add the no-changelog-required label.

Affected components

  • Server
  • Docs
  • Tests
  • [] CHANGELOG

Related Issues

This PR is on top of #6079

Solution and Design

Steps to test and verify

Limitations, known bugs & workarounds

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

  • No
  • Yes
    • Updated docs with SQL for downgrading the catalog

Metadata

Does this PR add a new Metadata feature?

  • No
  • Yes
    • Does run_sql auto manages the new metadata through schema diffing?
      • Yes
      • Not required
    • Does run_sql auto manages the definitions of metadata on renaming?
      • Yes
      • Not required
    • Does export_metadata/replace_metadata supports the new metadata added?
      • Yes
      • Not required

GraphQL

  • No new GraphQL schema is generated

Breaking changes

  • [] No Breaking changes
  • There are breaking changes:

Remote relationship permissions will work only if remote schema permissions are enabled in the graphql-engine.

  1. Metadata API

    Existing query types:

    • Modify args payload which is not backward compatible
    • Behavioural change of the API
    • Change in response JSON schema
    • Change in error code

  2. GraphQL API

    Schema Generation:

    • Change in any NamedType
    • Change in table field names

    Schema Resolve:-

    • Change in treatment of null value for any input fields

  3. Logging

    • Log JSON schema has changed
    • Log type names have changed

codingkarthik and others added 30 commits September 22, 2020 12:20
@codingkarthik
[WIP] add the add_remote_schema_permissions API
eec029b
@codingkarthik
add validation for directives, enums and input objects
e3c772a
@codingkarthik
add validation for interfaces, unions and object types
68f0dfa
@codingkarthik
integrate all validations into validateRemoteSchema
1d77539
@codingkarthik
refactor CustomRemoteSchema to RoleBasedSchema
170e664
@codingkarthik
add function to format the errors
9600a9c
@codingkarthik
integrate role based remote schema validation into the API
27e53ce
@codingkarthik
check for duplicate type names among the types
f57f6c3
@codingkarthik
fix object implementing interfaces validation
34a5ed9
@codingkarthik
add duplicate checks for args, fields and directives
b16f6bf
@codingkarthik
add documentation to some of the functions in Validate module
a2e3624
@codingkarthik
build remote schema context with permissions
4ceb271
@codingkarthik
modify the schema cache to include remote schema with perms
7ddc6e9
@codingkarthik
generate role based schema for each role
aa51c23
@codingkarthik
[not compiling] delete remote schema perms metadata obj
56f7a43
@rakeshkky
enable lenses for 'RemoteSchemaCtxWithPermissions' type
4f16e46
@codingkarthik
add drop_remote_schema_permissions api and include dependencies
3e1f857
@codingkarthik
Refactor SchemaDocumentTypeDefinitions to PartitionedTypeDefinitions
77d061e
@codingkarthik
minor refactoring of the RemoteSchema/Validate.hs module
c328d3a
@codingkarthik
move ParitionedTypeDefinitions to Types/RemoteSchema.hs
9d594e7
@codingkarthik
add remote schema permissions docs
4d1e47a
@codingkarthik
add feature flag to enable remote schema permissions
b71a541
@codingkarthik
don't expose remotes in unauthenticated context
2f23019 
- when remote schema permissions are enabled
@codingkarthik
add remote schema permissions in import and export metadata
56a2041
@codingkarthik
fix the haskell tests
89d5929
@codingkarthik
change permissions to be Maybe while exporting metadata
9a8a845
@codingkarthik
drop the related permissions while removing a remote schema
9e5dd5d
@codingkarthik
restrict adding remote schema permissions when permissions are not en…
c9b11de 
…abled
@codingkarthik
add a note about enabling remote schema permissions
73066a5
@codingkarthik
add CHANGELOG
a31fc86
@codingkarthik codingkarthik requested review from a team as code owners November 3, 2020 11:47
@codingkarthik codingkarthik marked this pull request as draft November 3, 2020 11:47
@netlify
Copy link

netlify bot commented Nov 3, 2020 •
edited
Loading

✔️ Deploy preview for hasura-docs ready!

🔨 Explore the source changes: 7850c48

🔍 Inspect the deploy logs: https://app.netlify.com/sites/hasura-docs/deploys/5fe1b200c015d300070ae44d

😎 Browse the preview: https://deploy-preview-6125--hasura-docs.netlify.app

@abooij abooij added the c/server Related to server label Nov 3, 2020
@codingkarthik codingkarthik force-pushed the remote-relationships-permissions branch from d21de7e to a25bafa Compare November 5, 2020 03:47
@codingkarthik codingkarthik mentioned this pull request Nov 9, 2020
Closed
30 tasks
hasura-bot added a commit that referenced this pull request Jan 19, 2021
@hasura-bot @codingkarthik
Server: Remote relationships permissions
98ccd81 
GITHUB_PR_NUMBER: 6125
GITHUB_PR_URL: #6125

Co-authored-by: Karthikeyan Chinnakonda <15602904+codingkarthik@users.noreply.github.com>
GitOrigin-RevId: 53d0671
@hasura-bot hasura-bot closed this Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
c/server Related to server merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@codingkarthik @abooij @hasura-bot @rakeshkky