Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-03-10 22:22:45 -05:00
Code Issues Activity

refactor(core): add on conflic ignore to the Relation insert query method (#5100)

Browse source 
* refactor(core): add on conflic ignore to the Relation insert query method

add on conflic ignore to the Relation insert query method

* chore: improve word

improve word

* test: add integration test

add integration test

* feat(core): update organization post api doc

update organization post api doc
This commit is contained in:
simeng-li 2023-12-14 15:04:20 +08:00 • committed by GitHub
parent 7c09ac850f
commit 9222eb9f80
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 43 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.changeset/chilly-bobcats-doubt.md Normal file
View file

@ -0,0 +1,7 @@
---
"@logto/core": patch
---
Set `on conflict do nothing` for all the `RelationQueries` insert operation.
- For all the relation table entities, we want to safely insert them into the database. If the relation entity already exists, instead of throwing an error, we ignore the insert operation, especially on a batch insert. Unlike other resource data entities, user does not care if the relation entity already exists. Therefore, we want to silently ignore the insert operation if the relation entity already exists.

12
packages/core/src/routes/organization/index.openapi.json
View file

@ -109,7 +109,7 @@
"schema": {
"properties": {
"userIds": {
"description": "An array of user IDs to be added to the organization."
"description": "An array of user IDs to be added to the organization. Organization existed users assignment will be ignored."
}
}
}
@ -121,7 +121,7 @@
"description": "Users were added to the organization successfully."
},
"422": {
"description": "At least one of the IDs provided is not valid. For example, the organization ID or user ID does not exist; or the user is already a member of the organization."
"description": "At least one of the IDs provided is not valid. For example, the organization ID or user ID does not exist."
}
}
},
@ -194,7 +194,7 @@
"description": "An array of user IDs to assign roles."
},
"organizationRoleIds": {
"description": "An array of organization role IDs to assign."
"description": "An array of organization role IDs to assign. User existed roles assignment will be ignored."
}
}
}
@ -206,7 +206,7 @@
"description": "Roles were assigned to organization users successfully."
},
"422": {
"description": "At least one of the IDs provided is not valid. For example, the organization ID, user ID, or organization role ID does not exist; the user is not a member of the organization; or the user already has the role."
"description": "At least one of the IDs provided is not valid. For example, the organization ID, user ID, or organization role ID does not exist; the user is not a member of the organization."
}
}
}
@ -258,7 +258,7 @@
"schema": {
"properties": {
"organizationRoleIds": {
"description": "An array of organization role IDs to assign to the user."
"description": "An array of organization role IDs to assign to the user. User existed roles assignment will be ignored."
}
}
}
@ -270,7 +270,7 @@
"description": "Roles were assigned to the user successfully."
},
"422": {
"description": "The user is not a member of the organization; or at least one of the IDs provided is not valid. For example, the organization ID or organization role ID does not exist; or the user already has the role."
"description": "The user is not a member of the organization; or at least one of the IDs provided is not valid. For example, the organization ID or organization role ID does not exist."
}
}
}

4
packages/core/src/routes/organization/roles.openapi.json
View file

@ -112,7 +112,7 @@
"schema": {
"properties": {
"organizationScopeIds": {
"description": "An array of organization scope IDs to be assigned."
"description": "An array of organization scope IDs to be assigned. Existed scope IDs assignments will be ignored."
}
}
}
@ -124,7 +124,7 @@
"description": "Organization scopes were assigned successfully."
},
"422": {
"description": "At least one of the IDs provided is invalid. For example, the organization scope ID does not exist; or the organization scope has already been assigned to the organization role."
"description": "At least one of the IDs provided is invalid. For example, the organization scope ID does not exist;"
}
}
},

4
packages/core/src/utils/RelationQueries.ts
View file

@ -93,6 +93,7 @@ export default class RelationQueries<
*
* Each entity must contain the same number of ids as the number of relations, and
* the order of the ids must match the order of the relations.
* Insert existing relations will be ignored.
*
* @param data Entities to insert.
* @returns A Promise that resolves to the query result.
@ -124,7 +125,8 @@ export default class RelationQueries<
)})`
),
sql`, `
)};
)}
${sql`on conflict do nothing`}
`);
}

25
packages/integration-tests/src/tests/api/organization-role.test.ts
View file

@ -176,6 +176,31 @@ describe('organization role APIs', () => {
);
});
it('should safely add scopes to a role when some of them already exist', async () => {
const [role, scope1, scope2] = await Promise.all([
roleApi.create({ name: 'test' + randomId() }),
scopeApi.create({ name: 'test' + randomId() }),
scopeApi.create({ name: 'test' + randomId() }),
]);
await roleApi.addScopes(role.id, [scope1.id, scope2.id]);
await expect(roleApi.addScopes(role.id, [scope2.id])).resolves.not.toThrow();
const scopes = await roleApi.getScopes(role.id);
expect(scopes).toContainEqual(
expect.objectContaining({
name: scope1.name,
})
);
expect(scopes).toContainEqual(
expect.objectContaining({
name: scope2.name,
})
);
});
it('should fail when try to add non-existent scopes to a role', async () => {
const [role, scope1, scope2] = await Promise.all([
roleApi.create({ name: 'test' + randomId() }),