chore(api, dal, shared): Rename API Rate Limiting types for consistency #4867
Conversation
NV-3060 🏎️ Token Bucket Rate Limiting use-case
What?Create a use-case that implements the Upstash Token bucket rate limiting algorithm. Why? (Context)We have chosen to use the token bucket rate limiting algorithm via the existing Upstash library because it aligns with our API access patterns and will allow us to quickly release a basic rate limiting capability. Definition of Done
|
| @@ -53,7 +53,7 @@ describe('Create Organization - /organizations (POST)', async () => { | |||
| const { body } = await session.testAgent.post('/v1/organizations').send(testOrganization).expect(201); | |||
| const dbOrganization = await organizationRepository.findById(body.data._id); | |||
|
|
|||
| expect(dbOrganization?.apiServiceLevel).to.eq(ApiServiceLevelTypeEnum.FREE); | |||
| expect(dbOrganization?.apiServiceLevel).to.eq(ApiServiceLevelEnum.FREE); | |||
There was a problem hiding this comment.
Changing the TypeEnum -> Enum suffix for better readability
| @IsDefined() | ||
| @IsEnum(ApiRateLimitCategoryEnum) | ||
| apiRateLimitCategory: ApiRateLimitCategoryEnum; | ||
| } |
There was a problem hiding this comment.
This was a refactor from the following file (below in PR) that wasn't picked up correctly by git:
https://github.com/novuhq/novu/pull/4867/files#diff-bb13833ec972ae0f2f3cd90b6ac0c9f68be590818abe737ca3f26baf85516740
| expect(result[mockRateLimitServiceLevel][mockRateLimitCategory]).to.equal(mockOverrideRateLimit); | ||
| delete process.env[envVarName]; // cleanup | ||
| }); | ||
| }); |
There was a problem hiding this comment.
This was a refactor from the following file (below in PR) that wasn't picked up correctly by git:
https://github.com/novuhq/novu/pull/4867/files#diff-7e5c0068062244f3c27665cfd6f282caa1cdef7ab4eb223432c264999e091984.
It is renamed get-default-api-rate-limits -> get-api-rate-limit-service-maximum-config to better reflect the fact that a configuration is being read from the environment variables.
| @@ -1,21 +1,21 @@ | |||
| import { Injectable, InternalServerErrorException, Logger } from '@nestjs/common'; | |||
There was a problem hiding this comment.
This is a rename from get-api-rate-limit -> get-api-rate-limit-maximum to better reflect the fact that a maximum allowed rate limit is being fetched for the given environment entity.
| GLOBAL = 'global', | ||
| } | ||
|
|
||
| export type IApiRateLimits = Record<ApiRateLimitCategoryTypeEnum, number>; |
There was a problem hiding this comment.
Refactoring this typing from the Environment repository due to the fact that the categories are specific to rate limiting configuration, therefore belong in the Rate Limit typings.
| @@ -0,0 +1,13 @@ | |||
| /** | |||
There was a problem hiding this comment.
The files below are refactored for better modularity to prepare for the evaluate rate limit use-case supporting configuration typings that will be introduced soon.
|
Closing in favour of putting the same changes into #4844 |
What change does this PR introduce?
TypeEnumsuffix ->Enumfor enums for readabilityWhy was this change needed?
Other information (Screenshots)
N/A