chore: get beta up to date with main, with additional documentation a…

…nd dependency resolutions (#1154) * feat: add more feeOptions - prevent auto submission (#1141) * add more feeOptions * fix schema * change tests for new feeOptions * custom error message * renaming to maxAttempts * Removed extra space --------- Co-authored-by: Luke Zigler <[email protected]> * Added README for submitter * Added docs for enabling the queue service from the runner side * Updated dependencies * More dependency updates * Updated babel dependencies across project * Updated babel-jest packages * Added resolution for babel core * Updated lockfile * Added resolution for babel traverse * Allowed postcss GHSA to avoid upgrading webpack * Fixed md table formatting * fix: change customPayErrorMessage type to string --------- Co-authored-by: Luke Zigler <[email protected]>
XGovFormBuilder · Nov 22, 2023 · 56559bb · 56559bb
1 parent f14b884
commit 56559bb
Show file tree

Hide file tree

Showing 27 changed files with 1,082 additions and 933 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,10 +1,7 @@
 {
-  "extends": [
-    "plugin:json/recommended",
-    "plugin:prettier/recommended"
-  ],
+  "extends": ["plugin:json/recommended", "plugin:prettier/recommended"],
   "plugins": ["@babel", "prettier"],
-  "parser": "babel-eslint",
+  "parser": "@babel/eslint-parser",
   "env": {
     "browser": true,
     "es6": true,
@@ -38,7 +35,12 @@
     {
       "files": ["*.ts", "*.tsx"],
       "parser": "@typescript-eslint/parser",
-      "plugins": ["@babel", "prettier", "@typescript-eslint", "eslint-plugin-tsdoc"],
+      "plugins": [
+        "@babel",
+        "prettier",
+        "@typescript-eslint",
+        "eslint-plugin-tsdoc"
+      ],
       "parserOptions": {
         "ecmaFeatures": { "jsx": true }
       }

diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -19,4 +19,6 @@ jobs:
       - name: "Dependency Review"
         uses: actions/dependency-review-action@v2
         with:
-          allow-ghsas: GHSA-c429-5p7v-vgjp
+          allow-ghsas:
+            - GHSA-c429-5p7v-vgjp
+            - GHSA-7fh5-64p2-3v2j
diff --git a/babel.config.json b/babel.config.json
@@ -3,11 +3,11 @@
   "exclude": ["node_modules/**"],
   "plugins": [
     "@babel/plugin-proposal-export-default-from",
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-private-property-in-object",
-    "@babel/plugin-proposal-private-methods",
+    "@babel/plugin-transform-class-properties",
+    "@babel/plugin-transform-private-property-in-object",
+    "@babel/plugin-transform-private-methods",
     "@babel/plugin-transform-runtime",
     "@babel/plugin-syntax-jsx",
-    "@babel/plugin-proposal-logical-assignment-operators"
+    "@babel/plugin-transform-logical-assignment-operators"
   ]
 }
diff --git a/designer/babel.config.js b/designer/babel.config.js
@@ -20,14 +20,14 @@ module.exports = {
     ],
   ],
   plugins: [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-private-methods",
+    "@babel/plugin-transform-class-properties",
+    "@babel/plugin-transform-private-methods",
     "@babel/plugin-syntax-dynamic-import",
     "@babel/plugin-transform-runtime",
     "@babel/plugin-proposal-export-default-from",
-    "@babel/plugin-proposal-nullish-coalescing-operator",
-    "@babel/plugin-proposal-optional-chaining",
-    "@babel/plugin-proposal-logical-assignment-operators",
+    "@babel/plugin-transform-nullish-coalescing-operator",
+    "@babel/plugin-transform-logical-assignment-operators",
+    "@babel/plugin-transform-optional-chaining",
     [
       "module-resolver",
       {

diff --git a/designer/package.json b/designer/package.json
@@ -63,25 +63,20 @@
     "yar": "^9.1.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.4",
-    "@babel/eslint-parser": "^7.21.3",
-    "@babel/eslint-plugin": "^7.19.1",
-    "@babel/node": "^7.20.7",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-export-namespace-from": "^7.18.9",
-    "@babel/plugin-proposal-logical-assignment-operators": "^7.20.7",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
-    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
-    "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/cli": "^7.23.3",
+    "@babel/core": "^7.23.3",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/eslint-plugin": "^7.22.10",
+    "@babel/node": "^7.22.19",
+    "@babel/plugin-proposal-export-default-from": "7.23.3",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-transform-modules-amd": "^7.20.11",
-    "@babel/plugin-transform-runtime": "^7.21.4",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-react": "^7.18.6",
-    "@babel/preset-typescript": "^7.21.4",
-    "@babel/register": "^7.21.0",
-    "@babel/runtime": "^7.21.0",
+    "@babel/plugin-transform-modules-amd": "^7.23.3",
+    "@babel/plugin-transform-runtime": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/preset-react": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
+    "@babel/register": "^7.22.15",
+    "@babel/runtime": "^7.23.3",
     "@hapi/code": "^8.0.7",
     "@hapi/eslint-plugin": "^6.0.0",
     "@hapi/lab": "^24.5.1",
@@ -99,7 +94,7 @@
     "acorn": "8.7.0",
     "autoprefixer": "^10.4.2",
     "babel-eslint": "^10.1.0",
-    "babel-loader": "^8.2.3",
+    "babel-loader": "^8.3.0",
     "babel-plugin-module-name-mapper": "^1.2.0",
     "babel-plugin-module-resolver": "^4.1.0",
     "babel-plugin-transform-import-ignore": "^1.1.0",
@@ -128,7 +123,7 @@
     "jsdom": "^19.0.0",
     "lcov-result-merger": "^3.1.0",
     "mini-css-extract-plugin": "^0.11.2",
-    "msw": "^1.2.1",
+    "msw": "^1.3.2",
     "nodemon": "^2.0.20",
     "nunjucks": "^3.2.3",
     "postcss": "^8.2.4",

diff --git a/designer/test/.transform.js b/designer/test/.transform.js
@@ -55,9 +55,9 @@ internals.transform = function (content, filename) {
     auxiliaryCommentAfter: "$lab:coverage:on$",
     plugins: [
       "@babel/plugin-proposal-export-default-from",
-      "@babel/plugin-proposal-class-properties",
-      "@babel/plugin-proposal-private-property-in-object",
-      "@babel/plugin-proposal-private-methods",
+      "@babel/plugin-transform-class-properties",
+      "@babel/plugin-transform-private-property-in-object",
+      "@babel/plugin-transform-private-methods",
       "@babel/plugin-transform-runtime",
       "@babel/plugin-syntax-dynamic-import",
       [

diff --git a/docs/runner/fee-options.md b/docs/runner/fee-options.md
@@ -0,0 +1,47 @@
+# Fee options
+
+`feeOptions` is a top level property in a form json. Fee options are used to configure API keys for GOV.UK Pay, and the behaviour of retrying payments. 
+
+
+```.json5
+{
+  // pages, sections, conditions etc ..
+  "feeOptions": {
+  /**
+   * If a payment is required, but the user fails, allow the user to skip payment
+   * and submit the form. this is the default behaviour.
+   *
+   * Any versions AFTER (and not including) v3.25.68-rc.927 allows this behaviour
+   * to be configurable. If you do not want payment to be skippable, set
+   * `allowSubmissionWithoutPayment: false`
+   */
+  "allowSubmissionWithoutPayment": true,
+
+  /**
+   * The maximum number of times a user can attempt to pay before the form is auto submitted.
+   * There is no limit when allowSubmissionWithoutPayment is false. (The user can retry as many times as they like).
+   */
+  "maxAttempts": 3,
+
+  /**
+   * A supplementary error message (`customPayErrorMessage`)
+   */
+  "customPayErrorMessage": "Custom error message",
+  }
+}
+```
+
+As a failsafe, if a user was not able to pay, we will allow them to try up to 3 times (`maxAttempts`), then auto submit (`"allowSubmissionWithoutPayment": true`).
+This is the default behaviour. Makes sure you check your organisations policy or legislative requirements. You must ensure there is a process to remediate payment failures.
+
+When a user fails a payment, they will see the page [pay-error](./../../runner/src/server/views/pay-error.html).
+
+When `allowSubmissionWithoutPayment` is true, the user will also see a link which allows them to skip payment. 
+
+
+## Recommendations 
+
+If your service does not allow submission without payment, set 
+`allowSubmissionWithoutPayment: false`. `maxAttempts` will have no effect. The user will be able to retry as many times as they like.
+You can provide them with `customPayErrorMessage` to provide them with another route to payment.  
+
diff --git a/docs/runner/submission-queue.md b/docs/runner/submission-queue.md
@@ -0,0 +1,17 @@
+# Submission queue
+
+The runner can be configured to add new submissions to a queue, and for this queue to be processed by the submitter module.
+
+By enabling the queue service this will change the webhook process, so that the runner will push the submission to a specified database, and will await a response from the submitter for a few seconds before returning the success screen to the user.
+
+## Setup
+
+Before enabling the queue service you will need a database instance set up which the runner can access. Once your database is set up, you can enable the queue service by configuring the following environment variables:
+
+| Variable name                  | Definition                                                                               | Default | Example                                     |
+| ------------------------------ | ---------------------------------------------------------------------------------------- | ------- | ------------------------------------------- |
+| ENABLE_QUEUE_SERVICE           | Whether the queue service is enabled or not                                              | `false` |                                             |
+| QUEUE_DATABASE_URL             | Used for configuring the endpoint of the database instance                               |         | mysql://username:password@endpoint/database |
+| QUEUE_DATABASE_USERNAME        | Used for configuring the user being used to access the database                          |         | root                                        |
+| QUEUE_DATABASE_PASSWORD        | Used for configuring the password used for accessing the database                        |         | password                                    |
+| QUEUE_SERVICE_POLLING_INTERVAL | The amount of time, in milliseconds, between poll requests for updates from the database | 500     |                                             |
diff --git a/model/babel.config.json b/model/babel.config.json
@@ -14,8 +14,8 @@
       ],
       "plugins": [
         "@babel/plugin-proposal-export-default-from",
-        "@babel/plugin-proposal-class-properties",
-        "@babel/plugin-proposal-private-methods",
+        "@babel/plugin-transform-class-properties",
+        "@babel/plugin-transform-private-methods",
         "@babel/plugin-transform-runtime"
       ],
       "sourceMaps": true
@@ -34,8 +34,8 @@
       ],
       "plugins": [
         "@babel/plugin-proposal-export-default-from",
-        "@babel/plugin-proposal-class-properties",
-        "@babel/plugin-proposal-private-methods",
+        "@babel/plugin-transform-class-properties",
+        "@babel/plugin-transform-private-methods",
         "@babel/plugin-transform-runtime"
       ],
       "sourceMaps": true

diff --git a/model/package.json b/model/package.json
@@ -28,27 +28,25 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@babel/runtime": "^7.21.0",
+    "@babel/runtime": "^7.23.3",
     "boom": "7.3.0",
     "btoa": "^1.2.1",
     "govuk-frontend": "^4.0.1",
     "joi": "17.2.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.4",
+    "@babel/cli": "^7.23.3",
+    "@babel/core": "^7.23.3",
     "@babel/eslint-parser": "^7.21.3",
-    "@babel/eslint-plugin": "^7.19.1",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-export-default-from": "^7.18.10",
-    "@babel/plugin-proposal-private-methods": "^7.18.6",
-    "@babel/plugin-transform-runtime": "^7.21.4",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
+    "@babel/eslint-plugin": "^7.22.10",
+    "@babel/plugin-proposal-export-default-from": "^7.23.3",
+    "@babel/plugin-transform-runtime": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
     "@types/jest": "^27.4.1",
     "@xgovformbuilder/lab-babel": "2.1.2",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^29.2.0",
+    "babel-jest": "^29.7.0",
     "cross-env": "^7.0.3",
     "depth-first": "^4.0.0",
     "eslint": "^8.10.0",

diff --git a/model/src/data-model/types.ts b/model/src/data-model/types.ts
@@ -156,4 +156,11 @@ export type FormDefinition = {
   payApiKey?: string | MultipleApiKeys | undefined;
   specialPages?: SpecialPages;
   paymentReferenceFormat?: string;
+  feeOptions: {
+    paymentReferenceFormat?: string;
+    payReturnUrl?: string;
+    allowSubmissionWithoutPayment: boolean;
+    maxAttempts: number;
+    customPayErrorMessage?: string;
+  };
 };
diff --git a/model/src/schema/__tests__/schema.test.ts b/model/src/schema/__tests__/schema.test.ts
@@ -71,6 +71,8 @@ describe("payment configuration", () => {
     const configuration = {
       ...baseConfiguration,
       feeOptions: {
+        allowSubmissionWithoutPayment: false,
+        maxAttempts: 10,
         paymentReferenceFormat: "EGGS-",
         payReturnUrl: "https://my.egg.service.scramble",
       },
@@ -81,6 +83,8 @@ describe("payment configuration", () => {
     });
 
     expect(value.feeOptions).toEqual({
+      allowSubmissionWithoutPayment: false,
+      maxAttempts: 10,
       paymentReferenceFormat: "EGGS-",
       payReturnUrl: "https://my.egg.service.scramble",
     });
@@ -91,6 +95,8 @@ describe("payment configuration", () => {
       ...baseConfiguration,
       paymentReferenceFormat: "FRIED-",
       feeOptions: {
+        allowSubmissionWithoutPayment: true,
+        maxAttempts: 3,
         paymentReferenceFormat: "EGGS-",
         payReturnUrl: "https://my.egg.service.scramble",
       },
@@ -101,6 +107,8 @@ describe("payment configuration", () => {
     });
 
     expect(value.feeOptions).toEqual({
+      allowSubmissionWithoutPayment: true,
+      maxAttempts: 3,
       paymentReferenceFormat: "EGGS-",
       payReturnUrl: "https://my.egg.service.scramble",
     });

diff --git a/model/src/schema/schema.ts b/model/src/schema/schema.ts
@@ -236,6 +236,9 @@ const feeOptionSchema = joi
     payApiKey: [joi.string().allow("").optional(), multiApiKeySchema],
     paymentReferenceFormat: [joi.string().optional()],
     payReturnUrl: joi.string().optional(),
+    allowSubmissionWithoutPayment: joi.boolean().optional().default(true),
+    maxAttempts: joi.number().optional().default(3),
+    customPayErrorMessage: joi.string().optional(),
   })
   .default(({ payApiKey, paymentReferenceFormat }) => {
     return {

diff --git a/package.json b/package.json
@@ -38,16 +38,14 @@
     "generate-architecture-diagrams": "concurrently 'npx arkit -c ./docs/designer/arkit.json' 'npx arkit -c ./docs/model/arkit.json' 'npx arkit -c ./docs/runner/arkit.json'"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.4",
-    "@babel/eslint-parser": "^7.21.3",
-    "@babel/eslint-plugin": "^7.19.1",
-    "@babel/plugin-proposal-logical-assignment-operators": "^7.20.7",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
+    "@babel/cli": "^7.23.3",
+    "@babel/core": "^7.23.3",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/eslint-plugin": "^7.22.10",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
     "@typescript-eslint/eslint-plugin": "^4.10.0",
     "@typescript-eslint/parser": "^4.10.0",
-    "babel-eslint": "^11.0.0-beta.2",
     "concurrently": "^5.3.0",
     "eslint": "^7.19.0",
     "eslint-config-prettier": "^8.5.0",
@@ -72,6 +70,8 @@
     "hmpo-components": "^5.2.1"
   },
   "resolutions": {
+    "@babel/core": "^7.23.3",
+    "@babel/traverse": "^7.23.3",
     "braces": "2.3.1",
     "pathval": "1.1.1",
     "y18n": "4.0.1",

diff --git a/queue-model/package.json b/queue-model/package.json
@@ -21,12 +21,12 @@
     "type-check": "tsc --noEmit"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.4",
-    "@babel/eslint-parser": "^7.21.3",
-    "@babel/eslint-plugin": "^7.19.1",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
+    "@babel/cli": "^7.23.3",
+    "@babel/core": "^7.23.3",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/eslint-plugin": "^7.22.10",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
     "@types/node": "^20.4.6",
     "babel-eslint": "^10.1.0",
     "eslint": "^8.10.0",