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

feat: Add initial retention policy #121

Merged
merged 1 commit into from
Apr 16, 2024

Conversation

isZumpo
Copy link
Contributor

@isZumpo isZumpo commented Apr 15, 2024

As mentioned, I wanted to give the simple retention policy a try. Anything is better than nothing as my raspberry keeps running out of space otherwise. I am still trying out this change locally and might make some more changes to it. However, I thought it could still be a good idea to open up this pull request to get some feedback on the idea itself and the code.

The simple retention policy works by every minute, querying the database for clips older than minEvictionHours, for these clips, it will then remove those for species that have more than minClipsPerSpecies. Always removing the oldest clips first.

I am a bit uncertain of where to place all the logic. Right now I jammed it into the realtime.go and interface.go, but there might be better places to put it? In addition, it has to be decided if this is a feature which should be enabled by default or not. In addition, the spectrogram images are currently saved to the clips folder too, I wonder if it might be better to move them to some other cached directory?

Summary by CodeRabbit

  • New Features
    • Introduced automated clip cleanup based on retention policies to manage storage efficiently.
  • Enhancements
    • Updated settings to allow configuration of clip retention parameters.
  • Tests
    • Added tests to ensure proper identification and removal of clips according to the new retention policies.

Copy link
Contributor

coderabbitai bot commented Apr 15, 2024

Walkthrough

The recent update introduces a system for monitoring and automatically deleting clips based on a retention policy. This involves initializing the monitoring process, determining which clips qualify for deletion, and executing the removal process. Configuration settings have been updated to include parameters that define the retention criteria.

Changes

File Path Change Summary
internal/analysis/... Added functions for initializing and running clip cleanup monitoring.
internal/conf/config.go Updated Settings struct to include retention parameters.
internal/datastore/... Enhanced interface with methods for clip removal and added tests for new functionality.

🐇✨
In the burrow of the code, deep and wide,
A cleanup crew now does reside.
Old clips fade, new space is found,
In digital fields, where bytes abound.
Hop, skip, a jump in the code's weave,
A tidy den, as we perceive. 🌟
🐇✨


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1659c9a and 365730a.
Files selected for processing (4)
  • internal/analysis/realtime.go (5 hunks)
  • internal/conf/config.go (2 hunks)
  • internal/datastore/interfaces.go (3 hunks)
  • internal/datastore/interfaces_test.go (1 hunks)
Additional Context Used
GitHub Check Runs (1)
lint failure (5)

internal/analysis/realtime.go: [failure] 179-179:
Error return value of dataStore.DeleteNoteClipPath is not checked (errcheck)


internal/datastore/interfaces_test.go: [failure] 38-38:
Error return value of dataStore.Save is not checked (errcheck)


internal/datastore/interfaces_test.go: [failure] 43-43:
Error return value of dataStore.Save is not checked (errcheck)


internal/datastore/interfaces_test.go: [failure] 48-48:
Error return value of dataStore.Save is not checked (errcheck)

Additional comments not posted (3)
internal/datastore/interfaces_test.go (3)

11-25: Setup and teardown of the test database are handled correctly.


43-43: Similar to the previous comment, the error return value of dataStore.Save is not checked here as well.


48-48: Again, ensure to check the error return value from dataStore.Save.


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.

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: 1

// No Amazing bird should be removed since there is only one
// While there are two Wonderful birds, only one of them are old enough, but too few to be removed
// While there are two Magnificent birds, only one of them have a clip, meaning that the remaining one should be kept
dataStore.Save(&Note{
Copy link
Contributor

Choose a reason for hiding this comment

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

Error return value of dataStore.Save is not checked. Consider handling this to avoid uncaught errors during tests.

- dataStore.Save(&Note{...}, []Results{})
+ if err := dataStore.Save(&Note{...}, []Results{}); err != nil {
+     t.Fatalf("Failed to save note: %v", err)
+ }

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
dataStore.Save(&Note{
if err := dataStore.Save(&Note{

@tphakala tphakala changed the title Add initial retention policy feat: Add initial retention policy Apr 16, 2024
@tphakala tphakala merged commit 784b06f into tphakala:main Apr 16, 2024
3 of 4 checks passed
@tphakala
Copy link
Owner

Thank you, merged.

@isZumpo
Copy link
Contributor Author

isZumpo commented Apr 16, 2024

That went way quicker than expected. Suppose that we will have to work out those questions as we go instead.

@isZumpo isZumpo deleted the initial_retention_policy branch April 16, 2024 20:45
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