Fix FE when tag name is undefined
#2146
Merged
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
Signed-off-by: rashidakanchwala <[email protected]>
Signed-off-by: rashidakanchwala <[email protected]>
jitu5
approved these changes
Oct 22, 2024
|
Kacper confirmed that this PR resolves the main issue i.e it doesn't break Kedro-viz; the outputs of pipelines are not entirely correct. and when he gets time he will create some example pipelines that we can use to reproduce and fix this bug. FYI @astrojuanlu |
Signed-off-by: rashidakanchwala <[email protected]>
src/utils/index.js
Outdated
| @@ -120,7 +120,7 @@ export const stripNamespace = (str) => { | |||
| * @param {String} str The string to check | |||
| * @returns {String} The string with or without replaced values | |||
| */ | |||
| export const prettifyName = (str) => { | |||
| export const prettifyName = (str = '') => { | |||
There was a problem hiding this comment.
@rashidakanchwala
The default value will only handle undefined, it will not handle cases of null. Though prettifyName will never be called with null, I would still suggest using an explicit check like below to handle all weird cases -
export const prettifyName = (str) => {
if (!str) {
return '';
}
...Signed-off-by: rashidakanchwala <[email protected]>
SajidAlamQB
approved these changes
Oct 25, 2024
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.
Description
Partly resolves #2106
Development notes
In the user's pipeline, one of the nodes was tagged as
validation. While this tag was mentioned in the{ node: { tags: [] } }response, it wasn't somehow mentioned in the{ tags: {} }response which caused the flowchart to break. We were unable to reproduce this issue on the backend, which would have been the optimal place to address it.As a workaround, we fixed this on the frontend. When a tag is not defined correctly in the backend, the frontend cannot link the tag to the corresponding tag name. Since the tag name and ID are the same, we added a fallback. If the tag name is undefined (due to an error we still need to investigate), we use the tag ID itself as a fallback. This prevents Kedro-Viz from breaking and ensures the flowchart runs correctly.
QA notes
To test this fix using the demo project:
Run
kedro viz --save-file=test. This will create a test folder with an api folder inside.Move the
apifolder into thekedro-viz/publicdirectory.Remove 'company' dict from
tags:inapi/mainfolderRun
npm run start:dev.Before this PR, you will see the app breaking with the error message the user encountered. After applying the PR, the issue will be fixed.
Checklist
RELEASE.mdfile