@webiny/api-form-builder-so-ddb 0.0.0-mt-1

package/operations/form/index.js

@@ -0,0 +1,745 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createFormStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _query = require("@webiny/db-dynamodb/utils/query");
+
+var _cleanup = require("@webiny/db-dynamodb/utils/cleanup");
+
+var _batchWrite = require("@webiny/db-dynamodb/utils/batchWrite");
+
+var _filter = require("@webiny/db-dynamodb/utils/filter");
+
+var _sort = require("@webiny/db-dynamodb/utils/sort");
+
+var _utils = require("@webiny/utils");
+
+var _FormDynamoDbFieldPlugin = require("../../plugins/FormDynamoDbFieldPlugin");
+
+var _cursor = require("@webiny/db-dynamodb/utils/cursor");
+
+var _get = require("@webiny/db-dynamodb/utils/get");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+const createFormStorageOperations = params => {
+  const {
+    entity,
+    table,
+    plugins
+  } = params;
+  const formDynamoDbFields = plugins.byType(_FormDynamoDbFieldPlugin.FormDynamoDbFieldPlugin.type);
+
+  const createFormPartitionKey = params => {
+    const {
+      tenant,
+      locale
+    } = params;
+    return `T#${tenant}#L#${locale}#FB#F`;
+  };
+
+  const createFormLatestPartitionKey = params => {
+    return `${createFormPartitionKey(params)}#L`;
+  };
+
+  const createFormLatestPublishedPartitionKey = params => {
+    return `${createFormPartitionKey(params)}#LP`;
+  };
+
+  const createFormGSIPartitionKey = params => {
+    const {
+      tenant,
+      locale,
+      id: targetId
+    } = params;
+    const {
+      id
+    } = (0, _utils.parseIdentifier)(targetId);
+    return `T#${tenant}#L#${locale}#FB#F#${id}`;
+  };
+
+  const createRevisionSortKey = ({
+    id
+  }) => {
+    return `${id}`;
+  };
+
+  const createFormLatestSortKey = ({
+    id,
+    formId
+  }) => {
+    const value = (0, _utils.parseIdentifier)(id || formId);
+    return value.id;
+  };
+
+  const createLatestPublishedSortKey = ({
+    id,
+    formId
+  }) => {
+    const value = (0, _utils.parseIdentifier)(id || formId);
+    return value.id;
+  };
+
+  const createGSISortKey = version => {
+    return `${version}`;
+  };
+
+  const createFormType = () => {
+    return "fb.form";
+  };
+
+  const createFormLatestType = () => {
+    return "fb.form.latest";
+  };
+
+  const createFormLatestPublishedType = () => {
+    return "fb.form.latestPublished";
+  };
+
+  const createRevisionKeys = form => {
+    return {
+      PK: createFormPartitionKey(form),
+      SK: createRevisionSortKey(form)
+    };
+  };
+
+  const createLatestKeys = form => {
+    return {
+      PK: createFormLatestPartitionKey(form),
+      SK: createFormLatestSortKey(form)
+    };
+  };
+
+  const createLatestPublishedKeys = form => {
+    return {
+      PK: createFormLatestPublishedPartitionKey(form),
+      SK: createLatestPublishedSortKey(form)
+    };
+  };
+
+  const createGSIKeys = form => {
+    return {
+      GSI1_PK: createFormGSIPartitionKey(form),
+      GSI1_SK: createGSISortKey(form.version)
+    };
+  };
+
+  const createForm = async params => {
+    const {
+      form
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const gsiKeys = createGSIKeys(form);
+    const items = [entity.putBatch(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, form), revisionKeys), gsiKeys), {}, {
+      TYPE: createFormType()
+    })), entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestKeys), {}, {
+      TYPE: createFormLatestType()
+    }))];
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not insert form data into table.", ex.code || "CREATE_FORM_ERROR", {
+        revisionKeys,
+        latestKeys,
+        form
+      });
+    }
+
+    return form;
+  };
+
+  const createFormFrom = async params => {
+    const {
+      form,
+      original,
+      latest
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const gsiKeys = createGSIKeys(form);
+    const items = [entity.putBatch(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, form), revisionKeys), gsiKeys), {}, {
+      TYPE: createFormType()
+    })), entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestKeys), {}, {
+      TYPE: createFormLatestType()
+    }))];
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not create form data in the table, from existing form.", ex.code || "CREATE_FORM_FROM_ERROR", {
+        revisionKeys,
+        latestKeys,
+        original,
+        form,
+        latest
+      });
+    }
+
+    return form;
+  };
+
+  const updateForm = async params => {
+    const {
+      form,
+      original
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const gsiKeys = createGSIKeys(form);
+    const {
+      formId,
+      tenant,
+      locale
+    } = form;
+    const latestForm = await getForm({
+      where: {
+        formId,
+        tenant,
+        locale,
+        latest: true
+      }
+    });
+    const isLatestForm = latestForm ? latestForm.id === form.id : false;
+    const items = [entity.putBatch(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, form), revisionKeys), gsiKeys), {}, {
+      TYPE: createFormType()
+    }))];
+
+    if (isLatestForm) {
+      items.push(entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestKeys), {}, {
+        TYPE: createFormLatestType()
+      })));
+    }
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not update form data in the table.", ex.code || "UPDATE_FORM_ERROR", {
+        revisionKeys,
+        latestKeys,
+        original,
+        form,
+        latestForm
+      });
+    }
+
+    return form;
+  };
+
+  const getForm = async params => {
+    const {
+      where
+    } = params;
+    const {
+      id,
+      formId,
+      latest,
+      published,
+      version
+    } = where;
+
+    if (latest && published) {
+      throw new _error.default("Cannot have both latest and published params.");
+    }
+
+    let partitionKey;
+    let sortKey;
+
+    if (latest) {
+      partitionKey = createFormLatestPartitionKey(where);
+      sortKey = createFormLatestSortKey(where);
+    } else if (published && !version) {
+      /**
+       * Because of the specifics how DynamoDB works, we must not load the published record if version is sent.
+       */
+      partitionKey = createFormLatestPublishedPartitionKey(where);
+      sortKey = createLatestPublishedSortKey(where);
+    } else if (id || version) {
+      partitionKey = createFormPartitionKey(where);
+      sortKey = createRevisionSortKey({
+        id: id || (0, _utils.createIdentifier)({
+          id: formId,
+          version
+        })
+      });
+    } else {
+      throw new _error.default("Missing parameter to create a sort key.", "MISSING_WHERE_PARAMETER", {
+        where
+      });
+    }
+
+    const keys = {
+      PK: partitionKey,
+      SK: sortKey
+    };
+
+    try {
+      const item = await (0, _get.get)({
+        entity,
+        keys
+      });
+      return (0, _cleanup.cleanupItem)(entity, item);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not get form by keys.", ex.code || "GET_FORM_ERROR", {
+        keys
+      });
+    }
+  };
+
+  const listForms = async params => {
+    const {
+      sort,
+      limit,
+      where: initialWhere,
+      after
+    } = params;
+    const queryAllParams = {
+      entity,
+      partitionKey: createFormLatestPartitionKey(initialWhere),
+      options: {
+        gte: " "
+      }
+    };
+    let results;
+
+    try {
+      results = await (0, _query.queryAll)(queryAllParams);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could list forms.", ex.code || "LIST_FORMS_ERROR", {
+        where: initialWhere,
+        partitionKey: queryAllParams.partitionKey
+      });
+    }
+
+    const totalCount = results.length;
+
+    const where = _objectSpread({}, initialWhere);
+    /**
+     * We need to remove conditions so we do not filter by them again.
+     */
+
+
+    delete where.tenant;
+    delete where.locale;
+    const filteredItems = (0, _filter.filterItems)({
+      plugins,
+      items: results,
+      where,
+      fields: formDynamoDbFields
+    });
+    const sortedItems = (0, _sort.sortItems)({
+      items: filteredItems,
+      sort,
+      fields: formDynamoDbFields
+    });
+    const start = (0, _cursor.decodeCursor)(after) || 0;
+    const hasMoreItems = totalCount > start + limit;
+    const end = limit > totalCount + start + limit ? undefined : start + limit;
+    const items = sortedItems.slice(start, end);
+    /**
+     * Although we do not need a cursor here, we will use it as such to keep it standardized.
+     * Number is simply encoded.
+     */
+
+    const cursor = items.length > 0 ? (0, _cursor.encodeCursor)(start + limit) : null;
+    const meta = {
+      hasMoreItems,
+      totalCount,
+      cursor
+    };
+    return {
+      items,
+      meta
+    };
+  };
+
+  const listFormRevisions = async params => {
+    const {
+      where: initialWhere,
+      sort
+    } = params;
+    const {
+      id,
+      formId,
+      tenant,
+      locale
+    } = initialWhere;
+    const queryAllParams = {
+      entity,
+      partitionKey: createFormGSIPartitionKey({
+        tenant,
+        locale,
+        id: formId || id
+      }),
+      options: {
+        index: "GSI1",
+        gte: " "
+      }
+    };
+    let items = [];
+
+    try {
+      items = await (0, _query.queryAll)(queryAllParams);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not query forms by given params.", ex.code || "QUERY_FORMS_ERROR", {
+        partitionKey: queryAllParams.partitionKey,
+        options: queryAllParams.options
+      });
+    }
+
+    const where = _objectSpread({}, initialWhere);
+    /**
+     * We need to remove conditions so we do not filter by them again.
+     */
+
+
+    delete where.id;
+    delete where.formId;
+    delete where.tenant;
+    delete where.locale;
+    const filteredItems = (0, _filter.filterItems)({
+      plugins,
+      items,
+      where,
+      fields: formDynamoDbFields
+    });
+    return (0, _sort.sortItems)({
+      items: filteredItems,
+      sort,
+      fields: formDynamoDbFields
+    });
+  };
+
+  const deleteForm = async params => {
+    const {
+      form
+    } = params;
+    let items;
+    /**
+     * This will find all form and submission records.
+     */
+
+    const queryAllParams = {
+      entity,
+      partitionKey: createFormPartitionKey(form),
+      options: {
+        gte: " "
+      }
+    };
+
+    try {
+      items = await (0, _query.queryAll)(queryAllParams);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not query forms and submissions by given params.", ex.code || "QUERY_FORM_AND_SUBMISSIONS_ERROR", {
+        partitionKey: queryAllParams.partitionKey,
+        options: queryAllParams.options
+      });
+    }
+
+    let hasLatestPublishedRecord = false;
+    const deleteItems = items.map(item => {
+      if (!hasLatestPublishedRecord && item.published) {
+        hasLatestPublishedRecord = true;
+      }
+
+      return entity.deleteBatch({
+        PK: item.PK,
+        SK: item.SK
+      });
+    });
+
+    if (hasLatestPublishedRecord) {
+      deleteItems.push(entity.deleteBatch(createLatestPublishedKeys(items[0])));
+    }
+
+    deleteItems.push(entity.deleteBatch(createLatestKeys(items[0])));
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items: deleteItems
+      });
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not delete form and it's submissions.", ex.code || "DELETE_FORM_AND_SUBMISSIONS_ERROR");
+    }
+
+    return form;
+  };
+  /**
+   * We need to:
+   * - delete current revision
+   * - get previously published revision and update the record if it exists or delete if it does not
+   * - update latest record if current one is the latest
+   */
+
+
+  const deleteFormRevision = async params => {
+    const {
+      form,
+      revisions,
+      previous
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const latestForm = revisions[0];
+    const latestPublishedForm = revisions.find(rev => rev.published === true);
+    const isLatest = latestForm ? latestForm.id === form.id : false;
+    const isLatestPublished = latestPublishedForm ? latestPublishedForm.id === form.id : false;
+    const items = [entity.deleteBatch(revisionKeys)];
+
+    if (isLatest || isLatestPublished) {
+      /**
+       * Sort out the latest published record.
+       */
+      if (isLatestPublished) {
+        const previouslyPublishedForm = revisions.filter(f => !!f.publishedOn && f.version !== form.version).sort((a, b) => {
+          return new Date(b.publishedOn).getTime() - new Date(a.publishedOn).getTime();
+        }).shift();
+
+        if (previouslyPublishedForm) {
+          items.push(entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, previouslyPublishedForm), createLatestPublishedKeys(previouslyPublishedForm)), {}, {
+            GSI1_PK: null,
+            GSI1_SK: null,
+            TYPE: createFormLatestPublishedType()
+          })));
+        } else {
+          items.push(entity.deleteBatch(createLatestPublishedKeys(previouslyPublishedForm)));
+        }
+      }
+      /**
+       * Sort out the latest record.
+       */
+
+
+      if (isLatest) {
+        items.push(entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, previous), latestKeys), {}, {
+          GSI1_PK: null,
+          GSI1_SK: null,
+          TYPE: createFormLatestType()
+        })));
+      }
+    }
+    /**
+     * Now save the batch data.
+     */
+
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+      return form;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not delete form revision from table.", ex.code || "DELETE_FORM_REVISION_ERROR", {
+        form,
+        latestForm,
+        revisionKeys,
+        latestKeys
+      });
+    }
+  };
+  /**
+   * We need to save form in:
+   * - regular form record
+   * - latest published form record
+   * - latest form record - if form is latest one
+   * - elasticsearch latest form record
+   */
+
+
+  const publishForm = async params => {
+    const {
+      form,
+      original
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const latestPublishedKeys = createLatestPublishedKeys(form);
+    const gsiKeys = {
+      GSI1_PK: createFormGSIPartitionKey(form),
+      GSI1_SK: createGSISortKey(form.version)
+    };
+    const {
+      locale,
+      tenant,
+      formId
+    } = form;
+    const latestForm = await getForm({
+      where: {
+        formId,
+        tenant,
+        locale,
+        latest: true
+      }
+    });
+    const isLatestForm = latestForm ? latestForm.id === form.id : false;
+    /**
+     * Update revision and latest published records
+     */
+
+    const items = [entity.putBatch(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, form), revisionKeys), gsiKeys), {}, {
+      TYPE: createFormType()
+    })), entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestPublishedKeys), {}, {
+      TYPE: createFormLatestPublishedType()
+    }))];
+    /**
+     * Update the latest form as well
+     */
+
+    if (isLatestForm) {
+      items.push(entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestKeys), {}, {
+        TYPE: createFormLatestType()
+      })));
+    }
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not publish form.", ex.code || "PUBLISH_FORM_ERROR", {
+        form,
+        original,
+        latestForm,
+        revisionKeys,
+        latestKeys,
+        latestPublishedKeys
+      });
+    }
+
+    return form;
+  };
+  /**
+   * We need to:
+   * - update form revision record
+   * - if latest published (LP) is current form, find the previously published record and update LP if there is some previously published, delete otherwise
+   * - if is latest update the Elasticsearch record
+   */
+
+
+  const unpublishForm = async params => {
+    const {
+      form,
+      original
+    } = params;
+    const revisionKeys = createRevisionKeys(form);
+    const latestKeys = createLatestKeys(form);
+    const latestPublishedKeys = createLatestPublishedKeys(form);
+    const gsiKeys = createGSIKeys(form);
+    const {
+      formId,
+      tenant,
+      locale
+    } = form;
+    const latestForm = await getForm({
+      where: {
+        formId,
+        tenant,
+        locale,
+        latest: true
+      }
+    });
+    const latestPublishedForm = await getForm({
+      where: {
+        formId,
+        tenant,
+        locale,
+        published: true
+      }
+    });
+    const isLatest = latestForm ? latestForm.id === form.id : false;
+    const isLatestPublished = latestPublishedForm ? latestPublishedForm.id === form.id : false;
+    const items = [entity.putBatch(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, form), revisionKeys), gsiKeys), {}, {
+      TYPE: createFormType()
+    }))];
+
+    if (isLatest) {
+      entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, form), latestKeys), {}, {
+        TYPE: createFormLatestType()
+      }));
+    }
+    /**
+     * In case previously published revision exists, replace current one with that one.
+     * And if it does not, delete the record.
+     */
+
+
+    if (isLatestPublished) {
+      const revisions = await listFormRevisions({
+        where: {
+          formId,
+          tenant,
+          locale,
+          version_not: form.version,
+          publishedOn_not: null
+        },
+        sort: ["savedOn_DESC"]
+      });
+      const previouslyPublishedRevision = revisions.shift();
+
+      if (previouslyPublishedRevision) {
+        items.push(entity.putBatch(_objectSpread(_objectSpread(_objectSpread({}, previouslyPublishedRevision), latestPublishedKeys), {}, {
+          TYPE: createFormLatestPublishedType()
+        })));
+      } else {
+        items.push(entity.deleteBatch(latestPublishedKeys));
+      }
+    }
+
+    try {
+      await (0, _batchWrite.batchWriteAll)({
+        table,
+        items
+      });
+      return form;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not unpublish form.", ex.code || "UNPUBLISH_FORM_ERROR", {
+        form,
+        original,
+        latestForm,
+        revisionKeys,
+        latestKeys,
+        latestPublishedKeys
+      });
+    }
+  };
+
+  return {
+    createForm,
+    createFormFrom,
+    updateForm,
+    listForms,
+    listFormRevisions,
+    getForm,
+    deleteForm,
+    deleteFormRevision,
+    publishForm,
+    unpublishForm,
+    createFormPartitionKey
+  };
+};
+
+exports.createFormStorageOperations = createFormStorageOperations;