Rename conflicting send_payload method
#2673
Merged
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 transport infrastructure is mostly generic, except for a few choke points. This addresses one of them. The `send_payload` method, while defined in a trace-specific module, is included at the class level. When attempting to reuse transport for other use cases, the method conflicts with other modules extending the generic client class. Luckily its use is very limited and self-contained to a trace transport specific scope. By renaming it additional modules are able to be included and can follow a consistent pattern without conflict.
Codecov Report
@@ Coverage Diff @@
## master #2673 +/- ##
=======================================
Coverage 98.09% 98.09%
=======================================
Files 1168 1168
Lines 64210 64212 +2
Branches 2857 2857
=======================================
+ Hits 62986 62991 +5
+ Misses 1224 1221 -3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
GustavoCaso
approved these changes
Mar 8, 2023
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?
Move a generically named method out of the way.
Motivation
The transport infrastructure is mostly generic, except for a few choke points. This addresses one of them.
The
send_payloadmethod, while defined in a trace-specific module, is included at the class level.When attempting to reuse transport for other use cases, the method conflicts with other modules extending the generic client class.
Luckily its use is very limited and self-contained to a trace transport specific scope. By renaming it additional modules are able to be included and can follow a consistent pattern without conflict.
Additional Notes
This has been discovered while implementing additional transport facilities for remote configuration, from an AppSec impetus.
The whole transport code is fairly involved and due for a rewrite, nonetheless it handles many corner cases. which would make a drop-in rewrite carry much risk to tracing.
Therefore a more segregated approach is being taken to implement the required additional transports, aiming:
This is one of those changes.
How to test the change?
CI should be green.