这是indexloc提供的服务，不要输入任何密码
Skip to content

feat: garbage collector test is added covering issue 1471 #1486

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 23, 2024
Merged

feat: garbage collector test is added covering issue 1471 #1486

merged 1 commit into from
Aug 23, 2024

Conversation

@ucatbas
Copy link
Contributor

@ucatbas ucatbas commented Aug 23, 2024 •
edited by coderabbitai bot
Loading

This PR is created to eliminate any bugs may occur in the future as Issue-1471.

I have added a garbage collector test under gc package. Here are the steps of the scenario:

  • Set up the database connection and permission client before each test to ensure a clean environment.
  • Create a new tenant to keep the data isolated.
  • Write the schema to the database for the tenant.
  • Insert and delete data, then perform permission checks to validate the state.
  • Run the garbage collector to clean up any stale data.

Permission Validation: After each step (insertion, deletion, and GC), perform permission checks to confirm the expected state.

Summary by CodeRabbit

  • New Features

    • Introduced a new utility function to compare string arrays for equality, regardless of order.
    • Added comprehensive tests for the Garbage Collector functionality, validating permission checks and data management.

  • Refactor

    • Updated the database instance initialization in various test suites to source from the new instance package, enhancing modularity and encapsulation.

  • Bug Fixes

    • Ensured that the overall control flow and functionality of existing tests remain intact after database initialization changes.

@ucatbas ucatbas requested a review from tolgaozen August 23, 2024 11:50
@vercel
Copy link

vercel bot commented Aug 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
permify ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 23, 2024 11:50am

@coderabbitai
Copy link

coderabbitai bot commented Aug 23, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve a refactoring of database initialization across multiple test files in the PostgreSQL storage module. The previous method of instantiating the database directly through postgresDB(version) has been replaced with instance.PostgresDB(version). Additionally, a new utility function isSameArray has been introduced for comparing string arrays, and the structure of the instance package has been modified for improved modularity.

Changes

Files Changed Change Summary
internal/storage/postgres/*.go Database initialization modified from postgresDB(version) to instance.PostgresDB(version) in multiple test files, including bundleReader_test.go, bundleWriter_test.go, dataReader_test.go, dataWriter_test.go, schemaReader_test.go, schemaWriter_test.go, tenantReader_test.go, tenantWriter_test.go, and watch_test.go.
internal/storage/postgres/consts.go New function isSameArray added for comparing string arrays.
internal/storage/postgres/instance/instance.go Package renamed from postgres to instance; function postgresDB renamed to PostgresDB to export it. isSameArray function removed.
internal/storage/postgres/gc/gc_test.go New file added for unit tests related to GarbageCollector.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Suite
    participant Instance as Instance Package
    participant DB as Database

    Test->>Instance: Call PostgresDB(version)
    Instance->>DB: Instantiate Database Connection
    DB-->>Instance: Return Database Instance
    Instance-->>Test: Return Database Instance
Loading

🐇 In the realm where code does dance,
A rabbit hops, taking a chance.
With instances now, we forge anew,
Connections bright, in lines so true.
A function added, arrays we compare,
In our code garden, we nurture with care! 🌼

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

@tolgaozen tolgaozen merged commit fbb624a into master Aug 23, 2024
@coderabbitai coderabbitai bot mentioned this pull request Sep 30, 2024
Open
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2024
Closed
@tolgaozen tolgaozen deleted the ufuk/gc-test branch February 3, 2025 08:45
This was referenced Sep 3, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tolgaozen tolgaozen Awaiting requested review from tolgaozen

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ucatbas @tolgaozen