Open compulim opened 3 years ago
Assigning to @Kaiqb for bringing more people from the SDK.
@mrivera-ms - who can investigate this one from the SDK side?
@Kaiqb, I have added the issue that will track this in the dotnet repo.
Link to the issue Monica created in dotnet repo: Issue #5310: First activity has fake replyToId value that is causing a bug in WebChat. We'll leave this issue open here because we'll have to remove code after the bug is fixed in the SDK.
@Kaiqb, @compulim, there is a PR in the dotnet repo to fix this issue that needs your comments. The SDK team has reviewed the PR but there are questions that need to be answered before it is approved. Please see the PR here.
@mrivera-ms FYI for visibility, I am adding a note to our project board.
Version
master
(as of pre-R12)Describe the bug
Although this is a SDK bug, I am filing it here because we have
// TODO
code to remove after that bug is fixed.First activity will have a bogus
replyToId
if it was from the bot.If this bug is not fixed, it might cause accessibility issues on our side.
replyToId
replyToId
has a value, but the value is random string, and it refer to an activity that never exists in the worldreplyToId
as the value is not a validreplyToId
in SDK and keep the workaround in #3431, it will cause issue in this scenario:Steps to reproduce
/__tests__/html/accessibility.delayActivity.withReplyToId.html
// TODO
line related to this bugExpected behavior
It should succeed, reasons:
replyToId
pointing to "Hello, World!"replyToId
is pointing to, is not known yet, the bot reply "You said, ..." should not appear on the transcriptTo fix #3431, we have to relax the delay for the very first bot message, since it may have a bogus ID, or it may have a valid ID, we can't tell whether the
replyToId
is valid or not. We assume the first one is bogus, so we don't add 5 seconds delay.But that PR inevitably introduced another accessibility issue, which is less severe, IMO.
The
// TODO
line is to send a bot activity first, so the bot reply, "You said, ..." activity, is no longer the first bot activity, and it should subject to delay.Additional context
Developers who are not familiar with how ABS works and how it order messages, should read this sequence diagram first.
https://github.com/microsoft/BotFramework-WebChat/blob/master/docs/media/direct-line-sequence-diagram.png
For accessibility, the order of the narration is based on time when we add the element to the tree. And not based on the actual position of the element in the tree.
[Bug]