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.

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

[Playground] Activity log #2746

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions assets/js/common/ActivityLogOverview/ActivityLogOverview.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import React, { useState, useEffect } from 'react';

Check failure on line 1 in assets/js/common/ActivityLogOverview/ActivityLogOverview.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

'useState' is defined but never used

Check failure on line 1 in assets/js/common/ActivityLogOverview/ActivityLogOverview.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

'useEffect' is defined but never used

export default function ActivityLogOverview() {
return <div>ActivityLogOverview</div>;
}
3 changes: 3 additions & 0 deletions assets/js/common/ActivityLogOverview/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import ActivityLogOverview from './ActivityLogOverview';

export default ActivityLogOverview;
3 changes: 3 additions & 0 deletions assets/js/lib/api/activityLogs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { networkClient } from '@lib/network';

export const getActivityLog = () => networkClient.get(`/activity_log`);
200 changes: 200 additions & 0 deletions assets/js/pages/ActivityLogPage/ActivityLogPage.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
import React, { useState, useEffect } from 'react';

import { logError } from '@lib/log';

import Table from '@common/Table';
import { getActivityLog } from '../../lib/api/activityLogs';
import ActivityLogOverview from '../../common/ActivityLogOverview/ActivityLogOverview';
import { format } from 'date-fns';

Check failure on line 8 in assets/js/pages/ActivityLogPage/ActivityLogPage.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

`date-fns` import should occur before import of `../../lib/api/activityLogs`

// @type activity_type ::
// :login_attempt
// | :resource_tagging
// | :resource_untagging
// | :api_key_generation
// | :saving_suma_settings
// | :changing_suma_settings
// | :clearing_suma_settings
// | :user_creation
// | :user_modification
// | :user_deletion
// | :profile_update
// | :cluster_checks_execution_request

const LOGIN_ATTEMPT = 'login_attempt';
const RESOURCE_TAGGING = 'resource_tagging';
const RESOURCE_UNTAGGING = 'resource_untagging';
const API_KEY_GENERATION = 'api_key_generation';
const SAVING_SUMA_SETTINGS = 'saving_suma_settings';
const CHANGING_SUMA_SETTINGS = 'changing_suma_settings';
const CLEARING_SUMA_SETTINGS = 'clearing_suma_settings';
const USER_CREATION = 'user_creation';
const USER_MODIFICATION = 'user_modification';
const USER_DELETION = 'user_deletion';
const PROFILE_UPDATE = 'profile_update';
const CLUSTER_CHECKS_EXECUTION_REQUEST = 'cluster_checks_execution_request';

const taggingActivities = [RESOURCE_TAGGING, RESOURCE_UNTAGGING];

const activityTypes = [
LOGIN_ATTEMPT,
...taggingActivities,
API_KEY_GENERATION,
SAVING_SUMA_SETTINGS,
CHANGING_SUMA_SETTINGS,
CLEARING_SUMA_SETTINGS,
USER_CREATION,
USER_MODIFICATION,
USER_DELETION,
PROFILE_UPDATE,
CLUSTER_CHECKS_EXECUTION_REQUEST,
];

const activityTypesLabels = {
[LOGIN_ATTEMPT]: 'Login Attempt',
[RESOURCE_TAGGING]: 'Tag Added',
[RESOURCE_UNTAGGING]: 'Tag Removed',
[API_KEY_GENERATION]: 'API Key Generated',
[SAVING_SUMA_SETTINGS]: 'SUMA Settings Saved',
[CHANGING_SUMA_SETTINGS]: 'SUMA Settings Changed',
[CLEARING_SUMA_SETTINGS]: 'SUMA Settings Cleared',
[USER_CREATION]: 'User Created',
[USER_MODIFICATION]: 'User Modified',
[USER_DELETION]: 'User Deleted',
[PROFILE_UPDATE]: 'Profile Updated',
[CLUSTER_CHECKS_EXECUTION_REQUEST]: 'Checks Execution Requested',
};

const resourceTypes = ['host', 'cluster', 'database', 'sap_system'];

Check failure on line 68 in assets/js/pages/ActivityLogPage/ActivityLogPage.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

'resourceTypes' is assigned a value but never used

const resourceTypesLabels = {
host: 'Host',
cluster: 'Cluster',
database: 'Database',
sap_system: 'SAP System',
};

const toResource = (activityLogEntry) => {
const { metadata, type } = activityLogEntry;
switch (type) {
case LOGIN_ATTEMPT:
return 'Application';
case RESOURCE_TAGGING:
case RESOURCE_UNTAGGING:
return resourceTypesLabels[metadata.resource_type];
case USER_CREATION:
case USER_MODIFICATION:
case USER_DELETION:
return 'User';
case PROFILE_UPDATE:
return 'Profile';
case SAVING_SUMA_SETTINGS:
case CHANGING_SUMA_SETTINGS:
case CLEARING_SUMA_SETTINGS:
return 'SUMA Settings';
case API_KEY_GENERATION:
return 'API Key';
case CLUSTER_CHECKS_EXECUTION_REQUEST:
return 'Cluster Checks';

default:
return 'AAA';
}
};

const toMessage = (activityLogEntry) => {
const { metadata, type } = activityLogEntry;

switch (type) {
case LOGIN_ATTEMPT:
return metadata?.reason ? 'Login failed' : 'User logged in';
case RESOURCE_TAGGING:
return `Tag "${metadata.added_tag}" added to "${metadata.resource_id}"`;
case RESOURCE_UNTAGGING:
return `Tag "${metadata.removed_tag}" removed to "${metadata.resource_id}"`;
case USER_CREATION:
return 'User was created';

case USER_MODIFICATION:
return 'User was modified';

case USER_DELETION:
return 'User was deleted';
case PROFILE_UPDATE:
return 'User modified profile';

case SAVING_SUMA_SETTINGS:
return 'SUMA Settings was saved';

case CHANGING_SUMA_SETTINGS:
return 'SUMA Settings was changed';

case CLEARING_SUMA_SETTINGS:
return 'SUMA Settings was cleared';

case API_KEY_GENERATION:
return 'API Key was generated';

case CLUSTER_CHECKS_EXECUTION_REQUEST:
return 'Checks execution requested for cluster';

default:
return 'AAA';
}
};

export default function ActivityLogPage() {
const [activityLog, setActivityLog] = useState([]);
// const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
getActivityLog()
.then((response) => {
setActivityLog(response.data);
// setIsLoading(false);
})
.catch((e) => logError(e));
}, []);

const config = {
pagination: true,
usePadding: false,
columns: [
{
title: 'Time',
key: 'occurred_on',
render: (time) => format(time, 'yyyy-MM-dd HH:mm:ss'),
},
{
title: 'Event Type',
key: 'type',
render: (type) =>
activityTypes.includes(type) ? activityTypesLabels[type] : 'Unknown',
},
{
title: 'Resource',
key: 'metadata',
render: (_, activityLogEntry) => toResource(activityLogEntry),
},
{
title: 'User',
key: 'actor',
},
{
title: 'Message',
key: 'metadata',
render: (_, activityLogEntry) => toMessage(activityLogEntry),
},
],
collapsibleDetailRenderer: (logEntry) => {

Check failure on line 189 in assets/js/pages/ActivityLogPage/ActivityLogPage.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

Do not define components during render. React will see a new component type on every render and destroy the entire subtree’s DOM nodes and state (https://reactjs.org/docs/reconciliation.html#elements-of-different-types). Instead, move this component definition out of the parent component “ActivityLogPage” and pass data as props. If you want to allow component creation in props, set allowAsProps option to true

Check failure on line 189 in assets/js/pages/ActivityLogPage/ActivityLogPage.jsx

View workflow job for this annotation

GitHub Actions / Static Code Analysis

Unexpected block statement surrounding arrow body; move the returned value immediately after the `=>`
return <pre>{JSON.stringify(logEntry, null, 2)}</pre>;
},
};

return (
<>
<ActivityLogOverview />
<Table config={config} data={activityLog} />
</>
);
}
3 changes: 3 additions & 0 deletions assets/js/pages/ActivityLogPage/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import ActivityLogPage from './ActivityLogPage';

export default ActivityLogPage;
6 changes: 6 additions & 0 deletions assets/js/pages/Layout/Layout.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
EOS_KEYBOARD_DOUBLE_ARROW_LEFT,
EOS_KEYBOARD_DOUBLE_ARROW_RIGHT,
EOS_SUPERVISED_USER_CIRCLE_OUTLINED,
EOS_ASSIGNMENT,
} from 'eos-icons-react';

import TrentoLogo from '@static/trento-logo-stacked.svg';
Expand Down Expand Up @@ -59,6 +60,11 @@ const navigation = [
icon: EOS_SUPERVISED_USER_CIRCLE_OUTLINED,
permittedFor: ['all:users'],
},
{
name: 'Activity Log',
href: '/activity_log',
icon: EOS_ASSIGNMENT,
},
{
name: 'Settings',
href: '/settings',
Expand Down
5 changes: 5 additions & 0 deletions assets/js/trento.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import SettingsPage from '@pages/SettingsPage';
import SomethingWentWrong from '@pages/SomethingWentWrong';
import UsersPage, { CreateUserPage, EditUserPage } from '@pages/Users';
import ProfilePage from '@pages/Profile';
import ActivityLogPage from '@pages/ActivityLogPage';

import { profile } from '@lib/auth';
import { networkClient } from '@lib/network';
Expand Down Expand Up @@ -113,6 +114,10 @@ const createRouter = ({ getUser }) =>
path="hosts/:hostID/patches/:advisoryID"
element={<AdvisoryDetailsPage />}
/>
<Route
path="activity_log"
element={<ActivityLogPage />}
/>
<Route
element={
<ForbiddenGuard permitted={['all:users']} outletMode />
Expand Down
Loading