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

[Doc]Contradictory documentation of websocket features #8688

Closed
hpvd opened this issue Nov 24, 2020 · 8 comments · Fixed by #8762
Closed

[Doc]Contradictory documentation of websocket features #8688

hpvd opened this issue Nov 24, 2020 · 8 comments · Fixed by #8762
Labels
release/2.7.1 type/bug The PR fixed a bug or issue reported a bug
Milestone

Comments

@hpvd
Copy link

hpvd commented Nov 24, 2020

Describe the bug
at https://pulsar.apache.org/docs/en/client-libraries-websocket/ is written:

Through WebSockets you can publish and consume messages and use all the features available in the Java, Go, Python and C++ client libraries.

When looking at the Pulsar client feature matrix
at https://github.com/apache/pulsar/wiki/Client-Features-Matrix

the picture looks different: Websocket seems to offer by far the least number of features.

Expected behavior
Same statements of the documentation at both places.

Screenshots
2020-11-24_21h09_54

Additional context
of course Feature Matrix is for 2.5.0, but latest version of pulsar would not have "solved" all red crosses in Matrix :-)

but for at least one red cross there is an open issue which contains a pull request: #8247
an other issue asks for feature parity #2678
which would of course makes this issue obsolete...

@codelipenghui
Copy link
Contributor

Thanks @hpvd, we should update the document. @jennifer88huang @Huanli-Meng Could you please help take a looks at this issue?

@Jennifer88huang-zz
Copy link
Contributor

@codelipenghui Sure.
@hpvd Thanks for raising the issue, we should sync the info in different places. Would you like to submit a PR and fix it?

@codelipenghui codelipenghui added this to the 2.8.0 milestone Nov 26, 2020
@hpvd
Copy link
Author

hpvd commented Nov 26, 2020

@jennifer88huang
Thanks for asking. I think someone with internal technical deep knowlegde and overview should do this, because it's not only about syncing but also about updating to what is possible with latest/up coming version.
I'm pretty new in the pulsar world and at this time only looking from extern (does not have an own active installation - hopefully this will change next year and we choose pulsar to be part of our core technology ;-)

@Jennifer88huang-zz
Copy link
Contributor

@hpvd Thanks for sharing this. Welcome to Pulsar community.
I'll take care of this issue after the Summit, and will sync with you next week.
Thanks for raising the issue. If you find any further issue, feel free to let us know.

@hpvd
Copy link
Author

hpvd commented Nov 27, 2020

@jennifer88huang Thanks a lot!
I've seen you have already worked on the feature matrix. Looks already a little more friendly for websocket :-)
Just a question: why are red crosses used in the websocket column for "missing features" but empty fields in the other columns?

@hpvd
Copy link
Author

hpvd commented Nov 27, 2020

@Jennifer88huang-zz
Copy link
Contributor

@hpvd Thank you very much for your feedback. I'd like to explain the following points:

  1. I've updated the client feature matrix page accordingly. Some features in Websocket are not supported, yet we have plan to support them in the future. If you are familiar with any feature and would like to help, feel free to contact us.
  2. Effectively-once is supported for websocket. We'll provide related info in Effectively-Once support for WebSockets #8175, and close the issue after @cvuijst agrees.
  3. Nack Ack will also be supported once the PR Nack support in WS #8249 is merged. Some test issues block Nack support in WS #8249. We can update the website again after this PR is merged.
  4. Concerning the documentation: "Through WebSockets you can publish and consume messages and use all the features available in the Java, Go, Python and C++ client libraries", it's our ultimate target. Currently, WebSockets could not use some features. To avoid misunderstanding, maybe I can refine it as "Through WebSockets you can publish and consume messages and use features available in the Java, Go, Python and C++ client libraries. For details on the features available for WebSockets, refer to Client Features Matrix."

@hpvd
Copy link
Author

hpvd commented Dec 1, 2020

@jennifer88huang
Many thanks for these details and work!
4 -> sounds perfect!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release/2.7.1 type/bug The PR fixed a bug or issue reported a bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants