Skip to content
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][ws] Remove unnecessary ping/pong implementation #20733

Merged
merged 2 commits into from
Jul 6, 2023

Conversation

michaeljmarshall
Copy link
Member

Motivation

This PR removes an incorrect implementation of the websocket proxy ping/pong feature.

The feature was requested here #10014. When it was implemented in #10035, it was added as an endpoint instead of as support for every endpoint, like our /producer, /consumer, and /reader endpoints. Notably, these endpoint already have support through the framework, so there is no reason for the /pingpong endpoint. I propose we remove it.

Note: since this endpoint should not be used by anyone, I propose we cherry pick this to all active branches.

Modifications

  • Remove the /ws/pingpong and the /ws/v2/pingpong endpoints and all associated code

Verifying this change

A test is modified to prove that the framework gives us the ping/pong support out of the box.

Does this pull request potentially affect one of the following parts:

Removes an unnecessary endpoint.

Documentation

  • doc-not-needed

Ping/pong support is not documented here https://pulsar.apache.org/docs/3.0.x/client-libraries-websocket/, so I think we are good to skip docs.

Matching PR in forked repository

PR in forked repository: michaeljmarshall#52

@michaeljmarshall michaeljmarshall added type/cleanup Code or doc cleanups e.g. remove the outdated documentation or remove the code no longer in use area/websocket release/2.10.5 release/2.11.2 release/3.0.2 labels Jul 6, 2023
@michaeljmarshall michaeljmarshall added this to the 3.1.0 milestone Jul 6, 2023
@michaeljmarshall michaeljmarshall self-assigned this Jul 6, 2023
@michaeljmarshall michaeljmarshall changed the title Fix incorrect ws ping pong [fix][ws] Remove unnecessary ping/pong implementation Jul 6, 2023
@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Jul 6, 2023
Copy link
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lhotari
Copy link
Member

lhotari commented Jul 6, 2023

/pulsarbot rerun-failure-checks

@lhotari
Copy link
Member

lhotari commented Jul 6, 2023

Good work @michaeljmarshall .

@lhotari lhotari merged commit 33044f0 into apache:master Jul 6, 2023
michaeljmarshall added a commit that referenced this pull request Jul 6, 2023
michaeljmarshall added a commit that referenced this pull request Jul 6, 2023
(cherry picked from commit 33044f0)
(cherry picked from commit 11ee36d)
michaeljmarshall added a commit to datastax/pulsar that referenced this pull request Jul 6, 2023
(cherry picked from commit 33044f0)
(cherry picked from commit 11ee36d)
michaeljmarshall added a commit that referenced this pull request Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/websocket cherry-picked/branch-2.10 cherry-picked/branch-2.11 cherry-picked/branch-3.0 doc-not-needed Your PR changes do not impact docs release/2.10.5 release/2.11.2 release/3.0.1 type/cleanup Code or doc cleanups e.g. remove the outdated documentation or remove the code no longer in use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants