Fix for sidebar search result based on Pretty name flag

[jitu5]

Description

This resolves case below for the Pretty name feature 1252

When the feature is turned on, the sidebar search will only allow the user to search for pretty-named things. For example, if one searches for data_processing.preprocessed_shuttles nothing will be returned, even though preprocessed shuttles exists and is the same thing. The same is true in the opposite direction.

Development notes

Now it works for both the type of search terms Pretty name and non Pretty name if it exist.

Checklist

• Read the contributing guidelines
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added new entries to the RELEASE.md file
• Added tests to cover my changes

[ravi-kumar-pilla]

I have added few comments. Please have a look. Thank you

[ravi-kumar-pilla]

This works in searching for both pretty and non-pretty names but the node list displayed is changed.

Have a look at the gif - The display names in the list gets changed based on search value i.e., I disabled pretty name flag and searched for a pretty name "Feat" and the node list shows Feature Engineering instead of feature_engineering. Though the search results return a value, we should push names based on the pretty flag I guess

[jitu5]

I checked current version on https://demo.kedro.org and this is happening before my changes. We can create a separate ticket for this if this behaviour is not as expected.

[ravi-kumar-pilla]

@tynandebold is this the expected behavior ?

[tynandebold]

No, that isn't expected. @jitu5 is right though, this isn't due to his change.

In the screen capture, what's returned when you search for feat when prettyName is off should be feature_engineering and not Feature Engineering.

Jitendra, can you please create a separate ticket to fix that?

[ravi-kumar-pilla]

[Nit] I feel opposite terminology not fitting but at the same time, I cannot come up with a suitable name here. @tynandebold any suggestions ?

[tynandebold]

I'm fine with it.

[ravi-kumar-pilla]

I have left few comments and none of them is a blocking change, so approving it now

[tynandebold]

Looking really good so far! The results are returning the way they should, and that's the main point of the PR, so well done there.

I am noticing one style bit that's off. On your branch, the search results aren't always highlighted like they should be. Notice the results aren't highlighted here:

It should look something like this:

This could be tricky to solve though, because what's being highlighted is the same exact text string that the user has entered. Have a look though and see if you can get it.

[jitu5]

@tynandebold Now searched/matched text is being highlighted in both the cases. please let me know if anythings is missing or broken.

[tynandebold]

Thanks for making that style change. It looks good to me now, and I'll approve.

I do think there's a little bit of odd UX wherein there can be a mismatch between what's returned in the sidebar and what's show in the flowchart. E.g. if prettyName is off and you search for Create mat you'll get back Create Matplot Chart, but in the flowchart the text of that node is create_matplotlib_chart.

I think this is ok for now. Let's see if anyone complains. The benefit is now you can search for both pretty and normal names. Nicely done!

[jitu5]

@tynandebold For this E.g. if prettyName is off and you search for Create mat you'll get back Create Matplot Chart, but in the flowchart the text of that node is create_matplotlib_chart.

Before the changes I did just now, it was returning correct text same as flowchart but it want highlighting because the enter text is pretty name (Create mat ) and returned text is non pretty name (create_matplotlib_chart).
But as you said we will see if anyone complains.