Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(projectHistory): handle submission related audit actions TASK-1409 #5428

Merged
merged 4 commits into from
Jan 22, 2025
Merged

feat(projectHistory): handle submission related audit actions TASK-1409 #5428

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de95347
define two more audit actions
magicznyleszek Jan 20, 2025
4b74d00
filter out add-submission audit action from UI
magicznyleszek Jan 20, 2025
0442d7c
Merge branch 'main' into leszek/task-1409-submission-audit-actions
magicznyleszek Jan 20, 2025
d6df32b
add `delete-submission` audit action handling
magicznyleszek Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions jsapp/js/components/activity/activity.constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*/
export enum AuditActions {
'add-media' = 'add-media',
'add-submission' = 'add-submission',
'allow-anonymous-submissions' = 'allow-anonymous-submissions',
'archive' = 'archive',
'clone-permissions' = 'clone-permissions',
Expand All @@ -19,6 +20,7 @@ export enum AuditActions {
'modify-imported-fields' = 'modify-imported-fields',
'modify-service' = 'modify-service',
'modify-sharing' = 'modify-sharing',
'modify-submission' = 'modify-submission',
'modify-user-permissions' = 'modify-user-permissions',
'redeploy' = 'redeploy',
'register-service' = 'register-service',
Expand Down Expand Up @@ -51,6 +53,12 @@ export const AUDIT_ACTION_TYPES: AuditActionTypes = {
label: t('add media attachment'),
message: t('##username## added a media attachment'),
},
'add-submission': {
order: 30,
name: AuditActions['add-submission'],
label: t('add submission'),
message: t('##username## added a submission'),
},
'allow-anonymous-submissions': {
order: 16,
name: AuditActions['allow-anonymous-submissions'],
Expand Down Expand Up @@ -141,6 +149,12 @@ export const AUDIT_ACTION_TYPES: AuditActionTypes = {
label: t('modify data sharing'),
message: t('##username## modified data sharing'),
},
'modify-submission': {
order: 31,
name: AuditActions['modify-submission'],
label: t('modify submission'),
message: t('##username## modified a submission'),
},
'modify-user-permissions': {
order: 12,
name: AuditActions['modify-user-permissions'],
Expand Down Expand Up @@ -229,6 +243,8 @@ export const AUDIT_ACTION_TYPES: AuditActionTypes = {

export const FALLBACK_MESSAGE = '##username## did action ##action##';

export const HIDDEN_AUDIT_ACTIONS = [AuditActions['add-submission']];

/**
* All possible log item types.
* @see `AuditType` class from {@link kobo/apps/audit_log/models.py} (BE code)
Expand Down
14 changes: 10 additions & 4 deletions jsapp/js/components/activity/activityLogs.query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type {
LabelValuePair,
PaginatedResponse,
} from 'js/dataInterface';
import {AUDIT_ACTION_TYPES} from './activity.constants';
import {AUDIT_ACTION_TYPES, HIDDEN_AUDIT_ACTIONS} from './activity.constants';
import type {AuditActions, ActivityLogsItem} from './activity.constants';
import {QueryKeys} from 'js/query/queryKeys';
import {fetchGet} from 'jsapp/js/api';
Expand All @@ -27,13 +27,18 @@ const getActivityLogs = async ({
limit: number;
offset: number;
}) => {
// Filter out unwanted actions (e.g. UI doesn't support them yet).
let q = `NOT action:'${HIDDEN_AUDIT_ACTIONS.join(',')}'`;
// Alternatively filter by only single selected action.
if (actionFilter !== '') {
q = `action:${actionFilter}`;
}

const params = new URLSearchParams({
limit: limit.toString(),
offset: offset.toString(),
q: q,
});
if (actionFilter) {
params.append('q', `action:${actionFilter}`);
}

const endpointUrl = endpoints.ASSET_HISTORY.replace(':asset_uid', assetUid);

Expand Down Expand Up @@ -70,6 +75,7 @@ const getFilterOptions = async (

return filterOptions.actions
.map((key) => AUDIT_ACTION_TYPES[key])
.filter((auditAction) => !HIDDEN_AUDIT_ACTIONS.includes(auditAction.name))
.sort((a, b) => a.order - b.order)
.map((auditAction) => {
return {
Expand Down
Loading