feat(api): Add automatic quota throttling

apps/api/package.json

@@ -23,7 +23,7 @@
     "lint:openapi": "spectral lint http://127.0.0.1:${PORT:-3000}/openapi.yaml",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' TZ=UTC NODE_ENV=test E2E_RUNNER=true mocha --require ts-node/register --exit --file e2e/setup.ts src/**/**/*.spec.ts",
     "test:e2e": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' TZ=UTC NODE_ENV=test E2E_RUNNER=true mocha --require ts-node/register --exit --file e2e/setup.ts src/**/*.e2e.ts",
-    "test:e2e:ee": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' TZ=UTC NODE_ENV=test E2E_RUNNER=true mocha --require ts-node/register --exit --file e2e/setup.ts src/**/*.e2e-ee.ts",
+    "test:e2e:ee": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' TZ=UTC NODE_ENV=test E2E_RUNNER=true CI_EE_TEST=true mocha --require ts-node/register --exit --file e2e/setup.ts src/**/*.e2e-ee.ts",
     "migration": "cross-env NODE_ENV=local MIGRATION=true ts-node --transpileOnly",
     "link:submodules": "pnpm link ../../enterprise/packages/auth && pnpm link ../../enterprise/packages/translation && pnpm link ../../enterprise/packages/billing",
     "admin:remove-user-account": "cross-env NODE_ENV=local MIGRATION=true ts-node --transpileOnly ./admin/remove-user-account.ts",
@@ -81,7 +81,7 @@
     "passport-jwt": "^4.0.0",
     "passport-oauth2": "^1.6.1",
     "recursive-diff": "^1.0.8",
-    "redlock": "4.2.0",
+    "redlock": "5.0.0-beta.2",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
     "rxjs": "7.8.1",

apps/api/src/app.module.ts

@@ -37,7 +37,6 @@ import { WorkflowOverridesModule } from './app/workflow-overrides/workflow-overr
 import { ApiRateLimitInterceptor } from './app/rate-limiting/guards';
 import { RateLimitingModule } from './app/rate-limiting/rate-limiting.module';
 import { ProductFeatureInterceptor } from './app/shared/interceptors/product-feature.interceptor';
-import { ResourceThrottlerInterceptor } from './app/resource-limiting/guards';
 import { AnalyticsModule } from './app/analytics/analytics.module';
 
 const enterpriseImports = (): Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> => {
@@ -60,6 +59,17 @@ const enterpriseImports = (): Array<Type | DynamicModule | Promise<DynamicModule
   return modules;
 };
 
+const enterpriseQuotaThrottlerInterceptor =
+  (process.env.NOVU_ENTERPRISE === 'true' || process.env.CI_EE_TEST === 'true') &&
+  require('@novu/ee-billing')?.QuotaThrottlerInterceptor
+    ? [
+        {
+          provide: APP_INTERCEPTOR,
+          useClass: require('@novu/ee-billing')?.QuotaThrottlerInterceptor,
+        },
+      ]
+    : [];
+
 const baseModules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> = [
   InboundParseModule,
   OrganizationModule,
@@ -106,10 +116,7 @@ const providers: Provider[] = [
     provide: APP_INTERCEPTOR,
     useClass: ProductFeatureInterceptor,
   },
-  {
-    provide: APP_INTERCEPTOR,
-    useClass: ResourceThrottlerInterceptor,
-  },
+  ...enterpriseQuotaThrottlerInterceptor,
   {
     provide: APP_INTERCEPTOR,
     useClass: IdempotencyInterceptor,

apps/api/src/app/events/events.controller.ts

@@ -9,6 +9,7 @@ import {
   ResourceEnum,
   TriggerRequestCategoryEnum,
 } from '@novu/shared';
+import { ResourceCategory } from '@novu/application-generic';
 
 import {
   BulkTriggerEventDto,
@@ -29,7 +30,6 @@ import { UserAuthGuard } from '../auth/framework/user.auth.guard';
 import { ApiCommonResponses, ApiResponse, ApiOkResponse } from '../shared/framework/response.decorator';
 import { DataBooleanDto } from '../shared/dtos/data-wrapper-dto';
 import { ThrottlerCategory, ThrottlerCost } from '../rate-limiting/guards';
-import { ResourceCategory } from '../resource-limiting/guards';
 
 @ThrottlerCategory(ApiRateLimitCategoryEnum.TRIGGER)
 @ResourceCategory(ResourceEnum.EVENTS)

apps/api/src/app/testing/billing/create-usage-records.e2e-ee.ts

@@ -237,6 +237,22 @@ describe('CreateUsageRecords', () => {
         notificationsCount: 100,
       },
     ]);
+    const mockNoMeteredSubscription = {
+      id: 'subscription_id',
+      items: {
+        data: [
+          {
+            id: 'item_id_flat',
+            price: { lookup_key: 'business_flat_monthly', recurring: { usage_type: StripeUsageTypeEnum.LICENSED } },
+          },
+        ],
+      },
+    };
+    getCustomerStub.resolves({
+      subscriptions: {
+        data: [mockNoMeteredSubscription],
+      },
+    });
     const useCase = createUseCase();
 
     await useCase.execute(
@@ -246,7 +262,7 @@ describe('CreateUsageRecords', () => {
     );
 
     expect(logStub.lastCall.args[0].message).to.equal(
-      "Subscription item not found for subscriptionId: 'subscription_id' and price lookup key: 'free_usage_notifications'"
+      "No metered subscription found for organizationId: 'organization_id_1'"
     );
 
     logStub.restore();