Resolve form mocking issue when running tests

Author: alexluckett

src/server/index.test.ts

@@ -6,6 +6,7 @@ import {
   getFormDefinition,
   getFormMetadata
 } from '~/src/server/plugins/engine/services/formsService.js'
+import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
 import { getUploadStatus } from '~/src/server/plugins/engine/services/uploadService.js'
 import {
   FileStatus,
@@ -30,7 +31,9 @@ describe('Model cache', () => {
   }
 
   beforeAll(async () => {
-    server = await createServer()
+    server = await createServer({
+      services: defaultServices
+    })
     await server.initialize()
   })
 

src/server/plugins/engine/configureEnginePlugin.ts

@@ -33,7 +33,8 @@ export const configureEnginePlugin = async ({
     plugin,
     options: {
       model,
-      services: {
+      services: services ?? {
+        // services for testing, else use the disk loader option for running this service locally
         ...defaultServices,
         formsService: await formsService()
       },

src/server/plugins/engine/services/formsService.js

@@ -2,10 +2,27 @@ const error = Error(
   'Not implemented. Consider setting up a form loader or providing a service implementation.'
 )
 
-export function getFormMetadata() {
+// eslint-disable-next-line jsdoc/require-returns-check
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _slug - the slug of the form
+ * @returns {Promise<FormMetadata>}
+ */
+export function getFormMetadata(_slug) {
   throw error
 }
 
-export function getFormDefinition() {
+// eslint-disable-next-line jsdoc/require-returns-check
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _id - the id of the form
+ * @param {FormStatus} _state - the state of the form
+ * @returns {Promise<FormDefinition | undefined>}
+ */
+export function getFormDefinition(_id, _state) {
   throw error
 }
+
+/**
+ * @import { FormStatus, FormDefinition, FormMetadata } from '@defra/forms-model'
+ */