-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Ersuo/adding send status telemetry #4631
Merged
compulim
merged 13 commits into
microsoft:main
from
Erli-ms:ersuo/adding_send_status_telemetry
Feb 13, 2023
Merged
Ersuo/adding send status telemetry #4631
compulim
merged 13 commits into
microsoft:main
from
Erli-ms:ersuo/adding_send_status_telemetry
Feb 13, 2023
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
Erli-ms
requested review from
a-b-r-o-w-n,
compulim,
cwhitten,
srinaath,
tdurnford and
beyackle2
as code owners
February 1, 2023 00:42
compulim
reviewed
Feb 7, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Notes:
- Think if we need these in another PR:
- In addition to
TelemetryPayload.type: 'event' | 'message' | ...
, should we also have something to tell if this is aImBack
/PostBack
/MessageBack
? - We should export the type, via
botframework-webchat-api/index.ts
so others know and can expect what we are sending out- We have 2-3 events that is already in Web Chat today, we will also need to type them out too... so in another PR or I can do it
- In addition to
packages/api/src/providers/ActivitySendStatusTelemetry/ActivitySendStatusTelemetryComposer.tsx
Outdated
Show resolved
Hide resolved
packages/api/src/providers/ActivitySendStatusTelemetry/ActivitySendStatusTelemetryComposer.tsx
Outdated
Show resolved
Hide resolved
packages/api/src/providers/ActivitySendStatusTelemetry/ActivitySendStatusTelemetryComposer.tsx
Outdated
Show resolved
Hide resolved
packages/api/src/providers/ActivitySendStatusTelemetry/ActivitySendStatusTelemetryComposer.tsx
Outdated
Show resolved
Hide resolved
packages/api/src/providers/ActivitySendStatusTelemetry/ActivitySendStatusTelemetryComposer.tsx
Outdated
Show resolved
Hide resolved
__tests__/html/activityStatusTelemetry.sendingToSendFailed.html
Outdated
Show resolved
Hide resolved
__tests__/html/activityStatusTelemetry.sendingToSendFailed.html
Outdated
Show resolved
Hide resolved
__tests__/html/activityStatusTelemetry.sendingToSendFailed.html
Outdated
Show resolved
Hide resolved
__tests__/html/activityStatusTelemetry.sendingToSendFailedToSent.html
Outdated
Show resolved
Hide resolved
Co-authored-by: William Wong <compulim@users.noreply.github.com>
I ran tests locally/manually. Everything looks good. |
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.
Changelog Entry
Description
Added an ActivityStatusTelemetryComposer inside of ActivitySendStatusComposer. Whenever the activity status changes, the ActivityStatusTelemetryComposer collects the map of concerned activities and triggers trackEvent to emit the event. Consumers of the events can react accordingly. This feature is requested by D365 OmniChannel team.
Design
Added a new provider to look at send status of every activity. Whenever send status of any activities changed, it will call
onTelemetry
event to fire its changes.Specific Changes
{ status, prevStatus, ClientActivityID, type, hasAttachment, key}
is emitted to the telemetry logger-
CHANGELOG.md
Review Checklist
Accessibility reviewed (tab order, content readability, alt text, color contrast)Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index
)Internationalization reviewed (strings, unit formatting)package.json
andpackage-lock.json
reviewedSecurity reviewed (no data URIs, check for nonce leak)