-
Notifications
You must be signed in to change notification settings - Fork 300
test(express): added route param validation tests #7223
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
Closed
lokesh-bitgo
wants to merge
1
commit into
master
from
WP-6315-express-route-params-validation-tests-for-all-typed-routes
Closed
Changes from all commits
Commits
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
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
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 |
|---|---|---|
|
|
@@ -13,6 +13,23 @@ import { | |
| } from '../../../src/typedRoutes/api/v2/coinSignTx'; | ||
| import { assertDecode } from './common'; | ||
|
|
||
| /** | ||
| * Helper function to extract path parameter names from a route path | ||
| * Supports both Express-style (:param) and OpenAPI-style ({param}) notation | ||
| */ | ||
| function extractPathParams(path: string): string[] { | ||
| const colonParams = path.match(/:(\w+)/g)?.map((p) => p.slice(1)) || []; | ||
| const braceParams = path.match(/\{(\w+)\}/g)?.map((p) => p.slice(1, -1)) || []; | ||
| return [...colonParams, ...braceParams]; | ||
| } | ||
|
|
||
| /** | ||
| * Helper function to get codec parameter names from a params object | ||
| */ | ||
| function getCodecParamNames(paramsCodec: Record<string, any>): string[] { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above |
||
| return Object.keys(paramsCodec); | ||
| } | ||
|
|
||
| describe('CoinSignTx codec tests', function () { | ||
| describe('CoinSignTxParams', function () { | ||
| it('should validate params with required coin', function () { | ||
|
|
@@ -370,5 +387,24 @@ describe('CoinSignTx codec tests', function () { | |
| assert.ok(PostCoinSignTx.response[200]); | ||
| assert.ok(PostCoinSignTx.response[400]); | ||
| }); | ||
|
|
||
| /** | ||
| * CRITICAL TEST: Validates that path parameter names match codec parameter names | ||
| * to prevent runtime validation errors. | ||
| */ | ||
| it('should have path parameter names matching codec parameter names', function () { | ||
| const pathParams = extractPathParams(PostCoinSignTx.path); | ||
| const codecParams = getCodecParamNames(CoinSignTxParams); | ||
|
|
||
| pathParams.sort(); | ||
| codecParams.sort(); | ||
|
|
||
| assert.deepStrictEqual( | ||
| pathParams, | ||
| codecParams, | ||
| `Path parameters ${JSON.stringify(pathParams)} do not match codec parameters ${JSON.stringify(codecParams)}. ` + | ||
| `This will cause runtime validation errors! Path: ${PostCoinSignTx.path}` | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
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
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
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
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
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
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
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.
Can we move this to a util?