feat: add audit-trails and view-audit-trail components (#406)
Fixes #404
This commit is contained in:
Chirag Gupta
@@ -0,0 +1,417 @@
|
||||
/** Angular Imports */
|
||||
import { Component, OnInit, ViewChild, AfterViewInit } from '@angular/core';
|
||||
import { MatPaginator, MatSort } from '@angular/material';
|
||||
import { ActivatedRoute } from '@angular/router';
|
||||
import { FormControl } from '@angular/forms';
|
||||
import { DatePipe } from '@angular/common';
|
||||
|
||||
/** Custom Data Source */
|
||||
import { AuditTrailsDataSource } from './audit-trail.datasource';
|
||||
|
||||
/** Custom Services */
|
||||
import { SystemService } from '../system.service';
|
||||
|
||||
/** rxjs Imports */
|
||||
import { merge } from 'rxjs';
|
||||
import { tap, debounceTime, distinctUntilChanged, startWith, map } from 'rxjs/operators';
|
||||
|
||||
/**
|
||||
* Audit Trails Component.
|
||||
*/
|
||||
@Component({
|
||||
selector: 'mifosx-audit-trails',
|
||||
templateUrl: './audit-trails.component.html',
|
||||
styleUrls: ['./audit-trails.component.scss']
|
||||
})
|
||||
export class AuditTrailsComponent implements OnInit, AfterViewInit {
|
||||
|
||||
/** Minimum date allowed. */
|
||||
minDate = new Date(2000, 0, 1);
|
||||
/** Maximum date allowed. */
|
||||
maxDate = new Date();
|
||||
/** Audit Trails Data */
|
||||
auditTrailsData: any;
|
||||
/** Filtered user data for autocomplete. */
|
||||
filteredUserData: any;
|
||||
/** Filtered action data for autocomplete. */
|
||||
filteredActionData: any;
|
||||
/** Filtered entity data for autocomplete. */
|
||||
filteredEntityData: any;
|
||||
/** Filtered checker data for autocomplete. */
|
||||
filteredCheckerData: any;
|
||||
/** Audit Trail Search Template Data. */
|
||||
auditTrailSearchTemplateData: any;
|
||||
/** Columns to be displayed in audit trails table. */
|
||||
displayedColumns: string[] = ['id', 'resourceId', 'processingResult', 'maker', 'actionName', 'entityName', 'officeName', 'madeOnDate', 'checker', 'checkedOnDate'];
|
||||
/** Data source for audit trails table. */
|
||||
dataSource: AuditTrailsDataSource;
|
||||
/** Audit Trails filter. */
|
||||
filterAuditTrailsBy = [
|
||||
{
|
||||
type: 'actionName',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'entityName',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'resourceId',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'makerId',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'makerDateTimeFrom',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'makerDateTimeTo',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'checkerDateTimeFrom',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'checkerDateTimeTo',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'checkerId',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'processingResult',
|
||||
value: ''
|
||||
},
|
||||
{
|
||||
type: 'dateFormat',
|
||||
value: 'yyyy-MM-dd'
|
||||
},
|
||||
{
|
||||
type: 'locale',
|
||||
value: 'en'
|
||||
}
|
||||
];
|
||||
/** User form control. */
|
||||
user = new FormControl('');
|
||||
/** From date form control. */
|
||||
fromDate = new FormControl();
|
||||
/** Checked from date form control. */
|
||||
checkedFromDate = new FormControl();
|
||||
/** Processing result form control. */
|
||||
processingResult = new FormControl();
|
||||
/** Action name form control. */
|
||||
actionName = new FormControl();
|
||||
/** Resource ID form control. */
|
||||
resourceId = new FormControl('');
|
||||
/** To date form control. */
|
||||
toDate = new FormControl();
|
||||
/** Checked to date form control. */
|
||||
checkedToDate = new FormControl();
|
||||
/** Entity name form control. */
|
||||
entityName = new FormControl();
|
||||
/** Checker form control. */
|
||||
checker = new FormControl();
|
||||
|
||||
/** Paginator for audit trails table. */
|
||||
@ViewChild(MatPaginator) paginator: MatPaginator;
|
||||
/** Sorter for audit trails table. */
|
||||
@ViewChild(MatSort) sort: MatSort;
|
||||
|
||||
/**
|
||||
* Retrieves the audit trail search template data from `resolve`.
|
||||
* @param {ActivatedRoute} route Activated Route.
|
||||
* @param {SystemService} systemService System Service.
|
||||
*/
|
||||
constructor(private route: ActivatedRoute,
|
||||
private systemService: SystemService,
|
||||
private datePipe: DatePipe) {
|
||||
this.route.data.subscribe((data: { auditTrailSearchTemplate: any }) => {
|
||||
this.auditTrailSearchTemplateData = data.auditTrailSearchTemplate;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets filtered users, actions and entities for autocomplete and audit trails table.
|
||||
*/
|
||||
ngOnInit() {
|
||||
this.setFilteredUsers();
|
||||
this.setFilteredActions();
|
||||
this.setFilteredEntities();
|
||||
this.setFilteredCheckers();
|
||||
this.getAuditTrails();
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribes to all search filters:
|
||||
* User Name, From Date, To Date, Checked From Date, Checked To Date, Resource ID, Action Name, Entity Name, Checker
|
||||
* sort change and page change.
|
||||
*/
|
||||
ngAfterViewInit() {
|
||||
this.user.valueChanges
|
||||
.pipe(
|
||||
map(value => value.id ? value.id : ''),
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(filterValue, 'makerId');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.fromDate.valueChanges
|
||||
.pipe(
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(this.getDate(filterValue), 'makerDateTimeFrom');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.toDate.valueChanges
|
||||
.pipe(
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(this.getDate(filterValue), 'makerDateTimeTo');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.checkedFromDate.valueChanges
|
||||
.pipe(
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(this.getDate(filterValue), 'checkerDateTimeFrom');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.checkedToDate.valueChanges
|
||||
.pipe(
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(this.getDate(filterValue), 'checkerDateTimeTo');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.resourceId.valueChanges
|
||||
.pipe(
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(filterValue, 'resourceId');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.actionName.valueChanges
|
||||
.pipe(
|
||||
map(value => value ? value : ''),
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(filterValue, 'actionName');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.entityName.valueChanges
|
||||
.pipe(
|
||||
map(value => value ? value : ''),
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(filterValue, 'entityName');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.checker.valueChanges
|
||||
.pipe(
|
||||
map(value => value ? value : ''),
|
||||
debounceTime(500),
|
||||
distinctUntilChanged(),
|
||||
tap((filterValue) => {
|
||||
this.applyFilter(filterValue, 'checkerId');
|
||||
})
|
||||
).subscribe();
|
||||
|
||||
this.sort.sortChange.subscribe(() => this.paginator.pageIndex = 0);
|
||||
|
||||
merge(this.sort.sortChange, this.paginator.page)
|
||||
.pipe(
|
||||
tap(() => this.loadAuditTrailsPage())
|
||||
).subscribe();
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the data source for audit trails table and loads the first page.
|
||||
*/
|
||||
getAuditTrails() {
|
||||
this.dataSource = new AuditTrailsDataSource(this.systemService);
|
||||
this.dataSource.getAuditTrails(this.filterAuditTrailsBy, this.sort.active, this.sort.direction, this.paginator.pageIndex, this.paginator.pageSize);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads a page of audit trails.
|
||||
*/
|
||||
loadAuditTrailsPage() {
|
||||
if (!this.sort.direction) {
|
||||
delete this.sort.active;
|
||||
}
|
||||
this.dataSource.getAuditTrails(this.filterAuditTrailsBy, this.sort.active, this.sort.direction, this.paginator.pageIndex, this.paginator.pageSize);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters data in audit trails table based on passed value and poperty.
|
||||
* @param {string} filterValue Value to filter data.
|
||||
* @param {string} property Property to filter data by.
|
||||
*/
|
||||
applyFilter(filterValue: string, property: string) {
|
||||
this.paginator.pageIndex = 0;
|
||||
const findIndex = this.filterAuditTrailsBy.findIndex(filter => filter.type === property);
|
||||
this.filterAuditTrailsBy[findIndex].value = filterValue;
|
||||
this.loadAuditTrailsPage();
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays user name in form control input.
|
||||
* @param {any} user User data.
|
||||
* @returns {string} User name if valid otherwise undefined.
|
||||
*/
|
||||
displayUserName(user?: any): string | undefined {
|
||||
return user ? user.name : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays action name in form control input.
|
||||
* @param {any} action Action data.
|
||||
* @returns {string} Action name if valid otherwise undefined.
|
||||
*/
|
||||
displayActionName(action?: any): string | undefined {
|
||||
return action ? action : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays entity name in form control input.
|
||||
* @param {any} entity Entity data.
|
||||
* @returns {string} Entity name if valid otherwise undefined.
|
||||
*/
|
||||
displayEntityName(entity?: any): string | undefined {
|
||||
return entity ? entity : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets filtered users for autocomplete.
|
||||
*/
|
||||
setFilteredUsers() {
|
||||
this.filteredUserData = this.user.valueChanges
|
||||
.pipe(
|
||||
startWith(''),
|
||||
map((user: any) => typeof user === 'string' ? user : user.name),
|
||||
map((userName: string) => userName ? this.filterUserAutocompleteData(userName) : this.auditTrailSearchTemplateData.appUsers)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets filtered checkers for autocomplete.
|
||||
*/
|
||||
setFilteredCheckers() {
|
||||
this.filteredCheckerData = this.checker.valueChanges
|
||||
.pipe(
|
||||
startWith(''),
|
||||
map((user: any) => typeof user === 'string' ? user : user.name),
|
||||
map((userName: string) => userName ? this.filterUserAutocompleteData(userName) : this.auditTrailSearchTemplateData.appUsers)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets filtered actions for autocomplete.
|
||||
*/
|
||||
setFilteredActions() {
|
||||
this.filteredActionData = this.actionName.valueChanges
|
||||
.pipe(
|
||||
startWith(''),
|
||||
map((action: any) => typeof action === 'string' ? action : ''),
|
||||
map((actionName: string) => actionName ? this.filterActionAutocompleteData(actionName) : this.auditTrailSearchTemplateData.actionNames)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets filtered entities for autocomplete.
|
||||
*/
|
||||
setFilteredEntities() {
|
||||
this.filteredEntityData = this.entityName.valueChanges
|
||||
.pipe(
|
||||
startWith(''),
|
||||
map((entity: any) => typeof entity === 'string' ? entity : ''),
|
||||
map((entityName: string) => entityName ? this.filterEntityAutocompleteData(entityName) : this.auditTrailSearchTemplateData.entityNames)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters users.
|
||||
* @param {string} userName User name to filter user by.
|
||||
* @returns {any} Filtered users.
|
||||
*/
|
||||
private filterUserAutocompleteData(userName: string): any {
|
||||
return this.auditTrailSearchTemplateData.appUsers.filter((user: any) => user.username.toLowerCase().includes(userName.toLowerCase()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters actions.
|
||||
* @param {string} actionName Action name to filter action by.
|
||||
* @returns {any} Filtered actions.
|
||||
*/
|
||||
private filterActionAutocompleteData(actionName: string): any {
|
||||
return this.auditTrailSearchTemplateData.actionNames.filter((action: any) => action.toLowerCase().includes(actionName.toLowerCase()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters entities.
|
||||
* @param {string} entityName Entity name to filter action by.
|
||||
* @returns {any} Filtered entities.
|
||||
*/
|
||||
private filterEntityAutocompleteData(entityName: string): any {
|
||||
return this.auditTrailSearchTemplateData.entityNames.filter((entity: any) => entity.toLowerCase().includes(entityName.toLowerCase()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the CSV file of Audit Trails Data.
|
||||
*/
|
||||
downloadCSV() {
|
||||
const dateFormat = 'yyyy-MM-dd';
|
||||
const replacer = (key: any, value: any) => value === undefined ? '' : value;
|
||||
const header = ['ID', 'Resource ID', 'Status', 'Office', 'Made On', 'Maker', 'Checked On', 'Checker', 'Entity', 'Action', 'Client'];
|
||||
const headerCode = ['id', 'resourceId', 'processingResult', 'officeName', 'madeOnDate', 'maker', 'checkedOnDate', 'checker', 'entityName', 'actionName', 'clientName'];
|
||||
this.systemService.getAuditTrails(this.filterAuditTrailsBy, this.sort.active ? this.sort.active : '', this.sort.direction, 0, -1).subscribe((response: any) => {
|
||||
if (response !== undefined) {
|
||||
let csv = response.pageItems.map((row: any) => headerCode.map(fieldName => (fieldName === 'madeOnDate' || fieldName === 'checkedOnDate') && (JSON.stringify(row[fieldName], replacer) !== '""')
|
||||
? this.datePipe.transform(JSON.stringify(row[fieldName], replacer), dateFormat)
|
||||
: JSON.stringify(row[fieldName], replacer)));
|
||||
csv.unshift(`data:text/csv;charset=utf-8,${header.join()}`);
|
||||
csv = csv.join('\r\n');
|
||||
const link = document.createElement('a');
|
||||
link.setAttribute('href', encodeURI(csv));
|
||||
link.setAttribute('download', 'Audit Trails.csv');
|
||||
document.body.appendChild(link);
|
||||
link.click();
|
||||
document.body.removeChild(link);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the date from the passed timestamp.
|
||||
*
|
||||
* TODO: Update once language and date settings are setup.
|
||||
*
|
||||
* @param {any} timestamp Timestamp from which date is to be extracted.
|
||||
*/
|
||||
private getDate(timestamp: any) {
|
||||
const dateFormat = 'yyyy-MM-dd';
|
||||
return this.datePipe.transform(timestamp, dateFormat);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user