Clarify how arrows operate over subject relations #219
+59
−21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
alecmerdler
reviewed
Apr 23, 2024
josephschorr
force-pushed
the
arrow-subject-rel
branch
from
1bd3fab to
77eb6f1
Compare
jzelinskie
reviewed
Apr 23, 2024
josephschorr
force-pushed
the
arrow-subject-rel
branch
from
77eb6f1 to
ee7f00e
Compare
jzelinskie
reviewed
Apr 23, 2024
| @@ -38,8 +38,9 @@ definition someobjecttype {} | |||
| ``` | |||
|
|
|||
| <Callout type="info"> | |||
| Note that the examples are unprefixed. | |||
| You'll need to add the prefix from your permissions system if calling `WriteSchema` for a permissions system hosted in Serverless. | |||
| Note that the examples are unprefixed. You'll need to add the prefix from your | |||
There was a problem hiding this comment.
Can we fix this in a followup when we add the linter?
jzelinskie
reviewed
Apr 23, 2024
| @@ -105,7 +107,8 @@ definition group { | |||
| ``` | |||
|
|
|||
| <Callout type="info"> | |||
| Subject Relations are useful in RBAC-style permissions systems to grant "roles" to _sets_ of subjects, such as the members of a team. | |||
| Subject Relations are useful in RBAC-style permissions systems to grant | |||
| "roles" to _sets_ of subjects, such as the members of a team. | |||
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| Be **very careful** with wildcard support in your schema! | ||
| **Only** grant it to read permissions, unless you intend to allow for universal writing. | ||
| Be **very careful** with wildcard support in your schema! **Only** grant it to | ||
| read permissions, unless you intend to allow for universal writing. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| of relations. This allows for easy nested computation, and is more readable. | ||
| It is _recommended_ that the right side of all arrows refer to | ||
| **permissions**, instead of relations, as this allows for easy nested | ||
| computation, and is more readable. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| <Callout type="warning"> | ||
| Arrows operate on the **object** of the subject(s) found on a `relation`. They | ||
| *do not* operate on the relation/permission of a subject, *even if the subject | ||
| refers to a relation or permission*. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| `parent->something` refers to the `something` permission on the **group**, and `#member` will be ignored for the arrow. | ||
|
|
||
| It is recommended to not use arrows over relations that allow for subject relations without noting that | ||
| fact via a comment. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| Why is this the case? In one word: **performance**. If arrows operated over | ||
| the subject's relation or permission, a full LookupSubjects call would be | ||
| necessary for the arrow to correctly "walk", which would make these | ||
| CheckPermission requests potentially *incredibly* expensive. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| You'll note that we also used `member` above in the relation example. Defining | ||
| `member` as a **permission** might be found when you have multiple "ways" a | ||
| subject can be a member of a resource, thus changing it from a simple relation | ||
| to a _computed_ set of subjects. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
| </Callout> | ||
|
|
||
| ## Comments | ||
|
|
||
| ### Documentation Comments | ||
|
|
||
| <Callout type="info"> | ||
| It is **highly** recommended to put doc comments on all definitions, relations and permissions. | ||
| It is **highly** recommended to put doc comments on all definitions, relations | ||
| and permissions. |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
reviewed
Apr 23, 2024
|
|
||
| <Callout type="info"> | ||
| Note that since `parent->read` calls the same `read` permission, it will form a recursive lookup across the chain of parent folder(s). | ||
| Note that since `parent->read` calls the same `read` permission, it will form | ||
| a recursive lookup across the chain of parent folder(s). |
There was a problem hiding this comment.
one sentence per line, need a linter for this
jzelinskie
approved these changes
Apr 23, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.