feat: separate forms like/dislike + api config route #506
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
|
Code Coverage SummaryDiff against mainResults for commit: 539483f Minimum allowed coverage is ♻️ This comment has been updated with latest results |
dazy-ds
reviewed
Apr 9, 2025
There was a problem hiding this comment.
Overall looks good, some minor changes from my side.
One thing that should be added to the backlog is creating a store/context with the config so that is accessible everywhere and fetched before app loads.
Regarding the enums, you can use them or create union type e.g. type FormType = ... and object that reassembles the enum (if you don't want to use them)
Comment on lines
+82
to
+89
| if (config) { | ||
| if ( | ||
| config.hasOwnProperty("like_form") || | ||
| config.hasOwnProperty("dislike_form") | ||
| ) { | ||
| pluginManager.activate(FeedbackFormPluginName); | ||
| } | ||
| } |
There was a problem hiding this comment.
nit: I am not a fan of that much nesting. We can change it to use be something like this:
if (!config || (!config.hasOwnProperty("likeForm) && !config.hasOwnProperty("dislike_form")) {
return
}
We can even extract the second part to named variable, like hasFeedbackForms to give it more meaning
| @@ -17,6 +19,8 @@ | |||
|
|
|||
| logger = logging.getLogger(__name__) | |||
|
|
|||
| STARTED_FROM_DIR = Path(os.getcwd()).resolve() | |||
There was a problem hiding this comment.
nit: Maybe let's change the name of this variable to WORKING_DIRECTORY. We can also consider removing it, as it's only used in one place and can be inlined in line 57 (that way maybe we would only call resolve once, but I am not sure if it's needed at all)
Comment on lines
+25
to
+26
| like_form?: FormSchema | null; | ||
| dislike_form?: FormSchema | null; |
There was a problem hiding this comment.
Maybe let's use an enum for the names, something like:
enum FormType {
LIKE "like_form"
DISLIKE: "dislike_form"
}
The goal is to use it to define type describing this state and chosen form in the lines 31-33 and hide the snake cased string literals.
Comment on lines
+31
to
+33
| const [feedbackName, setFeedbackName] = useState< | ||
| "like_form" | "dislike_form" | ||
| >(); |
There was a problem hiding this comment.
^ Same as above, let's hide the snake cased string literals
| setIsLoading(true); | ||
|
|
||
| const [data] = await axiosWrapper<Record<string, unknown>>({ | ||
| url: "http://127.0.0.1:8000/api/config", |
There was a problem hiding this comment.
Let's use buildApiUrl method with absolute path -> buildApiUrl('/api/config') (might require rebasing)
| const handleFetchConfig = async () => { | ||
| setIsLoading(true); | ||
|
|
||
| const [data] = await axiosWrapper<Record<string, unknown>>({ |
There was a problem hiding this comment.
We know the type of the config returned from the server, let's type it in the types/api.ts and use the type here.
|
|
||
| export type ChatMessageProps = { | ||
| classNames?: string[]; | ||
| chatMessage: ChatMessage; | ||
| onOpenFeedbackForm?: () => void; | ||
| onOpenFeedbackForm?: (name: "like_form" | "dislike_form") => void; |
There was a problem hiding this comment.
Mentioned above, let's also use enum here
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.
No description provided.