Skip to content

Add OPERATION_EXPIRE and an opt-in Watch kind for expirations - #177

Open
ecordell wants to merge 1 commit into
authzed:mainfrom
ecordell:evan/watch-expire-operation
Open

ecordell wants to merge 1 commit into
authzed:mainfrom
ecordell:evan/watch-expire-operation

Conversation

@ecordell

Copy link
Copy Markdown
Contributor

Watch currently excludes relationships that were removed because they expired, so a Watch consumer cannot tell that access ended. This adds a way for a server to report those removals.

Changes

  • RelationshipUpdate.Operation gets OPERATION_EXPIRE = 4.
  • WatchKind gets WATCH_KIND_INCLUDE_RELATIONSHIP_EXPIRATIONS = 4. Watch reports OPERATION_EXPIRE only when the request includes this kind, so existing clients never receive an enum value they do not know. Servers that do not record expirations as changes return no such updates.
  • WriteRelationshipsRequest rejects OPERATION_EXPIRE with a protovalidate CEL rule. RelationshipUpdate is shared by writes and Watch, so the rule is on the request, not on the field. protoc-gen-validate cannot express this check, so servers that use it must reject the operation themselves.
  • docs/apidocs.swagger.json is regenerated.

An OPERATION_EXPIRE update is reported at the revision where the server removed the relationship, which is at or after its optional_expires_at.

Checks

buf build, buf lint, and buf breaking --against upstream/main pass.

Watch currently excludes relationships that were removed because they
expired, so a Watch consumer cannot tell that access ended. Datastores that
record expirations as changes can now report them.

- RelationshipUpdate.Operation gets OPERATION_EXPIRE = 4.
- WatchKind gets WATCH_KIND_INCLUDE_RELATIONSHIP_EXPIRATIONS = 4. Watch
  reports OPERATION_EXPIRE only when the request asks for it, so existing
  clients never receive an enum value they do not know.
- WriteRelationshipsRequest rejects OPERATION_EXPIRE with a protovalidate
  CEL rule. protoc-gen-validate cannot express this check, so servers that
  use it must reject the operation themselves.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant