feat(api-locking-mechanism): implement base locking mechanism (#4049)

webiny · Apr 26, 2024 · 415a26e · 415a26e
1 parent a7220b5
commit 415a26e
Show file tree

Hide file tree

Showing 78 changed files with 3,105 additions and 113 deletions.
diff --git a/.github/workflows/pullRequests.yml b/.github/workflows/pullRequests.yml
@@ -177,7 +177,7 @@ jobs:
           - 18
         package: >-
           ${{
-          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
+          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-locking-mechanism","id":"api-locking-mechanism"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
           }}
     runs-on: ${{ matrix.os }}
     env:

diff --git a/.github/workflows/pushDev.yml b/.github/workflows/pushDev.yml
@@ -143,7 +143,7 @@ jobs:
           - 18
         package: >-
           ${{
-          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
+          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-locking-mechanism","id":"api-locking-mechanism"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
           }}
     runs-on: ${{ matrix.os }}
     env:

diff --git a/.github/workflows/pushNext.yml b/.github/workflows/pushNext.yml
@@ -143,7 +143,7 @@ jobs:
           - 18
         package: >-
           ${{
-          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
+          fromJson('[{"cmd":"packages/api","id":"api"},{"cmd":"packages/api-admin-settings","id":"api-admin-settings"},{"cmd":"packages/api-authentication","id":"api-authentication"},{"cmd":"packages/api-authentication-cognito","id":"api-authentication-cognito"},{"cmd":"packages/api-dynamodb-to-elasticsearch","id":"api-dynamodb-to-elasticsearch"},{"cmd":"packages/api-headless-cms-ddb","id":"api-headless-cms-ddb"},{"cmd":"packages/api-locking-mechanism","id":"api-locking-mechanism"},{"cmd":"packages/api-wcp","id":"api-wcp"},{"cmd":"packages/api-websockets","id":"api-websockets"},{"cmd":"packages/app-aco","id":"app-aco"},{"cmd":"packages/app-admin","id":"app-admin"},{"cmd":"packages/cwp-template-aws","id":"cwp-template-aws"},{"cmd":"packages/data-migration","id":"data-migration"},{"cmd":"packages/db-dynamodb","id":"db-dynamodb"},{"cmd":"packages/form","id":"form"},{"cmd":"packages/handler","id":"handler"},{"cmd":"packages/handler-aws","id":"handler-aws"},{"cmd":"packages/handler-graphql","id":"handler-graphql"},{"cmd":"packages/handler-logs","id":"handler-logs"},{"cmd":"packages/ioc","id":"ioc"},{"cmd":"packages/lexical-converter","id":"lexical-converter"},{"cmd":"packages/plugins","id":"plugins"},{"cmd":"packages/pubsub","id":"pubsub"},{"cmd":"packages/react-composition","id":"react-composition"},{"cmd":"packages/react-properties","id":"react-properties"},{"cmd":"packages/react-rich-text-lexical-renderer","id":"react-rich-text-lexical-renderer"},{"cmd":"packages/utils","id":"utils"},{"cmd":"packages/validation","id":"validation"}]')
           }}
     runs-on: ${{ matrix.os }}
     env:

diff --git a/apps/api/graphql/package.json b/apps/api/graphql/package.json
@@ -25,6 +25,7 @@
     "@webiny/api-i18n": "0.0.0",
     "@webiny/api-i18n-content": "0.0.0",
     "@webiny/api-i18n-ddb": "0.0.0",
+    "@webiny/api-locking-mechanism": "0.0.0",
     "@webiny/api-page-builder": "0.0.0",
     "@webiny/api-page-builder-aco": "0.0.0",
     "@webiny/api-page-builder-import-export": "0.0.0",

diff --git a/apps/api/graphql/src/index.ts b/apps/api/graphql/src/index.ts
@@ -43,6 +43,7 @@ import { createBenchmarkEnablePlugin } from "~/plugins/benchmarkEnable";
 import { createCountDynamoDbTask } from "~/plugins/countDynamoDbTask";
 import { createContinuingTask } from "~/plugins/continuingTask";
 import { createWebsockets } from "@webiny/api-websockets";
+import { createLockingMechanism } from "@webiny/api-locking-mechanism";
 
 const debug = process.env.DEBUG === "true";
 const documentClient = getDocumentClient();
@@ -70,6 +71,7 @@ export const handler = createHandler({
             })
         }),
         createHeadlessCmsGraphQL(),
+        createLockingMechanism(),
         createBackgroundTasks(),
         createFileManagerContext({
             storageOperations: createFileManagerStorageOperations({

diff --git a/apps/api/graphql/tsconfig.json b/apps/api/graphql/tsconfig.json
@@ -17,6 +17,9 @@
     {
       "path": "../../../packages/api-audit-logs/tsconfig.build.json"
     },
+    {
+      "path": "../../../packages/api-locking-mechanism/tsconfig.build.json"
+    },
     {
       "path": "../../../packages/api-file-manager/tsconfig.build.json"
     },
@@ -153,6 +156,8 @@
       "@webiny/api-headless-cms-aco": ["../../../packages/api-headless-cms-aco/src"],
       "@webiny/api-headless-cms-ddb/*": ["../../../packages/api-headless-cms-ddb/src/*"],
       "@webiny/api-headless-cms-ddb": ["../../../packages/api-headless-cms-ddb/src"],
+      "@webiny/api-locking-mechanism/*": ["../../../packages/api-locking-mechanism/src/*"],
+      "@webiny/api-locking-mechanism": ["../../../packages/api-locking-mechanism/src"],
       "@webiny/api-headless-cms-tasks/*": ["../../../packages/api-headless-cms-tasks/src/*"],
       "@webiny/api-headless-cms-tasks": ["../../../packages/api-headless-cms-tasks/src"],
       "@webiny/api-i18n/*": ["../../../packages/api-i18n/src/*"],

diff --git a/packages/api-headless-cms/__tests__/contentAPI/extendingGqlSchema.test.ts b/packages/api-headless-cms/__tests__/contentAPI/extendingGqlSchema.test.ts
@@ -1,7 +1,7 @@
 import { useGraphQLHandler } from "../testHelpers/useGraphQLHandler";
-import { CmsGraphQLSchemaPlugin } from "~/plugins";
+import { createCmsGraphQLSchemaPlugin } from "~/plugins";
 
-const graphqlSchemaPlugin = new CmsGraphQLSchemaPlugin({
+const graphqlSchemaPlugin = createCmsGraphQLSchemaPlugin({
     typeDefs: /* GraphQL */ `
         extend type Query {
             getOne: Int

diff --git a/packages/api-headless-cms/__tests__/contentAPI/extendingGqlSchemaError.test.ts b/packages/api-headless-cms/__tests__/contentAPI/extendingGqlSchemaError.test.ts
@@ -1,7 +1,7 @@
 import { useGraphQLHandler } from "../testHelpers/useGraphQLHandler";
-import { CmsGraphQLSchemaPlugin } from "~/plugins";
+import { createCmsGraphQLSchemaPlugin } from "~/plugins";
 
-const graphqlSchemaPlugin = new CmsGraphQLSchemaPlugin({
+const graphqlSchemaPlugin = createCmsGraphQLSchemaPlugin({
     typeDefs: /* GraphQL */ `
         type BrokenType {
             # types without fields are invalid

diff --git a/packages/api-headless-cms/src/crud/contentEntry.crud.ts b/packages/api-headless-cms/src/crud/contentEntry.crud.ts
@@ -12,7 +12,6 @@ import {
     CmsModel,
     CmsStorageEntry,
     EntryBeforeListTopicParams,
-    HeadlessCms,
     HeadlessCmsStorageOperations,
     OnEntryAfterCreateTopicParams,
     OnEntryAfterDeleteMultipleTopicParams,
@@ -1303,8 +1302,6 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
             );
         },
         /**
-         * TODO determine if this method is required at all.
-         *
          * @internal
          */
         async getEntry(model, params) {
@@ -1326,7 +1323,6 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
             });
         },
         async listLatestEntries<T = CmsEntryValues>(
-            this: HeadlessCms,
             model: CmsModel,
             params?: CmsEntryListParams
         ): Promise<[CmsEntry<T>[], CmsEntryMeta]> {
@@ -1338,7 +1334,6 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
             );
         },
         async listDeletedEntries<T = CmsEntryValues>(
-            this: HeadlessCms,
             model: CmsModel,
             params?: CmsEntryListParams
         ): Promise<[CmsEntry<T>[], CmsEntryMeta]> {

diff --git a/packages/api-headless-cms/src/crud/contentModel.crud.ts b/packages/api-headless-cms/src/crud/contentModel.crud.ts
@@ -70,11 +70,11 @@ export const createModelsCrud = (params: CreateModelsCrudParams): CmsModelContex
     };
 
     const managers = new Map<string, CmsModelManager>();
-    const updateManager = async (
+    const updateManager = async <T>(
         context: CmsContext,
         model: CmsModel
-    ): Promise<CmsModelManager> => {
-        const manager = await contentModelManagerFactory(context, model);
+    ): Promise<CmsModelManager<T>> => {
+        const manager = await contentModelManagerFactory<T>(context, model);
         managers.set(model.modelId, manager);
         return manager;
     };
@@ -206,15 +206,15 @@ export const createModelsCrud = (params: CreateModelsCrudParams): CmsModelContex
         });
     };
 
-    const getEntryManager: CmsModelContext["getEntryManager"] = async (
-        target
-    ): Promise<CmsModelManager> => {
+    const getEntryManager: CmsModelContext["getEntryManager"] = async <T>(
+        target: string | Pick<CmsModel, "modelId">
+    ): Promise<CmsModelManager<T>> => {
         const modelId = typeof target === "string" ? target : target.modelId;
         if (managers.has(modelId)) {
-            return managers.get(modelId) as CmsModelManager;
+            return managers.get(modelId) as CmsModelManager<T>;
         }
         const model = await getModelFromCache(modelId);
-        return await updateManager(context, model);
+        return await updateManager<T>(context, model);
     };
 
     /**

diff --git a/packages/api-headless-cms/src/crud/contentModel/contentModelManagerFactory.ts b/packages/api-headless-cms/src/crud/contentModel/contentModelManagerFactory.ts
@@ -2,22 +2,22 @@ import { CmsModel, CmsContext, ModelManagerPlugin, CmsModelManager } from "~/typ
 
 const defaultName = "content-model-manager-default";
 
-export const contentModelManagerFactory = async (
+export const contentModelManagerFactory = async <T>(
     context: CmsContext,
     model: CmsModel
-): Promise<CmsModelManager> => {
+): Promise<CmsModelManager<T>> => {
     const pluginsByType = context.plugins
         .byType<ModelManagerPlugin>("cms-content-model-manager")
         .reverse();
     for (const plugin of pluginsByType) {
         const target = Array.isArray(plugin.modelId) ? plugin.modelId : [plugin.modelId];
         if (target.includes(model.modelId) === true && plugin.name !== defaultName) {
-            return await plugin.create(context, model);
+            return await plugin.create<T>(context, model);
         }
     }
     const plugin = pluginsByType.find(plugin => plugin.name === defaultName);
     if (!plugin) {
         throw new Error("There is no default plugin to create CmsModelManager");
     }
-    return await plugin.create(context, model);
+    return await plugin.create<T>(context, model);
 };
diff --git a/packages/api-headless-cms/src/crud/contentModel/validateModelFields.ts b/packages/api-headless-cms/src/crud/contentModel/validateModelFields.ts
@@ -1,8 +1,8 @@
 import gql from "graphql-tag";
 import WebinyError from "@webiny/error";
 import {
-    CmsModel,
     CmsContext,
+    CmsModel,
     CmsModelField,
     CmsModelFieldToGraphQLPlugin,
     CmsModelFieldToGraphQLPluginValidateChildFieldsValidate,
@@ -16,7 +16,11 @@ import { getBaseFieldType } from "~/utils/getBaseFieldType";
 import { getContentModelTitleFieldId } from "./fields/titleField";
 import { getContentModelDescriptionFieldId } from "./fields/descriptionField";
 import { getContentModelImageFieldId } from "./fields/imageField";
-import { CmsGraphQLSchemaPlugin, CmsGraphQLSchemaSorterPlugin } from "~/plugins";
+import {
+    CmsGraphQLSchemaPlugin,
+    CmsGraphQLSchemaSorterPlugin,
+    ICmsGraphQLSchemaPlugin
+} from "~/plugins";
 import { buildSchemaPlugins } from "~/graphql/buildSchemaPlugins";
 import { createExecutableSchema } from "~/graphql/createExecutableSchema";
 import { generateAlphaNumericId } from "@webiny/utils";
@@ -227,8 +231,8 @@ const createGraphQLSchema = async (params: CreateGraphQLSchemaParams): Promise<a
     });
 
     const plugins = context.plugins
-        .byType<CmsGraphQLSchemaPlugin>(CmsGraphQLSchemaPlugin.type)
-        .reduce<Record<string, CmsGraphQLSchemaPlugin>>((collection, plugin) => {
+        .byType<ICmsGraphQLSchemaPlugin>(CmsGraphQLSchemaPlugin.type)
+        .reduce<Record<string, ICmsGraphQLSchemaPlugin>>((collection, plugin) => {
             const name =
                 plugin.name || `${CmsGraphQLSchemaPlugin.type}-${generateAlphaNumericId(16)}`;
             collection[name] = plugin;

diff --git a/packages/api-headless-cms/src/export/graphql/index.ts b/packages/api-headless-cms/src/export/graphql/index.ts
@@ -1,9 +1,9 @@
-import { CmsGraphQLSchemaPlugin } from "~/plugins";
+import { createCmsGraphQLSchemaPlugin } from "~/plugins";
 import { ErrorResponse, Response } from "@webiny/handler-graphql";
 import { ContextPlugin } from "@webiny/handler";
 import { CmsContext } from "~/types";
 
-const plugin = new CmsGraphQLSchemaPlugin({
+const plugin = createCmsGraphQLSchemaPlugin({
     typeDefs: /* GraphQL */ `
         type CmsExportStructureResponse {
             data: String

diff --git a/packages/api-headless-cms/src/graphql/buildSchemaPlugins.ts b/packages/api-headless-cms/src/graphql/buildSchemaPlugins.ts
@@ -4,7 +4,7 @@ import { createContentEntriesSchema } from "./schema/contentEntries";
 import { createGroupsSchema } from "./schema/contentModelGroups";
 import { createBaseContentSchema } from "./schema/baseContentSchema";
 import { generateSchemaPlugins } from "./schema/schemaPlugins";
-import { CmsGraphQLSchemaPlugin } from "~/plugins";
+import { ICmsGraphQLSchemaPlugin } from "~/plugins";
 
 /**
  * This factory is called whenever we need to generate graphql-schema plugins using the current context.
@@ -15,7 +15,7 @@ interface BuildSchemaPluginsParams {
 }
 export const buildSchemaPlugins = async (
     params: BuildSchemaPluginsParams
-): Promise<CmsGraphQLSchemaPlugin[]> => {
+): Promise<ICmsGraphQLSchemaPlugin[]> => {
     return [
         // Base GQL types and scalars
         createBaseContentSchema(params),

diff --git a/packages/api-headless-cms/src/graphql/createExecutableSchema.ts b/packages/api-headless-cms/src/graphql/createExecutableSchema.ts
@@ -1,8 +1,8 @@
 import { makeExecutableSchema } from "@graphql-tools/schema";
-import { CmsGraphQLSchemaPlugin } from "~/plugins";
+import { ICmsGraphQLSchemaPlugin } from "~/plugins";
 
 interface Params {
-    plugins: CmsGraphQLSchemaPlugin[];
+    plugins: ICmsGraphQLSchemaPlugin[];
 }
 
 export const createExecutableSchema = (params: Params) => {