-
Notifications
You must be signed in to change notification settings - Fork 173
Extract benchmark feature guard as middleware #2094
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+69
−21
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1aebd62
Extract benchmark feature guard into factory pattern
cezudas d50b897
Add test coverage
cezudas bd72a10
Merge branch 'main' into cezudas/OPS-3873
cezudas e6b2ac2
Refactor benchmark feature guard to use preHandler hook
cezudas 7a1226c
Fix lint error
cezudas 1968299
Remove unnecessary factory invocation
cezudas b92bc4a
Remove factory
cezudas ad98bca
Merge branch 'main' into cezudas/OPS-3873
cezudas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
12 changes: 6 additions & 6 deletions
12
packages/server/api/src/app/benchmark/benchmark-feature-guard.ts
This file contains hidden or 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,15 +1,15 @@ | ||
| import { AppSystemProp, logger, system } from '@openops/server-shared'; | ||
| import { preHandlerAsyncHookHandler } from 'fastify'; | ||
| import { throwFeatureDisabledError } from './errors'; | ||
|
|
||
| export async function assertBenchmarkFeatureEnabled( | ||
| projectId: string, | ||
| provider?: string, | ||
| ): Promise<void> { | ||
| export const assertBenchmarkFeatureEnabled: preHandlerAsyncHookHandler = async ( | ||
| request, | ||
| ) => { | ||
| if (system.getBoolean(AppSystemProp.FINOPS_BENCHMARK_ENABLED) !== true) { | ||
| logger.info( | ||
| 'Benchmark access denied: FINOPS_BENCHMARK_ENABLED flag is not enabled', | ||
| { provider, projectId }, | ||
| { projectId: request.principal.projectId }, | ||
| ); | ||
| throwFeatureDisabledError('Benchmark feature is not enabled'); | ||
| } | ||
| } | ||
| }; | ||
This file contains hidden or 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
61 changes: 61 additions & 0 deletions
61
packages/server/api/test/unit/benchmark/benchmark-feature-guard.test.ts
This file contains hidden or 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,61 @@ | ||
| jest.mock('@openops/server-shared', () => ({ | ||
| system: { | ||
| getBoolean: jest.fn(), | ||
| }, | ||
| AppSystemProp: { | ||
| FINOPS_BENCHMARK_ENABLED: 'FINOPS_BENCHMARK_ENABLED', | ||
| }, | ||
| logger: { | ||
| info: jest.fn(), | ||
| }, | ||
| })); | ||
|
|
||
| import { logger, system } from '@openops/server-shared'; | ||
| import { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'; | ||
|
|
||
| const mockSystem = system as jest.Mocked<typeof system>; | ||
|
|
||
| import { assertBenchmarkFeatureEnabled } from '../../../src/app/benchmark/benchmark-feature-guard'; | ||
|
|
||
| const mockFastifyInstance = {} as FastifyInstance; | ||
|
|
||
| const mockRequest = (projectId: string) => | ||
| ({ principal: { projectId } } as unknown as FastifyRequest); | ||
|
|
||
| const mockReply = {} as FastifyReply; | ||
|
|
||
| const callHook = (projectId: string) => | ||
| assertBenchmarkFeatureEnabled.call( | ||
| mockFastifyInstance, | ||
| mockRequest(projectId), | ||
| mockReply, | ||
cezudas marked this conversation as resolved.
Dismissed
Show dismissed
Hide dismissed
|
||
| ); | ||
|
|
||
| describe('assertBenchmarkFeatureEnabled', () => { | ||
| const projectId = 'project-id'; | ||
|
|
||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| it('should throw error if FINOPS_BENCHMARK_ENABLED is not enabled', async () => { | ||
| mockSystem.getBoolean.mockReturnValue(false); | ||
|
|
||
| await expect(callHook(projectId)).rejects.toThrow( | ||
| expect.objectContaining({ | ||
| message: 'FEATURE_DISABLED: Benchmark feature is not enabled', | ||
| }), | ||
| ); | ||
|
|
||
| expect(logger.info).toHaveBeenCalledWith( | ||
| 'Benchmark access denied: FINOPS_BENCHMARK_ENABLED flag is not enabled', | ||
| { projectId }, | ||
| ); | ||
| }); | ||
|
|
||
| it('should pass when FINOPS_BENCHMARK_ENABLED is true', async () => { | ||
| mockSystem.getBoolean.mockReturnValue(true); | ||
|
|
||
| await expect(callHook(projectId)).resolves.toBeUndefined(); | ||
| }); | ||
| }); | ||
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.
I see no good reason to log the provider, as this guard checks only the value of system env variable