Skip to content

Comments

Add optional targetClientId to ISignalMessage#19555

Merged
WillieHabi merged 11 commits intomicrosoft:mainfrom
WillieHabi:isignalmessage-targetid
Feb 14, 2024
Merged

Add optional targetClientId to ISignalMessage#19555
WillieHabi merged 11 commits intomicrosoft:mainfrom
WillieHabi:isignalmessage-targetid

Conversation

@WillieHabi
Copy link
Contributor

@WillieHabi WillieHabi commented Feb 8, 2024

Description

Updating ISignalMessage to inlcude optional targetSignalid.

This can be useful for receiving clients trying to understand the overall approximate load on service and maybe other understanding. If received signal has that property, then we know it wasn't broadcast to everyone.

FF API Council Context

I have a minor API change related to ISignalMessage. ODSP had made changes to allow for targeted signals and I have been tasked with doing some of the follow-up work related to this. Initially the idea was for the server to strip the targetClientId before sending the signal message to the targeted client, however Jason and Gary came to an agreement that it would be beneficial to leave this information on the message, which would involve adding an optional targetClientId member to ISignalMessage(Base). This could be useful for receiving clients trying to understand the overall approximate load on service and maybe other understanding. If received signal has that property, then we know it wasn't broadcast to everyone. Thanks.

@github-actions github-actions bot added public api change Changes to a public API base: main PRs targeted against main branch labels Feb 8, 2024
@WillieHabi WillieHabi marked this pull request as ready for review February 8, 2024 19:08
@WillieHabi WillieHabi marked this pull request as draft February 8, 2024 22:17
@WillieHabi WillieHabi marked this pull request as ready for review February 8, 2024 22:17
@jason-ha

This comment was marked as resolved.

@jason-ha
Copy link
Contributor

jason-ha commented Feb 8, 2024

And you can incorporate this comment into the Base one.


Refers to: common/lib/protocol-definitions/src/protocol.ts:379 in 9a90f6f. [](commit_id = 9a90f6f, deletion_comment = False)

@WillieHabi WillieHabi requested a review from jason-ha February 9, 2024 00:42
Copy link
Contributor

@jason-ha jason-ha left a comment

Choose a reason for hiding this comment

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

We should spruce up the comments. See some prior comments that are not yet Resolved.
(submit_signals_v2 reference doesn't belong on ISent; the base comments should reflect the bidi nature)

@WillieHabi
Copy link
Contributor Author

Made minor changes to the comments. Are these sufficient or was there something else in mind?

@WillieHabi WillieHabi requested a review from jason-ha February 9, 2024 16:32
@WillieHabi WillieHabi requested a review from jason-ha February 12, 2024 20:20
@WillieHabi WillieHabi merged commit af2d678 into microsoft:main Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

base: main PRs targeted against main branch public api change Changes to a public API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants