feat(api): Add automatic quota throttling #5485
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { createHash as createHashCrypto } from 'crypto'; | ||
|
|
||
| export const createHash = (str: string): string => { | ||
| const hash = createHashCrypto('sha256'); | ||
| hash.update(str); | ||
|
|
||
| return hash.digest('hex'); | ||
| }; | ||
|
There was a problem hiding this comment. Separating into a new file to keep independent from the key builder use-cases. There was a problem hiding this comment. 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. |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. This file only has internal API changes, no changes to external exports. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,173 +1,176 @@ | ||
| import { createHash } from './crypto'; | ||
| import { | ||
| BLUEPRINT_IDENTIFIER, | ||
| buildEnvironmentScopedKeyById, | ||
| buildUnscopedKey, | ||
| CacheKeyPrefixEnum, | ||
| CacheKeyTypeEnum, | ||
| IdentifierPrefixEnum, | ||
| ServiceConfigIdentifierEnum, | ||
| buildEnvironmentScopedKey, | ||
| buildOrganizationScopedKeyById, | ||
| buildOrganizationScopedKey, | ||
| buildServiceConfigKey, | ||
| } from './shared'; | ||
|
|
||
| export const buildSubscriberKey = ({ | ||
| subscriberId, | ||
| _environmentId, | ||
| }: { | ||
| subscriberId: string; | ||
| _environmentId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.SUBSCRIBER, | ||
| environmentId: _environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.SUBSCRIBER_ID, | ||
| identifier: subscriberId, | ||
| }); | ||
|
|
||
| export const buildVariablesKey = ({ | ||
| _environmentId, | ||
| _organizationId, | ||
| }: { | ||
| _environmentId: string; | ||
| _organizationId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKey({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.WORKFLOW_VARIABLES, | ||
| environmentId: _environmentId, | ||
| }); | ||
|
|
||
| export const buildUserKey = ({ _id }: { _id: string }): string => | ||
| buildUnscopedKey({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.USER, | ||
| identifier: _id, | ||
| }); | ||
|
|
||
| export const buildNotificationTemplateKey = ({ | ||
| _id, | ||
| _environmentId, | ||
| }: { | ||
| _id: string; | ||
| _environmentId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE, | ||
| environmentId: _environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.ID, | ||
| identifier: _id, | ||
| }); | ||
|
|
||
| export const buildNotificationTemplateIdentifierKey = ({ | ||
| templateIdentifier, | ||
| _environmentId, | ||
| }: { | ||
| templateIdentifier: string; | ||
| _environmentId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE, | ||
| environmentId: _environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.TEMPLATE_IDENTIFIER, | ||
| identifier: templateIdentifier, | ||
| }); | ||
|
|
||
| export const buildEnvironmentByApiKey = ({ | ||
| apiKey, | ||
| }: { | ||
| apiKey: string; | ||
| }): string => | ||
| buildUnscopedKey({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.ENVIRONMENT_BY_API_KEY, | ||
| identifier: apiKey, | ||
| identifierPrefix: IdentifierPrefixEnum.API_KEY, | ||
| }); | ||
|
|
||
| export const buildGroupedBlueprintsKey = (environmentId: string): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.GROUPED_BLUEPRINTS, | ||
| environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.GROUPED_BLUEPRINT, | ||
| identifier: BLUEPRINT_IDENTIFIER, | ||
| }); | ||
|
|
||
| export const buildAuthServiceKey = ({ apiKey }: { apiKey: string }): string => { | ||
| const apiKeyHash = createHash(apiKey); | ||
|
|
||
| return buildUnscopedKey({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.AUTH_SERVICE, | ||
| identifier: apiKeyHash, | ||
| identifierPrefix: IdentifierPrefixEnum.API_KEY, | ||
| }); | ||
| }; | ||
|
|
||
| export const buildMaximumApiRateLimitKey = ({ | ||
| apiRateLimitCategory, | ||
| _environmentId, | ||
| }: { | ||
| apiRateLimitCategory: string; | ||
| _environmentId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.MAXIMUM_API_RATE_LIMIT, | ||
| environmentId: _environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.API_RATE_LIMIT_CATEGORY, | ||
| identifier: apiRateLimitCategory, | ||
| }); | ||
|
|
||
| export const buildEvaluateApiRateLimitKey = ({ | ||
| apiRateLimitCategory, | ||
| _environmentId, | ||
| }: { | ||
| apiRateLimitCategory: string; | ||
| _environmentId: string; | ||
| }): string => | ||
| buildEnvironmentScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.EVALUATE_API_RATE_LIMIT, | ||
| environmentId: _environmentId, | ||
| identifierPrefix: IdentifierPrefixEnum.API_RATE_LIMIT_CATEGORY, | ||
| identifier: apiRateLimitCategory, | ||
| }); | ||
|
|
||
| export const buildEventUsageKey = ({ | ||
| _organizationId, | ||
| resourceType, | ||
| periodStart, | ||
| periodEnd, | ||
| }: { | ||
| _organizationId: string; | ||
| resourceType: string; | ||
| periodStart: number; | ||
| periodEnd: number; | ||
| }): string => | ||
| buildOrganizationScopedKeyById({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.USAGE, | ||
| identifierPrefix: IdentifierPrefixEnum.RESOURCE_TYPE, | ||
| identifier: `${resourceType}_${periodStart}_${periodEnd}`, | ||
| organizationId: _organizationId, | ||
| }); | ||
|
|
||
| export const buildSubscriptionKey = ({ | ||
| organizationId, | ||
| }: { | ||
| organizationId: string; | ||
| }): string => | ||
| buildOrganizationScopedKey({ | ||
| type: CacheKeyTypeEnum.ENTITY, | ||
| keyEntity: CacheKeyPrefixEnum.SUBSCRIPTION, | ||
| organizationId, | ||
| }); | ||
|
|
||
| export const buildServiceConfigApiRateLimitMaximumKey = (): string => | ||
| buildServiceConfigKey( | ||
| ServiceConfigIdentifierEnum.API_RATE_LIMIT_SERVICE_MAXIMUM | ||
| ); | ||
|
There was a problem hiding this comment. It's a bit of a code smell to update here, so we instead export each of the required builders in-line. |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,2 @@ | ||
| export * from './entities'; | ||
| export * from './queries'; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renaming to align with intended purpose, which is to limit resource quotas.