-
Notifications
You must be signed in to change notification settings - Fork 887
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ratings and feedback are working from child to parent
- Loading branch information
Showing
18 changed files
with
254 additions
and
208 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
121 changes: 121 additions & 0 deletions
121
components/ai_chat/resources/page/state/useSendFeedback.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| // Copyright (c) 2024 The Brave Authors. All rights reserved. | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this file, | ||
| // You can obtain one at https://mozilla.org/MPL/2.0/. | ||
|
|
||
| import * as React from 'react' | ||
| import { showAlert } from '@brave/leo/react/alertCenter' | ||
| import * as Mojom from '../../common/mojom' | ||
| import { getLocale } from '$web-common/locale' | ||
|
|
||
| /** | ||
| * State needed for UI to embed a feedback form | ||
| */ | ||
| export interface SendFeedbackState { | ||
| isFeedbackFormVisible: boolean | ||
| handleFeedbackFormCancel: () => void | ||
| handleFeedbackFormSubmit: (selectedCategory: string, feedbackText: string, shouldSendUrl: boolean) => void | ||
| } | ||
|
|
||
| export const defaultSendFeedbackState: SendFeedbackState = { | ||
| isFeedbackFormVisible: false, | ||
| handleFeedbackFormCancel: () => {}, | ||
| handleFeedbackFormSubmit: () => {} | ||
| } | ||
|
|
||
| /** | ||
| * This hook handles calls from the child frame to rate a message and provides | ||
| * handling of the form to collect more user feedback, actioned via the alert | ||
| * center. This is self-contained apart from the form itself which should | ||
| * be implemented in the parent frame UI. | ||
| */ | ||
| export default function useSendFeedback( | ||
| conversationHandler: Mojom.ConversationHandlerRemote, | ||
| conversationEntriesFrameObserver: Mojom.ParentUIFrameCallbackRouter | ||
| ): SendFeedbackState { | ||
| const feedbackId = React.useRef<string | null>(null) | ||
| const [isFeedbackFormVisible, setIsFeedbackFormVisible] = React.useState(false) | ||
|
|
||
| // Listen to ratings requests from the child frame | ||
| React.useEffect(() => { | ||
| async function handleRateMessage(turnUuid: string, isLiked: boolean) { | ||
| // Reset feedback form | ||
| feedbackId.current = null | ||
| setIsFeedbackFormVisible(false) | ||
| const response = await conversationHandler?.rateMessage(isLiked, turnUuid) | ||
| if (!response.ratingId) { | ||
| showAlert({ | ||
| type: 'error', | ||
| content: getLocale('ratingError'), | ||
| actions: [] | ||
| }) | ||
| return | ||
| } | ||
| if (isLiked) { | ||
| showAlert({ | ||
| type: 'info', | ||
| content: getLocale('answerLiked'), | ||
| actions: [] | ||
| }) | ||
| } else { | ||
| // Allow the alert to stay for longer so that the user has time | ||
| // to click the button to add feedback. | ||
| feedbackId.current = response.ratingId | ||
| showAlert({ | ||
| type: 'info', | ||
| content: getLocale('answerDisliked'), | ||
| actions: [ | ||
| { | ||
| text: getLocale('addFeedbackButtonLabel'), | ||
| kind: 'plain-faint', | ||
| action: () => setIsFeedbackFormVisible(true) | ||
| } | ||
| ] | ||
| }, 5000) | ||
| } | ||
| } | ||
|
|
||
| const listenerId = conversationEntriesFrameObserver.rateMessage.addListener( | ||
| handleRateMessage | ||
| ) | ||
|
|
||
| return () => { | ||
| conversationEntriesFrameObserver.removeListener(listenerId) | ||
| } | ||
| }, [conversationHandler, conversationEntriesFrameObserver]) | ||
|
|
||
| function handleFeedbackFormCancel() { | ||
| setIsFeedbackFormVisible(false) | ||
| } | ||
|
|
||
| async function handleFeedbackFormSubmit( | ||
| selectedCategory: string, feedbackText: string, shouldSendUrl: boolean | ||
| ) { | ||
| if (feedbackId.current) { | ||
| const response = await conversationHandler?.sendFeedback( | ||
| selectedCategory, feedbackText, feedbackId.current, shouldSendUrl | ||
| ) | ||
| if (!response.isSuccess) { | ||
| showAlert({ | ||
| type: 'error', | ||
| content: getLocale('feedbackError'), | ||
| actions: [] | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| showAlert({ | ||
| type: 'success', | ||
| content: getLocale('feedbackSent'), | ||
| actions: [] | ||
| }) | ||
| setIsFeedbackFormVisible(false) | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| isFeedbackFormVisible, | ||
| handleFeedbackFormCancel, | ||
| handleFeedbackFormSubmit | ||
| } | ||
| } |
Oops, something went wrong.