Compare commits

..

2 Commits

Author SHA1 Message Date
Jakub P.
53d95366e9 test: use new alert in create role and create user tests 2024-12-12 10:56:14 +00:00
kasia.oczkowska
7a8dc68592 feat: introduce inline error messages for create user and create role forms 2024-12-12 10:56:14 +00:00
20 changed files with 932 additions and 757 deletions

View File

@@ -1,52 +0,0 @@
name: release-tag
on:
push:
branches:
- 'main'
jobs:
release-image:
runs-on: ubuntu-latest
env:
DOCKER_ORG: groot
DOCKER_LATEST: latest
RUNNER_TOOL_CACHE: /toolcache
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up QEMU
uses: docker/setup-qemu-action@v2
- name: Set up Docker BuildX
uses: docker/setup-buildx-action@v2
with: # replace it with your local IP
config-inline: |
[registry."git.send.nrw"]
http = true
insecure = true
- name: Login to DockerHub
uses: docker/login-action@v2
with:
registry: git.send.nrw # replace it with your local IP
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Get Meta
id: meta
run: |
echo REPO_NAME=$(echo ${GITHUB_REPOSITORY} | awk -F"/" '{print $2}') >> $GITHUB_OUTPUT
echo REPO_VERSION=$(git describe --tags --always | sed 's/^v//') >> $GITHUB_OUTPUT
- name: Build and push
uses: docker/build-push-action@v4
with:
context: ./docker
file: ./docker/Dockerfile.compose
entrypoint: ./docker/compose-entrypoint.sh
platforms: |
linux/amd64
push: true
tags: | # replace it with your local IP and tags
git.send.nrw/${{ env.DOCKER_ORG }}/${{ steps.meta.outputs.REPO_NAME }}:${{ steps.meta.outputs.REPO_VERSION }}
git.send.nrw/${{ env.DOCKER_ORG }}/${{ steps.meta.outputs.REPO_NAME }}:${{ env.DOCKER_LATEST }}

View File

@@ -1,7 +1,10 @@
version: '3.9' version: '3.9'
services: services:
main: main:
image: git.send.nrw/groot/automatisch:latest build:
context: ./docker
dockerfile: Dockerfile.compose
entrypoint: /compose-entrypoint.sh
ports: ports:
- '3000:3000' - '3000:3000'
depends_on: depends_on:
@@ -25,7 +28,10 @@ services:
volumes: volumes:
- automatisch_storage:/automatisch/storage - automatisch_storage:/automatisch/storage
worker: worker:
image: git.send.nrw/groot/automatisch:latest build:
context: ./docker
dockerfile: Dockerfile.compose
entrypoint: /compose-entrypoint.sh
depends_on: depends_on:
- main - main
environment: environment:

View File

@@ -1,4 +1,27 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const actionQueue = new Queue('action', redisConnection);
actionQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error('Error happened in action queue!', error);
});
const actionQueue = generateQueue('action');
export default actionQueue; export default actionQueue;

View File

@@ -1,4 +1,27 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const deleteUserQueue = new Queue('delete-user', redisConnection);
deleteUserQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error('Error happened in delete user queue!', error);
});
const deleteUserQueue = generateQueue('delete-user');
export default deleteUserQueue; export default deleteUserQueue;

View File

@@ -1,4 +1,27 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const emailQueue = new Queue('email', redisConnection);
emailQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error('Error happened in email queue!', error);
});
const emailQueue = generateQueue('email');
export default emailQueue; export default emailQueue;

View File

@@ -1,4 +1,27 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const flowQueue = new Queue('flow', redisConnection);
flowQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error('Error happened in flow queue!', error);
});
const flowQueue = generateQueue('flow');
export default flowQueue; export default flowQueue;

View File

@@ -1,44 +0,0 @@
import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
export const generateQueue = (queueName, options) => {
const queue = new Queue(queueName, redisConnection);
queue.on('error', (error) => queueOnError(error, queueName));
if (options?.runDaily) addScheduler(queueName, queue);
return queue;
};
const queueOnError = (error, queueName) => {
if (error.code === CONNECTION_REFUSED) {
const errorMessage =
'Make sure you have installed Redis and it is running.';
logger.error(errorMessage, error);
process.exit();
}
logger.error(`Error happened in ${queueName} queue!`, error);
};
const addScheduler = (queueName, queue) => {
const everydayAtOneOclock = '0 1 * * *';
queue.add(queueName, null, {
jobId: queueName,
repeat: {
pattern: everydayAtOneOclock,
},
});
};

View File

@@ -1,8 +1,40 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const removeCancelledSubscriptionsQueue = generateQueue( const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const removeCancelledSubscriptionsQueue = new Queue(
'remove-cancelled-subscriptions', 'remove-cancelled-subscriptions',
{ runDaily: true } redisConnection
); );
removeCancelledSubscriptionsQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error(
'Error happened in remove cancelled subscriptions queue!',
error
);
});
removeCancelledSubscriptionsQueue.add('remove-cancelled-subscriptions', null, {
jobId: 'remove-cancelled-subscriptions',
repeat: {
pattern: '0 1 * * *',
},
});
export default removeCancelledSubscriptionsQueue; export default removeCancelledSubscriptionsQueue;

View File

@@ -1,4 +1,27 @@
import { generateQueue } from './queue.js'; import process from 'process';
import { Queue } from 'bullmq';
import redisConfig from '../config/redis.js';
import logger from '../helpers/logger.js';
const CONNECTION_REFUSED = 'ECONNREFUSED';
const redisConnection = {
connection: redisConfig,
};
const triggerQueue = new Queue('trigger', redisConnection);
triggerQueue.on('error', (error) => {
if (error.code === CONNECTION_REFUSED) {
logger.error(
'Make sure you have installed Redis and it is running.',
error
);
process.exit();
}
logger.error('Error happened in trigger queue!', error);
});
const triggerQueue = generateQueue('trigger');
export default triggerQueue; export default triggerQueue;

View File

@@ -1,3 +1,5 @@
const { expect } = require('@playwright/test');
const { faker } = require('@faker-js/faker'); const { faker } = require('@faker-js/faker');
const { AuthenticatedPage } = require('../authenticated-page'); const { AuthenticatedPage } = require('../authenticated-page');
@@ -11,11 +13,17 @@ export class AdminCreateUserPage extends AuthenticatedPage {
super(page); super(page);
this.fullNameInput = page.getByTestId('full-name-input'); this.fullNameInput = page.getByTestId('full-name-input');
this.emailInput = page.getByTestId('email-input'); this.emailInput = page.getByTestId('email-input');
this.roleInput = page.getByTestId('role.id-autocomplete'); this.roleInput = page.getByTestId('roleId-autocomplete');
this.createButton = page.getByTestId('create-button'); this.createButton = page.getByTestId('create-button');
this.pageTitle = page.getByTestId('create-user-title'); this.pageTitle = page.getByTestId('create-user-title');
this.invitationEmailInfoAlert = page.getByTestId('invitation-email-info-alert'); this.invitationEmailInfoAlert = page.getByTestId(
this.acceptInvitationLink = page.getByTestId('invitation-email-info-alert').getByRole('link'); 'invitation-email-info-alert'
);
this.acceptInvitationLink = page
.getByTestId('invitation-email-info-alert')
.getByRole('link');
this.createUserSuccessAlert = page.getByTestId('create-user-success-alert');
this.fieldError = page.locator('p[id$="-helper-text"]');
} }
seed(seed) { seed(seed) {
@@ -28,4 +36,8 @@ export class AdminCreateUserPage extends AuthenticatedPage {
email: faker.internet.email().toLowerCase(), email: faker.internet.email().toLowerCase(),
}; };
} }
async expectCreateUserSuccessAlertToBeVisible() {
await expect(this.createUserSuccessAlert).toBeVisible();
}
} }

View File

@@ -35,9 +35,8 @@ test.describe('Role management page', () => {
await adminCreateRolePage.closeSnackbar(); await adminCreateRolePage.closeSnackbar();
}); });
let roleRow = await test.step( let roleRow =
'Make sure role data is correct', await test.step('Make sure role data is correct', async () => {
async () => {
const roleRow = await adminRolesPage.getRoleRowByName( const roleRow = await adminRolesPage.getRoleRowByName(
'Create Edit Test' 'Create Edit Test'
); );
@@ -48,8 +47,7 @@ test.describe('Role management page', () => {
await expect(roleData.canEdit).toBe(true); await expect(roleData.canEdit).toBe(true);
await expect(roleData.canDelete).toBe(true); await expect(roleData.canDelete).toBe(true);
return roleRow; return roleRow;
} });
);
await test.step('Edit the role', async () => { await test.step('Edit the role', async () => {
await adminRolesPage.clickEditRole(roleRow); await adminRolesPage.clickEditRole(roleRow);
@@ -67,9 +65,8 @@ test.describe('Role management page', () => {
await adminEditRolePage.closeSnackbar(); await adminEditRolePage.closeSnackbar();
}); });
roleRow = await test.step( roleRow =
'Make sure changes reflected on roles page', await test.step('Make sure changes reflected on roles page', async () => {
async () => {
await adminRolesPage.isMounted(); await adminRolesPage.isMounted();
const roleRow = await adminRolesPage.getRoleRowByName( const roleRow = await adminRolesPage.getRoleRowByName(
'Create Update Test' 'Create Update Test'
@@ -81,8 +78,7 @@ test.describe('Role management page', () => {
await expect(roleData.canEdit).toBe(true); await expect(roleData.canEdit).toBe(true);
await expect(roleData.canDelete).toBe(true); await expect(roleData.canDelete).toBe(true);
return roleRow; return roleRow;
} });
);
await test.step('Delete the role', async () => { await test.step('Delete the role', async () => {
await adminRolesPage.clickDeleteRole(roleRow); await adminRolesPage.clickDeleteRole(roleRow);
@@ -184,9 +180,7 @@ test.describe('Role management page', () => {
await expect(snackbar.variant).toBe('success'); await expect(snackbar.variant).toBe('success');
await adminCreateRolePage.closeSnackbar(); await adminCreateRolePage.closeSnackbar();
}); });
await test.step( await test.step('Create a new user with the "Delete Role" role', async () => {
'Create a new user with the "Delete Role" role',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill('User Role Test'); await adminCreateUserPage.fullNameInput.fill('User Role Test');
@@ -198,22 +192,13 @@ test.describe('Role management page', () => {
.getByRole('option', { name: 'Delete Role', exact: true }) .getByRole('option', { name: 'Delete Role', exact: true })
.click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
await adminCreateUserPage.snackbar.waitFor({
state: 'attached',
});
await adminCreateUserPage.invitationEmailInfoAlert.waitFor({ await adminCreateUserPage.invitationEmailInfoAlert.waitFor({
state: 'attached', state: 'attached',
}); });
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success' });
);
await expect(snackbar.variant).toBe('success'); await test.step('Try to delete "Delete Role" role when new user has it', async () => {
await adminUsersPage.closeSnackbar();
}
);
await test.step(
'Try to delete "Delete Role" role when new user has it',
async () => {
await adminRolesPage.navigateTo(); await adminRolesPage.navigateTo();
const row = await adminRolesPage.getRoleRowByName('Delete Role'); const row = await adminRolesPage.getRoleRowByName('Delete Role');
const modal = await adminRolesPage.clickDeleteRole(row); const modal = await adminRolesPage.clickDeleteRole(row);
@@ -221,12 +206,13 @@ test.describe('Role management page', () => {
await adminRolesPage.snackbar.waitFor({ await adminRolesPage.snackbar.waitFor({
state: 'attached', state: 'attached',
}); });
const snackbar = await adminRolesPage.getSnackbarData('snackbar-delete-role-error'); const snackbar = await adminRolesPage.getSnackbarData(
'snackbar-delete-role-error'
);
await expect(snackbar.variant).toBe('error'); await expect(snackbar.variant).toBe('error');
await adminRolesPage.closeSnackbar(); await adminRolesPage.closeSnackbar();
await modal.close(); await modal.close();
} });
);
await test.step('Change the role the user has', async () => { await test.step('Change the role the user has', async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.usersLoader.waitFor({ await adminUsersPage.usersLoader.waitFor({
@@ -301,24 +287,16 @@ test.describe('Role management page', () => {
.getByRole('option', { name: 'Cannot Delete Role' }) .getByRole('option', { name: 'Cannot Delete Role' })
.click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
await adminCreateUserPage.snackbar.waitFor({
state: 'attached',
});
await adminCreateUserPage.invitationEmailInfoAlert.waitFor({ await adminCreateUserPage.invitationEmailInfoAlert.waitFor({
state: 'attached', state: 'attached',
}); });
const snackbar = await adminCreateUserPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success'
);
await expect(snackbar.variant).toBe('success');
await adminCreateUserPage.closeSnackbar();
}); });
await test.step('Delete this user', async () => { await test.step('Delete this user', async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
const row = await adminUsersPage.findUserPageWithEmail( const row = await adminUsersPage.findUserPageWithEmail(
'user-delete-role-test@automatisch.io' 'user-delete-role-test@automatisch.io'
); );
// await test.waitForTimeout(10000);
const modal = await adminUsersPage.clickDeleteUser(row); const modal = await adminUsersPage.clickDeleteUser(row);
await modal.deleteButton.click(); await modal.deleteButton.click();
await adminUsersPage.snackbar.waitFor({ await adminUsersPage.snackbar.waitFor({
@@ -385,17 +363,10 @@ test('Accessibility of role management page', async ({
.getByRole('option', { name: 'Basic Test' }) .getByRole('option', { name: 'Basic Test' })
.click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
await adminCreateUserPage.snackbar.waitFor({
state: 'attached',
});
await adminCreateUserPage.invitationEmailInfoAlert.waitFor({ await adminCreateUserPage.invitationEmailInfoAlert.waitFor({
state: 'attached', state: 'attached',
}); });
const snackbar = await adminCreateUserPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success'
);
await expect(snackbar.variant).toBe('success');
await adminCreateUserPage.closeSnackbar();
}); });
await test.step('Logout and login to the basic role user', async () => { await test.step('Logout and login to the basic role user', async () => {
@@ -409,22 +380,16 @@ test('Accessibility of role management page', async ({
await page.getByTestId('logout-item').click(); await page.getByTestId('logout-item').click();
const acceptInvitationPage = new AcceptInvitation(page); const acceptInvitationPage = new AcceptInvitation(page);
await acceptInvitationPage.open(acceptInvitatonToken); await acceptInvitationPage.open(acceptInvitatonToken);
await acceptInvitationPage.acceptInvitation('sample'); await acceptInvitationPage.acceptInvitation('sample');
const loginPage = new LoginPage(page); const loginPage = new LoginPage(page);
// await loginPage.isMounted();
await loginPage.login('basic-role-test@automatisch.io', 'sample'); await loginPage.login('basic-role-test@automatisch.io', 'sample');
await expect(loginPage.loginButton).not.toBeVisible(); await expect(loginPage.loginButton).not.toBeVisible();
await expect(page).toHaveURL('/flows'); await expect(page).toHaveURL('/flows');
}); });
await test.step( await test.step('Navigate to the admin settings page and make sure it is blank', async () => {
'Navigate to the admin settings page and make sure it is blank',
async () => {
const pageUrl = new URL(page.url()); const pageUrl = new URL(page.url());
const url = `${pageUrl.origin}/admin-settings/users`; const url = `${pageUrl.origin}/admin-settings/users`;
await page.goto(url); await page.goto(url);
@@ -443,8 +408,7 @@ test('Accessibility of role management page', async ({
return false; return false;
}); });
await expect(isUnmounted).toBe(true); await expect(isUnmounted).toBe(true);
} });
);
await test.step('Log back into the admin account', async () => { await test.step('Log back into the admin account', async () => {
await page.goto('/'); await page.goto('/');

View File

@@ -5,15 +5,16 @@ const { test, expect } = require('../../fixtures/index');
* otherwise tests will fail since users are only *soft*-deleted * otherwise tests will fail since users are only *soft*-deleted
*/ */
test.describe('User management page', () => { test.describe('User management page', () => {
test.beforeEach(async ({ adminUsersPage }) => { test.beforeEach(async ({ adminUsersPage }) => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.closeSnackbar(); await adminUsersPage.closeSnackbar();
}); });
test( test('User creation and deletion process', async ({
'User creation and deletion process', adminCreateUserPage,
async ({ adminCreateUserPage, adminEditUserPage, adminUsersPage }) => { adminEditUserPage,
adminUsersPage,
}) => {
adminCreateUserPage.seed(9000); adminCreateUserPage.seed(9000);
const user = adminCreateUserPage.generateUser(); const user = adminCreateUserPage.generateUser();
await adminUsersPage.usersLoader.waitFor({ await adminUsersPage.usersLoader.waitFor({
@@ -21,45 +22,33 @@ test.describe('User management page', () => {
because visibility: hidden is used as part of the state transition in because visibility: hidden is used as part of the state transition in
notistack, see notistack, see
https://github.com/iamhosseindhv/notistack/blob/122f47057eb7ce5a1abfe923316cf8475303e99a/src/transitions/Collapse/Collapse.tsx#L110 https://github.com/iamhosseindhv/notistack/blob/122f47057eb7ce5a1abfe923316cf8475303e99a/src/transitions/Collapse/Collapse.tsx#L110
*/ */,
}); });
await test.step( await test.step('Create a user', async () => {
'Create a user',
async () => {
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(user.fullName); await adminCreateUserPage.fullNameInput.fill(user.fullName);
await adminCreateUserPage.emailInput.fill(user.email); await adminCreateUserPage.emailInput.fill(user.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
await adminCreateUserPage.invitationEmailInfoAlert.waitFor({ await adminCreateUserPage.invitationEmailInfoAlert.waitFor({
state: 'attached' state: 'attached',
}); });
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success'
);
await expect(snackbar.variant).toBe('success');
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.closeSnackbar(); });
} await test.step('Check the user exists with the expected properties', async () => {
);
await test.step(
'Check the user exists with the expected properties',
async () => {
await adminUsersPage.findUserPageWithEmail(user.email); await adminUsersPage.findUserPageWithEmail(user.email);
const userRow = await adminUsersPage.getUserRowByEmail(user.email); const userRow = await adminUsersPage.getUserRowByEmail(user.email);
const data = await adminUsersPage.getRowData(userRow); const data = await adminUsersPage.getRowData(userRow);
await expect(data.email).toBe(user.email); await expect(data.email).toBe(user.email);
await expect(data.fullName).toBe(user.fullName); await expect(data.fullName).toBe(user.fullName);
await expect(data.role).toBe('Admin'); await expect(data.role).toBe('Admin');
} });
); await test.step('Edit user info and make sure the edit works correctly', async () => {
await test.step(
'Edit user info and make sure the edit works correctly',
async () => {
await adminUsersPage.findUserPageWithEmail(user.email); await adminUsersPage.findUserPageWithEmail(user.email);
let userRow = await adminUsersPage.getUserRowByEmail(user.email); let userRow = await adminUsersPage.getUserRowByEmail(user.email);
@@ -79,11 +68,8 @@ test.describe('User management page', () => {
userRow = await adminUsersPage.getUserRowByEmail(user.email); userRow = await adminUsersPage.getUserRowByEmail(user.email);
const rowData = await adminUsersPage.getRowData(userRow); const rowData = await adminUsersPage.getRowData(userRow);
await expect(rowData.fullName).toBe(newUserInfo.fullName); await expect(rowData.fullName).toBe(newUserInfo.fullName);
} });
); await test.step('Delete user and check the page confirms this deletion', async () => {
await test.step(
'Delete user and check the page confirms this deletion',
async () => {
await adminUsersPage.findUserPageWithEmail(user.email); await adminUsersPage.findUserPageWithEmail(user.email);
const userRow = await adminUsersPage.getUserRowByEmail(user.email); const userRow = await adminUsersPage.getUserRowByEmail(user.email);
await adminUsersPage.clickDeleteUser(userRow); await adminUsersPage.clickDeleteUser(userRow);
@@ -96,39 +82,30 @@ test.describe('User management page', () => {
await expect(snackbar.variant).toBe('success'); await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar(); await adminUsersPage.closeSnackbar();
await expect(userRow).not.toBeVisible(false); await expect(userRow).not.toBeVisible(false);
} });
);
}); });
test( test('Creating a user which has been deleted', async ({
'Creating a user which has been deleted', adminCreateUserPage,
async ({ adminCreateUserPage, adminUsersPage }) => { adminUsersPage,
}) => {
adminCreateUserPage.seed(9100); adminCreateUserPage.seed(9100);
const testUser = adminCreateUserPage.generateUser(); const testUser = adminCreateUserPage.generateUser();
await test.step( await test.step('Create the test user', async () => {
'Create the test user',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(testUser.fullName); await adminCreateUserPage.fullNameInput.fill(testUser.fullName);
await adminCreateUserPage.emailInput.fill(testUser.email); await adminCreateUserPage.emailInput.fill(testUser.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success' });
);
await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar();
}
);
await test.step( await test.step('Delete the created user', async () => {
'Delete the created user',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.findUserPageWithEmail(testUser.email); await adminUsersPage.findUserPageWithEmail(testUser.email);
const userRow = await adminUsersPage.getUserRowByEmail(testUser.email); const userRow = await adminUsersPage.getUserRowByEmail(testUser.email);
@@ -142,127 +119,94 @@ test.describe('User management page', () => {
await expect(snackbar.variant).toBe('success'); await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar(); await adminUsersPage.closeSnackbar();
await expect(userRow).not.toBeVisible(false); await expect(userRow).not.toBeVisible(false);
} });
);
await test.step( await test.step('Create the user again', async () => {
'Create the user again',
async () => {
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(testUser.fullName); await adminCreateUserPage.fullNameInput.fill(testUser.fullName);
await adminCreateUserPage.emailInput.fill(testUser.email); await adminCreateUserPage.emailInput.fill(testUser.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData('snackbar-error'); await expect(adminCreateUserPage.fieldError).toHaveCount(1);
await expect(snackbar.variant).toBe('error'); });
await adminUsersPage.closeSnackbar(); });
}
);
}
);
test( test('Creating a user which already exists', async ({
'Creating a user which already exists', adminCreateUserPage,
async ({ adminCreateUserPage, adminUsersPage, page }) => { adminUsersPage,
page,
}) => {
adminCreateUserPage.seed(9200); adminCreateUserPage.seed(9200);
const testUser = adminCreateUserPage.generateUser(); const testUser = adminCreateUserPage.generateUser();
await test.step( await test.step('Create the test user', async () => {
'Create the test user',
async () => {
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(testUser.fullName); await adminCreateUserPage.fullNameInput.fill(testUser.fullName);
await adminCreateUserPage.emailInput.fill(testUser.email); await adminCreateUserPage.emailInput.fill(testUser.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success' });
);
await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar();
}
);
await test.step( await test.step('Create the user again', async () => {
'Create the user again',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(testUser.fullName); await adminCreateUserPage.fullNameInput.fill(testUser.fullName);
await adminCreateUserPage.emailInput.fill(testUser.email); await adminCreateUserPage.emailInput.fill(testUser.email);
const createUserPageUrl = page.url(); const createUserPageUrl = page.url();
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
await expect(page.url()).toBe(createUserPageUrl); await expect(page.url()).toBe(createUserPageUrl);
const snackbar = await adminUsersPage.getSnackbarData('snackbar-error'); await expect(adminCreateUserPage.fieldError).toHaveCount(1);
await expect(snackbar.variant).toBe('error'); });
await adminUsersPage.closeSnackbar(); });
}
);
}
);
test( test('Editing a user to have the same email as another user should not be allowed', async ({
'Editing a user to have the same email as another user should not be allowed', adminCreateUserPage,
async ({ adminEditUserPage,
adminCreateUserPage, adminEditUserPage, adminUsersPage, page adminUsersPage,
page,
}) => { }) => {
adminCreateUserPage.seed(9300); adminCreateUserPage.seed(9300);
const user1 = adminCreateUserPage.generateUser(); const user1 = adminCreateUserPage.generateUser();
const user2 = adminCreateUserPage.generateUser(); const user2 = adminCreateUserPage.generateUser();
await test.step( await test.step('Create the first user', async () => {
'Create the first user',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(user1.fullName); await adminCreateUserPage.fullNameInput.fill(user1.fullName);
await adminCreateUserPage.emailInput.fill(user1.email); await adminCreateUserPage.emailInput.fill(user1.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success' });
);
await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar();
}
);
await test.step( await test.step('Create the second user', async () => {
'Create the second user',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.createUserButton.click(); await adminUsersPage.createUserButton.click();
await adminCreateUserPage.fullNameInput.fill(user2.fullName); await adminCreateUserPage.fullNameInput.fill(user2.fullName);
await adminCreateUserPage.emailInput.fill(user2.email); await adminCreateUserPage.emailInput.fill(user2.email);
await adminCreateUserPage.roleInput.click(); await adminCreateUserPage.roleInput.click();
await adminCreateUserPage.page.getByRole( await adminCreateUserPage.page
'option', { name: 'Admin' } .getByRole('option', { name: 'Admin' })
).click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success' });
);
await expect(snackbar.variant).toBe('success');
await adminUsersPage.closeSnackbar();
}
);
await test.step( await test.step('Try editing the second user to have the email of the first user', async () => {
'Try editing the second user to have the email of the first user',
async () => {
await adminUsersPage.navigateTo(); await adminUsersPage.navigateTo();
await adminUsersPage.findUserPageWithEmail(user2.email); await adminUsersPage.findUserPageWithEmail(user2.email);
let userRow = await adminUsersPage.getUserRowByEmail(user2.email); let userRow = await adminUsersPage.getUserRowByEmail(user2.email);
@@ -272,14 +216,10 @@ test.describe('User management page', () => {
const editPageUrl = page.url(); const editPageUrl = page.url();
await adminEditUserPage.updateButton.click(); await adminEditUserPage.updateButton.click();
const snackbar = await adminUsersPage.getSnackbarData( const snackbar = await adminUsersPage.getSnackbarData('snackbar-error');
'snackbar-error'
);
await expect(snackbar.variant).toBe('error'); await expect(snackbar.variant).toBe('error');
await adminUsersPage.closeSnackbar(); await adminUsersPage.closeSnackbar();
await expect(page.url()).toBe(editPageUrl); await expect(page.url()).toBe(editPageUrl);
} });
); });
}
);
}); });

View File

@@ -7,9 +7,10 @@ test('Ensure creating a new flow works', async ({ page }) => {
); );
}); });
test( test('Create a new flow with a Scheduler step then an Ntfy step', async ({
'Create a new flow with a Scheduler step then an Ntfy step', flowEditorPage,
async ({ flowEditorPage, page }) => { page,
}) => {
await test.step('create flow', async () => { await test.step('create flow', async () => {
await test.step('navigate to new flow page', async () => { await test.step('navigate to new flow page', async () => {
await page.getByTestId('create-flow-button').click(); await page.getByTestId('create-flow-button').click();
@@ -27,17 +28,13 @@ test(
await test.step('choose app and event substep', async () => { await test.step('choose app and event substep', async () => {
await test.step('choose application', async () => { await test.step('choose application', async () => {
await flowEditorPage.appAutocomplete.click(); await flowEditorPage.appAutocomplete.click();
await page await page.getByRole('option', { name: 'Scheduler' }).click();
.getByRole('option', { name: 'Scheduler' })
.click();
}); });
await test.step('choose and event', async () => { await test.step('choose and event', async () => {
await expect(flowEditorPage.eventAutocomplete).toBeVisible(); await expect(flowEditorPage.eventAutocomplete).toBeVisible();
await flowEditorPage.eventAutocomplete.click(); await flowEditorPage.eventAutocomplete.click();
await page await page.getByRole('option', { name: 'Every hour' }).click();
.getByRole('option', { name: 'Every hour' })
.click();
}); });
await test.step('continue to next step', async () => { await test.step('continue to next step', async () => {
@@ -89,9 +86,7 @@ test(
await test.step('choose an event', async () => { await test.step('choose an event', async () => {
await expect(flowEditorPage.eventAutocomplete).toBeVisible(); await expect(flowEditorPage.eventAutocomplete).toBeVisible();
await flowEditorPage.eventAutocomplete.click(); await flowEditorPage.eventAutocomplete.click();
await page await page.getByRole('option', { name: 'Send message' }).click();
.getByRole('option', { name: 'Send message' })
.click();
}); });
await test.step('continue to next step', async () => { await test.step('continue to next step', async () => {
@@ -107,14 +102,18 @@ test(
await test.step('choose connection substep', async () => { await test.step('choose connection substep', async () => {
await test.step('choose connection list item', async () => { await test.step('choose connection list item', async () => {
await flowEditorPage.connectionAutocomplete.click(); await flowEditorPage.connectionAutocomplete.click();
await page.getByRole('option').first().click(); await page
.getByRole('option')
.filter({ hasText: 'Add new connection' })
.click();
}); });
await test.step('continue to next step', async () => { await test.step('continue to next step', async () => {
await flowEditorPage.continueButton.click(); await page.getByTestId('create-connection-button').click();
}); });
await test.step('collapses the substep', async () => { await test.step('collapses the substep', async () => {
await flowEditorPage.continueButton.click();
await expect(flowEditorPage.connectionAutocomplete).not.toBeVisible(); await expect(flowEditorPage.connectionAutocomplete).not.toBeVisible();
}); });
}); });
@@ -143,10 +142,7 @@ test(
await test.step('test trigger substep', async () => { await test.step('test trigger substep', async () => {
await test.step('show sample output', async () => { await test.step('show sample output', async () => {
await expect(flowEditorPage.testOutput).not.toBeVisible(); await expect(flowEditorPage.testOutput).not.toBeVisible();
await page await page.getByTestId('flow-substep-continue-button').first().click();
.getByTestId('flow-substep-continue-button')
.first()
.click();
await expect(flowEditorPage.testOutput).toBeVisible(); await expect(flowEditorPage.testOutput).toBeVisible();
await flowEditorPage.screenshot({ await flowEditorPage.screenshot({
path: 'Ntfy action test output.png', path: 'Ntfy action test output.png',
@@ -172,9 +168,7 @@ test(
}); });
await test.step('unpublish from snackbar', async () => { await test.step('unpublish from snackbar', async () => {
await page await page.getByTestId('unpublish-flow-from-snackbar').click();
.getByTestId('unpublish-flow-from-snackbar')
.click();
await expect(flowEditorPage.infoSnackbar).not.toBeVisible(); await expect(flowEditorPage.infoSnackbar).not.toBeVisible();
}); });
@@ -200,5 +194,4 @@ test(
await expect(page).toHaveURL('/flows'); await expect(page).toHaveURL('/flows');
}); });
}); });
} });
);

View File

@@ -33,10 +33,7 @@ publicTest.describe('My Profile', () => {
.getByRole('option', { name: 'Admin' }) .getByRole('option', { name: 'Admin' })
.click(); .click();
await adminCreateUserPage.createButton.click(); await adminCreateUserPage.createButton.click();
const snackbar = await adminUsersPage.getSnackbarData( await adminCreateUserPage.expectCreateUserSuccessAlertToBeVisible();
'snackbar-create-user-success'
);
await expect(snackbar.variant).toBe('success');
}); });
await publicTest.step('copy invitation link', async () => { await publicTest.step('copy invitation link', async () => {

View File

@@ -1,10 +1,19 @@
import * as React from 'react'; import * as React from 'react';
import PropTypes from 'prop-types';
import MuiContainer from '@mui/material/Container'; import MuiContainer from '@mui/material/Container';
export default function Container(props) { export default function Container({ maxWidth = 'lg', ...props }) {
return <MuiContainer {...props} />; return <MuiContainer maxWidth={maxWidth} {...props} />;
} }
Container.defaultProps = { Container.propTypes = {
maxWidth: 'lg', maxWidth: PropTypes.oneOf([
'xs',
'sm',
'md',
'lg',
'xl',
false,
PropTypes.string,
]),
}; };

View File

@@ -46,7 +46,12 @@ function Form(props) {
return ( return (
<FormProvider {...methods}> <FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)} {...formProps}> <form
onSubmit={methods.handleSubmit((data, event) =>
onSubmit?.(data, event, methods.setError),
)}
{...formProps}
>
{render ? render(methods) : children} {render ? render(methods) : children}
</form> </form>
</FormProvider> </FormProvider>

View File

@@ -0,0 +1,18 @@
// Helpers to extract errors received from the API
export const getGeneralErrorMessage = ({ error, fallbackMessage }) => {
if (!error) {
return;
}
const errors = error?.response?.data?.errors;
const generalError = errors?.general;
if (generalError && Array.isArray(generalError)) {
return generalError.join(' ');
}
if (!errors) {
return error?.message || fallbackMessage;
}
};

View File

@@ -225,6 +225,8 @@
"userForm.email": "Email", "userForm.email": "Email",
"userForm.role": "Role", "userForm.role": "Role",
"userForm.password": "Password", "userForm.password": "Password",
"userForm.mandatoryInput": "{inputName} is required.",
"userForm.validateEmail": "Email must be valid.",
"createUser.submit": "Create", "createUser.submit": "Create",
"createUser.successfullyCreated": "The user has been created.", "createUser.successfullyCreated": "The user has been created.",
"createUser.invitationEmailInfo": "Invitation email will be sent if SMTP credentials are valid. Otherwise, you can share the invitation link manually: <link></link>", "createUser.invitationEmailInfo": "Invitation email will be sent if SMTP credentials are valid. Otherwise, you can share the invitation link manually: <link></link>",
@@ -249,8 +251,11 @@
"createRolePage.title": "Create role", "createRolePage.title": "Create role",
"roleForm.name": "Name", "roleForm.name": "Name",
"roleForm.description": "Description", "roleForm.description": "Description",
"roleForm.mandatoryInput": "{inputName} is required.",
"createRole.submit": "Create", "createRole.submit": "Create",
"createRole.successfullyCreated": "The role has been created.", "createRole.successfullyCreated": "The role has been created.",
"createRole.generalError": "Error while creating the role.",
"createRole.permissionsError": "Permissions are invalid.",
"editRole.submit": "Update", "editRole.submit": "Update",
"editRole.successfullyUpdated": "The role has been updated.", "editRole.successfullyUpdated": "The role has been updated.",
"roleList.name": "Name", "roleList.name": "Name",

View File

@@ -1,10 +1,14 @@
import LoadingButton from '@mui/lab/LoadingButton'; import LoadingButton from '@mui/lab/LoadingButton';
import Grid from '@mui/material/Grid'; import Grid from '@mui/material/Grid';
import Stack from '@mui/material/Stack'; import Stack from '@mui/material/Stack';
import Alert from '@mui/material/Alert';
import AlertTitle from '@mui/material/AlertTitle';
import PermissionCatalogField from 'components/PermissionCatalogField/index.ee'; import PermissionCatalogField from 'components/PermissionCatalogField/index.ee';
import useEnqueueSnackbar from 'hooks/useEnqueueSnackbar'; import useEnqueueSnackbar from 'hooks/useEnqueueSnackbar';
import * as React from 'react'; import * as React from 'react';
import { useNavigate } from 'react-router-dom'; import { useNavigate } from 'react-router-dom';
import { yupResolver } from '@hookform/resolvers/yup';
import * as yup from 'yup';
import Container from 'components/Container'; import Container from 'components/Container';
import Form from 'components/Form'; import Form from 'components/Form';
@@ -15,10 +19,45 @@ import {
getComputedPermissionsDefaultValues, getComputedPermissionsDefaultValues,
getPermissions, getPermissions,
} from 'helpers/computePermissions.ee'; } from 'helpers/computePermissions.ee';
import { getGeneralErrorMessage } from 'helpers/errors';
import useFormatMessage from 'hooks/useFormatMessage'; import useFormatMessage from 'hooks/useFormatMessage';
import useAdminCreateRole from 'hooks/useAdminCreateRole'; import useAdminCreateRole from 'hooks/useAdminCreateRole';
import usePermissionCatalog from 'hooks/usePermissionCatalog.ee'; import usePermissionCatalog from 'hooks/usePermissionCatalog.ee';
const getValidationSchema = (formatMessage) => {
const getMandatoryFieldMessage = (fieldTranslationId) =>
formatMessage('roleForm.mandatoryInput', {
inputName: formatMessage(fieldTranslationId),
});
return yup.object().shape({
name: yup
.string()
.trim()
.required(getMandatoryFieldMessage('roleForm.name')),
description: yup.string().trim(),
});
};
const getPermissionsErrorMessage = (error) => {
const errors = error?.response?.data?.errors;
if (errors) {
const permissionsErrors = Object.keys(errors)
.filter((key) => key.startsWith('permissions'))
.reduce((obj, key) => {
obj[key] = errors[key];
return obj;
}, {});
if (Object.keys(permissionsErrors).length > 0) {
return JSON.stringify(permissionsErrors, null, 2);
}
}
return null;
};
export default function CreateRole() { export default function CreateRole() {
const navigate = useNavigate(); const navigate = useNavigate();
const formatMessage = useFormatMessage(); const formatMessage = useFormatMessage();
@@ -41,7 +80,7 @@ export default function CreateRole() {
[permissionCatalogData], [permissionCatalogData],
); );
const handleRoleCreation = async (roleData) => { const handleRoleCreation = async (roleData, e, setError) => {
try { try {
const permissions = getPermissions(roleData.computedPermissions); const permissions = getPermissions(roleData.computedPermissions);
@@ -60,14 +99,38 @@ export default function CreateRole() {
navigate(URLS.ROLES); navigate(URLS.ROLES);
} catch (error) { } catch (error) {
const errors = Object.values(error.response.data.errors); const errors = error?.response?.data?.errors;
for (const [errorMessage] of errors) { if (errors) {
enqueueSnackbar(errorMessage, { const fieldNames = ['name', 'description'];
variant: 'error', Object.entries(errors).forEach(([fieldName, fieldErrors]) => {
SnackbarProps: { if (fieldNames.includes(fieldName) && Array.isArray(fieldErrors)) {
'data-test': 'snackbar-error', setError(fieldName, {
}, type: 'fieldRequestError',
message: fieldErrors.join(', '),
});
}
});
}
const permissionError = getPermissionsErrorMessage(error);
if (permissionError) {
setError('root.permissions', {
type: 'fieldRequestError',
message: permissionError,
});
}
const generalError = getGeneralErrorMessage({
error,
fallbackMessage: formatMessage('createRole.generalError'),
});
if (generalError) {
setError('root.general', {
type: 'requestError',
message: generalError,
}); });
} }
} }
@@ -83,7 +146,15 @@ export default function CreateRole() {
</Grid> </Grid>
<Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}> <Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}>
<Form onSubmit={handleRoleCreation} defaultValues={defaultValues}> <Form
onSubmit={handleRoleCreation}
defaultValues={defaultValues}
noValidate
resolver={yupResolver(
getValidationSchema(formatMessage, defaultValues),
)}
automaticValidation={false}
render={({ formState: { errors } }) => (
<Stack direction="column" gap={2}> <Stack direction="column" gap={2}>
<TextField <TextField
required={true} required={true}
@@ -91,6 +162,8 @@ export default function CreateRole() {
label={formatMessage('roleForm.name')} label={formatMessage('roleForm.name')}
fullWidth fullWidth
data-test="name-input" data-test="name-input"
error={!!errors?.name}
helperText={errors?.name?.message}
/> />
<TextField <TextField
@@ -98,10 +171,29 @@ export default function CreateRole() {
label={formatMessage('roleForm.description')} label={formatMessage('roleForm.description')}
fullWidth fullWidth
data-test="description-input" data-test="description-input"
error={!!errors?.description}
helperText={errors?.description?.message}
/> />
<PermissionCatalogField name="computedPermissions" /> <PermissionCatalogField name="computedPermissions" />
{errors?.root?.permissions && (
<Alert severity="error" data-test="create-role-error-alert">
<AlertTitle>
{formatMessage('createRole.permissionsError')}
</AlertTitle>
<pre>
<code>{errors?.root?.permissions?.message}</code>
</pre>
</Alert>
)}
{errors?.root?.general && (
<Alert severity="error" data-test="create-role-error-alert">
{errors?.root?.general?.message}
</Alert>
)}
<LoadingButton <LoadingButton
type="submit" type="submit"
variant="contained" variant="contained"
@@ -113,7 +205,8 @@ export default function CreateRole() {
{formatMessage('createRole.submit')} {formatMessage('createRole.submit')}
</LoadingButton> </LoadingButton>
</Stack> </Stack>
</Form> )}
/>
</Grid> </Grid>
</Grid> </Grid>
</Container> </Container>

View File

@@ -3,9 +3,10 @@ import Grid from '@mui/material/Grid';
import Stack from '@mui/material/Stack'; import Stack from '@mui/material/Stack';
import Alert from '@mui/material/Alert'; import Alert from '@mui/material/Alert';
import MuiTextField from '@mui/material/TextField'; import MuiTextField from '@mui/material/TextField';
import useEnqueueSnackbar from 'hooks/useEnqueueSnackbar';
import * as React from 'react'; import * as React from 'react';
import { useQueryClient } from '@tanstack/react-query'; import { useQueryClient } from '@tanstack/react-query';
import * as yup from 'yup';
import { yupResolver } from '@hookform/resolvers/yup';
import Can from 'components/Can'; import Can from 'components/Can';
import Container from 'components/Container'; import Container from 'components/Container';
@@ -16,50 +17,94 @@ import TextField from 'components/TextField';
import useFormatMessage from 'hooks/useFormatMessage'; import useFormatMessage from 'hooks/useFormatMessage';
import useRoles from 'hooks/useRoles.ee'; import useRoles from 'hooks/useRoles.ee';
import useAdminCreateUser from 'hooks/useAdminCreateUser'; import useAdminCreateUser from 'hooks/useAdminCreateUser';
import useCurrentUserAbility from 'hooks/useCurrentUserAbility';
import { getGeneralErrorMessage } from 'helpers/errors';
function generateRoleOptions(roles) { function generateRoleOptions(roles) {
return roles?.map(({ name: label, id: value }) => ({ label, value })); return roles?.map(({ name: label, id: value }) => ({ label, value }));
} }
const getValidationSchema = (formatMessage, canUpdateRole) => {
const getMandatoryFieldMessage = (fieldTranslationId) =>
formatMessage('userForm.mandatoryInput', {
inputName: formatMessage(fieldTranslationId),
});
return yup.object().shape({
fullName: yup
.string()
.trim()
.required(getMandatoryFieldMessage('userForm.fullName')),
email: yup
.string()
.trim()
.email(formatMessage('userForm.validateEmail'))
.required(getMandatoryFieldMessage('userForm.email')),
...(canUpdateRole
? {
roleId: yup
.string()
.required(getMandatoryFieldMessage('userForm.role')),
}
: {}),
});
};
const defaultValues = {
fullName: '',
email: '',
roleId: '',
};
export default function CreateUser() { export default function CreateUser() {
const formatMessage = useFormatMessage(); const formatMessage = useFormatMessage();
const { const {
mutateAsync: createUser, mutateAsync: createUser,
isPending: isCreateUserPending, isPending: isCreateUserPending,
data: createdUser, data: createdUser,
isSuccess: createUserSuccess,
} = useAdminCreateUser(); } = useAdminCreateUser();
const { data: rolesData, loading: isRolesLoading } = useRoles(); const { data: rolesData, loading: isRolesLoading } = useRoles();
const roles = rolesData?.data; const roles = rolesData?.data;
const enqueueSnackbar = useEnqueueSnackbar();
const queryClient = useQueryClient(); const queryClient = useQueryClient();
const currentUserAbility = useCurrentUserAbility();
const canUpdateRole = currentUserAbility.can('update', 'Role');
const handleUserCreation = async (userData) => { const handleUserCreation = async (userData, e, setError) => {
try { try {
await createUser({ await createUser({
fullName: userData.fullName, fullName: userData.fullName,
email: userData.email, email: userData.email,
roleId: userData.role?.id, roleId: userData.roleId,
}); });
queryClient.invalidateQueries({ queryKey: ['admin', 'users'] }); queryClient.invalidateQueries({ queryKey: ['admin', 'users'] });
enqueueSnackbar(formatMessage('createUser.successfullyCreated'), {
variant: 'success',
persist: true,
SnackbarProps: {
'data-test': 'snackbar-create-user-success',
},
});
} catch (error) { } catch (error) {
enqueueSnackbar(formatMessage('createUser.error'), { const errors = error?.response?.data?.errors;
variant: 'error',
persist: true, if (errors) {
SnackbarProps: { const fieldNames = Object.keys(defaultValues);
'data-test': 'snackbar-error', Object.entries(errors).forEach(([fieldName, fieldErrors]) => {
}, if (fieldNames.includes(fieldName) && Array.isArray(fieldErrors)) {
setError(fieldName, {
type: 'fieldRequestError',
message: fieldErrors.join(', '),
});
}
});
}
const generalError = getGeneralErrorMessage({
error,
fallbackMessage: formatMessage('createUser.error'),
}); });
throw new Error('Failed while creating!'); if (generalError) {
setError('root.general', {
type: 'requestError',
message: generalError,
});
}
} }
}; };
@@ -73,7 +118,16 @@ export default function CreateUser() {
</Grid> </Grid>
<Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}> <Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}>
<Form onSubmit={handleUserCreation}> <Form
noValidate
onSubmit={handleUserCreation}
mode="onSubmit"
defaultValues={defaultValues}
resolver={yupResolver(
getValidationSchema(formatMessage, canUpdateRole),
)}
automaticValidation={false}
render={({ formState: { errors } }) => (
<Stack direction="column" gap={2}> <Stack direction="column" gap={2}>
<TextField <TextField
required={true} required={true}
@@ -81,6 +135,8 @@ export default function CreateUser() {
label={formatMessage('userForm.fullName')} label={formatMessage('userForm.fullName')}
data-test="full-name-input" data-test="full-name-input"
fullWidth fullWidth
error={!!errors?.fullName}
helperText={errors?.fullName?.message}
/> />
<TextField <TextField
@@ -89,11 +145,13 @@ export default function CreateUser() {
label={formatMessage('userForm.email')} label={formatMessage('userForm.email')}
data-test="email-input" data-test="email-input"
fullWidth fullWidth
error={!!errors?.email}
helperText={errors?.email?.message}
/> />
<Can I="update" a="Role"> <Can I="update" a="Role">
<ControlledAutocomplete <ControlledAutocomplete
name="role.id" name="roleId"
fullWidth fullWidth
disablePortal disablePortal
disableClearable={true} disableClearable={true}
@@ -103,28 +161,40 @@ export default function CreateUser() {
{...params} {...params}
required required
label={formatMessage('userForm.role')} label={formatMessage('userForm.role')}
error={!!errors?.roleId}
helperText={errors?.roleId?.message}
/> />
)} )}
loading={isRolesLoading} loading={isRolesLoading}
showHelperText={false}
/> />
</Can> </Can>
<LoadingButton {errors?.root?.general && (
type="submit" <Alert data-test="create-user-error-alert" severity="error">
variant="contained" {errors?.root?.general?.message}
color="primary" </Alert>
sx={{ boxShadow: 2 }} )}
loading={isCreateUserPending}
data-test="create-button" {createUserSuccess && (
<Alert
severity="success"
data-test="create-user-success-alert"
> >
{formatMessage('createUser.submit')} {formatMessage('createUser.successfullyCreated')}
</LoadingButton> </Alert>
)}
{createdUser && ( {createdUser && (
<Alert <Alert
severity="info" severity="info"
color="primary" color="primary"
data-test="invitation-email-info-alert" data-test="invitation-email-info-alert"
sx={{
a: {
wordBreak: 'break-all',
},
}}
> >
{formatMessage('createUser.invitationEmailInfo', { {formatMessage('createUser.invitationEmailInfo', {
link: () => ( link: () => (
@@ -139,8 +209,20 @@ export default function CreateUser() {
})} })}
</Alert> </Alert>
)} )}
<LoadingButton
type="submit"
variant="contained"
color="primary"
sx={{ boxShadow: 2 }}
loading={isCreateUserPending}
data-test="create-button"
>
{formatMessage('createUser.submit')}
</LoadingButton>
</Stack> </Stack>
</Form> )}
/>
</Grid> </Grid>
</Grid> </Grid>
</Container> </Container>