Skip to content

[spicedb] Small schema adjustments #18380

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

Merged
merged 2 commits into from
Jul 28, 2023
Merged

[spicedb] Small schema adjustments #18380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30ee678
[spicedb] Validate schema on build
geropl Jul 28, 2023
10bc9c2
[spicedb] Small schema adjustments
geropl Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/server/src/authorization/authorizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ export class Authorizer {
set(rel.user(userId).self.user(userId)), //
set(
owningOrgId
? rel.user(userId).container.organization(owningOrgId)
: rel.user(userId).container.installation,
? rel.user(userId).organization.organization(owningOrgId)
: rel.user(userId).installation.installation,
),
);
}
Expand Down
17 changes: 13 additions & 4 deletions components/server/src/authorization/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ export type Permission = UserPermission | InstallationPermission | OrganizationP

export type UserResourceType = "user";

export type UserRelation = "self" | "container";
export type UserRelation = "self" | "organization" | "installation";

export type UserPermission = "read_info" | "write_info" | "suspend" | "make_admin";
export type UserPermission = "read_info" | "write_info" | "make_admin";

export type InstallationResourceType = "installation";

Expand Down Expand Up @@ -85,10 +85,10 @@ export const rel = {
};
},

get container() {
get organization() {
const result2 = {
...result,
relation: "container",
relation: "organization",
};
return {
organization(objectId: string) {
Expand All @@ -102,6 +102,15 @@ export const rel = {
},
} as v1.Relationship;
},
};
},

get installation() {
const result2 = {
...result,
relation: "installation",
};
return {
get installation() {
return {
...result2,
Expand Down
16 changes: 8 additions & 8 deletions components/server/src/authorization/relationship-updater.spec.db.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ describe("RelationshipUpdater", async () => {

it("should update a simple user", async () => {
let user = await userDB.newUser();
await notExpected(rel.user(user.id).container.installation);
await notExpected(rel.user(user.id).installation.installation);
await notExpected(rel.user(user.id).self.user(user.id));
await notExpected(rel.installation.member.user(user.id));

user = await migrate(user);

await expected(rel.user(user.id).container.installation);
await expected(rel.user(user.id).installation.installation);
await expected(rel.user(user.id).self.user(user.id));
await notExpected(rel.installation.admin.user(user.id));
await expected(rel.installation.member.user(user.id));
Expand All @@ -65,7 +65,7 @@ describe("RelationshipUpdater", async () => {
user = await userDB.storeUser(user);
user = await migrate(user);

await expected(rel.user(user.id).container.installation);
await expected(rel.user(user.id).installation.installation);
await expected(rel.user(user.id).self.user(user.id));
await expected(rel.installation.admin.user(user.id));
await expected(rel.installation.member.user(user.id));
Expand All @@ -77,7 +77,7 @@ describe("RelationshipUpdater", async () => {
user = await userDB.storeUser(user);
user = await migrate(user);

await expected(rel.user(user.id).container.installation);
await expected(rel.user(user.id).installation.installation);
await expected(rel.user(user.id).self.user(user.id));
await notExpected(rel.installation.admin.user(user.id));
await expected(rel.installation.member.user(user.id));
Expand All @@ -92,7 +92,7 @@ describe("RelationshipUpdater", async () => {
user = await migrate(user);

await expected(rel.user(user.id).self.user(user.id));
await expected(rel.user(user.id).container.organization(org.id));
await expected(rel.user(user.id).organization.organization(org.id));
await expected(rel.organization(org.id).installation.installation);
await expected(rel.organization(org.id).member.user(user.id));
await expected(rel.organization(org.id).owner.user(user.id));
Expand All @@ -109,10 +109,10 @@ describe("RelationshipUpdater", async () => {
user = await migrate(user);

await expected(rel.user(user.id).self.user(user.id));
await expected(rel.user(user.id).container.organization(org.id));
await expected(rel.user(user.id).organization.organization(org.id));

// we haven't called migrate on user2, so we don't expect any relationships
await notExpected(rel.user(user2.id).container.installation);
await notExpected(rel.user(user2.id).installation.installation);
await notExpected(rel.user(user2.id).self.user(user2.id));

// but on the org user2 is a member
Expand All @@ -124,7 +124,7 @@ describe("RelationshipUpdater", async () => {

user2 = await migrate(user2);

await expected(rel.user(user2.id).container.installation);
await expected(rel.user(user2.id).installation.installation);
await expected(rel.user(user2.id).self.user(user2.id));

// rest should be the same
Expand Down
6 changes: 1 addition & 5 deletions components/server/src/user/user-service.spec.db.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,15 @@ describe("UserService", async () => {
it("createUser", async () => {
expect(await auth.hasPermissionOnUser(user.id, "read_info", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(user.id, "write_info", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(user.id, "suspend", user.id)).to.be.true;

expect(await auth.hasPermissionOnUser(user2.id, "read_info", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(user2.id, "write_info", user.id)).to.be.false;
expect(await auth.hasPermissionOnUser(user2.id, "suspend", user.id)).to.be.false;

expect(await auth.hasPermissionOnUser(nonOrgUser.id, "read_info", user.id)).to.be.false;
expect(await auth.hasPermissionOnUser(nonOrgUser.id, "write_info", user.id)).to.be.false;
expect(await auth.hasPermissionOnUser(nonOrgUser.id, "suspend", user.id)).to.be.false;

expect(await auth.hasPermissionOnUser(admin.id, "read_info", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(admin.id, "write_info", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(admin.id, "suspend", user.id)).to.be.true;
expect(await auth.hasPermissionOnUser(admin.id, "write_info", user.id)).to.be.false;
});

it("updateLoggedInUser_avatarUrlNotUpdatable", async () => {
Expand Down
3 changes: 3 additions & 0 deletions components/spicedb/BUILD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ packages:
type: generic
srcs:
- "schema/*.yaml"
config:
test:
- ["zed", "validate", "./schema/schema.yaml"]

- name: lib
type: go
Expand Down
14 changes: 8 additions & 6 deletions components/spicedb/schema/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
schema: |-
definition user {
relation self: user
relation container: organization | installation

// Only ONE of the following relations is ever present for a given user (XOR)
relation organization: organization
relation installation: installation

// permissions
permission read_info = self + container->member + container->owner + container->admin
permission write_info = self + container->owner + container->admin
permission suspend = self + container->owner + container->admin
permission make_admin = container->admin
permission read_info = self + organization->member + organization->owner + installation->admin
permission write_info = self
permission make_admin = installation->admin
}

// There's only one global installation
Expand Down Expand Up @@ -81,7 +83,7 @@ schema: |-
relationships: |-
// we have one installation
installation:installation_0#member@user:user_0
user:user_0#container@installation:installation_0
user:user_0#installation@installation:installation_0

installation:installation_0#admin@user:user_admin

Expand Down