-
Notifications
You must be signed in to change notification settings - Fork 307
Fix breakage caused by external use of our internal API #953
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
Fix breakage caused by external use of our internal API #953
Conversation
Because Logstash Core v7.7.0-v7.8.x override the `use_event_type?` in a monitoring implelentation's subclass with a required (and ignored) `client` argument, when we send `use_event_type?` internally, we must send an argument or else we break compatibility with those versions of Logstash. This change re-adds the required argument and modifies our call-site to send with an arity of 1, re-names the resulting local variable to be descriptive of our intent, and adds commentary to prevent future accidental breakage.
Not sure how or why, but I've pushed changelog and version bump to the branch referenced here and Github is not picking it up -> master...yaauie:fix-external-use-of-internal-api |
GitHub is acting up, already happened in another PR
…On Wed, 15 Jul 2020 at 17:57, Ry Biesemeyer ***@***.***> wrote:
Not sure how or why, but I've pushed changelog and version bump to the
branch referenced here and Github is not picking it up ->
master...yaauie:fix-external-use-of-internal-api
<master...yaauie:fix-external-use-of-internal-api>
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#953 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAHYQPXM7PCD2L62ENYAPTR3XNYRANCNFSM4O2WPSEA>
.
|
5dee3ba
to
baeb4b1
Compare
Ah, it seems caught up now. |
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.
LGTM
@@ -60,7 +60,14 @@ def successful_connection? | |||
!!maximum_seen_major_version | |||
end | |||
|
|||
def use_event_type? | |||
## | |||
# WARNING: This method is overridden in a subclass in Logstash Core 7.7-7.8's monitoring, |
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.
❤️
Needs a doc fix too before publishing. |
a14e5da
to
fb9657c
Compare
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.
Left a suggestion on link format. Your way is ideal, but we have some technical issues around versioning to sort out before the attribute will work in the Versioned Plugin Reference.
Versioned Plugins doc gen doesn't have the placeholder, so using it breaks the build. Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
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.
LGTM
Because Logstash Core v7.7.0-v7.8.x override the
use_event_type?
in amonitoring implelentation's subclass with a required (and ignored)
client
argument, when we send
use_event_type?
internally, we must send an argumentor else we break compatibility with those versions of Logstash.
This change re-adds the required argument and modifies our call-site to send
with an arity of 1, re-names the resulting local variable to be descriptive
of our intent, and adds commentary to prevent future accidental breakage.