Only load file-based forms when running the devserver

Author: alexluckett

src/config/index.ts

@@ -250,7 +250,7 @@ export const config = convict({
   submissionEmailAddress: {
     doc: 'Email address to send the form to (local devtool only)',
     format: String,
-    default: null,
+    default: '',
     env: 'SUBMISSION_EMAIL_ADDRESS'
   } as SchemaObj<string>
 })

src/server/plugins/engine/configureEnginePlugin.ts

@@ -9,6 +9,8 @@ import {
   type PluginOptions
 } from '~/src/server/plugins/engine/plugin.js'
 import { findPackageRoot } from '~/src/server/plugins/engine/plugin.js'
+import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
+import { formsService } from '~/src/server/plugins/engine/services/localFormsService.js'
 import { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'
 import { type RouteConfig } from '~/src/server/types.js'
 
@@ -31,7 +33,10 @@ export const configureEnginePlugin = async ({
     plugin,
     options: {
       model,
-      services,
+      services: {
+        ...defaultServices,
+        formsService: await formsService()
+      },
       controllers,
       cacheName: 'session',
       nunjucks: {

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

@@ -1,43 +1,11 @@
-import { config } from '~/src/config/index.js'
-import { FileFormService } from '~/src/server/utils/file-form-service.js'
+const error = Error(
+  'Not implemented. Consider setting up a form loader or providing a service implementation.'
+)
 
-// Create shared form metadata
-const now = new Date()
-const user = { id: 'user', displayName: 'Username' }
-const author = {
-  createdAt: now,
-  createdBy: user,
-  updatedAt: now,
-  updatedBy: user
+export function getFormMetadata() {
+  throw error
 }
-const metadata = {
-  organisation: 'Defra',
-  teamName: 'Team name',
-  teamEmail: 'team@defra.gov.uk',
-  submissionGuidance: "Thanks for your submission, we'll be in touch",
-  notificationEmail: config.get('submissionEmailAddress'),
-  ...author,
-  live: author
-}
-
-// Instantiate the file loader form service
-const loader = new FileFormService()
-
-// Add a Json form
-await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.json', {
-  ...metadata,
-  id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
-  title: 'Register as a unicorn breeder',
-  slug: 'register-as-a-unicorn-breeder'
-})
 
-// Add a Yaml form
-await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
-  ...metadata,
-  id: '641aeafd-13dd-40fa-9186-001703800efb',
-  title: 'Register as a unicorn breeder (yaml)',
-  slug: 'register-as-a-unicorn-breeder-yaml' // if we needed to validate any JSON logic, make it available for convenience
-})
-
-// Get the forms service
-export const formsService = loader.toFormsService()
+export function getFormDefinition() {
+  throw error
+}

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

@@ -1,3 +1,3 @@
-export { formsService } from '~/src/server/plugins/engine/services/formsService.js'
+export * as formsService from '~/src/server/plugins/engine/services/formsService.js'
 export * as formSubmissionService from '~/src/server/plugins/engine/services/formSubmissionService.js'
 export * as outputService from '~/src/server/plugins/engine/services/notifyService.js'

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

@@ -0,0 +1,45 @@
+import { config } from '~/src/config/index.js'
+import { FileFormService } from '~/src/server/utils/file-form-service.js'
+
+// Create shared form metadata
+const now = new Date()
+const user = { id: 'user', displayName: 'Username' }
+const author = {
+  createdAt: now,
+  createdBy: user,
+  updatedAt: now,
+  updatedBy: user
+}
+const metadata = {
+  organisation: 'Defra',
+  teamName: 'Team name',
+  teamEmail: 'team@defra.gov.uk',
+  submissionGuidance: "Thanks for your submission, we'll be in touch",
+  notificationEmail: config.get('submissionEmailAddress'),
+  ...author,
+  live: author
+}
+
+// Get the forms service
+export const formsService = async () => {
+  // Instantiate the file loader form service
+  const loader = new FileFormService()
+
+  // Add a Json form
+  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.json', {
+    ...metadata,
+    id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
+    title: 'Register as a unicorn breeder',
+    slug: 'register-as-a-unicorn-breeder'
+  })
+
+  // Add a Yaml form
+  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
+    ...metadata,
+    id: '641aeafd-13dd-40fa-9186-001703800efb',
+    title: 'Register as a unicorn breeder (yaml)',
+    slug: 'register-as-a-unicorn-breeder-yaml' // if we needed to validate any JSON logic, make it available for convenience
+  })
+
+  return loader.toFormsService()
+}