Skip to content

Comments

Updates of fuzziness rules for tokens search#277

Merged
RanaBug merged 1 commit intostagingfrom
feat/PRO-3166/search-contract-address
Mar 28, 2025
Merged

Updates of fuzziness rules for tokens search#277
RanaBug merged 1 commit intostagingfrom
feat/PRO-3166/search-contract-address

Conversation

@RanaBug
Copy link
Collaborator

@RanaBug RanaBug commented Mar 28, 2025

Description

  • Updates of fuzziness rules for tokens search

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Summary by CodeRabbit

  • New Features
    • Enhanced search functionality for more precise results.
    • Long queries are now automatically formatted for exact matching, ensuring improved accuracy.
    • Adjusted search parameters for better consistency in results.

@RanaBug RanaBug requested a review from IAmKio March 28, 2025 16:30
@RanaBug RanaBug self-assigned this Mar 28, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 28, 2025

Walkthrough

This pull request modifies the search logic within the searchTokens function in the src/services/tokensData.ts file. The changes adjust the Fuse instance configuration by removing the blockchain key and lowering the threshold from 0.3 to 0.2. New properties—minMatchCharLength set to 3 and useExtendedSearch enabled—are introduced. Additionally, the search query construction now includes logic to format queries longer than 40 characters as exact match strings, while the results continue to be processed by mapping over the returned items.

Changes

File Changes Summary
src/services/tokensData.ts Updated searchTokens function: removed blockchain from Fuse keys, changed threshold from 0.3 to 0.2, added minMatchCharLength: 3 and useExtendedSearch: true; added logic to format long queries (length > 40) as exact match strings.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as searchTokens Function
    participant F as Fuse Instance
    participant M as Mapping of Results

    U->>S: Initiate token search with query
    S->>S: Check if query length > 40
    alt Query length > 40
        S->>S: Format query as exact match (="query")
    else
        S->>S: Use query as provided
    end
    S->>F: Execute Fuse search with updated configuration
    F-->>S: Return search results
    S->>M: Map results to extract item property
    M-->>S: Processed results returned
    S-->>U: Return final search results
Loading

Possibly related PRs

Suggested reviewers

  • IAmKio

Poem

I hopped through code on a bright spring day,
Adjusting fuse logic in a nimble display.
With queries refined and settings so neat,
I skip through tokens on tiny, quick feet.
A bunny’s delight in each line of code—
Hopping on changes down the innovation road!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Collaborator

@IAmKio IAmKio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/services/tokensData.ts (2)

213-217: Search key and threshold adjustments

The changes to the Fuse configuration have several impacts:

  1. Removing 'blockchain' from search keys means users can no longer search by chain names
  2. Lowering the threshold from (likely) 0.3 to 0.2 makes matching more permissive
  3. Adding minMatchCharLength ensures more relevant results despite the lower threshold
  4. Enabling extended search supports the exact matching syntax

Was removing 'blockchain' from searchable keys intentional? This will prevent users from finding tokens by typing chain names like "Ethereum" or "Polygon". If this was intentional (perhaps because UI provides chain filtering separately), please add a comment explaining this decision.


219-221: Comment doesn't match implementation

The comment states "Check if query length is above 20 characters" but the code checks for > 40 characters.

Update the comment to match the implementation:

-  // Check if query length is above 20 characters have an exact match
+  // Check if query length is above 40 characters for an exact match
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc3491b and 5f6c480.

📒 Files selected for processing (1)
  • src/services/tokensData.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: unit-tests
  • GitHub Check: Cloudflare Pages
  • GitHub Check: build
🔇 Additional comments (1)
src/services/tokensData.ts (1)

219-222: Exact matching for long queries is a good approach

Using exact matching for queries longer than 40 characters is excellent for handling contract addresses, where fuzzy matching could lead to incorrect matches between similar-looking but different addresses.

This approach improves search precision for contract addresses while maintaining fuzzy searching for token names and symbols.

@cloudflare-workers-and-pages
Copy link

Deploying x with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5f6c480
Status: ✅  Deploy successful!
Preview URL: https://2ebb9ef7.x-e62.pages.dev
Branch Preview URL: https://feat-pro-3166-search-contrac.x-e62.pages.dev

View logs

@RanaBug RanaBug merged commit ff19601 into staging Mar 28, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants