Skip to content

Expose ClientPort communication warning callback for protocol/schema mismatch reporting#558

Merged
azisislm merged 3 commits intomainfrom
alex/expose-clientport-communication-warning
Mar 9, 2026
Merged

Expose ClientPort communication warning callback for protocol/schema mismatch reporting#558
azisislm merged 3 commits intomainfrom
alex/expose-clientport-communication-warning

Conversation

@azisislm
Copy link
Contributor

@azisislm azisislm commented Mar 9, 2026

No description provided.

@github-actions github-actions bot added the CLA signed Indicates if all contributors have signed the CLA label Mar 9, 2026
@azisislm azisislm requested a review from ryan-the-crayon March 9, 2026 17:08
@azisislm azisislm marked this pull request as ready for review March 9, 2026 17:08
},
"communicationWarning",
);
this.reportCommunicationWarning({
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's do this. In the case that a onCommunicationWarning callback is set, no need to log the warning above.

@ryan-the-crayon
Copy link
Collaborator

So there is one thing that is annoying. Unfortunately, now communications warnings will be emitted even for cases that doesn't really indicate a protocol breakage. For example, if received a message for a channel that was recently closed can also emit a communication warning.

I think what we need is to add a "kind" field to the communication warnings to indicate the type of warning. For example: rpcParameterTypeError, channelUnknown. We will also need to add this field to the underlying transport level protocol. This field will have to be optional to prevent breakage. Also, when parsing this kind, it should map unknown values to "unknown" to provide backwards compatibility. This way, upper level users can use this "kind" field to determine the severity of the issue.

@azisislm azisislm merged commit 480f61e into main Mar 9, 2026
1 check passed
@azisislm azisislm deleted the alex/expose-clientport-communication-warning branch March 9, 2026 19:50
@github-actions github-actions bot locked and limited conversation to collaborators Mar 9, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

CLA signed Indicates if all contributors have signed the CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants