feat(datatrakWeb): RN-1336: Create a task workflow

packages/admin-panel/src/VizBuilderApp/components/DataLibrary/component/TransformModal.jsx

@@ -7,7 +7,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { Dialog } from '@material-ui/core';
 import styled from 'styled-components';
-import { ModalHeader } from '../../../../widgets';
+import { ModalHeader } from '@tupaia/ui-components';
 
 const Wrapper = styled.div`
   height: 80vh;

packages/admin-panel/src/VizBuilderApp/components/Modal/EditModal.jsx

@@ -4,11 +4,16 @@
  */
 import React, { useState } from 'react';
 import { useParams } from 'react-router-dom';
-import { Button, Dialog } from '@tupaia/ui-components';
+import {
+  Button,
+  Dialog,
+  ModalContentProvider,
+  ModalFooter,
+  ModalHeader,
+} from '@tupaia/ui-components';
 import { DashboardItemMetadataForm } from '../DashboardItem';
 import { MapOverlayMetadataForm } from '../MapOverlay';
 import { DASHBOARD_ITEM_OR_MAP_OVERLAY_PARAM } from '../../constants';
-import { ModalContentProvider, ModalFooter, ModalHeader } from '../../../widgets';
 
 export const EditModal = () => {
   const { dashboardItemOrMapOverlay } = useParams();

packages/admin-panel/src/VizBuilderApp/components/Modal/SaveVisualisationModal.jsx

@@ -8,11 +8,11 @@ import PropTypes from 'prop-types';
 import styled from 'styled-components';
 import { Link as RouterLink, useParams } from 'react-router-dom';
 import Typography from '@material-ui/core/Typography';
+import { Modal, ModalCenteredContent } from '@tupaia/ui-components';
 import { DASHBOARD_ITEM_OR_MAP_OVERLAY_PARAM, MODAL_STATUS } from '../../constants';
 import { useVisualisationContext, useVizConfigContext } from '../../context';
 import { useSaveDashboardVisualisation, useSaveMapOverlayVisualisation } from '../../api';
 import { useVizBuilderBasePath } from '../../utils';
-import { Modal, ModalCenteredContent } from '../../../widgets';
 
 const Heading = styled(Typography).attrs({
   variant: 'h3',

packages/admin-panel/src/editor/EditModal.jsx

@@ -6,9 +6,9 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { connect } from 'react-redux';
+import { Modal } from '@tupaia/ui-components';
 import { dismissEditor } from './actions';
 import { UsedBy } from '../usedBy/UsedBy';
-import { Modal } from '../widgets';
 import { useEditFiles } from './useEditFiles';
 import { FieldsEditor } from './FieldsEditor';
 import { withConnectedEditor } from './withConnectedEditor';

packages/admin-panel/src/importExport/ExportModal.jsx

@@ -5,7 +5,7 @@
 
 import React, { useState } from 'react';
 import PropTypes from 'prop-types';
-import { Modal } from '../widgets';
+import { Modal } from '@tupaia/ui-components';
 import { useApiContext } from '../utilities/ApiProvider';
 import { ActionButton } from '../editor';
 import { ExportIcon } from '../icons';

packages/admin-panel/src/importExport/ImportModal.jsx

@@ -6,8 +6,8 @@
 import React, { useState } from 'react';
 import { connect } from 'react-redux';
 import PropTypes from 'prop-types';
-import { FileUploadField } from '@tupaia/ui-components';
-import { InputField, Modal } from '../widgets';
+import { FileUploadField, Modal } from '@tupaia/ui-components';
+import { InputField } from '../widgets';
 import { useApiContext } from '../utilities/ApiProvider';
 import { DATA_CHANGE_ERROR, DATA_CHANGE_REQUEST, DATA_CHANGE_SUCCESS } from '../table/constants';
 import { checkVisibilityCriteriaAreMet, labelToId } from '../utilities';

packages/admin-panel/src/library.js

@@ -31,14 +31,7 @@ export { PrivateRoute } from './authentication';
 export { getHasBESAdminAccess } from './utilities/getHasBESAdminAccess';
 export * from './pages/resources';
 export { ReduxAutocomplete } from './autocomplete';
-export {
-  IconButton,
-  ModalContentProvider,
-  Modal,
-  ModalFooter,
-  ModalHeader,
-  ModalCenteredContent,
-} from './widgets';
+export { IconButton } from './widgets';
 export { AdminPanelDataProviders } from './utilities/AdminPanelProviders';
 export { useApiContext } from './utilities/ApiProvider';
 export { DataChangeAction, ActionButton } from './editor';

packages/admin-panel/src/logsTable/LogsModal.jsx

@@ -6,8 +6,8 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { connect } from 'react-redux';
+import { Modal } from '@tupaia/ui-components';
 import { changeLogsTablePage, closeLogsModal } from './actions';
-import { Modal } from '../widgets';
 import { LogsTable } from './LogsTable';
 
 export const LogsModalComponent = ({

packages/admin-panel/src/qrCode/QrCodeModal.jsx

@@ -6,9 +6,9 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { connect } from 'react-redux';
+import { Modal } from '@tupaia/ui-components';
 import { QrCodeContainer } from './QrCodeContainer';
 import { closeQrCodeModal } from './actions';
-import { Modal } from '../widgets';
 
 export const QrCodeModalComponent = ({ isOpen, onDismiss, qrCodeContents, humanReadableId }) => {
   return (

packages/admin-panel/src/surveyResponse/FileQuestionField.jsx

@@ -7,13 +7,13 @@ import React, { useState } from 'react';
 import PropTypes from 'prop-types';
 import styled from 'styled-components';
 import generateId from 'uuid/v1';
-import { TextField } from '@tupaia/ui-components';
+import { TextField, Modal } from '@tupaia/ui-components';
 import { getUniqueFileNameParts } from '@tupaia/utils';
 import EditIcon from '@material-ui/icons/Edit';
 import DeleteIcon from '@material-ui/icons/Delete';
 import ExportIcon from '@material-ui/icons/GetApp';
 import { FileUploadField } from '../widgets/InputField/FileUploadField';
-import { IconButton, Modal } from '../widgets';
+import { IconButton } from '../widgets';
 import { useApiContext } from '../utilities/ApiProvider';
 
 const Container = styled.div`

packages/admin-panel/src/surveyResponse/Form.jsx

@@ -5,10 +5,9 @@
 
 import React, { useState, useCallback, useEffect } from 'react';
 import PropTypes from 'prop-types';
-import { Button } from '@tupaia/ui-components';
+import { Button, ModalContentProvider, ModalFooter } from '@tupaia/ui-components';
 import { Divider } from '@material-ui/core';
 import { useGetExistingData } from './useGetExistingData';
-import { ModalContentProvider, ModalFooter } from '../widgets';
 import { useResubmitSurveyResponse } from '../api/mutations/useResubmitSurveyResponse';
 import { MODAL_STATUS } from './constants';
 import { SurveyScreens } from './SurveyScreens';

packages/admin-panel/src/surveyResponse/ResubmitSurveyResponseModal.jsx

@@ -6,10 +6,9 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { connect } from 'react-redux';
-import { Dialog } from '@tupaia/ui-components';
+import { Dialog, ModalHeader } from '@tupaia/ui-components';
 import { closeResubmitSurveyModal, onAfterMutate as onAfterMutateAction } from './actions';
 import { Form } from './Form';
-import { ModalHeader } from '../widgets';
 
 export const ResubmitSurveyResponseModalComponent = ({
   isOpen,

packages/admin-panel/src/widgets/ConfirmDeleteModal.jsx

@@ -7,7 +7,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import Typography from '@material-ui/core/Typography';
 import styled from 'styled-components';
-import { Modal, ModalCenteredContent } from './Modal';
+import { Modal, ModalCenteredContent } from '@tupaia/ui-components';
 
 const Heading = styled(Typography).attrs({
   variant: 'h3',

packages/admin-panel/src/widgets/InputField/CheckboxListField.jsx

@@ -16,10 +16,10 @@ import {
   Typography,
 } from '@material-ui/core';
 import { Search } from '@material-ui/icons';
-import { InputLabel } from '@tupaia/ui-components';
+import { InputLabel, useDebounce } from '@tupaia/ui-components';
 import { get } from '../../VizBuilderApp/api/api';
 import { Checkbox } from '../Checkbox';
-import { convertSearchTermToFilter, useDebounce } from '../../utilities';
+import { convertSearchTermToFilter } from '../../utilities';
 
 const useOptions = (
   endpoint,

packages/admin-panel/src/widgets/index.js

@@ -8,13 +8,6 @@ export { InputField, JsonEditorInputField } from './InputField';
 export { Tabs } from './Tabs';
 export { PageHeader } from './PageHeader';
 export { PageBody, Footer } from '../layout';
-export {
-  ModalContentProvider,
-  Modal,
-  ModalFooter,
-  ModalHeader,
-  ModalCenteredContent,
-} from './Modal';
 export { JsonEditor, JsonTreeEditor } from './JsonEditor';
 export { SecondaryNavbar } from '../layout/navigation/SecondaryNavbar';
 export { ConfirmDeleteModal } from './ConfirmDeleteModal';

packages/central-server/src/apiV2/utilities/constructNewRecordValidationRules.js

@@ -446,26 +446,45 @@ export const constructForSingle = (models, recordType) => {
         survey_id: [constructRecordExistsWithId(models.survey)],
         assignee_id: [constructIsEmptyOr(constructRecordExistsWithId(models.user))],
         due_date: [
-          (value, { status }) => {
-            if (status !== 'repeating' && !value) {
-              throw new Error('Due date is required for non-recurring tasks');
+          (value, { repeat_schedule: repeatSchedule }) => {
+            if (repeatSchedule) {
+              if (value) {
+                throw new Error('Non-recurring tasks must not have a due date');
+              }
+              return true;
             }
+            if (!value) throw new Error('Due date is required for non-recurring tasks');
             return true;
           },
         ],
         repeat_schedule: [
-          (value, { status }) => {
-            if (status === 'repeating' && !value) {
-              throw new Error('Repeat frequency is required for recurring tasks');
+          (value, { due_date: dueDate }) => {
+            // If the task has a due date, the repeat schedule is empty
+            if (dueDate) {
+              if (value) {
+                throw new Error('Non-recurring tasks cannot have a repeat schedule');
+              }
+              return true;
+            }
+
+            if (!value) {
+              throw new Error('Repeat schedule is required for recurring tasks');
             }
             return true;
           },
         ],
         status: [
           (value, { repeat_schedule: repeatSchedule }) => {
-            if (repeatSchedule) return true;
+            // If the task is recurring, the status is empty
+            if (repeatSchedule) {
+              if (value) {
+                throw new Error('Recurring tasks cannot have a status');
+              }
+              return true;
+            }
+
             if (!value) {
-              throw new Error('Status is required');
+              throw new Error('Status is required for non-recurring tasks');
             }
             return true;
           },

packages/central-server/src/tests/apiV2/tasks/CreateTask.test.js

@@ -47,7 +47,7 @@ describe('Permissions checker for CreateTask', async () => {
 
   const BASE_TASK = {
     assignee_id: assignee.id,
-    repeat_schedule: '{}',
+    repeat_schedule: null,
     due_date: new Date('2021-12-31'),
     status: 'to_do',
   };

packages/database/src/DatabaseModel.js

@@ -78,7 +78,11 @@ export class DatabaseModel {
     if (!this.fieldNames) {
       const schema = await this.fetchSchema();
 
-      this.fieldNames = Object.keys(schema);
+      const customColumnSelectors = this.customColumnSelectors || {};
+
+      this.fieldNames = [
+        ...new Set([...Object.keys(schema), ...Object.keys(customColumnSelectors)]),
+      ];
     }
     return this.fieldNames;
   }
@@ -120,11 +124,12 @@ export class DatabaseModel {
     // Alias field names to the table to prevent errors when joining other tables
     // with same column names.
     const fieldNames = await this.fetchFieldNames();
+
     return fieldNames.map(fieldName => {
       const qualifiedName = this.fullyQualifyColumn(fieldName);
-      const customSelector = this.customColumnSelectors && this.customColumnSelectors[fieldName];
-      if (customSelector) {
-        return { [fieldName]: customSelector(qualifiedName) };
+      const customColumnSelector = this.getColumnSelector(fieldName, qualifiedName);
+      if (customColumnSelector) {
+        return { [fieldName]: customColumnSelector };
       }
       return qualifiedName;
     });
@@ -148,6 +153,14 @@ export class DatabaseModel {
     return { ...options, ...customQueryOptions };
   }
 
+  getColumnSelector(fieldName, qualifiedName) {
+    const customSelector = this.customColumnSelectors && this.customColumnSelectors[fieldName];
+    if (customSelector) {
+      return customSelector(qualifiedName);
+    }
+    return null;
+  }
+
   async getDbConditions(dbConditions = {}) {
     const fieldNames = await this.fetchFieldNames();
     const fullyQualifiedConditions = {};
@@ -162,9 +175,15 @@ export class DatabaseModel {
         // Don't touch RAW conditions
         fullyQualifiedConditions[field] = value;
       } else {
-        const fullyQualifiedField = fieldNames.includes(field)
-          ? this.fullyQualifyColumn(field)
-          : field;
+        const qualifiedName = this.fullyQualifyColumn(field);
+        const customSelector = this.getColumnSelector(field, qualifiedName);
+        let fieldSelector = qualifiedName;
+        // if there is a custom selector, and it is a string, use it as the field selector. In some cases it will be an object, e.g. `castAs: 'text'` which is used to cast the field to a specific type, but this is not used as the field selector as an error will be thrown.
+        if (customSelector && typeof customSelector === 'string') {
+          fieldSelector = customSelector;
+        }
+
+        const fullyQualifiedField = fieldNames.includes(field) ? fieldSelector : field;
         fullyQualifiedConditions[fullyQualifiedField] = value;
       }
     }

packages/database/src/TupaiaDatabase.js

@@ -514,6 +514,7 @@ export class TupaiaDatabase {
  */
 function buildQuery(connection, queryConfig, where = {}, options = {}) {
   const { recordType, queryMethod, queryMethodParameter } = queryConfig;
+
   let query = connection(recordType); // Query starts as just the table, but will be built up
 
   // If an innerQuery is defined, make the outer query wrap it
@@ -676,6 +677,7 @@ function addWhereClause(connection, baseQuery, where) {
     }
 
     const columnKey = getColSelector(connection, key);
+
     const columnSelector = castAs ? connection.raw(`??::${castAs}`, [columnKey]) : columnKey;
 
     const { args = [comparator, sanitizeComparisonValue(comparator, comparisonValue)] } = value;
@@ -740,6 +742,7 @@ function getColSelector(connection, inputColStr) {
     return connection.raw(`COALESCE(${identifiers})`, bindings);
   }
   const casePattern = /^CASE/;
+
   if (casePattern.test(inputColStr)) {
     return connection.raw(inputColStr);
   }

packages/database/src/modelClasses/PermissionGroup.js

@@ -34,6 +34,17 @@ export class PermissionGroupRecord extends DatabaseRecord {
       permissionGroupTree.map(treeItemFields => this.model.generateInstance(treeItemFields)),
     );
   }
+
+  async getAncestors() {
+    const permissionGroupTree = await this.model.database.findWithParents(
+      this.constructor.databaseRecord,
+      this.id,
+    );
+
+    return Promise.all(
+      permissionGroupTree.map(treeItemFields => this.model.generateInstance(treeItemFields)),
+    );
+  }
 }
 
 export class PermissionGroupModel extends DatabaseModel {

packages/database/src/modelClasses/User.js

@@ -53,6 +53,14 @@ export class UserModel extends DatabaseModel {
     return user;
   }
 
+  customColumnSelectors = {
+    full_name: () =>
+      `CASE 
+        WHEN last_name IS NULL THEN first_name 
+        ELSE first_name || ' ' || last_name 
+      END`,
+  };
+
   emailVerifiedStatuses = {
     UNVERIFIED: 'unverified',
     VERIFIED: 'verified',

packages/datatrak-web-server/examples.http

@@ -52,3 +52,8 @@ content-type: {{contentType}}
 ### Get survey
 GET {{host}}/surveys/TAR HTTP/1.1
 content-type: {{contentType}}
+
+
+### Get survey users
+GET {{host}}/users/TAR HTTP/1.1
+content-type: {{contentType}}

packages/datatrak-web-server/src/app/createApp.ts

@@ -47,6 +47,10 @@ import {
   GenerateLoginTokenRequest,
   TasksRequest,
   TasksRoute,
+  SurveyUsersRequest,
+  SurveyUsersRoute,
+  CreateTaskRequest,
+  CreateTaskRoute,
 } from '../routes';
 import { attachAccessPolicy } from './middleware';
 
@@ -82,6 +86,8 @@ export async function createApp() {
     .get<ActivityFeedRequest>('activityFeed', handleWith(ActivityFeedRoute))
     .get<TasksRequest>('tasks', handleWith(TasksRoute))
     .get<SingleSurveyResponseRequest>('surveyResponse/:id', handleWith(SingleSurveyResponseRoute))
+    .get<SurveyUsersRequest>('users/:surveyCode/:countryCode', handleWith(SurveyUsersRoute))
+    .post<CreateTaskRequest>('tasks', handleWith(CreateTaskRoute))
     // Forward auth requests to web-config
     .use('signup', forwardRequest(WEB_CONFIG_API_URL, { authHandlerProvider }))
     .use('resendEmail', forwardRequest(WEB_CONFIG_API_URL, { authHandlerProvider }))