make sure to assign a valid processor to the appsec component #2637
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
github-actions
bot
added
appsec
lloeki
approved these changes
Feb 22, 2023
lib/datadog/appsec/component.rb
Outdated
Comment on lines
35
to
38
| if processor | ||
| processor.finalize | ||
| @processor = nil | ||
| end |
There was a problem hiding this comment.
To improve thread safety, Processor might be finalized already but not yet nil.
Also, prefer a guard clause:
Suggested change
| if processor | |
| processor.finalize | |
| @processor = nil | |
| end | |
| return if processor.nil? || !processor.ready? | |
| processor.finalize | |
| @processor = nil |
There was a problem hiding this comment.
I prefer a guard clause too. It looks like steep likes:
def shutdown!
if processor && processor.ready?
processor.finalize
@processor = nil
end
endWith this form, steep is able to resolve the type checking issue we discussed earlier in which steep does not find the finalize method
lib/datadog/appsec/component.rb:28:18: [error] Type `::Datadog::AppSec::Processor` does not have method `finalize`
│ Diagnostic ID: Ruby::NoMethod
│
└ processor.finalize if processor
~~~~~~~~
Detected 1 problem from 1 file
Codecov Report
@@ Coverage Diff @@
## master #2637 +/- ##
==========================================
- Coverage 98.08% 98.08% -0.01%
==========================================
Files 1155 1155
Lines 63330 63358 +28
Branches 2826 2828 +2
==========================================
+ Hits 62117 62142 +25
- Misses 1213 1216 +3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
After merging #2632, we got alerted that our system tests were failing.
The scenario that is failing is when the appsec processor fails to parse the WAF rules.
The test fails when the app wants tries to shout down and we try to finalize the appsec component. The problem is that the processor was never ready, so finalizing a non-ready processor caused an error.
This PR fix that case by making sure to check if the processor is ready to assign to the appsec component.
Additional Notes
Should we make the
AppSec::Component.newmethod private and only allow to usebuild_appsec_component?How to test the change?