@defra/forms-engine-plugin 0.0.3 → 0.0.4

package/src/server/plugins/engine/models/FormModel.ts

@@ -1,443 +0,0 @@
-import {
-  ComponentType,
-  ConditionsModel,
-  ControllerPath,
-  ControllerType,
-  Engine,
-  formDefinitionSchema,
-  hasComponents,
-  hasRepeater,
-  type ComponentDef,
-  type ConditionWrapper,
-  type ConditionsModelData,
-  type DateUnits,
-  type FormDefinition,
-  type List,
-  type Page
-} from '@defra/forms-model'
-import { add } from 'date-fns'
-import { Parser, type Value } from 'expr-eval'
-import joi from 'joi'
-
-import { type Component } from '~/src/server/plugins/engine/components/helpers.js'
-import {
-  findPage,
-  getError,
-  getPage
-} from '~/src/server/plugins/engine/helpers.js'
-import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'
-import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
-import {
-  createPage,
-  type PageControllerClass
-} from '~/src/server/plugins/engine/pageControllers/helpers.js'
-import { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
-import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
-import {
-  type FormContext,
-  type FormContextRequest,
-  type FormState,
-  type FormSubmissionError,
-  type FormSubmissionState
-} from '~/src/server/plugins/engine/types.js'
-import { FormAction } from '~/src/server/routes/types.js'
-import { merge } from '~/src/server/services/cacheService.js'
-import { type Services } from '~/src/server/types.js'
-
-export class FormModel {
-  /** The runtime engine that should be used */
-  engine?: Engine
-
-  /** the entire form JSON as an object */
-  def: FormDefinition
-
-  lists: FormDefinition['lists']
-  sections: FormDefinition['sections'] = []
-  name: string
-  values: FormDefinition
-  basePath: string
-  conditions: Partial<Record<string, ExecutableCondition>>
-  pages: PageControllerClass[]
-  services: Services
-
-  controllers?: Record<string, typeof PageController>
-  pageDefMap: Map<string, Page>
-  listDefMap: Map<string, List>
-  componentDefMap: Map<string, ComponentDef>
-  pageMap: Map<string, PageControllerClass>
-  componentMap: Map<string, Component>
-
-  constructor(
-    def: typeof this.def,
-    options: { basePath: string },
-    services: Services = defaultServices,
-    controllers?: Record<string, typeof PageController>
-  ) {
-    const result = formDefinitionSchema.validate(def, { abortEarly: false })
-
-    if (result.error) {
-      throw result.error
-    }
-
-    // Make a clone of the shallow copy returned
-    // by joi so as not to change the source data.
-    def = structuredClone(result.value)
-
-    // Add default lists
-    def.lists.push({
-      name: '__yesNo',
-      title: 'Yes/No',
-      type: 'boolean',
-      items: [
-        {
-          text: 'Yes',
-          value: true
-        },
-        {
-          text: 'No',
-          value: false
-        }
-      ]
-    })
-
-    this.engine = def.engine
-    this.def = def
-    this.lists = def.lists
-    this.sections = def.sections
-    this.name = def.name ?? ''
-    this.values = result.value
-    this.basePath = options.basePath
-    this.conditions = {}
-    this.services = services
-    this.controllers = controllers
-
-    def.conditions.forEach((conditionDef) => {
-      const condition = this.makeCondition(conditionDef)
-      this.conditions[condition.name] = condition
-    })
-
-    this.pages = def.pages.map((pageDef) => createPage(this, pageDef))
-
-    if (
-      !def.pages.some(
-        ({ controller }) =>
-          // Check for user-provided status page (optional)
-          controller === ControllerType.Status
-      )
-    ) {
-      this.pages.push(
-        createPage(this, {
-          title: 'Form submitted',
-          path: ControllerPath.Status,
-          controller: ControllerType.Status
-        })
-      )
-    }
-
-    this.pageDefMap = new Map(def.pages.map((page) => [page.path, page]))
-    this.listDefMap = new Map(def.lists.map((list) => [list.name, list]))
-    this.componentDefMap = new Map(
-      def.pages
-        .filter(hasComponents)
-        .flatMap((page) =>
-          page.components.map((component) => [component.name, component])
-        )
-    )
-
-    this.pageMap = new Map(this.pages.map((page) => [page.path, page]))
-    this.componentMap = new Map(
-      this.pages.flatMap((page) =>
-        page.collection.components.map((component) => [
-          component.name,
-          component
-        ])
-      )
-    )
-  }
-
-  /**
-   * build the entire model schema from individual pages/sections
-   */
-  makeSchema() {
-    return this.makeFilteredSchema(this.pages)
-  }
-
-  /**
-   * build the entire model schema from individual pages/sections and filter out answers
-   * for pages which are no longer accessible due to an answer that has been changed
-   */
-  makeFilteredSchema(relevantPages: PageControllerClass[]) {
-    // Build the entire model schema
-    // from the individual pages/sections
-    let schema = joi.object<FormSubmissionState>().required()
-
-    relevantPages.forEach((page) => {
-      schema = schema.concat(page.collection.stateSchema)
-    })
-
-    return schema
-  }
-
-  /**
-   * Instantiates a Condition based on {@link ConditionWrapper}
-   * @param condition
-   */
-  makeCondition(condition: ConditionWrapper): ExecutableCondition {
-    const parser = new Parser({
-      operators: {
-        logical: true
-      }
-    })
-
-    Object.assign(parser.functions, {
-      dateForComparison(timePeriod: number, timeUnit: DateUnits) {
-        return add(new Date(), { [timeUnit]: timePeriod }).toISOString()
-      }
-    })
-
-    const { name, displayName, value } = condition
-    const expr = this.toConditionExpression(value, parser)
-
-    const fn = (evaluationState: FormState) => {
-      const ctx = this.toConditionContext(evaluationState, this.conditions)
-      try {
-        return expr.evaluate(ctx) as boolean
-      } catch {
-        return false
-      }
-    }
-
-    return {
-      name,
-      displayName,
-      value,
-      expr,
-      fn
-    }
-  }
-
-  toConditionContext(
-    evaluationState: FormState,
-    conditions: Partial<Record<string, ExecutableCondition>>
-  ) {
-    const context = { ...evaluationState }
-
-    for (const key in conditions) {
-      Object.defineProperty(context, key, {
-        get() {
-          return conditions[key]?.fn(evaluationState)
-        }
-      })
-    }
-
-    return context as Extract<Value, Record<string, Value>>
-  }
-
-  toConditionExpression(value: ConditionsModelData, parser: Parser) {
-    const conditions = ConditionsModel.from(value)
-    return parser.parse(conditions.toExpression())
-  }
-
-  getList(name: string): List | undefined {
-    return this.lists.find((list) => list.name === name)
-  }
-
-  /**
-   * Form context for the current page
-   */
-  getFormContext(
-    request: FormContextRequest,
-    state: FormState,
-    errors?: FormSubmissionError[]
-  ): FormContext {
-    const { query } = request
-
-    const page = getPage(this, request)
-
-    // Determine form paths
-    const currentPath = page.path
-    const startPath = page.getStartPath()
-
-    // Preview URL direct access is allowed
-    const isForceAccess = 'force' in query
-
-    let context: FormContext = {
-      evaluationState: {},
-      relevantState: {},
-      relevantPages: [],
-      payload: page.getFormDataFromState(request, state),
-      state,
-      paths: [],
-      errors,
-      isForceAccess,
-      data: {},
-      pageDefMap: this.pageDefMap,
-      listDefMap: this.listDefMap,
-      componentDefMap: this.componentDefMap,
-      pageMap: this.pageMap,
-      componentMap: this.componentMap
-    }
-
-    // Validate current page
-    context = validateFormPayload(request, page, context)
-
-    // Find start page
-    let nextPage = findPage(this, startPath)
-
-    this.initialiseContext(context)
-
-    // Walk form pages from start
-    while (nextPage) {
-      // Add page to context
-      context.relevantPages.push(nextPage)
-
-      this.assignEvaluationState(context, nextPage)
-
-      this.assignRelevantState(context, nextPage)
-
-      // Stop at current page
-      if (nextPage.path === currentPath) {
-        break
-      }
-
-      // Apply conditions to determine next page
-      nextPage = findPage(this, nextPage.getNextPath(context))
-    }
-
-    // Validate form state
-    context = validateFormState(request, page, context)
-
-    // Add paths for navigation
-    this.assignPaths(context)
-
-    return context
-  }
-
-  private initialiseContext(context: FormContext) {
-    // For the V2 engine, we need to initialise `evaluationState` to null
-    // for all keys. This is because the current condition evaluation
-    // library (eval-expr) will throw if an expression uses a key that is undefined.
-    if (this.engine === Engine.V2) {
-      for (const page of this.pages) {
-        for (const key of page.keys) {
-          context.evaluationState[key] = null
-        }
-      }
-    }
-  }
-
-  private assignEvaluationState(
-    context: FormContext,
-    page: PageControllerClass
-  ) {
-    const { collection, pageDef } = page
-    // Skip evaluation state for repeater pages
-
-    if (!hasRepeater(pageDef)) {
-      Object.assign(
-        context.evaluationState,
-        collection.getContextValueFromState(context.state)
-      )
-    }
-  }
-
-  private assignRelevantState(context: FormContext, page: PageControllerClass) {
-    // Copy relevant state by expected keys
-    for (const key of page.keys) {
-      if (typeof context.state[key] !== 'undefined') {
-        context.relevantState[key] = context.state[key]
-      }
-    }
-  }
-
-  private assignPaths(context: FormContext) {
-    for (const { keys, path } of context.relevantPages) {
-      context.paths.push(path)
-
-      // Stop at page with errors
-      if (
-        context.errors?.some(({ name, path }) => {
-          return keys.includes(name) || keys.some((key) => path.includes(key))
-        })
-      ) {
-        break
-      }
-    }
-  }
-}
-
-/**
- * Validate current page only
- */
-function validateFormPayload(
-  request: FormContextRequest,
-  page: PageControllerClass,
-  context: FormContext
-): FormContext {
-  const { collection } = page
-  const { payload, state } = context
-
-  const { action } = page.getFormParams(request)
-
-  // Skip validation GET requests or other actions
-  if (!request.payload || action !== FormAction.Validate) {
-    return context
-  }
-
-  // For checkbox fields missing in the payload (i.e. unchecked),
-  // explicitly set their value to undefined so that any previously
-  // stored value is cleared and required field validation is enforced.
-  const update = { ...request.payload }
-  collection.fields.forEach((field) => {
-    if (
-      field.type === ComponentType.CheckboxesField &&
-      !(field.name in update)
-    ) {
-      update[field.name] = undefined
-    }
-  })
-
-  const { value, errors } = collection.validate({
-    ...payload,
-    ...update
-  })
-
-  // Add sanitised payload (ready to save)
-  const formState = page.getStateFromValidForm(request, state, value)
-
-  return {
-    ...context,
-    payload: merge(payload, value),
-    state: merge(state, formState),
-    errors
-  }
-}
-
-/**
- * Validate entire form state
- */
-function validateFormState(
-  request: FormContextRequest,
-  page: PageControllerClass,
-  context: FormContext
-): FormContext {
-  const { errors = [], relevantPages, relevantState } = context
-
-  // Exclude current page
-  const previousPages = relevantPages.filter(
-    (relevantPage) => relevantPage !== page
-  )
-
-  // Validate relevant state
-  const { error } = page.model
-    .makeFilteredSchema(previousPages)
-    .validate(relevantState, { ...opts, stripUnknown: true })
-
-  // Add relevant state errors
-  if (error) {
-    const errorsState = error.details.map(getError)
-    return { ...context, errors: errors.concat(errorsState) }
-  }
-
-  return context
-}

package/src/server/plugins/engine/models/SummaryViewModel.test.ts

@@ -1,209 +0,0 @@
-import {
-  FormModel,
-  SummaryViewModel
-} from '~/src/server/plugins/engine/models/index.js'
-import {
-  createPage,
-  type PageControllerClass
-} from '~/src/server/plugins/engine/pageControllers/helpers.js'
-import {
-  type FormContext,
-  type FormContextRequest,
-  type FormState
-} from '~/src/server/plugins/engine/types.js'
-import definition from '~/test/form/definitions/repeat-mixed.js'
-
-const basePath = '/test'
-
-describe('SummaryViewModel', () => {
-  const itemId1 = 'abc-123'
-  const itemId2 = 'xyz-987'
-
-  let model: FormModel
-  let page: PageControllerClass
-  let pageUrl: URL
-  let request: FormContextRequest
-  let context: FormContext
-  let summaryViewModel: SummaryViewModel
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    page = createPage(model, definition.pages[2])
-    pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
-
-    request = {
-      method: 'get',
-      url: pageUrl,
-      path: pageUrl.pathname,
-      params: {
-        path: 'pizza-order',
-        slug: 'repeat'
-      },
-      query: {},
-      app: { model }
-    }
-  })
-
-  describe.each([
-    {
-      description: '0 items',
-      state: {
-        orderType: 'collection',
-        pizza: []
-      } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizzas'],
-      values: ['Collection', 'Not supplied']
-    },
-    {
-      description: '1 item',
-      state: {
-        orderType: 'delivery',
-        pizza: [
-          {
-            toppings: 'Ham',
-            quantity: 2,
-            itemId: itemId1
-          }
-        ]
-      } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizza added'],
-      values: ['Delivery', 'You added 1 Pizza']
-    },
-    {
-      description: '2 items',
-      state: {
-        orderType: 'delivery',
-        pizza: [
-          {
-            toppings: 'Ham',
-            quantity: 2,
-            itemId: itemId1
-          },
-          {
-            toppings: 'Pepperoni',
-            quantity: 1,
-            itemId: itemId2
-          }
-        ]
-      } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizzas added'],
-      values: ['Delivery', 'You added 2 Pizzas']
-    }
-  ])('Check answers ($description)', ({ state, keys, values }) => {
-    beforeEach(() => {
-      context = model.getFormContext(request, state)
-      summaryViewModel = new SummaryViewModel(request, page, context)
-    })
-
-    it('should add title for each section', () => {
-      const [checkAnswers1, checkAnswers2] = summaryViewModel.checkAnswers
-
-      // 1st summary list has no title
-      expect(checkAnswers1).toHaveProperty('title', undefined)
-
-      // 2nd summary list has section title
-      expect(checkAnswers2).toHaveProperty('title', {
-        text: 'Food'
-      })
-    })
-
-    it('should add summary list for each section', () => {
-      expect(summaryViewModel.checkAnswers).toHaveLength(2)
-
-      const [checkAnswers1, checkAnswers2] = summaryViewModel.checkAnswers
-
-      const { summaryList: summaryList1 } = checkAnswers1
-      const { summaryList: summaryList2 } = checkAnswers2
-
-      expect(summaryList1).toHaveProperty('rows', [
-        {
-          key: {
-            text: keys[0]
-          },
-          value: {
-            classes: 'app-prose-scope',
-            html: values[0]
-          },
-          actions: {
-            items: [
-              {
-                classes: 'govuk-link--no-visited-state',
-                href: `${basePath}/delivery-or-collection?returnUrl=${encodeURIComponent(`${basePath}/summary`)}`,
-                text: 'Change',
-                visuallyHiddenText: keys[0]
-              }
-            ]
-          }
-        }
-      ])
-
-      expect(summaryList2).toHaveProperty('rows', [
-        {
-          key: {
-            text: keys[1]
-          },
-          value: {
-            classes: 'app-prose-scope',
-            html: values[1]
-          },
-          actions: {
-            items: [
-              {
-                classes: 'govuk-link--no-visited-state',
-                href: `${basePath}/pizza-order/summary?returnUrl=${encodeURIComponent(`${basePath}/summary`)}`,
-                text: 'Change',
-                visuallyHiddenText: 'Pizza'
-              }
-            ]
-          }
-        }
-      ])
-    })
-
-    it('should add summary list for each section (preview URL direct access)', () => {
-      request.query.force = '' // Preview URL '?force'
-      context = model.getFormContext(request, state)
-      summaryViewModel = new SummaryViewModel(request, page, context)
-
-      expect(summaryViewModel.checkAnswers).toHaveLength(2)
-
-      const [checkAnswers1, checkAnswers2] = summaryViewModel.checkAnswers
-
-      const { summaryList: summaryList1 } = checkAnswers1
-      const { summaryList: summaryList2 } = checkAnswers2
-
-      expect(summaryList1).toHaveProperty('rows', [
-        {
-          key: {
-            text: keys[0]
-          },
-          value: {
-            classes: 'app-prose-scope',
-            html: values[0]
-          },
-          actions: {
-            items: []
-          }
-        }
-      ])
-
-      expect(summaryList2).toHaveProperty('rows', [
-        {
-          key: {
-            text: keys[1]
-          },
-          value: {
-            classes: 'app-prose-scope',
-            html: values[1]
-          },
-          actions: {
-            items: []
-          }
-        }
-      ])
-    })
-  })
-})