groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: make role name unique and remove key usage

Browse Source
This commit is contained in:
Ali BARIN
2024-09-04 11:07:45 +00:00
parent b089069b8e
commit 63dfb6947e
33 changed files with 51 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/backend/bin/database/utils.js
View File

@@ -10,7 +10,7 @@ import process from 'process';
async function fetchAdminRole() {
const role = await Role.query()
.where({
key: 'admin',
name: 'Admin',
})
.limit(1)
.first();

2
packages/backend/src/controllers/api/v1/admin/apps/create-auth-client.ee.test.js
View File

@@ -15,7 +15,7 @@ describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/apps/create-config.ee.test.js
View File

@@ -15,7 +15,7 @@ describe('POST /api/v1/admin/apps/:appKey/config', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.test.js
View File

@@ -15,7 +15,7 @@ describe('GET /api/v1/admin/apps/:appKey/auth-clients/:appAuthClientId', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
currentAppAuthClient = await createAppAuthClient({

2
packages/backend/src/controllers/api/v1/admin/apps/get-auth-clients.ee.test.js
View File

@@ -14,7 +14,7 @@ describe('GET /api/v1/admin/apps/:appKey/auth-clients', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/apps/update-auth-client.ee.test.js
View File

@@ -17,7 +17,7 @@ describe('PATCH /api/v1/admin/apps/:appKey/auth-clients', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/apps/update-config.ee.test.js
View File

@@ -15,7 +15,7 @@ describe('PATCH /api/v1/admin/apps/:appKey/config', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/config/update.ee.test.js
View File

@@ -14,7 +14,7 @@ describe('PATCH /api/v1/admin/config', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js
View File

@@ -11,7 +11,7 @@ describe('GET /api/v1/admin/permissions/catalog', () => {
let role, currentUser, token;
beforeEach(async () => {
role = await createRole({ key: 'admin' });
role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
token = await createAuthTokenByUserId(currentUser.id);

3
packages/backend/src/controllers/api/v1/admin/roles/create-role.ee.js
View File

@@ -1,4 +1,3 @@
import kebabCase from 'lodash/kebabCase.js';
import { renderObject } from '../../../../../helpers/renderer.js';
import Role from '../../../../../models/role.js';
@@ -14,10 +13,8 @@ export default async (request, response) => {
const roleParams = (request) => {
const { name, description, permissions } = request.body;
const key = kebabCase(name);
return {
key,
name,
description,
permissions,

13
packages/backend/src/controllers/api/v1/admin/roles/create-role.ee.test.js
View File

@@ -14,7 +14,7 @@ describe('POST /api/v1/admin/roles', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
role = await createRole({ key: 'admin' });
role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
token = await createAuthTokenByUserId(currentUser.id);
@@ -41,7 +41,7 @@ describe('POST /api/v1/admin/roles', () => {
const createdRole = await Role.query()
.withGraphFetched({ permissions: true })
.findOne({ key: 'viewer' })
.findOne({ name: 'Viewer' })
.throwIfNotFound();
const expectedPayload = await createRoleMock(
@@ -61,7 +61,7 @@ describe('POST /api/v1/admin/roles', () => {
expect(response.body).toEqual(expectedPayload);
});
it('should return unprocessable entity response for invalid data', async () => {
it('should return unprocessable entity response for invalid role data', async () => {
const roleData = {
description: '',
permissions: [],
@@ -76,7 +76,6 @@ describe('POST /api/v1/admin/roles', () => {
expect(response.body).toStrictEqual({
errors: {
name: ["must have required property 'name'"],
key: ['must NOT have fewer than 1 characters'],
},
meta: {
type: 'ModelValidation',
@@ -85,8 +84,10 @@ describe('POST /api/v1/admin/roles', () => {
});
it('should return unprocessable entity response for duplicate role', async () => {
await createRole({ name: 'Viewer' });
const roleData = {
name: 'admin',
name: 'Viewer',
permissions: [],
};
@@ -98,7 +99,7 @@ describe('POST /api/v1/admin/roles', () => {
expect(response.body).toStrictEqual({
errors: {
key: ["'key' must be unique."],
name: ["'name' must be unique."],
},
meta: {
type: 'UniqueViolationError',

2
packages/backend/src/controllers/api/v1/admin/roles/get-role.ee.test.js
View File

@@ -13,7 +13,7 @@ describe('GET /api/v1/admin/roles/:roleId', () => {
let role, currentUser, token, permissionOne, permissionTwo;
beforeEach(async () => {
role = await createRole({ key: 'admin' });
role = await createRole({ name: 'Admin' });
permissionOne = await createPermission({ roleId: role.id });
permissionTwo = await createPermission({ roleId: role.id });
currentUser = await createUser({ roleId: role.id });

4
packages/backend/src/controllers/api/v1/admin/roles/get-roles.ee.test.js
View File

@@ -11,8 +11,8 @@ describe('GET /api/v1/admin/roles', () => {
let roleOne, roleTwo, currentUser, token;
beforeEach(async () => {
roleOne = await createRole({ key: 'admin' });
roleTwo = await createRole({ key: 'user' });
roleOne = await createRole({ name: 'Admin' });
roleTwo = await createRole({ name: 'User' });
currentUser = await createUser({ roleId: roleOne.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/create-saml-auth-provider.ee.test.js
View File

@@ -13,7 +13,7 @@ describe('POST /api/v1/admin/saml-auth-provider', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
role = await createRole({ key: 'admin' });
role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-role-mappings.ee.test.js
View File

@@ -13,7 +13,7 @@ describe('GET /api/v1/admin/saml-auth-providers/:samlAuthProviderId/role-mapping
let roleMappingOne, roleMappingTwo, samlAuthProvider, currentUser, token;
beforeEach(async () => {
const role = await createRole({ key: 'admin' });
const role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
samlAuthProvider = await createSamlAuthProvider();

2
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.test.js
View File

@@ -13,7 +13,7 @@ describe('GET /api/v1/admin/saml-auth-provider/:samlAuthProviderId', () => {
let samlAuthProvider, currentUser, token;
beforeEach(async () => {
const role = await createRole({ key: 'admin' });
const role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
samlAuthProvider = await createSamlAuthProvider();

2
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.test.js
View File

@@ -12,7 +12,7 @@ describe('GET /api/v1/admin/saml-auth-providers', () => {
let samlAuthProviderOne, samlAuthProviderTwo, currentUser, token;
beforeEach(async () => {
const role = await createRole({ key: 'admin' });
const role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
samlAuthProviderOne = await createSamlAuthProvider();

2
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/update-saml-auth-provider.ee.test.js
View File

@@ -15,7 +15,7 @@ describe('PATCH /api/v1/admin/saml-auth-provider/:samlAuthProviderId', () => {
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
role = await createRole({ key: 'admin' });
role = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: role.id });
token = await createAuthTokenByUserId(currentUser.id);

2
packages/backend/src/controllers/api/v1/admin/users/delete-user.test.js
View File

@@ -10,7 +10,7 @@ describe('DELETE /api/v1/admin/users/:userId', () => {
let currentUser, currentUserRole, anotherUser, token;
beforeEach(async () => {
currentUserRole = await createRole({ key: 'admin' });
currentUserRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: currentUserRole.id });
anotherUser = await createUser();

2
packages/backend/src/controllers/api/v1/admin/users/get-user.ee.test.js
View File

@@ -12,7 +12,7 @@ describe('GET /api/v1/admin/users/:userId', () => {
let currentUser, currentUserRole, anotherUser, anotherUserRole, token;
beforeEach(async () => {
currentUserRole = await createRole({ key: 'admin' });
currentUserRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: currentUserRole.id });
anotherUser = await createUser();

3
packages/backend/src/controllers/api/v1/admin/users/get-users.ee.test.js
View File

@@ -10,7 +10,7 @@ describe('GET /api/v1/admin/users', () => {
let currentUser, currentUserRole, anotherUser, anotherUserRole, token;
beforeEach(async () => {
currentUserRole = await createRole({ key: 'admin' });
currentUserRole = await createRole({ name: 'Admin' });
currentUser = await createUser({
roleId: currentUserRole.id,
@@ -18,7 +18,6 @@ describe('GET /api/v1/admin/users', () => {
});
anotherUserRole = await createRole({
key: 'anotherUser',
name: 'Another user role',
});

2
packages/backend/src/controllers/api/v1/admin/users/update-user.ee.test.js
View File

@@ -11,7 +11,7 @@ describe('PATCH /api/v1/admin/users/:userId', () => {
let currentUser, adminRole, token;
beforeEach(async () => {
adminRole = await createRole({ key: 'admin' });
adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id });
token = await createAuthTokenByUserId(currentUser.id);

11
packages/backend/src/controllers/api/v1/installation/users/create-user.test.js
View File

@@ -13,8 +13,7 @@ describe('POST /api/v1/installation/users', () => {
beforeEach(async () => {
adminRole = await createRole({
name: 'Admin',
key: 'admin',
})
});
});
describe('for incomplete installations', () => {
@@ -26,7 +25,7 @@ describe('POST /api/v1/installation/users', () => {
.send({
email: 'user@automatisch.io',
password: 'password',
fullName: 'Initial admin'
fullName: 'Initial admin',
})
.expect(204);
@@ -48,7 +47,7 @@ describe('POST /api/v1/installation/users', () => {
.send({
email: 'user@automatisch.io',
password: 'password',
fullName: 'Initial admin'
fullName: 'Initial admin',
})
.expect(403);
@@ -71,7 +70,7 @@ describe('POST /api/v1/installation/users', () => {
.send({
email: 'user@automatisch.io',
password: 'password',
fullName: 'Initial admin'
fullName: 'Initial admin',
})
.expect(403);
@@ -80,5 +79,5 @@ describe('POST /api/v1/installation/users', () => {
expect(user).toBeUndefined();
expect(await Config.isInstallationCompleted()).toBe(true);
});
})
});
});

4
packages/backend/src/db/migrations/20240903110620_make_role_key_unique.js → packages/backend/src/db/migrations/20240903110620_make_role_name_unique.js
View File

@@ -1,11 +1,11 @@
export async function up(knex) {
return await knex.schema.alterTable('roles', (table) => {
table.unique('key');
table.unique('name');
});
}
export async function down(knex) {
return await knex.schema.alterTable('roles', function (table) {
table.dropUnique('key');
table.dropUnique('name');
});
}

11
packages/backend/src/db/migrations/20240904091615_remove_key_column_in_roles.js Normal file
View File

@@ -0,0 +1,11 @@
export async function up(knex) {
return await knex.schema.alterTable('roles', (table) => {
table.dropColumn('key');
});
}
export async function down(knex) {
return await knex.schema.alterTable('roles', function (table) {
table.string('key').notNullable();
});
}

2
packages/backend/src/graphql/mutations/create-user.ee.js
View File

@@ -32,7 +32,7 @@ const createUser = async (_parent, params, context) => {
userPayload.roleId = params.input.role.id;
} catch {
// void
const role = await Role.query().findOne({ key: 'admin' });
const role = await Role.findAdmin();
userPayload.roleId = role.id;
}

2
packages/backend/src/graphql/mutations/register-user.ee.js
View File

@@ -15,7 +15,7 @@ const registerUser = async (_parent, params) => {
throw new Error('User already exists!');
}
const role = await Role.query().findOne({ key: 'user' });
const role = await Role.query().findOne({ name: 'User' });
const user = await User.query().insert({
fullName,

11
packages/backend/src/models/role.js
View File

@@ -7,22 +7,17 @@ class Role extends Base {
static jsonSchema = {
type: 'object',
required: ['name', 'key'],
required: ['name'],
properties: {
id: { type: 'string', format: 'uuid' },
name: { type: 'string', minLength: 1 },
key: { type: 'string', minLength: 1 },
description: { type: ['string', 'null'], maxLength: 255 },
createdAt: { type: 'string' },
updatedAt: { type: 'string' },
},
};
static get virtualAttributes() {
return ['isAdmin'];
}
static relationMappings = () => ({
users: {
relation: Base.HasManyRelation,
@@ -43,11 +38,11 @@ class Role extends Base {
});
get isAdmin() {
return this.key === 'admin';
return this.name === 'Admin';
}
static async findAdmin() {
return await this.query().findOne({ key: 'admin' });
return await this.query().findOne({ name: 'Admin' });
}
}

2
packages/backend/test/factories/role.js
View File

@@ -3,10 +3,8 @@ import Role from '../../src/models/role';
export const createRole = async (params = {}) => {
const name = faker.lorem.word();
const key = name.toLowerCase();
params.name = params?.name || name;
params.key = params?.key || key;
const role = await Role.query().insertAndFetch(params);

1
packages/backend/test/mocks/rest/api/v1/admin/roles/create-role.ee.js
View File

@@ -1,7 +1,6 @@
const createRoleMock = async (role, permissions = []) => {
const data = {
id: role.id,
key: role.key,
name: role.name,
isAdmin: role.isAdmin,
description: role.description,

1
packages/backend/test/mocks/rest/api/v1/admin/roles/get-role.ee.js
View File

@@ -1,7 +1,6 @@
const getRoleMock = async (role, permissions) => {
const data = {
id: role.id,
key: role.key,
name: role.name,
isAdmin: role.isAdmin,
description: role.description,

1
packages/backend/test/mocks/rest/api/v1/admin/roles/get-roles.ee.js
View File

@@ -2,7 +2,6 @@ const getRolesMock = async (roles) => {
const data = roles.map((role) => {
return {
id: role.id,
key: role.key,
name: role.name,
isAdmin: role.isAdmin,
description: role.description,

1
packages/backend/test/mocks/rest/api/v1/admin/users/update-user.js
View File

@@ -9,7 +9,6 @@ const updateUserMock = (user, role) => {
updatedAt: user.updatedAt.getTime(),
role: {
id: role.id,
key: role.key,
name: role.name,
isAdmin: role.isAdmin,
createdAt: role.createdAt.getTime(),