fix(serverless-cms-aws): add control for full website render

Author: Pavel910

packages/serverless-cms-aws/src/createWebsiteApp.ts

@@ -5,11 +5,13 @@ import {
     lambdaEdgeWarning,
     renderWebsite,
     telemetryNoLongerNewUser,
-    ensureApiDeployedBeforeBuild
+    ensureApiDeployedBeforeBuild,
+    IRenderWebsiteParams
 } from "./website/plugins";
 import { uploadAppToS3 } from "./react/plugins";
 
 export interface CreateWebsiteAppParams extends CreateWebsitePulumiAppParams {
+    renderWebsiteAfterDeploy?: (params: IRenderWebsiteParams) => boolean;
     plugins?: PluginCollection;
 }
 
@@ -18,7 +20,7 @@ export function createWebsiteApp(projectAppParams: CreateWebsiteAppParams = {})
         uploadAppToS3({ folder: "apps/website" }),
         generateCommonHandlers,
         lambdaEdgeWarning,
-        renderWebsite,
+        renderWebsite({ prerender: projectAppParams.renderWebsiteAfterDeploy ?? (() => true) }),
         telemetryNoLongerNewUser,
         ensureApiDeployedBeforeBuild
     ];

packages/serverless-cms-aws/src/enterprise/createWebsiteApp.ts

@@ -8,11 +8,13 @@ import {
     lambdaEdgeWarning,
     renderWebsite,
     telemetryNoLongerNewUser,
-    ensureApiDeployedBeforeBuild
+    ensureApiDeployedBeforeBuild,
+    IRenderWebsiteParams
 } from "~/website/plugins";
 import { uploadAppToS3 } from "~/react/plugins";
 
 export interface CreateWebsiteAppParams extends CreateWebsitePulumiAppParams {
+    renderWebsiteAfterDeploy?: (params: IRenderWebsiteParams) => boolean;
     plugins?: PluginCollection;
 }
 
@@ -21,7 +23,7 @@ export function createWebsiteApp(projectAppParams: CreateWebsiteAppParams = {})
         uploadAppToS3({ folder: "apps/website" }),
         generateCommonHandlers,
         lambdaEdgeWarning,
-        renderWebsite,
+        renderWebsite({ prerender: projectAppParams.renderWebsiteAfterDeploy ?? (() => true) }),
         telemetryNoLongerNewUser,
         ensureApiDeployedBeforeBuild
     ];

packages/serverless-cms-aws/src/website/plugins/renderWebsite.ts

@@ -2,58 +2,77 @@ import { EventBridgeClient, PutEventsCommand } from "@webiny/aws-sdk/client-even
 import { CliContext } from "@webiny/cli/types";
 import { getStackOutput } from "@webiny/cli-plugin-deploy-pulumi/utils";
 
+export interface IRenderWebsiteParams {
+    env: string;
+    inputs: IRenderWebsiteParamsInputs;
+}
+
+export interface IRenderWebsiteParamsInputs {
+    preview?: boolean;
+    build?: boolean;
+}
+
+interface RenderWebsiteParams {
+    prerender: (params: IRenderWebsiteParams) => boolean;
+}
+
 /**
  * On every deployment of the Website project application, this plugin ensures all pages created
  * with the Webiny Page Builder application are re-rendered.
  */
-export const renderWebsite = {
-    type: "hook-after-deploy",
-    name: "hook-after-deploy-website-render",
-    async hook(params: Record<string, any>, context: CliContext) {
-        if (params.inputs.build === false) {
-            context.info(`"--no-build" argument detected - skipping Website re-rendering.`);
-            return;
-        }
+export const renderWebsite = (renderWebsiteParams: RenderWebsiteParams) => {
+    return {
+        type: "hook-after-deploy",
+        name: "hook-after-deploy-website-render",
+        async hook(params: IRenderWebsiteParams, context: CliContext) {
+            if (params.inputs.build === false) {
+                context.info(`"--no-build" argument detected - skipping Website re-rendering.`);
+                return;
+            }
 
-        // No need to re-render the website if we're doing a preview.
-        if (params.inputs.preview) {
-            return;
-        }
+            // No need to re-render the website if we're doing a preview.
+            if (params.inputs.preview) {
+                return;
+            }
 
-        const coreOutput = getStackOutput({ folder: "apps/core", env: params.env });
-
-        context.info("Issuing a complete website render job...");
-
-        try {
-            const client = new EventBridgeClient({ region: coreOutput["region"] });
-
-            const result = await client.send(
-                new PutEventsCommand({
-                    Entries: [
-                        {
-                            Source: "webiny-cli",
-                            EventBusName: coreOutput["eventBusArn"],
-                            DetailType: "RenderPages",
-                            Detail: JSON.stringify({ path: "*", tenant: "*" })
-                        }
-                    ]
-                })
-            );
-
-            const entry = result.Entries?.[0];
-            if (entry?.ErrorMessage) {
-                throw new Error(entry.ErrorMessage);
+            if (!renderWebsiteParams.prerender(params)) {
+                context.info("Skipping complete website rendering.");
+                return;
             }
 
-            context.success("Website re-render job successfully issued.");
-            context.info(
-                "Please note that it can take a couple of minutes for the website to be fully updated."
-            );
-        } catch (e) {
-            context.error(
-                `An error occurred while trying to update default Page Builder app's settings!`
-            );
-            console.log(e);
+            const coreOutput = getStackOutput({ folder: "apps/core", env: params.env });
+
+            context.info("Issuing a complete website rendering job...");
+
+            try {
+                const client = new EventBridgeClient({ region: coreOutput["region"] });
+
+                const result = await client.send(
+                    new PutEventsCommand({
+                        Entries: [
+                            {
+                                Source: "webiny-cli",
+                                EventBusName: coreOutput["eventBusArn"],
+                                DetailType: "RenderPages",
+                                Detail: JSON.stringify({ path: "*", tenant: "*" })
+                            }
+                        ]
+                    })
+                );
+
+                const entry = result.Entries?.[0];
+                if (entry?.ErrorMessage) {
+                    throw new Error(entry.ErrorMessage);
+                }
+
+                context.success("Website rendering job successfully issued.");
+                context.info(
+                    "Please note that it can take a couple of minutes for the website to be fully updated."
+                );
+            } catch (e) {
+                context.error(`An error occurred while issuing a website rendering job!`);
+                console.log(e);
+            }
         }
-    }
+    };
 };