anytype-heart icon indicating copy to clipboard operation
anytype-heart copied to clipboard

GO-3040 add ft fields to the objectSearch responses

Open requilence opened this issue 1 year ago • 1 comments

add fields to the ObjectSearch results: _block - contains the ID of block where the match was found _relation - contains the key of relation where the match was found _highlight - contains html of highlight in the form of here is the <mark>word</mark> I was looking for

I've decided not to add this fields as a real relations to the relations.json as it makes no sense and this is just a list of types.Struct we are using for the search results.

Summary by CodeRabbit

  • New Features

    • Introduced advanced search filters and sorting capabilities in the database querying system.
    • Added search result highlighting with HTML styling.
  • Enhancements

    • Improved the efficiency of data handling with a new function that maintains pointer integrity during struct copying.
  • Refactor

    • Restructured database filter configurations to include full-text metadata support.

requilence avatar Mar 12 '24 16:03 requilence

Walkthrough

The recent updates bring significant advancements to the object store's querying and search capabilities. New functions enhance relation handling, full-text search with highlighting, and metadata filtering. Deprecated RPC methods are replaced with more advanced search functions. The GitHub Actions workflow is also updated for improved compatibility and performance.

Changes

Files/Paths Change Summary
pkg/lib/localstore/objectstore/queries.go Added functions for querying objects, handling filters, sorting, and full-text search with highlights.
docs/proto.md Deprecated Rpc.Object.Search, added Rpc.Object.SearchWithMeta and related request/response structures.
pkg/lib/pb/model/protos/models.proto Added Search message with nested Result and Meta messages.
.github/workflows/test.yml Updated actions/checkout to v4, added actions/setup-go@v5, and modified gotestsum command.
pkg/lib/database/database.go Added fields and methods for full-text search and metadata handling in database records.
pb/protos/commands.proto Deprecated Search, introduced SearchWithMeta with new request and response fields.
pkg/lib/localstore/ftsearch/ftsearch.go Added HighlightFormatter type, updated Search method to handle highlighting.
pkg/lib/localstore/ftsearch/ftsearch_test.go Updated tests to validate full-text search with HTML highlighting.

In fields of code where queries bloom,
New functions rise to chase the gloom.
With highlights bright and searches keen,
Our data flows in streams unseen.
🐇✨ In bytes and bits, we find our tune,
As algorithms hum a joyful tune.
— CodeRabbit 🐰

[!TIP]

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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
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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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[bot] avatar Apr 18 '24 09:04 coderabbitai[bot]

New Coverage 44.8% of statements
Patch Coverage 64.9% of changed statements (174/268)


Coverage provided by https://github.com/seriousben/go-patch-cover-action

github-actions[bot] avatar May 22 '24 16:05 github-actions[bot]