RN-632: Show Data-Tables in the Admin-Panel (#4175)

packages/admin-panel/src/pages/resources/DataTablesPage.js

@@ -0,0 +1,55 @@
+/*
+ * Tupaia
+ * Copyright (c) 2017 - 2021 Beyond Essential Systems Pty Ltd
+ */
+
+import React from 'react';
+import PropTypes from 'prop-types';
+import { ResourcePage } from './ResourcePage';
+
+const DATA_TABLES_ENDPOINT = 'dataTables';
+
+const FIELDS = [
+  {
+    Header: 'Code',
+    source: 'code',
+    type: 'tooltip',
+  },
+  {
+    Header: 'Description',
+    source: 'description',
+  },
+  {
+    Header: 'Type',
+    source: 'type',
+  },
+  {
+    Header: 'Config',
+    source: 'config',
+    type: 'jsonTooltip',
+    editConfig: { type: 'jsonEditor' },
+  },
+  {
+    Header: 'Permission groups',
+    source: 'permission_groups',
+    type: 'tooltip',
+    editConfig: {
+      type: 'jsonArray',
+    },
+  },
+];
+
+const COLUMNS = [...FIELDS];
+
+export const DataTablesPage = ({ getHeaderEl }) => (
+  <ResourcePage
+    title="Data-Tables"
+    endpoint={DATA_TABLES_ENDPOINT}
+    columns={COLUMNS}
+    getHeaderEl={getHeaderEl}
+  />
+);
+
+DataTablesPage.propTypes = {
+  getHeaderEl: PropTypes.func.isRequired,
+};

packages/admin-panel/src/pages/resources/index.js

@@ -20,6 +20,7 @@ export { UsersPage } from './UsersPage';
 export { SocialFeedPage } from './SocialFeedPage';
 export { DisasterResponsePage } from './DisasterResponsePage';
 export { DataGroupsPage, DataElementsPage } from './DataSourcesPage';
+export { DataTablesPage } from './DataTablesPage';
 export { AccessRequestsPage } from './AccessRequestsPage';
 export { MapOverlaysPage } from './MapOverlaysPage';
 export { MapOverlayGroupsPage } from './MapOverlayGroupsPage';

packages/admin-panel/src/routes.js

@@ -31,6 +31,7 @@ import {
   DataGroupsPage,
   ProjectsPage,
   SyncGroupsPage,
+  DataTablesPage,
 } from './pages/resources';
 
 export const ROUTES = [
@@ -121,6 +122,11 @@ export const ROUTES = [
         to: '/indicators',
         component: IndicatorsPage,
       },
+      {
+        label: 'Data-Tables',
+        to: '/dataTables',
+        component: DataTablesPage,
+      },
       {
         label: 'Social Feed',
         to: '/social-feed',

packages/central-server/src/apiV2/dataTables/GETDataTables.js

@@ -0,0 +1,30 @@
+/**
+ * Tupaia
+ * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ */
+
+import { GETHandler } from '../GETHandler';
+import {
+  assertDataTableGETPermissions,
+  createDataTableDBFilter,
+} from './assertDataTablePermissions';
+import { assertAnyPermissions, assertBESAdminAccess } from '../../permissions';
+
+export class GETDataTables extends GETHandler {
+  permissionsFilteredInternally = true;
+
+  async findSingleRecord(dataTableId, options) {
+    const dataGroupPermissionChecker = accessPolicy =>
+      assertDataTableGETPermissions(accessPolicy, this.models, dataTableId);
+    await this.assertPermissions(
+      assertAnyPermissions([assertBESAdminAccess, dataGroupPermissionChecker]),
+    );
+
+    return super.findSingleRecord(dataTableId, options);
+  }
+
+  async getPermissionsFilter(criteria, options) {
+    const dbConditions = await createDataTableDBFilter(this.accessPolicy, this.models, criteria);
+    return { dbConditions, dbOptions: options };
+  }
+}

packages/central-server/src/apiV2/dataTables/assertDataTablePermissions.js

@@ -0,0 +1,61 @@
+/**
+ * Tupaia
+ * Copyright (c) 2017 - 2021 Beyond Essential Systems Pty Ltd
+ */
+
+import { hasBESAdminAccess } from '../../permissions';
+
+const getPermissionListWithWildcard = async accessPolicy => {
+  const userPermissionGroups = accessPolicy.getPermissionGroups();
+  return ['*', ...userPermissionGroups];
+};
+
+export const assertDataTableGETPermissions = async (accessPolicy, models, dataTableId) => {
+  // User requires access to any permission group
+  if (await assertDataTablePermissions(accessPolicy, models, dataTableId, 'some')) {
+    return true;
+  }
+  throw new Error('You do not have permission to view this data-table');
+};
+
+export const assertDataTableEditPermissions = async (accessPolicy, models, dataTableId) => {
+  // User requires access to all permission groups
+  if (await assertDataTablePermissions(accessPolicy, models, dataTableId, 'every')) {
+    return true;
+  }
+  throw new Error(
+    'You require access to all of a data-tables permission groups to perform this action',
+  );
+};
+
+const assertDataTablePermissions = async (accessPolicy, models, dataTableId, test) => {
+  const dataTable = await models.dataTable.findById(dataTableId);
+  if (!dataTable) {
+    throw new Error(`No data-table exists with id ${dataTableId}`);
+  }
+  const userPermissions = await getPermissionListWithWildcard(accessPolicy);
+  // Test if user has access to any or all permission groups against the data-table
+  if (
+    dataTable.permission_groups.length <= 0 ||
+    dataTable.permission_groups[test](code => userPermissions.includes(code))
+  ) {
+    return true;
+  }
+  return false;
+};
+
+export const createDataTableDBFilter = async (accessPolicy, models, criteria) => {
+  if (hasBESAdminAccess(accessPolicy)) {
+    return criteria;
+  }
+  const dbConditions = { ...criteria };
+  const userPermissions = await getPermissionListWithWildcard(accessPolicy);
+
+  // Permission groups on the data-table overlap with our permission groups
+  // Wildcard is added to our list so it will be included
+  dbConditions.permission_groups = {
+    comparator: '&&', // Checks two array have any elements in common
+    comparisonValue: userPermissions,
+  };
+  return dbConditions;
+};

packages/central-server/src/apiV2/dataTables/index.js

@@ -0,0 +1,6 @@
+/**
+ * Tupaia
+ * Copyright (c) 2017 - 2022 Beyond Essential Systems Pty Ltd
+ */
+
+export { GETDataTables } from './GETDataTables';

packages/central-server/src/apiV2/index.js

@@ -30,6 +30,7 @@ import { GETClinics } from './GETClinics';
 import { GETDisasters } from './GETDisasters';
 import { GETDataElements, EditDataElements, DeleteDataElements } from './dataElements';
 import { GETDataGroups, EditDataGroups, DeleteDataGroups } from './dataGroups';
+import { GETDataTables } from './dataTables';
 import { GETEntities } from './GETEntities';
 import { GETFeedItems } from './GETFeedItems';
 import { GETGeographicalAreas } from './GETGeographicalAreas';
@@ -212,6 +213,7 @@ apiV2.get('/accessRequests/:recordId?', useRouteHandler(GETAccessRequests));
 apiV2.get('/dataElements/:recordId?', useRouteHandler(GETDataElements));
 apiV2.get('/dataGroups/:parentRecordId/dataElements', useRouteHandler(GETDataElements));
 apiV2.get('/dataGroups/:recordId?', useRouteHandler(GETDataGroups));
+apiV2.get('/dataTables/:recordId?', useRouteHandler(GETDataTables));
 apiV2.get('/dataElementDataGroups', useRouteHandler(GETDataElementDataGroups));
 apiV2.get('/entities/:recordId?', useRouteHandler(GETEntities));
 apiV2.get('/entities/:parentRecordId/surveyResponses', useRouteHandler(GETSurveyResponses));