@webiny/api-page-builder-import-export 0.0.0-mt-3 → 0.0.0-unstable.2af142b57e

package/import/process/templatesHandler.js

@@ -0,0 +1,169 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.templatesHandler = void 0;
+var _types = require("../../types");
+var _utils = require("../utils");
+var _client = require("../../client");
+var _mockSecurity = require("../../mockSecurity");
+var _utils2 = require("@webiny/utils");
+const templatesHandler = async (configuration, payload, context) => {
+  const log = console.log;
+  let subTask;
+  let noPendingTask = true;
+  let prevStatusOfSubTask = _types.ImportExportTaskStatus.PENDING;
+  log("RUNNING Import Template Queue Process");
+  const {
+    pageBuilder
+  } = context;
+  const {
+    taskId,
+    subTaskIndex,
+    type,
+    identity
+  } = payload;
+  // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks
+  // and this Lambda is invoked internally, without credentials.
+  (0, _mockSecurity.mockSecurity)(identity, context);
+  try {
+    /*
+     * Note: We're not going to DB for getting next sub-task to process,
+     * because the data might be out of sync due to GSI eventual consistency.
+     */
+
+    subTask = await pageBuilder.importExportTask.getSubTask(taskId, (0, _utils2.zeroPad)(subTaskIndex, 5));
+
+    /**
+     * Base condition!!
+     * Bail out early, if task not found or task's status is not "pending".
+     */
+    if (!subTask || subTask.status !== _types.ImportExportTaskStatus.PENDING) {
+      noPendingTask = true;
+      return {
+        data: "",
+        error: null
+      };
+    } else {
+      noPendingTask = false;
+    }
+    prevStatusOfSubTask = subTask.status;
+    log(`Fetched sub task => ${subTask.id}`);
+    const {
+      templateKey,
+      zipFileKey,
+      input
+    } = subTask.data;
+    const {
+      fileUploadsData
+    } = input;
+    log(`Processing template key "${templateKey}"`);
+
+    // Mark task status as PROCESSING
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.PROCESSING
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.PROCESSING
+    });
+    prevStatusOfSubTask = subTask.status;
+
+    // Real job
+    const template = await (0, _utils.importTemplate)({
+      context,
+      templateKey,
+      key: zipFileKey,
+      fileUploadsData
+    });
+
+    // Create a template
+    const pbTemplate = await context.pageBuilder.createPageTemplate({
+      title: template.title,
+      slug: template.slug,
+      tags: template.tags,
+      layout: template.layout,
+      description: template.description,
+      content: template.content
+    });
+
+    // Update task record in DB
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.COMPLETED,
+      data: {
+        message: "Done",
+        template: {
+          id: pbTemplate.id,
+          title: pbTemplate.title
+        }
+      }
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.COMPLETED
+    });
+    prevStatusOfSubTask = subTask.status;
+  } catch (e) {
+    log("[IMPORT_TEMPLATES_PROCESS] Error => ", e.message);
+    if (subTask && subTask.id) {
+      /**
+       * In case of error, we'll update the task status to "failed",
+       * so that, client can show notify the user appropriately.
+       */
+      subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+        status: _types.ImportExportTaskStatus.FAILED,
+        error: {
+          name: e.name,
+          message: e.message,
+          code: "IMPORT_FAILED"
+        }
+      });
+
+      // Update stats in main task
+      await pageBuilder.importExportTask.updateStats(taskId, {
+        prevStatus: prevStatusOfSubTask,
+        nextStatus: _types.ImportExportTaskStatus.FAILED
+      });
+      prevStatusOfSubTask = subTask.status;
+    }
+    return {
+      data: null,
+      error: {
+        message: e.message
+      }
+    };
+  } finally {
+    // Base condition!
+    if (noPendingTask) {
+      log(`No pending sub-task for task ${taskId}`);
+      await pageBuilder.importExportTask.updateTask(taskId, {
+        status: _types.ImportExportTaskStatus.COMPLETED,
+        data: {
+          message: `Finish importing templates.`
+        }
+      });
+    } else {
+      log(`Invoking PROCESS for task "${subTaskIndex + 1}"`);
+      // We want to continue with Self invocation no matter if current template error out.
+      await (0, _client.invokeHandlerClient)({
+        context,
+        name: configuration.handlers.process,
+        payload: {
+          taskId,
+          subTaskIndex: subTaskIndex + 1,
+          type,
+          identity: context.security.getIdentity()
+        },
+        description: "Import templates - process - subtask"
+      });
+    }
+  }
+  return {
+    data: "",
+    error: null
+  };
+};
+exports.templatesHandler = templatesHandler;

package/import/process/templatesHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["templatesHandler","configuration","payload","context","log","console","subTask","noPendingTask","prevStatusOfSubTask","ImportExportTaskStatus","PENDING","pageBuilder","taskId","subTaskIndex","type","identity","mockSecurity","importExportTask","getSubTask","zeroPad","status","data","error","id","templateKey","zipFileKey","input","fileUploadsData","updateSubTask","PROCESSING","updateStats","prevStatus","nextStatus","template","importTemplate","key","pbTemplate","createPageTemplate","title","slug","tags","layout","description","content","COMPLETED","message","e","FAILED","name","code","updateTask","invokeHandlerClient","handlers","process","security","getIdentity"],"sources":["templatesHandler.ts"],"sourcesContent":["import { ImportExportTaskStatus, PbImportExportContext } from \"~/types\";\nimport { importTemplate } from \"~/import/utils\";\nimport { invokeHandlerClient } from \"~/client\";\nimport { mockSecurity } from \"~/mockSecurity\";\nimport { zeroPad } from \"@webiny/utils\";\nimport { Configuration, Payload, Response } from \"~/import/process\";\n\nexport const templatesHandler = async (\n    configuration: Configuration,\n    payload: Payload,\n    context: PbImportExportContext\n): Promise<Response> => {\n    const log = console.log;\n    let subTask;\n    let noPendingTask = true;\n    let prevStatusOfSubTask = ImportExportTaskStatus.PENDING;\n\n    log(\"RUNNING Import Template Queue Process\");\n    const { pageBuilder } = context;\n    const { taskId, subTaskIndex, type, identity } = payload;\n    // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks\n    // and this Lambda is invoked internally, without credentials.\n    mockSecurity(identity, context);\n\n    try {\n        /*\n         * Note: We're not going to DB for getting next sub-task to process,\n         * because the data might be out of sync due to GSI eventual consistency.\n         */\n\n        subTask = await pageBuilder.importExportTask.getSubTask(taskId, zeroPad(subTaskIndex, 5));\n\n        /**\n         * Base condition!!\n         * Bail out early, if task not found or task's status is not \"pending\".\n         */\n        if (!subTask || subTask.status !== ImportExportTaskStatus.PENDING) {\n            noPendingTask = true;\n            return {\n                data: \"\",\n                error: null\n            };\n        } else {\n            noPendingTask = false;\n        }\n        prevStatusOfSubTask = subTask.status;\n\n        log(`Fetched sub task => ${subTask.id}`);\n\n        const { templateKey, zipFileKey, input } = subTask.data;\n        const { fileUploadsData } = input;\n\n        log(`Processing template key \"${templateKey}\"`);\n\n        // Mark task status as PROCESSING\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.PROCESSING\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.PROCESSING\n        });\n        prevStatusOfSubTask = subTask.status;\n\n        // Real job\n        const template = await importTemplate({\n            context,\n            templateKey,\n            key: zipFileKey,\n            fileUploadsData\n        });\n\n        // Create a template\n        const pbTemplate = await context.pageBuilder.createPageTemplate({\n            title: template.title,\n            slug: template.slug,\n            tags: template.tags,\n            layout: template.layout,\n            description: template.description,\n            content: template.content\n        });\n\n        // Update task record in DB\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.COMPLETED,\n            data: {\n                message: \"Done\",\n                template: {\n                    id: pbTemplate.id,\n                    title: pbTemplate.title\n                }\n            }\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.COMPLETED\n        });\n        prevStatusOfSubTask = subTask.status;\n    } catch (e) {\n        log(\"[IMPORT_TEMPLATES_PROCESS] Error => \", e.message);\n\n        if (subTask && subTask.id) {\n            /**\n             * In case of error, we'll update the task status to \"failed\",\n             * so that, client can show notify the user appropriately.\n             */\n            subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n                status: ImportExportTaskStatus.FAILED,\n                error: {\n                    name: e.name,\n                    message: e.message,\n                    code: \"IMPORT_FAILED\"\n                }\n            });\n\n            // Update stats in main task\n            await pageBuilder.importExportTask.updateStats(taskId, {\n                prevStatus: prevStatusOfSubTask,\n                nextStatus: ImportExportTaskStatus.FAILED\n            });\n            prevStatusOfSubTask = subTask.status;\n        }\n\n        return {\n            data: null,\n            error: {\n                message: e.message\n            }\n        };\n    } finally {\n        // Base condition!\n        if (noPendingTask) {\n            log(`No pending sub-task for task ${taskId}`);\n\n            await pageBuilder.importExportTask.updateTask(taskId, {\n                status: ImportExportTaskStatus.COMPLETED,\n                data: {\n                    message: `Finish importing templates.`\n                }\n            });\n        } else {\n            log(`Invoking PROCESS for task \"${subTaskIndex + 1}\"`);\n            // We want to continue with Self invocation no matter if current template error out.\n            await invokeHandlerClient<Payload>({\n                context,\n                name: configuration.handlers.process,\n                payload: {\n                    taskId,\n                    subTaskIndex: subTaskIndex + 1,\n                    type,\n                    identity: context.security.getIdentity()\n                },\n                description: \"Import templates - process - subtask\"\n            });\n        }\n    }\n    return {\n        data: \"\",\n        error: null\n    };\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AAGO,MAAMA,gBAAgB,GAAG,OAC5BC,aAA4B,EAC5BC,OAAgB,EAChBC,OAA8B,KACV;EACpB,MAAMC,GAAG,GAAGC,OAAO,CAACD,GAAG;EACvB,IAAIE,OAAO;EACX,IAAIC,aAAa,GAAG,IAAI;EACxB,IAAIC,mBAAmB,GAAGC,6BAAsB,CAACC,OAAO;EAExDN,GAAG,CAAC,uCAAuC,CAAC;EAC5C,MAAM;IAAEO;EAAY,CAAC,GAAGR,OAAO;EAC/B,MAAM;IAAES,MAAM;IAAEC,YAAY;IAAEC,IAAI;IAAEC;EAAS,CAAC,GAAGb,OAAO;EACxD;EACA;EACA,IAAAc,0BAAY,EAACD,QAAQ,EAAEZ,OAAO,CAAC;EAE/B,IAAI;IACA;AACR;AACA;AACA;;IAEQG,OAAO,GAAG,MAAMK,WAAW,CAACM,gBAAgB,CAACC,UAAU,CAACN,MAAM,EAAE,IAAAO,eAAO,EAACN,YAAY,EAAE,CAAC,CAAC,CAAC;;IAEzF;AACR;AACA;AACA;IACQ,IAAI,CAACP,OAAO,IAAIA,OAAO,CAACc,MAAM,KAAKX,6BAAsB,CAACC,OAAO,EAAE;MAC/DH,aAAa,GAAG,IAAI;MACpB,OAAO;QACHc,IAAI,EAAE,EAAE;QACRC,KAAK,EAAE;MACX,CAAC;IACL,CAAC,MAAM;MACHf,aAAa,GAAG,KAAK;IACzB;IACAC,mBAAmB,GAAGF,OAAO,CAACc,MAAM;IAEpChB,GAAG,CAAE,uBAAsBE,OAAO,CAACiB,EAAG,EAAC,CAAC;IAExC,MAAM;MAAEC,WAAW;MAAEC,UAAU;MAAEC;IAAM,CAAC,GAAGpB,OAAO,CAACe,IAAI;IACvD,MAAM;MAAEM;IAAgB,CAAC,GAAGD,KAAK;IAEjCtB,GAAG,CAAE,4BAA2BoB,WAAY,GAAE,CAAC;;IAE/C;IACAlB,OAAO,GAAG,MAAMK,WAAW,CAACM,gBAAgB,CAACW,aAAa,CAAChB,MAAM,EAAEN,OAAO,CAACiB,EAAE,EAAE;MAC3EH,MAAM,EAAEX,6BAAsB,CAACoB;IACnC,CAAC,CAAC;IACF;IACA,MAAMlB,WAAW,CAACM,gBAAgB,CAACa,WAAW,CAAClB,MAAM,EAAE;MACnDmB,UAAU,EAAEvB,mBAAmB;MAC/BwB,UAAU,EAAEvB,6BAAsB,CAACoB;IACvC,CAAC,CAAC;IACFrB,mBAAmB,GAAGF,OAAO,CAACc,MAAM;;IAEpC;IACA,MAAMa,QAAQ,GAAG,MAAM,IAAAC,qBAAc,EAAC;MAClC/B,OAAO;MACPqB,WAAW;MACXW,GAAG,EAAEV,UAAU;MACfE;IACJ,CAAC,CAAC;;IAEF;IACA,MAAMS,UAAU,GAAG,MAAMjC,OAAO,CAACQ,WAAW,CAAC0B,kBAAkB,CAAC;MAC5DC,KAAK,EAAEL,QAAQ,CAACK,KAAK;MACrBC,IAAI,EAAEN,QAAQ,CAACM,IAAI;MACnBC,IAAI,EAAEP,QAAQ,CAACO,IAAI;MACnBC,MAAM,EAAER,QAAQ,CAACQ,MAAM;MACvBC,WAAW,EAAET,QAAQ,CAACS,WAAW;MACjCC,OAAO,EAAEV,QAAQ,CAACU;IACtB,CAAC,CAAC;;IAEF;IACArC,OAAO,GAAG,MAAMK,WAAW,CAACM,gBAAgB,CAACW,aAAa,CAAChB,MAAM,EAAEN,OAAO,CAACiB,EAAE,EAAE;MAC3EH,MAAM,EAAEX,6BAAsB,CAACmC,SAAS;MACxCvB,IAAI,EAAE;QACFwB,OAAO,EAAE,MAAM;QACfZ,QAAQ,EAAE;UACNV,EAAE,EAAEa,UAAU,CAACb,EAAE;UACjBe,KAAK,EAAEF,UAAU,CAACE;QACtB;MACJ;IACJ,CAAC,CAAC;IACF;IACA,MAAM3B,WAAW,CAACM,gBAAgB,CAACa,WAAW,CAAClB,MAAM,EAAE;MACnDmB,UAAU,EAAEvB,mBAAmB;MAC/BwB,UAAU,EAAEvB,6BAAsB,CAACmC;IACvC,CAAC,CAAC;IACFpC,mBAAmB,GAAGF,OAAO,CAACc,MAAM;EACxC,CAAC,CAAC,OAAO0B,CAAC,EAAE;IACR1C,GAAG,CAAC,sCAAsC,EAAE0C,CAAC,CAACD,OAAO,CAAC;IAEtD,IAAIvC,OAAO,IAAIA,OAAO,CAACiB,EAAE,EAAE;MACvB;AACZ;AACA;AACA;MACYjB,OAAO,GAAG,MAAMK,WAAW,CAACM,gBAAgB,CAACW,aAAa,CAAChB,MAAM,EAAEN,OAAO,CAACiB,EAAE,EAAE;QAC3EH,MAAM,EAAEX,6BAAsB,CAACsC,MAAM;QACrCzB,KAAK,EAAE;UACH0B,IAAI,EAAEF,CAAC,CAACE,IAAI;UACZH,OAAO,EAAEC,CAAC,CAACD,OAAO;UAClBI,IAAI,EAAE;QACV;MACJ,CAAC,CAAC;;MAEF;MACA,MAAMtC,WAAW,CAACM,gBAAgB,CAACa,WAAW,CAAClB,MAAM,EAAE;QACnDmB,UAAU,EAAEvB,mBAAmB;QAC/BwB,UAAU,EAAEvB,6BAAsB,CAACsC;MACvC,CAAC,CAAC;MACFvC,mBAAmB,GAAGF,OAAO,CAACc,MAAM;IACxC;IAEA,OAAO;MACHC,IAAI,EAAE,IAAI;MACVC,KAAK,EAAE;QACHuB,OAAO,EAAEC,CAAC,CAACD;MACf;IACJ,CAAC;EACL,CAAC,SAAS;IACN;IACA,IAAItC,aAAa,EAAE;MACfH,GAAG,CAAE,gCAA+BQ,MAAO,EAAC,CAAC;MAE7C,MAAMD,WAAW,CAACM,gBAAgB,CAACiC,UAAU,CAACtC,MAAM,EAAE;QAClDQ,MAAM,EAAEX,6BAAsB,CAACmC,SAAS;QACxCvB,IAAI,EAAE;UACFwB,OAAO,EAAG;QACd;MACJ,CAAC,CAAC;IACN,CAAC,MAAM;MACHzC,GAAG,CAAE,8BAA6BS,YAAY,GAAG,CAAE,GAAE,CAAC;MACtD;MACA,MAAM,IAAAsC,2BAAmB,EAAU;QAC/BhD,OAAO;QACP6C,IAAI,EAAE/C,aAAa,CAACmD,QAAQ,CAACC,OAAO;QACpCnD,OAAO,EAAE;UACLU,MAAM;UACNC,YAAY,EAAEA,YAAY,GAAG,CAAC;UAC9BC,IAAI;UACJC,QAAQ,EAAEZ,OAAO,CAACmD,QAAQ,CAACC,WAAW;QAC1C,CAAC;QACDb,WAAW,EAAE;MACjB,CAAC,CAAC;IACN;EACJ;EACA,OAAO;IACHrB,IAAI,EAAE,EAAE;IACRC,KAAK,EAAE;EACX,CAAC;AACL,CAAC;AAAC"}

package/import/utils.d.ts

@@ -0,0 +1,56 @@
+import { File } from "@webiny/api-file-manager/types";
+import { PbImportExportContext } from "../graphql/types";
+import { ExportedPageData, ExportedBlockData, ExportedTemplateData } from "../export/utils";
+interface UploadAssetsParams {
+    context: PbImportExportContext;
+    filesData: File[];
+    fileUploadsData: FileUploadsData;
+}
+interface UploadAssetsReturnType {
+    fileIdToKeyMap: Map<string, string>;
+}
+export declare const uploadAssets: (params: UploadAssetsParams) => Promise<UploadAssetsReturnType>;
+interface FileUploadsData {
+    data: string;
+    assets: Record<string, string>;
+}
+interface ImportPageParams {
+    key: string;
+    pageKey: string;
+    context: PbImportExportContext;
+    fileUploadsData: FileUploadsData;
+}
+export declare function importPage({ pageKey, context, fileUploadsData }: ImportPageParams): Promise<ExportedPageData["page"]>;
+interface ImportBlockParams {
+    key: string;
+    blockKey: string;
+    context: PbImportExportContext;
+    fileUploadsData: FileUploadsData;
+}
+export declare function importBlock({ blockKey, context, fileUploadsData }: ImportBlockParams): Promise<ExportedBlockData["block"]>;
+interface ImportTemplateParams {
+    key: string;
+    templateKey: string;
+    context: PbImportExportContext;
+    fileUploadsData: FileUploadsData;
+}
+export declare function importTemplate({ templateKey, context, fileUploadsData }: ImportTemplateParams): Promise<ExportedTemplateData["template"]>;
+interface ImportData {
+    assets: Record<string, string>;
+    data: string;
+    key: string;
+}
+/**
+ * Function will read the given zip file from S3 via stream, extract its content and upload it to S3 bucket.
+ * @param zipFileUrl
+ * @return ImportData S3 file keys for all uploaded assets group by page/block.
+ */
+export declare function readExtractAndUploadZipFileContents(zipFileUrl: string): Promise<ImportData[]>;
+export declare function initialStats(total: number): {
+    pending: number;
+    processing: number;
+    completed: number;
+    failed: number;
+    total: number;
+};
+export {};