chore: improve the implementation of pubsub module #7043
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
This was referenced May 13, 2022
spacewander
reviewed
May 13, 2022
apisix/core/pubsub.lua
Outdated
| @@ -119,8 +138,8 @@ end | |||
| -- no error exists. | |||
| -- | |||
| -- @function core.pubsub.on | |||
| -- @tparam string command to add callback | |||
| -- @tparam function handler callback on receipt of command | |||
| -- @tparam string The command to add callback. | |||
There was a problem hiding this comment.
Suggested change
| -- @tparam string The command to add callback. | |
| -- @tparam string command The command to add callback. |
| - t/admin t/cli t/config-center-yaml t/control t/core t/debug t/discovery t/error_page t/misc t/pubsub | ||
| - t/node t/router t/script t/stream-node t/utils t/wasm t/xds-library t/xrpc | ||
| - t/admin t/cli t/config-center-yaml t/control t/core t/debug t/discovery t/error_page t/misc | ||
| - t/node t/pubsub t/router t/script t/stream-node t/utils t/wasm t/xds-library t/xrpc |
There was a problem hiding this comment.
I'm a little confused, according to the principle you mentioned at #6995 (comment), p should be in the middle of n and r in alphabetical order except for plugin. lmnopqrst
apisix/core/pubsub.lua
Outdated
| local function send_resp(ws, sequence, data) | ||
| data.sequence = sequence | ||
| local ok, encoded = pcall(pb.encode, "PubSubResp", data) | ||
| if not ok or not data then |
There was a problem hiding this comment.
A careless mistake that I will fix
There was a problem hiding this comment.
@tzssangglass fixed
| -- @tparam string command to add callback | ||
| -- @tparam function handler callback on receipt of command | ||
| -- @tparam string command The command to add callback. | ||
| -- @tparam func handler The callback function on receipt of command. |
There was a problem hiding this comment.
The documentation indicates that func should be used.
spacewander
approved these changes
May 13, 2022
tzssangglass
approved these changes
May 13, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
May 20, 2022
spacewander
pushed a commit
that referenced
this pull request
Jun 30, 2022
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.
Description
According to the closed #6995 PR, there are some review comments on the pubsub module, fix it throughout the PR.
Fixes # (issue)
Checklist