fix(search): Search not returning result if query text contains forward slash

[siladitya2]

We recently discovered an issue while performing Search operation on Datahub.

Issue: When a search query text contains a forward slash /, Search result does not return the expected result.
As an example:
We have a dataset exists on datahub with Name: databox.arn:aws:s3:::dl-odin-pro-datalake-16vmobiqqrhwn/odin/v2/autotrader-au/notification
When we search with the query text databox.arn:aws:s3:::dl-odin-pro-datalake-16vmobiqqrhwn/odin/v2/autotrader-au/notification from Datahub UI or GraphQL API, the search result does not return any result.

Fix:
Instead of 4 preceding backslashes "\\\\" we need to use 2 preceding backslashes "\\" while escaping Forward Slash.(forward slash / is a reserved character in elastic search)

The Problem was when we were searching with an input query string databox.arn:aws:s3:::dl-odin-pro-datalake-16vmobiqqrhwn/odin/v2/autotrader-au/notification the escapeForwardSlash method of ResolverUtils.java converted the input query string into databox.arn:aws:s3:::dl-odin-pro-datalake-16vmobiqqrhwn\\/odin\\/v2\\/autotrader-au\\/notification(added 2 backward slashes) then the query string again JSON Stringified by SimpleQueryStringBuilder while building the Search Query, so the final query string became databox.arn:aws:s3:::dl-odin-pro-datalake-16vmobiqqrhwn\\\\/odin\\\\/v2\\\\/autotrader-au\\\\/notification with additional 2 extra back ward slashes (\). Due to this, the elastic search query was failed to return any record.

Test Result with the fix:

Note:
We also found that this class (datahub-frontend/app/utils/SearchUtil.java) also have the similar code

datahub/datahub-frontend/app/utils/SearchUtil.java

Line 23 in 82e5a04

input = input.replace("/", "\\\\/");

, but this is being used only from test cases. I updated the same as well in the PR.

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of forward slash escape sequences in search functionality.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The primary change modifies the escapeForwardSlash method in both SearchUtil and ResolverUtils to replace occurrences of / with \/ instead of \\\/. Corresponding test cases in SearchUtilTest were updated to reflect this change in the escape sequences for forward slashes.

Changes

File Path	Change Summary
.../app/utils/SearchUtil.java	Modified escapeForwardSlash to replace / with \\/ instead of \\\/.
.../test/utils/SearchUtilTest.java	Updated test cases to reflect changes in escaping forward slashes and asterisks.
.../graphql/resolvers/ResolverUtils.java	Modified escapeForwardSlash to replace / with \/ instead of \\\/.

Poem

In code's deep woods where slashes roam,
A tweak, a change, we now call home.
To / we add but one small line,
\/ it sings, a tune divine.
Tests will pass, the code refined,
Our paths escape, so well-aligned.
🌟🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 13b6feb and 6d44508.

Files selected for processing (1)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java (1 hunks)

Additional comments not posted (2)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java (2)

74-74: Correct implementation of forward slash escaping.

The change from \\\\/ to \\/ for escaping forward slashes is correct and aligns with ElasticSearch guidelines. This should resolve the issue with search queries containing forward slashes not returning expected results.

---

74-74: Verify the usage of escapeForwardSlash across the codebase.

Ensure that the change in the escaping logic does not affect other functionalities where this method is used.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d44508 and bf469c7.

Files selected for processing (3)

• datahub-frontend/app/utils/SearchUtil.java (1 hunks)
• datahub-frontend/test/utils/SearchUtilTest.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java

Additional comments not posted (3)

datahub-frontend/test/utils/SearchUtilTest.java (2)

11-11: Updated test case for escaping forward slashes.

The test case correctly reflects the new escape sequence for forward slashes, aligning with the changes in the escapeForwardSlash method.

---

14-14: Updated test case for mixed characters.

This test case ensures that forward slashes are escaped while asterisks are not, maintaining regex behavior. It properly tests the updated functionality.

datahub-frontend/app/utils/SearchUtil.java (1)

23-23: Correct implementation of the forward slash escaping.

The modification in escapeForwardSlash method correctly updates the escape sequence for forward slashes (/ to \\/). This change aligns with the PR's objective to fix search issues related to forward slashes in Elasticsearch queries.

[david-leifker]

I think the issue here is that SimpleQueryStringBuilder is not always involved in the query. For the cases when SimpleQueryStringBuilder is not used I believe the quoting is correct. We likely need to apply your suggested change only when SimpleQueryStringBuilder is used.

[siladitya2]

I think the issue here is that SimpleQueryStringBuilder is not always involved in the query. For the cases when SimpleQueryStringBuilder is not used I believe the quoting is correct. We likely need to apply your suggested change only when SimpleQueryStringBuilder is used.

@david-leifker
The same problem exists with other Query Builders as well.
As an example, I found the same issue for match_phrase, match_phrase_prefix, term as well.
Please find below query generated for above-mentioned Query Builders for the same search input string.

{
              "match_phrase" : {
                "qualifiedName.wordGrams2" : {
                  "query" : "dl-odin-pro-datalake-16vmobiqqrhwn\\\\/odin\\\\/v2\\\\/autotrader-au\\\\/notification",
                  "slop" : 0,
                  "zero_terms_query" : "NONE",
                  "boost" : 14.400001,
                  "_name" : "qualifiedName"
                }
              }
            }

    {
              "match_phrase_prefix" : {
                "fullName.delimited" : {
                  "query" : "dl-odin-pro-datalake-16vmobiqqrhwn\\\\/odin\\\\/v2\\\\/autotrader-au\\\\/notification",
                  "slop" : 0,
                  "max_expansions" : 50,
                  "zero_terms_query" : "NONE",
                  "boost" : 4.48,
                  "_name" : "fullName"
                }
              }
            }

            {
              "term" : {
                "type.keyword" : {
                  "value" : "dl-odin-pro-datalake-16vmobiqqrhwn\\\\/odin\\\\/v2\\\\/autotrader-au\\\\/notification",
                  "case_insensitive" : true,
                  "boost" : 7.0,
                  "_name" : "type"
                }
              }
            }

So considering this, I think that the fix provided on this PR on datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java should be necessary to fix this issue, wdyt?

[david-leifker]

Thanks!