Replace owasp java encoder with faster implementation #227
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
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #227 +/- ##
============================================
- Coverage 93.02% 92.77% -0.26%
- Complexity 1142 1164 +22
============================================
Files 64 65 +1
Lines 2912 2991 +79
Branches 467 476 +9
============================================
+ Hits 2709 2775 +66
- Misses 110 123 +13
Partials 93 93
☔ View full report in Codecov by Sentry. |
|
This likely needs to be 3.0 then, because of the breaking change to the interface? |
casid
changed the title
Closed
I think you are right, there are quite a few things that accumulated for a new major version. I've created a ticket to collect all changes in one place: #230 |
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.
Benchmarks as in #225 have shown that OWASP Java Encoder is slower than expected for output escaping. In order to use the faster methods of OWASP encoder, all template outputs had to provide an instance of the rather ancient and clumsy
Writerinterface, that really should not be part of the public API ofTemplateOutput.This PR replaces the four methods we currently use from the OWASP Java Encoder project by optimized methods that work directly on a
TemplateOutput:org.owasp.encoder.Encode.forHtmlContent->gg.jte.html.escape.Escape.htmlContentorg.owasp.encoder.Encode.forHtmlAttribute->gg.jte.html.escape.Escape.htmlAttributeorg.owasp.encoder.Encode.forJavaScriptBlock->gg.jte.html.escape.Escape.javaScriptBlockorg.owasp.encoder.Encode.forJavaScriptAttribute->gg.jte.html.escape.Escape.javaScriptAttributeAll methods should behave exactly like their OWASP counterparts.
After this patch is merged, jte will be free from external dependencies.