feat(locking): Locking module (medusajs#9524)

**What** - Locking Module to manage concurrency - Default `in-memory` provider
mdsxbm · Oct 11, 2024 · c8b375a · c8b375a
1 parent 5c9e289
commit c8b375a
Show file tree

Hide file tree

Showing 28 changed files with 806 additions and 39 deletions.
diff --git a/.changeset/little-books-reply.md b/.changeset/little-books-reply.md
@@ -60,6 +60,7 @@
 "@medusajs/admin-vite-plugin": patch
 "@medusajs/framework": patch
 "@medusajs/index": patch
+"@medusajs/locking": patch
 ---
 
 chore: Preview release changeset
diff --git a/.eslintignore b/.eslintignore
@@ -23,6 +23,7 @@ packages/*
 !packages/cache-inmemory
 !packages/create-medusa-app
 !packages/product
+!packages/locking
 !packages/orchestration
 !packages/workflows-sdk
 !packages/core-flows

diff --git a/.eslintrc.js b/.eslintrc.js
@@ -128,6 +128,7 @@ module.exports = {
           "./packages/modules/workflow-engine-redis/tsconfig.spec.json",
           "./packages/modules/link-modules/tsconfig.spec.json",
           "./packages/modules/user/tsconfig.spec.json",
+          "./packages/modules/locking/tsconfig.spec.json",
 
           "./packages/modules/providers/file-local/tsconfig.spec.json",
           "./packages/modules/providers/file-s3/tsconfig.spec.json",

diff --git a/.gitignore b/.gitignore
@@ -20,6 +20,7 @@ www/**/.yarn/*
 .idea
 .turbo
 build/**
+dist/**
 **/dist
 **/stats
 .favorites.json

diff --git a/packages/core/framework/src/types/container.ts b/packages/core/framework/src/types/container.ts
@@ -1,36 +1,37 @@
-import { Knex } from "@mikro-orm/knex"
 import { RemoteLink } from "@medusajs/modules-sdk"
-import { AwilixContainer, ResolveOptions } from "awilix"
-import { Modules, ContainerRegistrationKeys } from "@medusajs/utils"
 import {
-  Logger,
   ConfigModule,
-  ModuleImplementations,
-  RemoteQueryFunction,
+  IApiKeyModuleService,
   IAuthModuleService,
   ICacheService,
   ICartModuleService,
+  ICurrencyModuleService,
   ICustomerModuleService,
   IEventBusModuleService,
+  IFileModuleService,
+  IFulfillmentModuleService,
   IInventoryService,
+  ILockingModule,
+  INotificationModuleService,
+  IOrderModuleService,
   IPaymentModuleService,
   IPricingModuleService,
   IProductModuleService,
   IPromotionModuleService,
+  IRegionModuleService,
   ISalesChannelModuleService,
-  ITaxModuleService,
-  IFulfillmentModuleService,
   IStockLocationService,
+  IStoreModuleService,
+  ITaxModuleService,
   IUserModuleService,
   IWorkflowEngineService,
-  IRegionModuleService,
-  IOrderModuleService,
-  IApiKeyModuleService,
-  IStoreModuleService,
-  ICurrencyModuleService,
-  IFileModuleService,
-  INotificationModuleService,
+  Logger,
+  ModuleImplementations,
+  RemoteQueryFunction,
 } from "@medusajs/types"
+import { ContainerRegistrationKeys, Modules } from "@medusajs/utils"
+import { Knex } from "@mikro-orm/knex"
+import { AwilixContainer, ResolveOptions } from "awilix"
 
 declare module "@medusajs/types" {
   export interface ModuleImplementations {
@@ -63,6 +64,7 @@ declare module "@medusajs/types" {
     [Modules.CURRENCY]: ICurrencyModuleService
     [Modules.FILE]: IFileModuleService
     [Modules.NOTIFICATION]: INotificationModuleService
+    [Modules.LOCKING]: ILockingModule
   }
 }
 

diff --git a/packages/core/modules-sdk/src/definitions.ts b/packages/core/modules-sdk/src/definitions.ts
@@ -16,7 +16,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.EVENT_BUS),
     isRequired: true,
     isQueryable: false,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -63,7 +63,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.PRODUCT),
     isRequired: false,
     isQueryable: true,
-    dependencies: [Modules.EVENT_BUS, "logger"],
+    dependencies: [Modules.EVENT_BUS, ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -75,7 +75,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.PRICING),
     isRequired: false,
     isQueryable: true,
-    dependencies: [Modules.EVENT_BUS, "logger"],
+    dependencies: [Modules.EVENT_BUS, ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -87,7 +87,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.PROMOTION),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -99,7 +99,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.AUTH),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -111,7 +111,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.WORKFLOW_ENGINE),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     __passSharedContainer: true,
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
@@ -124,7 +124,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.SALES_CHANNEL),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -136,7 +136,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.FULFILLMENT),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger", Modules.EVENT_BUS],
+    dependencies: [ContainerRegistrationKeys.LOGGER, Modules.EVENT_BUS],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -148,7 +148,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.CART),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -160,7 +160,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.CUSTOMER),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -172,7 +172,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.PAYMENT),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -184,7 +184,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.USER),
     isRequired: false,
     isQueryable: true,
-    dependencies: [Modules.EVENT_BUS, "logger"],
+    dependencies: [Modules.EVENT_BUS, ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -196,7 +196,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.REGION),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -208,7 +208,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.ORDER),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger", Modules.EVENT_BUS],
+    dependencies: [ContainerRegistrationKeys.LOGGER, Modules.EVENT_BUS],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -220,7 +220,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.TAX),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger", Modules.EVENT_BUS],
+    dependencies: [ContainerRegistrationKeys.LOGGER, Modules.EVENT_BUS],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -232,7 +232,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.API_KEY),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -244,7 +244,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.STORE),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -256,7 +256,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.CURRENCY),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -268,7 +268,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.FILE),
     isRequired: false,
     isQueryable: true,
-    dependencies: ["logger"],
+    dependencies: [ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -280,7 +280,7 @@ export const ModulesDefinition: {
     label: upperCaseFirst(Modules.NOTIFICATION),
     isRequired: false,
     isQueryable: true,
-    dependencies: [Modules.EVENT_BUS, "logger"],
+    dependencies: [Modules.EVENT_BUS, ContainerRegistrationKeys.LOGGER],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
       resources: MODULE_RESOURCE_TYPE.SHARED,
@@ -294,7 +294,7 @@ export const ModulesDefinition: {
     isQueryable: false,
     dependencies: [
       Modules.EVENT_BUS,
-      "logger",
+      ContainerRegistrationKeys.LOGGER,
       ContainerRegistrationKeys.REMOTE_QUERY,
       ContainerRegistrationKeys.QUERY,
     ],
@@ -303,6 +303,18 @@ export const ModulesDefinition: {
       resources: MODULE_RESOURCE_TYPE.SHARED,
     },
   },
+  [Modules.LOCKING]: {
+    key: Modules.LOCKING,
+    defaultPackage: false,
+    label: upperCaseFirst(Modules.LOCKING),
+    isRequired: false,
+    isQueryable: false,
+    dependencies: [ContainerRegistrationKeys.LOGGER],
+    defaultModuleDeclaration: {
+      scope: MODULE_SCOPE.INTERNAL,
+      resources: MODULE_RESOURCE_TYPE.SHARED,
+    },
+  },
 }
 
 export const MODULE_DEFINITIONS: ModuleDefinition[] =

diff --git a/packages/core/modules-sdk/src/medusa-app.ts b/packages/core/modules-sdk/src/medusa-app.ts
@@ -84,7 +84,7 @@ export async function loadModules(args: {
     sharedResourcesConfig,
     migrationOnly = false,
     loaderOnly = false,
-    workerMode = "server" as ModuleBootstrapOptions["workerMode"],
+    workerMode = "shared" as ModuleBootstrapOptions["workerMode"],
   } = args
 
   const allModules = {} as any
@@ -307,7 +307,7 @@ async function MedusaApp_({
   injectedDependencies = {},
   migrationOnly = false,
   loaderOnly = false,
-  workerMode = "server",
+  workerMode = "shared",
 }: MedusaAppOptions & {
   migrationOnly?: boolean
 } = {}): Promise<MedusaAppOutput> {

diff --git a/packages/core/types/src/index.ts b/packages/core/types/src/index.ts
@@ -20,6 +20,7 @@ export * from "./index-data"
 export * from "./inventory"
 export * from "./joiner"
 export * from "./link-modules"
+export * from "./locking"
 export * from "./logger"
 export * from "./modules-sdk"
 export * from "./notification"

diff --git a/packages/core/types/src/locking/index.ts b/packages/core/types/src/locking/index.ts
@@ -0,0 +1,69 @@
+import { Context } from "../shared-context"
+
+export interface ILockingProvider {
+  execute<T>(
+    keys: string | string[],
+    job: () => Promise<T>,
+    args?: {
+      timeout?: number
+    },
+    sharedContext?: Context
+  ): Promise<T>
+  acquire(
+    keys: string | string[],
+    args?: {
+      ownerId?: string | null
+      expire?: number
+    },
+    sharedContext?: Context
+  ): Promise<void>
+  release(
+    keys: string | string[],
+    args?: {
+      ownerId?: string | null
+    },
+    sharedContext?: Context
+  ): Promise<boolean>
+  releaseAll(
+    args?: {
+      ownerId?: string | null
+    },
+    sharedContext?: Context
+  ): Promise<void>
+}
+
+export interface ILockingModule {
+  execute<T>(
+    keys: string | string[],
+    job: () => Promise<T>,
+    args?: {
+      timeout?: number
+      provider?: string
+    },
+    sharedContext?: Context
+  ): Promise<T>
+  acquire(
+    keys: string | string[],
+    args?: {
+      ownerId?: string | null
+      expire?: number
+      provider?: string
+    },
+    sharedContext?: Context
+  ): Promise<void>
+  release(
+    keys: string | string[],
+    args?: {
+      ownerId?: string | null
+      provider?: string
+    },
+    sharedContext?: Context
+  ): Promise<boolean>
+  releaseAll(
+    args?: {
+      ownerId?: string | null
+      provider?: string
+    },
+    sharedContext?: Context
+  ): Promise<void>
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,6 +20,7 @@ www/**/.yarn/* @@
     .idea
     .turbo
     build/**
+    dist/**
     **/dist
     **/stats
     .favorites.json
@@ Expand Down @@