Post userDetails to updateAnswers endpoint; Some clean-up (#702)

Author: devkokov

app/controllers/baseCollectionController.ts

@@ -4,7 +4,10 @@ import { NextFunction, Response } from 'express'
 import FormWizard from 'hmpo-form-wizard'
 import BaseController from './baseController'
 import { createAnswerDTOs, flattenAnswers } from './saveAndContinue.utils'
-import StrengthsBasedNeedsAssessmentsApiService, { SessionData } from '../../server/services/strengthsBasedNeedsService'
+import StrengthsBasedNeedsAssessmentsApiService, {
+  SessionData,
+  userDetailsFromSession,
+} from '../../server/services/strengthsBasedNeedsService'
 import { HandoverSubject } from '../../server/services/arnsHandoverService'
 import { compileConditionalFields, fieldsById, withPlaceholdersFrom, withValuesFrom } from '../utils/field.utils'
 import { FieldType } from '../../server/@types/hmpo-form-wizard/enums'
@@ -131,8 +134,6 @@ abstract class BaseCollectionController extends BaseController {
         }
       }
 
-      res.locals.oasysEquivalent = assessment.oasysEquivalent
-
       const withFieldIds = (others: FormWizard.Fields, [key, field]: [string, FormWizard.Field]) => ({
         ...others,
         [key]: { ...field, id: key },
@@ -258,7 +259,11 @@ abstract class BaseCollectionController extends BaseController {
     const { assessmentId } = req.session.sessionData as SessionData
     const answersToAdd = this.buildRequestBody(req, res)
 
-    await this.apiService.updateAnswers(assessmentId, { answersToAdd, answersToRemove: [] })
+    await this.apiService.updateAnswers(assessmentId, {
+      answersToAdd,
+      answersToRemove: [],
+      userDetails: userDetailsFromSession(req.session.sessionData as SessionData),
+    })
   }
 
   async successHandler(req: FormWizard.Request, res: Response, next: NextFunction) {

app/controllers/saveAndContinue.utils.ts

@@ -90,6 +90,11 @@ export const buildRequestBody = (
             sectionFields.includes(fieldCode) && !relevantFields.some(field => field.field.code === fieldCode),
         )
       : [],
+    userDetails: {
+      id: 'user-id',
+      name: 'User Name',
+      type: 'SAN',
+    },
   }
 }
 

app/controllers/saveAndContinueController.ts

@@ -2,7 +2,10 @@ import { NextFunction, Response } from 'express'
 import FormWizard from 'hmpo-form-wizard'
 import BaseController from './baseController'
 import { buildRequestBody, flattenAnswers } from './saveAndContinue.utils'
-import StrengthsBasedNeedsAssessmentsApiService, { SessionData } from '../../server/services/strengthsBasedNeedsService'
+import StrengthsBasedNeedsAssessmentsApiService, {
+  SessionData,
+  userDetailsFromSession,
+} from '../../server/services/strengthsBasedNeedsService'
 import { HandoverSubject } from '../../server/services/arnsHandoverService'
 import {
   compileConditionalFields,
@@ -45,7 +48,6 @@ class SaveAndContinueController extends BaseController {
         : await this.apiService.fetchAssessment(sessionData.assessmentId, sessionData.assessmentVersion)
 
       req.form.persistedAnswers = flattenAnswers(assessment.assessment)
-      res.locals.oasysEquivalent = assessment.oasysEquivalent
       res.locals.assessmentVersion = assessment.metaData.versionNumber
 
       const withFieldIds = (others: FormWizard.Fields, [key, field]: [string, FormWizard.Field]) => ({
@@ -233,7 +235,11 @@ class SaveAndContinueController extends BaseController {
     }
     res.locals.values = req.form.values
 
-    await this.apiService.updateAnswers(assessmentId, { answersToAdd, answersToRemove })
+    await this.apiService.updateAnswers(assessmentId, {
+      answersToAdd,
+      answersToRemove,
+      userDetails: userDetailsFromSession(req.session.sessionData as SessionData),
+    })
   }
 
   async successHandler(req: FormWizard.Request, res: Response, next: NextFunction) {

app/controllers/startController.ts

@@ -1,8 +1,10 @@
 import { Request, Response, NextFunction } from 'express'
 import StrengthsBasedNeedsAssessmentsApiService, {
   AssessmentResponse,
+  SessionData,
+  userDetailsFromSession,
 } from '../../server/services/strengthsBasedNeedsService'
-import ArnsHandoverService, { HandoverContextData } from '../../server/services/arnsHandoverService'
+import ArnsHandoverService, { HandoverSubject } from '../../server/services/arnsHandoverService'
 import { createAnswerDto, isReadOnly } from './saveAndContinue.utils'
 import thinkingBehavioursFields from '../form/v1_0/fields/thinking-behaviours-attitudes'
 import { stepUrls } from '../form/v1_0/steps/thinking-behaviours-attitudes'
@@ -22,13 +24,15 @@ const startController = async (req: Request, res: Response, next: NextFunction)
     const assessment = await apiService.fetchAssessment(contextData.assessmentContext.assessmentId)
     const version = assessment.metaData.formVersion.replace(/\./g, '/')
 
-    if (!isReadOnly(contextData.principal)) await setSexuallyMotivatedOffenceHistory(assessment, contextData)
-
     req.session.sessionData = {
       ...contextData.assessmentContext,
       user: contextData.principal,
     }
     req.session.subjectDetails = contextData.subject
+
+    if (!isReadOnly(contextData.principal))
+      await setSexuallyMotivatedOffenceHistory(assessment, contextData.subject, req.session.sessionData as SessionData)
+
     req.session.save(error => {
       if (error) {
         return next(error)
@@ -43,9 +47,13 @@ const startController = async (req: Request, res: Response, next: NextFunction)
   }
 }
 
-const setSexuallyMotivatedOffenceHistory = async (assessment: AssessmentResponse, contextData: HandoverContextData) => {
+const setSexuallyMotivatedOffenceHistory = async (
+  assessment: AssessmentResponse,
+  subject: HandoverSubject,
+  session: SessionData,
+) => {
   const field = thinkingBehavioursFields.thinkingBehavioursAttitudesRiskSexualHarm
-  const oasysAnswer = contextData.subject.sexuallyMotivatedOffenceHistory
+  const oasysAnswer = subject.sexuallyMotivatedOffenceHistory
   const sanAnswer = assessment.assessment[field.code]?.value
   const sectionCompleteField = thinkingBehavioursFields.sectionComplete()
   const isUserSubmittedField = thinkingBehavioursFields.isUserSubmitted(stepUrls.thinkingBehavioursAttitudes)
@@ -59,6 +67,7 @@ const setSexuallyMotivatedOffenceHistory = async (assessment: AssessmentResponse
         [assessmentComplete.code]: createAnswerDto(assessmentComplete, 'NO'),
       },
       answersToRemove: [],
+      userDetails: userDetailsFromSession(session),
     })
   }
 }

app/form/v1_0/config/templates.ts

@@ -2,6 +2,5 @@ export default {
   analysisComplete: 'forms/summary/summary-analysis-complete',
   analysisIncomplete: 'forms/summary/summary-analysis-incomplete',
   drugUsage: 'forms/drug-usage',
-  dataMapping: 'forms/summary/data-mapping',
   printPreview: 'pages/print-preview',
 }

app/form/v1_0/steps/index.ts

@@ -15,18 +15,6 @@ import { Section, SectionConfig } from '../config/sections'
 import templates from '../config/templates'
 
 export const sectionConfigs: SectionConfig[] = [
-  {
-    section: {
-      title: 'Data mapping',
-      code: 'data-mapping',
-    },
-    steps: [
-      {
-        url: 'data-mapping',
-        template: templates.dataMapping,
-      },
-    ],
-  },
   {
     section: {
       title: 'Print preview',

cypress/support/commands/api.ts

@@ -139,6 +139,11 @@ export const createAssessment = (data = null) => {
           auth: { bearer: apiToken },
           body: {
             answersToAdd: data.assessment,
+            userDetails: {
+              id: 'cypress',
+              name: 'Cypress User',
+              type: 'SAN',
+            },
           },
           retryOnNetworkFailure: false,
         })

server/services/strengthsBasedNeedsService.ts

@@ -1,26 +1,10 @@
-import { UUID } from 'crypto'
 import querystring from 'querystring'
 import config from '../config'
 import RestClient from '../data/restClient'
 import getHmppsAuthClient from '../data/index'
 import { FieldType } from '../@types/hmpo-form-wizard/enums'
 import { HandoverPrincipal } from './arnsHandoverService'
 
-export interface CreateAssessmentRequest extends Record<string, unknown> {
-  oasysAssessmentPk: string
-  userDetails: {
-    id: string
-    name: string
-  }
-}
-
-export interface CreateAssessmentResponse {
-  sanAssessmentId: UUID
-  sanAssessmentVersion: number
-  sentencePlanId?: UUID
-  sentencePlanVersion?: number
-}
-
 export interface SessionData {
   assessmentId: string
   assessmentVersion: number
@@ -63,19 +47,24 @@ export interface AssessmentResponse {
   metaData: AssessmentMetaData
 }
 
-export interface OasysAssessmentResponse {
-  sanAssessmentId: string
-  sanAssessmentVersion: number
-  sanAssessmentData: AssessmentResponse
-  lastUpdatedTimestamp: string
-}
-
 export interface UpdateAnswersDto extends Record<string, unknown> {
   answersToAdd: AnswerDTOs
   answersToRemove: string[]
-  tags?: string[]
+  userDetails: UserDetails
 }
 
+interface UserDetails {
+  id: string
+  name: string
+  type: string
+}
+
+export const userDetailsFromSession = (session: SessionData): UserDetails => ({
+  id: session.user.identifier,
+  name: session.user.displayName,
+  type: 'OASYS',
+})
+
 export default class StrengthsBasedNeedsAssessmentsApiService {
   authClient