feat(api): Add automatic quota throttling #5485

rifont · 2024-05-02T10:10:20Z

What changed? Why was the change needed?

Integrate the quota limiting PR from EE repo
Add feature flag for quota limiting
Rename feature flag for event limiting to align with other naming and purpose
Refactor cache key builders to use new folder hierarchy to separate builder pattern from use-cases
Add new cache key builders for quota limit cache

Screenshots

Passing key builder Tests

Expand for optional sections

Related enterprise PR

https://github.com/novuhq/packages-enterprise/pull/133

Special notes for your reviewer

linear · 2024-05-02T10:10:23Z

ENT-5 💶 API Ingress Blocking

netlify · 2024-05-02T10:12:01Z

✅ Deploy Preview for dev-web-novu ready!

Name	Link
🔨 Latest commit	`b016f39`
🔍 Latest deploy log	https://app.netlify.com/sites/dev-web-novu/deploys/66446561873f7c000877cf18
😎 Deploy Preview	https://deploy-preview-5485--dev-web-novu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-05-02T10:12:27Z

✅ Deploy Preview for novu-design ready!

Name	Link
🔨 Latest commit	`b016f39`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-design/deploys/66446561cc03680008fd30e5
😎 Deploy Preview	https://deploy-preview-5485--novu-design.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rifont · 2024-05-02T10:12:37Z

apps/web/src/components/nav/SettingsNavMenu.tsx

@@ -71,7 +71,7 @@ export const SettingsNavMenu: React.FC = () => {
          testId="side-nav-settings-branding-link"
        ></NavMenuLinkButton>
        <NavMenuLinkButton
-          label="Billing plans"
+          label="Billing"


This was a regression during Information Architecture feature development.

rifont · 2024-05-02T10:12:56Z

apps/api/src/app/resource-limiting/guards/resource-throttler.guard.ts

@@ -47,7 +48,7 @@ export class ResourceThrottlerInterceptor implements NestInterceptor {
            organizationId,
            environmentId: 'system',
            userId: 'system',
-            key: FeatureFlagsKeysEnum.IS_EVENT_RESOURCE_LIMITING_ENABLED,
+            key: FeatureFlagsKeysEnum.IS_EVENT_QUOTA_LIMITING_ENABLED,


Renaming to align with intended purpose, which is to limit resource quotas.

rifont · 2024-05-02T10:13:22Z

packages/application-generic/src/services/cache/key-builders/crypto.ts

+  hash.update(str);
+
+  return hash.digest('hex');
+};


Separating into a new file to keep independent from the key builder use-cases.

Love it! , i wanted to separate this one and another 'createHmac' but was not able to do it because we had changes in multiple PRs.
IMO this one is a generic function and can live outside of the cache scope, wdyt?

rifont · 2024-05-02T10:13:47Z

packages/application-generic/src/services/cache/key-builders/entities.ts

-  buildEvaluateApiRateLimitKey,
-  buildServiceConfigApiRateLimitMaximumKey,
-  buildVariablesKey,
-};


It's a bit of a code smell to update here, so we instead export each of the required builders in-line.

rifont · 2024-05-02T10:17:57Z

packages/application-generic/src/services/cache/key-builders/queries.ts

This file only has internal API changes, no change to external exports.

rifont · 2024-05-02T10:18:16Z

packages/application-generic/src/services/cache/key-builders/entities.ts

This file only has internal API changes, no changes to external exports.

rifont · 2024-05-02T10:19:22Z

packages/application-generic/src/services/cache/key-builders/shared.ts

This file has comments added to provide a description of when to modify and use each base key builder. There are changes to the exports of these builders which are in-turn, consumed by the entities and queries.

rifont · 2024-05-02T10:20:00Z

packages/application-generic/src/services/cache/key-builders/shared.ts

@@ -87,15 +241,26 @@ export enum IdentifierPrefixEnum {
  GROUPED_BLUEPRINT = 'g_b',
  API_RATE_LIMIT_CATEGORY = 'a_r_l_c',
  SERVICE_CONFIG = 's_c',
+  RESOURCE_TYPE = 'r_t',


New prefix to handle storage of quota usage for each resource.

rifont · 2024-05-02T10:44:34Z

packages/application-generic/src/services/cache/key-builders/identifiers.ts

Refactoring all the identifiers out into a separate file.

djabarovgeorge

LGTM, left a couple of comments for your review.
all of them as thoughts

djabarovgeorge · 2024-05-02T10:55:25Z

packages/application-generic/src/services/cache/key-builders/crypto.ts

+  hash.update(str);
+
+  return hash.digest('hex');
+};


Love it! , i wanted to separate this one and another 'createHmac' but was not able to do it because we had changes in multiple PRs.
IMO this one is a generic function and can live outside of the cache scope, wdyt?

djabarovgeorge · 2024-05-02T11:05:52Z

packages/application-generic/src/services/cache/key-builders/identifiers.ts

djabarovgeorge · 2024-05-02T11:07:54Z

packages/application-generic/src/services/cache/key-builders/shared.ts

+ * Wraps the entire prefix string with curly braces. This has the effect of ensuring
+ * that the entire prefix string is treated as a single key part by Redis.


Love this one!

djabarovgeorge · 2024-05-02T11:09:41Z

packages/application-generic/src/services/cache/key-builders/shared.ts

+ ***************************************
+ *         BASE KEY BUILDERS
+ ***************************************
+ */


Maybe we could create a separate file for every section that has such a title, wdyt?

* fix(web): Rename Billing plans to Billing * refactor(shared): Tidy up builders and add comments * chore(shared): Add feature flags for quota limiting * test(shared): Update key builder test * fix(api): Use new ff key * chore(shared): Remove uncessary out-of-line exports * chore(app-gen): Fix typo * refactor(app-gen): Separate file for key builder identifiers * chore: Update per PR comments * fix: App gen imports * fix: testing controller import * fix: imports * fix: naming * chore: Upgrade to Redlock with typescript * chore: Remove unused decorator * feat: Add locking to cached entity interceptor * test: fix create-usage-records test * test: fix customer subscription updated test * test(api): add evaluate-event-resource-limit tests * chore: remove redundant resource guard * feat(api): Add safe EE import for quota throttler * chore: Add nestjs imports for billing * test(api): Add ci ee flag to api ee tests * test(api): Use enums for test * test(api): Add quota throttler guard test * chore: update submodule * revert(api): Accidental package script change * chore: Update submodule * chore: submodule * chore: submodule update * chore: update submodule * test(web): Update cypress tests * chore: update submodule * fix(billing): Add mongoose dependency * test(web): Update billing widget assertion * fix(app-gen): Separate method resolution and cache set * chore: update submodule * fix(app-gen): unlock only on error

rifont added 4 commits May 2, 2024 10:42

fix(web): Rename Billing plans to Billing

f508668

refactor(shared): Tidy up builders and add comments

fc456ba

chore(shared): Add feature flags for quota limiting

c4c9323

test(shared): Update key builder test

322e892

rifont requested a review from djabarovgeorge May 2, 2024 10:10

rifont requested a review from a team as a code owner May 2, 2024 10:10

github-actions bot added @novu/web @novu/shared labels May 2, 2024

rifont changed the title ~~Ent 5 api ingress blocking cache keys~~ chore(shared): Refactor cache key builders and quota limit feature flags May 2, 2024

fix(api): Use new ff key

caeaac1

github-actions bot added the @novu/api label May 2, 2024

chore(shared): Remove uncessary out-of-line exports

90bf53d

rifont changed the title ~~chore(shared): Refactor cache key builders and quota limit feature flags~~ chore(shared, app-gen): Refactor cache key builders and quota limit feature flags May 2, 2024

chore(app-gen): Fix typo

34b47a8

rifont commented May 2, 2024

View reviewed changes

refactor(app-gen): Separate file for key builder identifiers

f295e9e

rifont commented May 2, 2024

View reviewed changes

djabarovgeorge approved these changes May 2, 2024

View reviewed changes

rifont added 9 commits May 6, 2024 16:20

chore: Update per PR comments

5f64d9f

fix: App gen imports

8caabdb

fix: testing controller import

8af48e0

fix: imports

61f823f

fix: naming

3d30dfd

chore: Upgrade to Redlock with typescript

2ff0773

chore: Remove unused decorator

76d0395

feat: Add locking to cached entity interceptor

793f4d9

test: fix create-usage-records test

ff336bb

rifont added 13 commits May 13, 2024 12:32

test: fix customer subscription updated test

9044b66

test(api): add evaluate-event-resource-limit tests

1ed11f8

chore: remove redundant resource guard

9326c64

feat(api): Add safe EE import for quota throttler

1b58c90

chore: Add nestjs imports for billing

0d6bfdf

test(api): Add ci ee flag to api ee tests

9daeb62

test(api): Use enums for test

19ac014

test(api): Add quota throttler guard test

29e1cf8

chore: update submodule

9af0be5

revert(api): Accidental package script change

1729934

chore: Update submodule

9483c1a

chore: submodule

3c98b6c

chore: submodule update

97f64cb

rifont changed the title ~~chore(shared, app-gen): Refactor cache key builders and quota limit feature flags~~ feat(api): Add automatic quota throttling May 13, 2024

rifont added 10 commits May 14, 2024 07:43

chore: update submodule

e0c4cee

Merge branch 'next' into ent-5-api-ingress-blocking-cache-keys

0e97783

test(web): Update cypress tests

0fb97d1

chore: update submodule

f416326

fix(billing): Add mongoose dependency

3371125

test(web): Update billing widget assertion

76df417

fix(app-gen): Separate method resolution and cache set

57c7eeb

chore: update submodule

361a8cb

fix(app-gen): unlock only on error

7327bb4

Merge branch 'next' into ent-5-api-ingress-blocking-cache-keys

b016f39

rifont merged commit 571104a into next May 15, 2024
26 checks passed

rifont deleted the ent-5-api-ingress-blocking-cache-keys branch May 15, 2024 08:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): Add automatic quota throttling #5485

feat(api): Add automatic quota throttling #5485

rifont commented May 2, 2024 •

edited

linear bot commented May 2, 2024

netlify bot commented May 2, 2024 •

edited

netlify bot commented May 2, 2024 •

edited

rifont May 2, 2024 •

edited

rifont May 2, 2024

rifont May 2, 2024

djabarovgeorge May 2, 2024

rifont May 2, 2024

rifont May 2, 2024

rifont May 2, 2024

rifont May 2, 2024

rifont May 2, 2024

rifont May 2, 2024

djabarovgeorge May 2, 2024

djabarovgeorge left a comment

djabarovgeorge May 2, 2024

djabarovgeorge May 2, 2024

djabarovgeorge May 2, 2024

djabarovgeorge May 2, 2024

		* Wraps the entire prefix string with curly braces. This has the effect of ensuring
		* that the entire prefix string is treated as a single key part by Redis.

feat(api): Add automatic quota throttling #5485

feat(api): Add automatic quota throttling #5485

Conversation

rifont commented May 2, 2024 • edited

What changed? Why was the change needed?

Screenshots

Related enterprise PR

Special notes for your reviewer

linear bot commented May 2, 2024

netlify bot commented May 2, 2024 • edited

✅ Deploy Preview for dev-web-novu ready!

netlify bot commented May 2, 2024 • edited

✅ Deploy Preview for novu-design ready!

rifont May 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djabarovgeorge left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rifont commented May 2, 2024 •

edited

netlify bot commented May 2, 2024 •

edited

netlify bot commented May 2, 2024 •

edited

rifont May 2, 2024 •

edited