Merge pull request #2093 from automatisch/aut-1191
feat(config): make data structure horizontal
This commit is contained in:
@@ -1,23 +1,28 @@
|
|||||||
import pick from 'lodash/pick.js';
|
|
||||||
import { renderObject } from '../../../../../helpers/renderer.js';
|
import { renderObject } from '../../../../../helpers/renderer.js';
|
||||||
import Config from '../../../../../models/config.js';
|
import Config from '../../../../../models/config.js';
|
||||||
|
|
||||||
export default async (request, response) => {
|
export default async (request, response) => {
|
||||||
const config = configParams(request);
|
const config = await Config.query().updateFirstOrInsert(
|
||||||
|
configParams(request)
|
||||||
await Config.batchUpdate(config);
|
);
|
||||||
|
|
||||||
renderObject(response, config);
|
renderObject(response, config);
|
||||||
};
|
};
|
||||||
|
|
||||||
const configParams = (request) => {
|
const configParams = (request) => {
|
||||||
const updatableConfigurationKeys = [
|
const {
|
||||||
'logo.svgData',
|
logoSvgData,
|
||||||
'palette.primary.dark',
|
palettePrimaryDark,
|
||||||
'palette.primary.light',
|
palettePrimaryLight,
|
||||||
'palette.primary.main',
|
palettePrimaryMain,
|
||||||
'title',
|
title,
|
||||||
];
|
} = request.body;
|
||||||
|
|
||||||
return pick(request.body, updatableConfigurationKeys);
|
return {
|
||||||
|
logoSvgData,
|
||||||
|
palettePrimaryDark,
|
||||||
|
palettePrimaryLight,
|
||||||
|
palettePrimaryMain,
|
||||||
|
title,
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
@@ -5,7 +5,7 @@ import app from '../../../../../app.js';
|
|||||||
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
|
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
|
||||||
import { createUser } from '../../../../../../test/factories/user.js';
|
import { createUser } from '../../../../../../test/factories/user.js';
|
||||||
import { createRole } from '../../../../../../test/factories/role.js';
|
import { createRole } from '../../../../../../test/factories/role.js';
|
||||||
import { createBulkConfig } from '../../../../../../test/factories/config.js';
|
import { updateConfig } from '../../../../../../test/factories/config.js';
|
||||||
import * as license from '../../../../../helpers/license.ee.js';
|
import * as license from '../../../../../helpers/license.ee.js';
|
||||||
|
|
||||||
describe('PATCH /api/v1/admin/config', () => {
|
describe('PATCH /api/v1/admin/config', () => {
|
||||||
@@ -30,13 +30,13 @@ describe('PATCH /api/v1/admin/config', () => {
|
|||||||
|
|
||||||
const appConfig = {
|
const appConfig = {
|
||||||
title,
|
title,
|
||||||
'palette.primary.main': palettePrimaryMain,
|
palettePrimaryMain: palettePrimaryMain,
|
||||||
'palette.primary.dark': palettePrimaryDark,
|
palettePrimaryDark: palettePrimaryDark,
|
||||||
'palette.primary.light': palettePrimaryLight,
|
palettePrimaryLight: palettePrimaryLight,
|
||||||
'logo.svgData': logoSvgData,
|
logoSvgData: logoSvgData,
|
||||||
};
|
};
|
||||||
|
|
||||||
await createBulkConfig(appConfig);
|
await updateConfig(appConfig);
|
||||||
|
|
||||||
const newTitle = 'Updated title';
|
const newTitle = 'Updated title';
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ describe('PATCH /api/v1/admin/config', () => {
|
|||||||
.expect(200);
|
.expect(200);
|
||||||
|
|
||||||
expect(response.body.data.title).toEqual(newTitle);
|
expect(response.body.data.title).toEqual(newTitle);
|
||||||
expect(response.body.meta.type).toEqual('Object');
|
expect(response.body.meta.type).toEqual('Config');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should return created config for unexisting config', async () => {
|
it('should return created config for unexisting config', async () => {
|
||||||
@@ -68,7 +68,7 @@ describe('PATCH /api/v1/admin/config', () => {
|
|||||||
.expect(200);
|
.expect(200);
|
||||||
|
|
||||||
expect(response.body.data.title).toEqual(newTitle);
|
expect(response.body.data.title).toEqual(newTitle);
|
||||||
expect(response.body.meta.type).toEqual('Object');
|
expect(response.body.meta.type).toEqual('Config');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should return null for deleted config entry', async () => {
|
it('should return null for deleted config entry', async () => {
|
||||||
@@ -83,6 +83,6 @@ describe('PATCH /api/v1/admin/config', () => {
|
|||||||
.expect(200);
|
.expect(200);
|
||||||
|
|
||||||
expect(response.body.data.title).toBeNull();
|
expect(response.body.data.title).toBeNull();
|
||||||
expect(response.body.meta.type).toEqual('Object');
|
expect(response.body.meta.type).toEqual('Config');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@@ -1,25 +1,8 @@
|
|||||||
import appConfig from '../../../../config/app.js';
|
|
||||||
import Config from '../../../../models/config.js';
|
import Config from '../../../../models/config.js';
|
||||||
import { renderObject } from '../../../../helpers/renderer.js';
|
import { renderObject } from '../../../../helpers/renderer.js';
|
||||||
|
|
||||||
export default async (request, response) => {
|
export default async (request, response) => {
|
||||||
const defaultConfig = {
|
const config = await Config.get();
|
||||||
disableNotificationsPage: appConfig.disableNotificationsPage,
|
|
||||||
disableFavicon: appConfig.disableFavicon,
|
|
||||||
additionalDrawerLink: appConfig.additionalDrawerLink,
|
|
||||||
additionalDrawerLinkIcon: appConfig.additionalDrawerLinkIcon,
|
|
||||||
additionalDrawerLinkText: appConfig.additionalDrawerLinkText,
|
|
||||||
};
|
|
||||||
|
|
||||||
let config = await Config.query().orderBy('key', 'asc');
|
|
||||||
|
|
||||||
config = config.reduce((computedConfig, configEntry) => {
|
|
||||||
const { key, value } = configEntry;
|
|
||||||
|
|
||||||
computedConfig[key] = value?.data;
|
|
||||||
|
|
||||||
return computedConfig;
|
|
||||||
}, defaultConfig);
|
|
||||||
|
|
||||||
renderObject(response, config);
|
renderObject(response, config);
|
||||||
};
|
};
|
||||||
|
@@ -1,66 +1,47 @@
|
|||||||
import { vi, expect, describe, it } from 'vitest';
|
import { vi, expect, describe, it } from 'vitest';
|
||||||
import request from 'supertest';
|
import request from 'supertest';
|
||||||
import { createConfig } from '../../../../../test/factories/config.js';
|
import { updateConfig } from '../../../../../test/factories/config.js';
|
||||||
import app from '../../../../app.js';
|
import app from '../../../../app.js';
|
||||||
import configMock from '../../../../../test/mocks/rest/api/v1/automatisch/config.js';
|
import configMock from '../../../../../test/mocks/rest/api/v1/automatisch/config.js';
|
||||||
import * as license from '../../../../helpers/license.ee.js';
|
import * as license from '../../../../helpers/license.ee.js';
|
||||||
import appConfig from '../../../../config/app.js';
|
import appConfig from '../../../../config/app.js';
|
||||||
|
|
||||||
describe('GET /api/v1/automatisch/config', () => {
|
describe('GET /api/v1/automatisch/config', () => {
|
||||||
it('should return Automatisch config', async () => {
|
it('should return Automatisch config along with static config', async () => {
|
||||||
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
|
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
|
||||||
|
vi.spyOn(appConfig, 'disableNotificationsPage', 'get').mockReturnValue(
|
||||||
|
true
|
||||||
|
);
|
||||||
|
vi.spyOn(appConfig, 'disableFavicon', 'get').mockReturnValue(true);
|
||||||
|
vi.spyOn(appConfig, 'additionalDrawerLink', 'get').mockReturnValue('link');
|
||||||
|
vi.spyOn(appConfig, 'additionalDrawerLinkIcon', 'get').mockReturnValue(
|
||||||
|
'icon'
|
||||||
|
);
|
||||||
|
vi.spyOn(appConfig, 'additionalDrawerLinkText', 'get').mockReturnValue(
|
||||||
|
'text'
|
||||||
|
);
|
||||||
|
|
||||||
const logoConfig = await createConfig({
|
const config = await updateConfig({
|
||||||
key: 'logo.svgData',
|
logoSvgData: '<svg>Sample</svg>',
|
||||||
value: { data: '<svg>Sample</svg>' },
|
palettePrimaryDark: '#001f52',
|
||||||
});
|
palettePrimaryLight: '#4286FF',
|
||||||
|
palettePrimaryMain: '#0059F7',
|
||||||
const primaryDarkConfig = await createConfig({
|
title: 'Sample Title',
|
||||||
key: 'palette.primary.dark',
|
|
||||||
value: { data: '#001F52' },
|
|
||||||
});
|
|
||||||
|
|
||||||
const primaryLightConfig = await createConfig({
|
|
||||||
key: 'palette.primary.light',
|
|
||||||
value: { data: '#4286FF' },
|
|
||||||
});
|
|
||||||
|
|
||||||
const primaryMainConfig = await createConfig({
|
|
||||||
key: 'palette.primary.main',
|
|
||||||
value: { data: '#0059F7' },
|
|
||||||
});
|
|
||||||
|
|
||||||
const titleConfig = await createConfig({
|
|
||||||
key: 'title',
|
|
||||||
value: { data: 'Sample Title' },
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const response = await request(app)
|
const response = await request(app)
|
||||||
.get('/api/v1/automatisch/config')
|
.get('/api/v1/automatisch/config')
|
||||||
.expect(200);
|
.expect(200);
|
||||||
|
|
||||||
const expectedPayload = configMock(
|
const expectedPayload = configMock({
|
||||||
logoConfig,
|
...config,
|
||||||
primaryDarkConfig,
|
disableNotificationsPage: true,
|
||||||
primaryLightConfig,
|
disableFavicon: true,
|
||||||
primaryMainConfig,
|
additionalDrawerLink: 'link',
|
||||||
titleConfig
|
additionalDrawerLinkIcon: 'icon',
|
||||||
);
|
additionalDrawerLinkText: 'text',
|
||||||
|
});
|
||||||
|
|
||||||
expect(response.body).toEqual(expectedPayload);
|
expect(response.body).toStrictEqual(expectedPayload);
|
||||||
});
|
|
||||||
|
|
||||||
it('should return additional environment variables', async () => {
|
|
||||||
vi.spyOn(appConfig, 'disableNotificationsPage', 'get').mockReturnValue(true);
|
|
||||||
vi.spyOn(appConfig, 'disableFavicon', 'get').mockReturnValue(true);
|
|
||||||
vi.spyOn(appConfig, 'additionalDrawerLink', 'get').mockReturnValue('link');
|
|
||||||
vi.spyOn(appConfig, 'additionalDrawerLinkIcon', 'get').mockReturnValue('icon');
|
|
||||||
vi.spyOn(appConfig, 'additionalDrawerLinkText', 'get').mockReturnValue('text');
|
|
||||||
|
|
||||||
expect(appConfig.disableNotificationsPage).toEqual(true);
|
|
||||||
expect(appConfig.disableFavicon).toEqual(true);
|
|
||||||
expect(appConfig.additionalDrawerLink).toEqual('link');
|
|
||||||
expect(appConfig.additionalDrawerLinkIcon).toEqual('icon');
|
|
||||||
expect(appConfig.additionalDrawerLinkText).toEqual('text');
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@@ -5,7 +5,7 @@ import Config from '../../../../../models/config.js';
|
|||||||
import User from '../../../../../models/user.js';
|
import User from '../../../../../models/user.js';
|
||||||
import { createRole } from '../../../../../../test/factories/role';
|
import { createRole } from '../../../../../../test/factories/role';
|
||||||
import { createUser } from '../../../../../../test/factories/user';
|
import { createUser } from '../../../../../../test/factories/user';
|
||||||
import { createInstallationCompletedConfig } from '../../../../../../test/factories/config';
|
import { markInstallationCompleted } from '../../../../../../test/factories/config';
|
||||||
|
|
||||||
describe('POST /api/v1/installation/users', () => {
|
describe('POST /api/v1/installation/users', () => {
|
||||||
let adminRole;
|
let adminRole;
|
||||||
@@ -59,7 +59,7 @@ describe('POST /api/v1/installation/users', () => {
|
|||||||
|
|
||||||
describe('for completed installations', () => {
|
describe('for completed installations', () => {
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
await createInstallationCompletedConfig();
|
await markInstallationCompleted();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should respond with HTTP 403 when installation completed', async () => {
|
it('should respond with HTTP 403 when installation completed', async () => {
|
||||||
|
@@ -0,0 +1,105 @@
|
|||||||
|
export async function up(knex) {
|
||||||
|
await knex.schema.alterTable('config', (table) => {
|
||||||
|
table.dropUnique('key');
|
||||||
|
|
||||||
|
table.string('key').nullable().alter();
|
||||||
|
table.boolean('installation_completed').defaultTo(false);
|
||||||
|
table.text('logo_svg_data');
|
||||||
|
table.text('palette_primary_dark');
|
||||||
|
table.text('palette_primary_light');
|
||||||
|
table.text('palette_primary_main');
|
||||||
|
table.string('title');
|
||||||
|
});
|
||||||
|
|
||||||
|
const config = await knex('config').select('key', 'value');
|
||||||
|
|
||||||
|
const newConfigData = {
|
||||||
|
logo_svg_data: getValueForKey(config, 'logo.svgData'),
|
||||||
|
palette_primary_dark: getValueForKey(config, 'palette.primary.dark'),
|
||||||
|
palette_primary_light: getValueForKey(config, 'palette.primary.light'),
|
||||||
|
palette_primary_main: getValueForKey(config, 'palette.primary.main'),
|
||||||
|
title: getValueForKey(config, 'title'),
|
||||||
|
installation_completed: getValueForKey(config, 'installation.completed'),
|
||||||
|
};
|
||||||
|
|
||||||
|
const [configEntry] = await knex('config')
|
||||||
|
.insert(newConfigData)
|
||||||
|
.select('id')
|
||||||
|
.returning('id');
|
||||||
|
|
||||||
|
await knex('config').where('id', '!=', configEntry.id).delete();
|
||||||
|
|
||||||
|
await knex.schema.alterTable('config', (table) => {
|
||||||
|
table.dropColumn('key');
|
||||||
|
table.dropColumn('value');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function down(knex) {
|
||||||
|
await knex.schema.alterTable('config', (table) => {
|
||||||
|
table.string('key');
|
||||||
|
table.jsonb('value').notNullable().defaultTo({});
|
||||||
|
});
|
||||||
|
|
||||||
|
const configRow = await knex('config').first();
|
||||||
|
|
||||||
|
const config = [
|
||||||
|
{
|
||||||
|
key: 'logo.svgData',
|
||||||
|
value: {
|
||||||
|
data: configRow.logo_svg_data,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'palette.primary.dark',
|
||||||
|
value: {
|
||||||
|
data: configRow.palette_primary_dark,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'palette.primary.light',
|
||||||
|
value: {
|
||||||
|
data: configRow.palette_primary_light,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'palette.primary.main',
|
||||||
|
value: {
|
||||||
|
data: configRow.palette_primary_main,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'title',
|
||||||
|
value: {
|
||||||
|
data: configRow.title,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'installation.completed',
|
||||||
|
value: {
|
||||||
|
data: configRow.installation_completed,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
await knex('config').insert(config).returning('id');
|
||||||
|
|
||||||
|
await knex('config').where('id', '=', configRow.id).delete();
|
||||||
|
|
||||||
|
await knex.schema.alterTable('config', (table) => {
|
||||||
|
table.dropColumn('installation_completed');
|
||||||
|
table.dropColumn('logo_svg_data');
|
||||||
|
table.dropColumn('palette_primary_dark');
|
||||||
|
table.dropColumn('palette_primary_light');
|
||||||
|
table.dropColumn('palette_primary_main');
|
||||||
|
table.dropColumn('title');
|
||||||
|
|
||||||
|
table.string('key').unique().notNullable().alter();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function getValueForKey(rows, key) {
|
||||||
|
const row = rows.find((row) => row.key === key);
|
||||||
|
|
||||||
|
return row?.value?.data || null;
|
||||||
|
}
|
@@ -1,3 +1,4 @@
|
|||||||
|
import appConfig from '../config/app.js';
|
||||||
import Base from './base.js';
|
import Base from './base.js';
|
||||||
|
|
||||||
class Config extends Base {
|
class Config extends Base {
|
||||||
@@ -5,68 +6,79 @@ class Config extends Base {
|
|||||||
|
|
||||||
static jsonSchema = {
|
static jsonSchema = {
|
||||||
type: 'object',
|
type: 'object',
|
||||||
required: ['key', 'value'],
|
|
||||||
|
|
||||||
properties: {
|
properties: {
|
||||||
id: { type: 'string', format: 'uuid' },
|
id: { type: 'string', format: 'uuid' },
|
||||||
key: { type: 'string', minLength: 1 },
|
installationCompleted: { type: 'boolean' },
|
||||||
value: { type: 'object' },
|
logoSvgData: { type: ['string', 'null'] },
|
||||||
|
palettePrimaryDark: { type: ['string', 'null'] },
|
||||||
|
palettePrimaryLight: { type: ['string', 'null'] },
|
||||||
|
palettePrimaryMain: { type: ['string', 'null'] },
|
||||||
|
title: { type: ['string', 'null'] },
|
||||||
|
createdAt: { type: 'string' },
|
||||||
|
updatedAt: { type: 'string' },
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [
|
||||||
|
'disableNotificationsPage',
|
||||||
|
'disableFavicon',
|
||||||
|
'additionalDrawerLink',
|
||||||
|
'additionalDrawerLinkIcon',
|
||||||
|
'additionalDrawerLinkText',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
get disableNotificationsPage() {
|
||||||
|
return appConfig.disableNotificationsPage;
|
||||||
|
}
|
||||||
|
|
||||||
|
get disableFavicon() {
|
||||||
|
return appConfig.disableFavicon;
|
||||||
|
}
|
||||||
|
|
||||||
|
get additionalDrawerLink() {
|
||||||
|
return appConfig.additionalDrawerLink;
|
||||||
|
}
|
||||||
|
|
||||||
|
get additionalDrawerLinkIcon() {
|
||||||
|
return appConfig.additionalDrawerLinkIcon;
|
||||||
|
}
|
||||||
|
|
||||||
|
get additionalDrawerLinkText() {
|
||||||
|
return appConfig.additionalDrawerLinkText;
|
||||||
|
}
|
||||||
|
|
||||||
|
static async get() {
|
||||||
|
const existingConfig = await this.query().limit(1).first();
|
||||||
|
|
||||||
|
if (!existingConfig) {
|
||||||
|
return await this.query().insertAndFetch({});
|
||||||
|
}
|
||||||
|
|
||||||
|
return existingConfig;
|
||||||
|
}
|
||||||
|
|
||||||
|
static async update(config) {
|
||||||
|
const configEntry = await this.get();
|
||||||
|
|
||||||
|
return await configEntry.$query().patchAndFetch(config);
|
||||||
|
}
|
||||||
|
|
||||||
static async isInstallationCompleted() {
|
static async isInstallationCompleted() {
|
||||||
const installationCompletedEntry = await this.query()
|
const config = await this.get();
|
||||||
.where({
|
|
||||||
key: 'installation.completed',
|
|
||||||
})
|
|
||||||
.first();
|
|
||||||
|
|
||||||
const installationCompleted =
|
return config.installationCompleted;
|
||||||
installationCompletedEntry?.value?.data === true;
|
|
||||||
|
|
||||||
return installationCompleted;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
static async markInstallationCompleted() {
|
static async markInstallationCompleted() {
|
||||||
return await this.query().insert({
|
const config = await this.get();
|
||||||
key: 'installation.completed',
|
|
||||||
value: {
|
return await config.$query().patchAndFetch({
|
||||||
data: true,
|
installationCompleted: true,
|
||||||
},
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
static async batchUpdate(config) {
|
|
||||||
const configKeys = Object.keys(config);
|
|
||||||
const updates = [];
|
|
||||||
|
|
||||||
for (const key of configKeys) {
|
|
||||||
const newValue = config[key];
|
|
||||||
|
|
||||||
if (newValue) {
|
|
||||||
const entryUpdate = Config.query()
|
|
||||||
.insert({
|
|
||||||
key,
|
|
||||||
value: {
|
|
||||||
data: newValue,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
.onConflict('key')
|
|
||||||
.merge({
|
|
||||||
value: {
|
|
||||||
data: newValue,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
updates.push(entryUpdate);
|
|
||||||
} else {
|
|
||||||
const entryUpdate = Config.query().findOne({ key }).delete();
|
|
||||||
updates.push(entryUpdate);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return await Promise.all(updates);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export default Config;
|
export default Config;
|
||||||
|
@@ -53,6 +53,18 @@ class ExtendedQueryBuilder extends Model.QueryBuilder {
|
|||||||
[DELETED_COLUMN_NAME]: null,
|
[DELETED_COLUMN_NAME]: null,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async updateFirstOrInsert(data = {}) {
|
||||||
|
let firstRow = await this.first();
|
||||||
|
|
||||||
|
if (firstRow) {
|
||||||
|
return firstRow.$query().patchAndFetch(data);
|
||||||
|
}
|
||||||
|
|
||||||
|
const newInstance = this.insertAndFetch(data);
|
||||||
|
|
||||||
|
return newInstance;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export default ExtendedQueryBuilder;
|
export default ExtendedQueryBuilder;
|
||||||
|
20
packages/backend/src/serializers/config.js
Normal file
20
packages/backend/src/serializers/config.js
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
const configSerializer = (config) => {
|
||||||
|
return {
|
||||||
|
id: config.id,
|
||||||
|
updatedAt: config.updatedAt.getTime(),
|
||||||
|
createdAt: config.createdAt.getTime(),
|
||||||
|
disableFavicon: config.disableFavicon,
|
||||||
|
disableNotificationsPage: config.disableNotificationsPage,
|
||||||
|
additionalDrawerLink: config.additionalDrawerLink,
|
||||||
|
additionalDrawerLinkIcon: config.additionalDrawerLinkIcon,
|
||||||
|
additionalDrawerLinkText: config.additionalDrawerLinkText,
|
||||||
|
logoSvgData: config.logoSvgData,
|
||||||
|
palettePrimaryDark: config.palettePrimaryDark,
|
||||||
|
palettePrimaryMain: config.palettePrimaryMain,
|
||||||
|
palettePrimaryLight: config.palettePrimaryLight,
|
||||||
|
installationCompleted: config.installationCompleted,
|
||||||
|
title: config.title,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export default configSerializer;
|
32
packages/backend/src/serializers/config.test.js
Normal file
32
packages/backend/src/serializers/config.test.js
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
import { describe, it, expect, beforeEach } from 'vitest';
|
||||||
|
import { getConfig } from '../../test/factories/config';
|
||||||
|
import configSerializer from './config';
|
||||||
|
|
||||||
|
describe('configSerializer', () => {
|
||||||
|
let config;
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
config = await getConfig();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should return config data', async () => {
|
||||||
|
const expectedPayload = {
|
||||||
|
id: config.id,
|
||||||
|
disableFavicon: config.disableFavicon,
|
||||||
|
disableNotificationsPage: config.disableNotificationsPage,
|
||||||
|
logoSvgData: config.logoSvgData,
|
||||||
|
palettePrimaryDark: config.palettePrimaryDark,
|
||||||
|
palettePrimaryMain: config.palettePrimaryMain,
|
||||||
|
palettePrimaryLight: config.palettePrimaryLight,
|
||||||
|
installationCompleted: config.installationCompleted,
|
||||||
|
title: config.title,
|
||||||
|
additionalDrawerLink: config.additionalDrawerLink,
|
||||||
|
additionalDrawerLinkIcon: config.additionalDrawerLinkIcon,
|
||||||
|
additionalDrawerLinkText: config.additionalDrawerLinkText,
|
||||||
|
createdAt: config.createdAt.getTime(),
|
||||||
|
updatedAt: config.updatedAt.getTime(),
|
||||||
|
};
|
||||||
|
|
||||||
|
expect(configSerializer(config)).toEqual(expectedPayload);
|
||||||
|
});
|
||||||
|
});
|
@@ -17,6 +17,7 @@ import executionSerializer from './execution.js';
|
|||||||
import executionStepSerializer from './execution-step.js';
|
import executionStepSerializer from './execution-step.js';
|
||||||
import subscriptionSerializer from './subscription.ee.js';
|
import subscriptionSerializer from './subscription.ee.js';
|
||||||
import adminUserSerializer from './admin/user.js';
|
import adminUserSerializer from './admin/user.js';
|
||||||
|
import configSerializer from './config.js';
|
||||||
|
|
||||||
const serializers = {
|
const serializers = {
|
||||||
AdminUser: adminUserSerializer,
|
AdminUser: adminUserSerializer,
|
||||||
@@ -38,6 +39,7 @@ const serializers = {
|
|||||||
Execution: executionSerializer,
|
Execution: executionSerializer,
|
||||||
ExecutionStep: executionStepSerializer,
|
ExecutionStep: executionStepSerializer,
|
||||||
Subscription: subscriptionSerializer,
|
Subscription: subscriptionSerializer,
|
||||||
|
Config: configSerializer,
|
||||||
};
|
};
|
||||||
|
|
||||||
export default serializers;
|
export default serializers;
|
||||||
|
@@ -1,35 +1,15 @@
|
|||||||
import { faker } from '@faker-js/faker';
|
|
||||||
import Config from '../../src/models/config';
|
import Config from '../../src/models/config';
|
||||||
|
|
||||||
export const createConfig = async (params = {}) => {
|
export const getConfig = async () => {
|
||||||
const configData = {
|
return await Config.get();
|
||||||
key: params?.key || faker.lorem.word(),
|
|
||||||
value: params?.value || { data: 'sampleConfig' },
|
|
||||||
};
|
|
||||||
|
|
||||||
const config = await Config.query().insertAndFetch(configData);
|
|
||||||
|
|
||||||
return config;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const createBulkConfig = async (params = {}) => {
|
export const updateConfig = async (params = {}) => {
|
||||||
const updateQueries = Object.entries(params).map(([key, value]) => {
|
return await Config.update(params);
|
||||||
const config = {
|
|
||||||
key,
|
|
||||||
value: { data: value },
|
|
||||||
};
|
|
||||||
|
|
||||||
return createConfig(config);
|
|
||||||
});
|
|
||||||
|
|
||||||
await Promise.all(updateQueries);
|
|
||||||
|
|
||||||
return await Config.query().whereIn('key', Object.keys(params));
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const createInstallationCompletedConfig = async () => {
|
export const markInstallationCompleted = async () => {
|
||||||
return await createConfig({
|
return await updateConfig({
|
||||||
key: 'installation.completed',
|
installationCompleted: true,
|
||||||
value: { data: true },
|
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
@@ -1,28 +1,29 @@
|
|||||||
const infoMock = (
|
const configMock = (config) => {
|
||||||
logoConfig,
|
|
||||||
primaryDarkConfig,
|
|
||||||
primaryLightConfig,
|
|
||||||
primaryMainConfig,
|
|
||||||
titleConfig
|
|
||||||
) => {
|
|
||||||
return {
|
return {
|
||||||
data: {
|
data: {
|
||||||
disableFavicon: false,
|
id: config.id,
|
||||||
disableNotificationsPage: false,
|
updatedAt: config.updatedAt.getTime(),
|
||||||
'logo.svgData': logoConfig.value.data,
|
createdAt: config.createdAt.getTime(),
|
||||||
'palette.primary.dark': primaryDarkConfig.value.data,
|
disableFavicon: config.disableFavicon,
|
||||||
'palette.primary.light': primaryLightConfig.value.data,
|
disableNotificationsPage: config.disableNotificationsPage,
|
||||||
'palette.primary.main': primaryMainConfig.value.data,
|
additionalDrawerLink: config.additionalDrawerLink,
|
||||||
title: titleConfig.value.data,
|
additionalDrawerLinkIcon: config.additionalDrawerLinkIcon,
|
||||||
|
additionalDrawerLinkText: config.additionalDrawerLinkText,
|
||||||
|
logoSvgData: config.logoSvgData,
|
||||||
|
palettePrimaryDark: config.palettePrimaryDark,
|
||||||
|
palettePrimaryMain: config.palettePrimaryMain,
|
||||||
|
palettePrimaryLight: config.palettePrimaryLight,
|
||||||
|
installationCompleted: config.installationCompleted || false,
|
||||||
|
title: config.title,
|
||||||
},
|
},
|
||||||
meta: {
|
meta: {
|
||||||
count: 1,
|
count: 1,
|
||||||
currentPage: null,
|
currentPage: null,
|
||||||
isArray: false,
|
isArray: false,
|
||||||
totalPages: null,
|
totalPages: null,
|
||||||
type: 'Object',
|
type: 'Config',
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export default infoMock;
|
export default configMock;
|
||||||
|
@@ -2,7 +2,6 @@ import PropTypes from 'prop-types';
|
|||||||
import CssBaseline from '@mui/material/CssBaseline';
|
import CssBaseline from '@mui/material/CssBaseline';
|
||||||
import { ThemeProvider as BaseThemeProvider } from '@mui/material/styles';
|
import { ThemeProvider as BaseThemeProvider } from '@mui/material/styles';
|
||||||
import clone from 'lodash/clone';
|
import clone from 'lodash/clone';
|
||||||
import get from 'lodash/get';
|
|
||||||
import set from 'lodash/set';
|
import set from 'lodash/set';
|
||||||
import * as React from 'react';
|
import * as React from 'react';
|
||||||
|
|
||||||
@@ -10,18 +9,33 @@ import useAutomatischInfo from 'hooks/useAutomatischInfo';
|
|||||||
import useAutomatischConfig from 'hooks/useAutomatischConfig';
|
import useAutomatischConfig from 'hooks/useAutomatischConfig';
|
||||||
import { defaultTheme, mationTheme } from 'styles/theme';
|
import { defaultTheme, mationTheme } from 'styles/theme';
|
||||||
|
|
||||||
|
const overrideIfGiven = (theme, key, value) => {
|
||||||
|
if (value) {
|
||||||
|
set(theme, key, value);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
const customizeTheme = (theme, config) => {
|
const customizeTheme = (theme, config) => {
|
||||||
// `clone` is needed so that the new theme reference triggers re-render
|
// `clone` is needed so that the new theme reference triggers re-render
|
||||||
const shallowDefaultTheme = clone(theme);
|
const shallowDefaultTheme = clone(theme);
|
||||||
|
|
||||||
for (const key in config) {
|
overrideIfGiven(
|
||||||
const value = config[key];
|
shallowDefaultTheme,
|
||||||
const exists = get(theme, key);
|
'palette.primary.main',
|
||||||
|
config.palettePrimaryMain,
|
||||||
|
);
|
||||||
|
|
||||||
if (exists) {
|
overrideIfGiven(
|
||||||
set(shallowDefaultTheme, key, value);
|
shallowDefaultTheme,
|
||||||
}
|
'palette.primary.light',
|
||||||
}
|
config.palettePrimaryLight,
|
||||||
|
);
|
||||||
|
|
||||||
|
overrideIfGiven(
|
||||||
|
shallowDefaultTheme,
|
||||||
|
'palette.primary.dark',
|
||||||
|
config.palettePrimaryDark,
|
||||||
|
);
|
||||||
|
|
||||||
return shallowDefaultTheme;
|
return shallowDefaultTheme;
|
||||||
};
|
};
|
||||||
|
@@ -6,7 +6,7 @@ export default function useAdminUpdateConfig(appKey) {
|
|||||||
|
|
||||||
const query = useMutation({
|
const query = useMutation({
|
||||||
mutationFn: async (payload) => {
|
mutationFn: async (payload) => {
|
||||||
const { data } = await api.patch(`/v1/admin/config`, payload);
|
const { data } = await api.patch('/v1/admin/config', payload);
|
||||||
|
|
||||||
return data;
|
return data;
|
||||||
},
|
},
|
||||||
|
@@ -2,7 +2,7 @@ import LoadingButton from '@mui/lab/LoadingButton';
|
|||||||
import Grid from '@mui/material/Grid';
|
import Grid from '@mui/material/Grid';
|
||||||
import Skeleton from '@mui/material/Skeleton';
|
import Skeleton from '@mui/material/Skeleton';
|
||||||
import Stack from '@mui/material/Stack';
|
import Stack from '@mui/material/Stack';
|
||||||
import merge from 'lodash/merge';
|
import mergeWith from 'lodash/mergeWith';
|
||||||
import * as React from 'react';
|
import * as React from 'react';
|
||||||
|
|
||||||
import ColorInput from 'components/ColorInput';
|
import ColorInput from 'components/ColorInput';
|
||||||
@@ -10,7 +10,6 @@ import Container from 'components/Container';
|
|||||||
import Form from 'components/Form';
|
import Form from 'components/Form';
|
||||||
import PageTitle from 'components/PageTitle';
|
import PageTitle from 'components/PageTitle';
|
||||||
import TextField from 'components/TextField';
|
import TextField from 'components/TextField';
|
||||||
import nestObject from 'helpers/nestObject';
|
|
||||||
import useAdminUpdateConfig from 'hooks/useAdminUpdateConfig';
|
import useAdminUpdateConfig from 'hooks/useAdminUpdateConfig';
|
||||||
import useAutomatischConfig from 'hooks/useAutomatischConfig';
|
import useAutomatischConfig from 'hooks/useAutomatischConfig';
|
||||||
import useFormatMessage from 'hooks/useFormatMessage';
|
import useFormatMessage from 'hooks/useFormatMessage';
|
||||||
@@ -27,9 +26,17 @@ const getPrimaryLightColor = (color) => color || primaryLightColor;
|
|||||||
|
|
||||||
const defaultValues = {
|
const defaultValues = {
|
||||||
title: 'Automatisch',
|
title: 'Automatisch',
|
||||||
'palette.primary.main': primaryMainColor,
|
palettePrimaryMain: primaryMainColor,
|
||||||
'palette.primary.dark': primaryDarkColor,
|
palettePrimaryDark: primaryDarkColor,
|
||||||
'palette.primary.light': primaryLightColor,
|
palettePrimaryLight: primaryLightColor,
|
||||||
|
};
|
||||||
|
|
||||||
|
const mergeIfGiven = (oldValue, newValue) => {
|
||||||
|
if (newValue) {
|
||||||
|
return newValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
return oldValue;
|
||||||
};
|
};
|
||||||
|
|
||||||
export default function UserInterface() {
|
export default function UserInterface() {
|
||||||
@@ -39,21 +46,16 @@ export default function UserInterface() {
|
|||||||
const config = configData?.data;
|
const config = configData?.data;
|
||||||
|
|
||||||
const enqueueSnackbar = useEnqueueSnackbar();
|
const enqueueSnackbar = useEnqueueSnackbar();
|
||||||
const configWithDefaults = merge({}, defaultValues, nestObject(config));
|
const configWithDefaults = mergeWith(defaultValues, config, mergeIfGiven);
|
||||||
|
|
||||||
const handleUserInterfaceUpdate = async (uiData) => {
|
const handleUserInterfaceUpdate = async (uiData) => {
|
||||||
try {
|
try {
|
||||||
const input = {
|
const input = {
|
||||||
title: uiData?.title,
|
title: uiData.title,
|
||||||
'palette.primary.main': getPrimaryMainColor(
|
palettePrimaryMain: getPrimaryMainColor(uiData.palettePrimaryMain),
|
||||||
uiData?.palette?.primary.main,
|
palettePrimaryDark: getPrimaryDarkColor(uiData.palettePrimaryDark),
|
||||||
),
|
palettePrimaryLight: getPrimaryLightColor(uiData.palettePrimaryLight),
|
||||||
'palette.primary.dark': getPrimaryDarkColor(
|
'logo.svgData': uiData.logoSvgData,
|
||||||
uiData?.palette?.primary.dark,
|
|
||||||
),
|
|
||||||
'palette.primary.light': getPrimaryLightColor(
|
|
||||||
uiData?.palette?.primary.light,
|
|
||||||
),
|
|
||||||
'logo.svgData': uiData?.logo?.svgData,
|
|
||||||
};
|
};
|
||||||
await updateConfig(input);
|
await updateConfig(input);
|
||||||
enqueueSnackbar(formatMessage('userInterfacePage.successfullyUpdated'), {
|
enqueueSnackbar(formatMessage('userInterfacePage.successfullyUpdated'), {
|
||||||
@@ -66,6 +68,7 @@ export default function UserInterface() {
|
|||||||
throw new Error('Failed while updating!');
|
throw new Error('Failed while updating!');
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Container sx={{ py: 3, display: 'flex', justifyContent: 'center' }}>
|
<Container sx={{ py: 3, display: 'flex', justifyContent: 'center' }}>
|
||||||
<Grid container item xs={12} sm={10} md={9}>
|
<Grid container item xs={12} sm={10} md={9}>
|
||||||
@@ -96,7 +99,7 @@ export default function UserInterface() {
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
<ColorInput
|
<ColorInput
|
||||||
name="palette.primary.main"
|
name="palettePrimaryMain"
|
||||||
label={formatMessage(
|
label={formatMessage(
|
||||||
'userInterfacePage.primaryMainColorFieldLabel',
|
'userInterfacePage.primaryMainColorFieldLabel',
|
||||||
)}
|
)}
|
||||||
@@ -105,7 +108,7 @@ export default function UserInterface() {
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
<ColorInput
|
<ColorInput
|
||||||
name="palette.primary.dark"
|
name="palettePrimaryDark"
|
||||||
label={formatMessage(
|
label={formatMessage(
|
||||||
'userInterfacePage.primaryDarkColorFieldLabel',
|
'userInterfacePage.primaryDarkColorFieldLabel',
|
||||||
)}
|
)}
|
||||||
@@ -114,7 +117,7 @@ export default function UserInterface() {
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
<ColorInput
|
<ColorInput
|
||||||
name="palette.primary.light"
|
name="palettePrimaryLight"
|
||||||
label={formatMessage(
|
label={formatMessage(
|
||||||
'userInterfacePage.primaryLightColorFieldLabel',
|
'userInterfacePage.primaryLightColorFieldLabel',
|
||||||
)}
|
)}
|
||||||
@@ -123,7 +126,7 @@ export default function UserInterface() {
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
<TextField
|
<TextField
|
||||||
name="logo.svgData"
|
name="logoSvgData"
|
||||||
label={formatMessage('userInterfacePage.svgDataFieldLabel')}
|
label={formatMessage('userInterfacePage.svgDataFieldLabel')}
|
||||||
multiline
|
multiline
|
||||||
fullWidth
|
fullWidth
|
||||||
|
Reference in New Issue
Block a user