Feat: Allow skipping complexity check in Harden Plugin #3340
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@michaelbromley Not sure why tests are failing, HardenPlugin doesn't seem to be included in any e2e tests. Someone else broke the minor branch maybe? |
twlite
reviewed
Jan 30, 2025
packages/harden-plugin/src/middleware/query-complexity-plugin.ts
Outdated
Show resolved
Hide resolved
| @@ -79,4 +80,16 @@ export interface HardenPluginOptions { | |||
| * @default 'prod' | |||
| */ | |||
| apiMode?: 'dev' | 'prod'; | |||
| /** | |||
| * @description | |||
| * Allows you to skip the complexity check for certain requests. | |||
There was a problem hiding this comment.
I think we should note that the ctx is not the RequestContext object here, since I think a lot of people will make that assumption based on typical Vendure patterns.
Maybe even rename it to context to make it even more explicit.
There was a problem hiding this comment.
@michaelbromley Valid concern. Fixed :-)
|
michaelbromley
approved these changes
Feb 11, 2025
|
Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
We are using the Harden Plugin, but would like to be able to skip the complexity check for storefront SSR builds.
This PR introduces an optional
skipfunction, inspired by express-rate-limit, that allows the consumer to skip certain requests.Screenshots below we're tested with the following config:
This skips the complexity check when the header
x-skip-complexityis present. In production use, you would check for a token or something.Breaking changes
No
Screenshots
Complex query without header
The same complex query with custom header
And, another test without a
skipfunction specified.Checklist
📌 Always:
👍 Most of the time: