Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GO-3733 Search: do not inject tag/types results for deleted/archived objects #1378

Merged
merged 4 commits into from
Jul 10, 2024

Conversation

requilence
Copy link
Contributor

No description provided.

@requilence requilence changed the title GO-3733 Search: do not inject tag/types result for deleted/archived objects GO-3733 Search: do not inject tag/types results for deleted/archived objects Jul 9, 2024
Copy link

coderabbitai bot commented Jul 9, 2024

Walkthrough

A check for isDeleted and isArchived flags was added to the getInjectedResults function in dsObjectStore to filter out deleted or archived objects by returning nil. Corresponding test objects and cases were introduced to ensure proper full-text search behavior for objects marked as deleted or archived.

Changes

File Change Summary
pkg/lib/localstore/objectstore/queries.go Added checks for isDeleted and isArchived flags in getInjectedResults to filter out objects.
pkg/lib/localstore/objectstore/queries_test.go Introduced new test objects relObjDeleted and relObjArchived, and added test cases for full-text search based on deletion and archival tags.

Poem

In the code, a tale unfolds,
Of objects archived, and others sold,
Deleted now, they fade from view,
With tests to guide, as code renews.
A rabbit hops with joy and cheer,
For cleaner code, let’s give a cheer!
🐰🎉


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.
    • @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 as 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.

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.

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7059138 and 3e6f967.

Files selected for processing (1)
  • pkg/lib/localstore/objectstore/queries.go (1 hunks)
Additional comments not posted (2)
pkg/lib/localstore/objectstore/queries.go (2)

59-63: LGTM! Ensure edge cases are covered.

The added checks for isDeleted and isArchived flags are appropriate to prevent injecting results for deleted or archived objects.

Verify if there are any edge cases where the flags might not be set correctly or additional flags need to be considered.


70-71: LGTM! Default case in switch statement.

The default case in the switch statement is a good safeguard to handle unrecognized object types.

Copy link

github-actions bot commented Jul 9, 2024

New Coverage 46.8% of statements
Patch Coverage 100.0% of changed statements (6/6)

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

Copy link
Contributor

@fat-fellow fat-fellow left a comment

Choose a reason for hiding this comment

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

tests?

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3e6f967 and 3ea1e1e.

Files selected for processing (1)
  • pkg/lib/localstore/objectstore/queries_test.go (2 hunks)
Additional comments not posted (3)
pkg/lib/localstore/objectstore/queries_test.go (3)

254-261: Addition of relObjDeleted looks good.

The new test object relObjDeleted is correctly defined with the appropriate fields set to simulate a deleted relation.


270-270: Inclusion of relObjDeleted in the test setup.

The relObjDeleted object is correctly included in the AddObjects call to ensure it is part of the test data.


553-568: New test case for full-text search by deleted tag.

The test case correctly verifies that a full-text search by the deleted tag returns no results. This ensures that deleted objects are not included in search results.

Copy link
Contributor

@fat-fellow fat-fellow left a comment

Choose a reason for hiding this comment

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

1

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3ea1e1e and e25690c.

Files selected for processing (1)
  • pkg/lib/localstore/objectstore/queries_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • pkg/lib/localstore/objectstore/queries_test.go

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e25690c and a5076d9.

Files selected for processing (1)
  • pkg/lib/localstore/objectstore/queries_test.go (6 hunks)
Files skipped from review as they are similar to previous changes (1)
  • pkg/lib/localstore/objectstore/queries_test.go

@requilence requilence merged commit b451084 into main Jul 10, 2024
5 checks passed
@requilence requilence deleted the go-3733-deleted-tag-values-appear-in-search-results branch July 10, 2024 16:13
@github-actions github-actions bot locked and limited conversation to collaborators Jul 10, 2024
bundle.RelationKeyId: pbtypes.String("relid3"),
bundle.RelationKeyRelationKey: pbtypes.String("bsonid1"),
bundle.RelationKeyName: pbtypes.String("archived"),
bundle.RelationKeyIsDeleted: pbtypes.Bool(true),
Copy link
Member

Choose a reason for hiding this comment

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

@requilence this should be bundle.RelationKeyIsArchived?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nope, it's just a name of the object I use to search :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants