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

BHBC-900: Use management page + accesss request list #246

Merged
merged 5 commits into from
Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
118 changes: 118 additions & 0 deletions api/src/paths/administrative-activities.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import { RequestHandler } from 'express';
import { Operation } from 'express-openapi';
import { READ_ROLES } from '../constants/roles';
import { getDBConnection } from '../database/db';
import { HTTP400 } from '../errors/CustomError';
import { getAdministrativeActivitiesSQL } from '../queries/administrative-activity/administrative-activity-queries';
import { getLogger } from '../utils/logger';
import { logRequest } from '../utils/path-utils';

const defaultLog = getLogger('paths/administrative-activity');

export const GET: Operation = [logRequest('paths/administrative-activity', 'GET'), getAdministrativeActivities()];

GET.apiDoc = {
description: 'Get a list of administrative activities based on the provided criteria.',
tags: ['project'],
security: [
{
Bearer: READ_ROLES
}
],
parameters: [
{
in: 'query',
name: 'type',
schema: {
type: 'string',
enum: ['System Access']
}
}
],
responses: {
200: {
description: 'List of administrative activities.',
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'number'
},
description: {
type: 'string'
},
notes: {
type: 'string'
},
data: {
type: 'object',
properties: {
// Don't specify as this is a JSON blob column
}
},
create_date: {
type: 'string'
}
}
}
}
}
}
},
400: {
$ref: '#/components/responses/400'
},
401: {
$ref: '#/components/responses/401'
},
403: {
$ref: '#/components/responses/401'
},
500: {
$ref: '#/components/responses/500'
},
default: {
$ref: '#/components/responses/default'
}
}
};

/**
* Get all projects.
*
* @returns {RequestHandler}
*/
function getAdministrativeActivities(): RequestHandler {
return async (req, res) => {
const connection = getDBConnection(req['keycloak_token']);

try {
const administrativeActivityTypeName = (req.query?.type as string) || undefined;

const sqlStatement = getAdministrativeActivitiesSQL(administrativeActivityTypeName);

if (!sqlStatement) {
throw new HTTP400('Failed to build SQL get statement');
}

await connection.open();

const response = await connection.query(sqlStatement.text, sqlStatement.values);

await connection.commit();

const result = (response && response.rows && response.rows[0]) || [];

return res.status(200).json(result);
} catch (error) {
defaultLog.debug({ label: 'getAdministrativeActivities', message: 'error', error });
throw error;
} finally {
connection.release();
}
};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { SQL, SQLStatement } from 'sql-template-strings';
import { getLogger } from '../../utils/logger';

const defaultLog = getLogger('queries/project/project-view-queries');

/**
* SQL query to get a list of administrative activities, optionally filtered by the administrative activity type name.
*
* @param {string} [administrativeActivityTypeName]
* @returns {SQLStatement} sql query object
*/
export const getAdministrativeActivitiesSQL = (administrativeActivityTypeName?: string): SQLStatement | null => {
defaultLog.debug({ label: 'getAdministrativeActivitiesSQL', message: 'params', administrativeActivityTypeName });

const sqlStatement = SQL`
SELECT
aat.id as aat,
aast.id as aast,
aa.description,
aa.data,
aa.notes,
aa.create_date
FROM
administrative_activity aa
LEFT OUTER JOIN
administrative_activity_status_type aast
ON
aa.aast_id = aast.id
LEFT OUTER JOIN
administrative_activity_type aat
ON
aa.aat_id = aat.id
`;

if (administrativeActivityTypeName) {
sqlStatement.append(SQL`
WHERE
aat.name = '${administrativeActivityTypeName}'
`);
}

sqlStatement.append(';');

defaultLog.debug({
label: 'getAdministrativeActivitiesSQL',
message: 'sql',
'sqlStatement.text': sqlStatement.text,
'sqlStatement.values': sqlStatement.values
});

return sqlStatement;
};
2 changes: 2 additions & 0 deletions app/src/AppRouter.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import AdminRouter from 'features/admin/AdminRouter';
import ProjectsRouter from 'features/projects/ProjectsRouter';
import AuthLayout from 'layouts/AuthLayout';
import PublicLayout from 'layouts/PublicLayout';
Expand Down Expand Up @@ -28,6 +29,7 @@ const AppRouter: React.FC = () => {
layout={AuthLayout}
title={getTitle('Projects')}
/>
<AppRoute protected path="/admin" component={AdminRouter} layout={AuthLayout} title={getTitle('Admin')} />
<AppRoute title="*" path="*" component={() => <Redirect to="/page-not-found" />} />
</Switch>
);
Expand Down
3 changes: 3 additions & 0 deletions app/src/components/layout/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ const Header: React.FC = () => {
<Link to="/projects" color={'inherit'}>
Projects
</Link>
<Link to="/admin/users" color={'inherit'}>
Manage Users
</Link>
</Toolbar>
</Container>
</Box>
Expand Down
6 changes: 6 additions & 0 deletions app/src/components/layout/__snapshots__/Header.test.tsx.snap
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ exports[`NotFoundPage renders correctly 1`] = `
>
Projects
</a>
<a
color="inherit"
href="/admin/users"
>
Manage Users
</a>
</div>
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions app/src/constants/dateFormats.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export enum DATE_FORMAT {
ShortMediumDateFormat = 'MMM D, YYYY', //Jan 5, 2020
ShortMediumDateTimeFormat = 'MMM D, YYYY, h:mm a', //Jan 5, 2020, 3:30 pm
MediumDateFormat = 'MMMM D, YYYY', //January 5, 2020
MediumDateFormat2 = 'MMMM-DD-YYYY', //January-5-2020
MediumDateTimeFormat = 'MMMM D, YYYY, h:mm a', //January 5, 2020, 3:30 pm
LongDateFormat = 'dddd, MMMM D, YYYY, h:mm a', //Monday, January 5, 2020, 3:30 pm
LongDateTimeFormat = 'dddd, MMMM D, YYYY, h:mm a' //Monday, January 5, 2020, 3:30 pm
Expand Down
35 changes: 35 additions & 0 deletions app/src/features/admin/AdminLayout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import Box from '@material-ui/core/Box';
import makeStyles from '@material-ui/core/styles/makeStyles';
import React from 'react';

const useStyles = makeStyles(() => ({
adminLayoutRoot: {
width: 'inherit',
height: '100%',
display: 'flex',
flex: '1',
flexDirection: 'column'
},
adminContainer: {
flex: '1',
overflow: 'auto'
}
}));

/**
* Layout for all admin pages.
*
* @param {*} props
* @return {*}
*/
const AdminLayout: React.FC = (props) => {
const classes = useStyles();

return (
<Box className={classes.adminLayoutRoot}>
<Box className={classes.adminContainer}>{props.children}</Box>
</Box>
);
};

export default AdminLayout;
28 changes: 28 additions & 0 deletions app/src/features/admin/AdminRouter.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import AdminLayout from 'features/admin/AdminLayout';
import React from 'react';
import { Redirect, Switch } from 'react-router';
import AppRoute from 'utils/AppRoute';
import PrivateRoute from 'utils/PrivateRoute';
import ManageUsersPage from './users/ManageUsersPage';

interface IAdminRouterProps {
classes: any;
}

/**
* Router for all `/admin/*` pages.
*
* @param {*} props
* @return {*}
*/
const AdminRouter: React.FC<IAdminRouterProps> = (props) => {
return (
<Switch>
<PrivateRoute exact layout={AdminLayout} path="/admin/users" component={ManageUsersPage} componentProps={props} />
{/* Catch any unknown routes, and re-direct to the not found page */}
<AppRoute title="*" path="/admin/*" component={() => <Redirect to="/page-not-found" />} />
</Switch>
);
};

export default AdminRouter;
Loading