Adding authentication check to fetch new token before endchat #390
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
| @@ -19,6 +19,9 @@ import { TelemetryManager } from "../../../common/telemetry/TelemetryManager"; | |||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | |||
| const prepareEndChat = async (props: ILiveChatWidgetProps, chatSDK: any, state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, setWebChatStyles: any, adapter: any) => { | |||
| try { | |||
| //Get new auth token again if chat continued for longer time, otherwise chatsdk throws 401 error for auth chats | |||
| await handleAuthenticationIfEnabled(props, chatSDK); | |||
There was a problem hiding this comment.
Update CHANGE_LOG please
| @@ -19,6 +19,9 @@ import { TelemetryManager } from "../../../common/telemetry/TelemetryManager"; | |||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | |||
| const prepareEndChat = async (props: ILiveChatWidgetProps, chatSDK: any, state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, setWebChatStyles: any, adapter: any) => { | |||
| try { | |||
| //Get new auth token again if chat continued for longer time, otherwise chatsdk throws 401 error for auth chats | |||
| await handleAuthenticationIfEnabled(props, chatSDK); | |||
There was a problem hiding this comment.
If token is not expired, will this hurt performance?
There was a problem hiding this comment.
Yes and No,
Yes - because it's making an additional call to get token.
No - because chat is already ending at this stage.
Should we allow this PR to fix the breaking functionality and have another tracking item for perf improvement?
There was a problem hiding this comment.
I was reviewing the code again, if performance is a problem, then instead of introducing a new handleAuthenticationIfEnabled, maybe we should move the existing one from endChat to this method in prepareEndChat?
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.
Thank you for your contribution. Before submitting this PR, please include:
Id of the task, bug, story or other reference.
Issue 3651972: [DFC] - Chat Survey return rate discrepancies in Consumer
Incident 436007411 : Post chat survey didn't load for long ongoing chats
Description
Include a description of the problem to be solved
Issue: The chat widget fails to return post-chat surveys for long-running chats, which has been reported by several SxG organization partners. This has resulted in a significant drop of approximately 25% in receiving feedback rates.
Investigation Findings: Upon investigating the issue, we identified that the problem is due to 401 unauthorized error returned from the
prepareEndChatfunction.Consistency: The issue appears to be consistently reproducible in the context of long-running chats.
Solution Proposed
Detail what is the solution proposed, include links to design document if required or any other document required to support the solution
To address this issue, the recommendation is to implement a solution that ensures the
chatSDKhas a valid authentication token before executing the remaining code inprepareEndChatfunction, in case of authenticated chats. The included fix will get a new token and allowchatSDK.getConversationDetails()to run successfully, without encountering unauthorized errors, and subsequently, the survey can be rendered.Acceptance criteria
Define what are the conditions to consider the PR has achieved the intended goal
Test cases and evidence
Include what tests cases were considered, any evidence of testing for future references, to identify any corner cases, etc
Sanity Tests
A11y
Not required, as there is no change to UX.
Please provide justification if any of the validations has been skipped.