FLS-1452 - Remove publishing endpoints

Publishing endpoints in Form Runner are used as Form Designer's primary persistence mechanism - each change made to a form in Form Designer will trigger a POST request to the /publish endpoint, updating the form configuration in the Runner's cache. They are also used as a means to allow FAB and Form Designer to offer form previews for forms that are not loaded into the Runner cache on app startup. Thus they are integral to the current functioning of the application, and this commit can very much be considered a potentially breaking change, so it's important that FAB and Form Designer are redirected at Pre-Award before this goes live.

Why are we removing them then? They are components of a flawed system that is being revamped by Live Services as part of our forms re-architecture work. In the future, there will be no need for arbitrary forms to be published into the cache, in order to support persistence or preview. Forms will be stored in a new location - the Pre-Award database - and Form Designer will POST updated form configuration data to a Pre-Award API. And regarding form preview, for a form to even be shown in Form Designer or FAB it must exist in the Pre-Award database, and so rendering it from Form Designer or FAB will be a simple case of requesting the form directly from the Runner, which will get it from the Pre-Award API, with no precursor publish call necessary.

Author: wjrm500

runner/src/server/plugins/engine/api/RegisterFormsApi.ts

@@ -12,71 +12,7 @@ import {jwtAuthStrategyName} from "../Auth";
 import {config} from "../../utils/AdapterConfigurationSchema";
 
 export class RegisterFormsApi implements RegisterApi {
-
-    /**
-     * The following publish endpoints (/publish, /published/{id}, /published)
-     * are used from the designer for operating in 'preview' mode.
-     * I.E. Designs saved in the designer can be accessed in the runner for viewing.
-     * The designer also uses these endpoints as a persistence mechanism for storing and retrieving data
-     * for its own purposes so if you're changing these endpoints you likely need to go and amend
-     * the designer too!
-     */
     register(server: HapiServer) {
-        server.route({
-            method: "post",
-            path: "/publish",
-            options: {
-                description: "See API-README.md file in the runner/src/server/plugins/engine/api",
-            },
-            handler: async (request: HapiRequest, h: HapiResponseToolkit) => {
-                const {adapterCacheService} = request.services([]);
-                const payload = request.payload as FormPayload;
-                const {id, configuration} = payload;
-                const parsedConfiguration =
-                    typeof configuration === "string"
-                        ? JSON.parse(configuration)
-                        : configuration;
-                if (parsedConfiguration.configuration) {
-                    await adapterCacheService.setFormConfiguration(id, parsedConfiguration, request.server)
-                } else {
-                    await adapterCacheService.setFormConfiguration(id, {configuration: parsedConfiguration}, request.server)
-                }
-                return h.response({}).code(204);
-            }
-        });
-
-        server.route({
-            method: "get",
-            path: "/published/{id}",
-            options: {
-                description: "See API-README.md file in the runner/src/server/plugins/engine/api",
-            },
-            handler: async (request: HapiRequest, h: HapiResponseToolkit) => {
-                const {id} = request.params;
-                const {adapterCacheService} = request.services([]);
-                const form = await adapterCacheService.getFormAdapterModel(id, request);
-                if (!form) {
-                    return h.response({}).code(204);
-                }
-                const {values} = await adapterCacheService.getFormAdapterModel(id, request);
-                return h.response(JSON.stringify({id, values})).code(200);
-            }
-        });
-
-        server.route({
-            method: "get",
-            path: "/published",
-            options: {
-                description: "See API-README.md file in the runner/src/server/plugins/engine/api",
-            },
-            handler: async (request: HapiRequest, h: HapiResponseToolkit) => {
-                const {adapterCacheService} = request.services([]);
-                return h
-                    .response(JSON.stringify(await adapterCacheService.getFormConfigurations(request)))
-                    .code(200);
-            }
-        });
-
         server.route({
             method: "get",
             path: "/",
@@ -133,7 +69,6 @@ export class RegisterFormsApi implements RegisterApi {
         /**
          * Middleware to check if the user session is still valid.
          *
-         * Changes behaviour only when previewMode is FALSE, meaning PRODUCTION
          * If the session is dropped, it will throw a client timeout error
          */
         const checkUserSession = async (