feat: add first_usage filter on /volumes endpoint

[gfyrag]

Fixes LX-6

[coderabbitai]

Walkthrough

This pull request refactors the test setup by extracting the query hook creation into a dedicated variable with conditional debug configuration. In addition, a new "first_usage" filter is introduced in the volumes resource handler, updating both the dataset-building and filter resolution logic to include the "first_usage" column. Two new test cases are added to validate volumes retrieval—with and without a Point In Time (PIT) query—using this filter. No changes were made to exported or public entity declarations.

Changes

File(s)	Summary of Changes
internal/storage/ledger/main_test.go	Moved the bundebug import to a new line; refactored the TestMain function to create a hook variable for the query hook and conditionally set its Debug property based on DEBUG.
internal/storage/ledger/resource_volumes.go	Added a new "first_usage" filter in the filters() method; updated the buildDataset method to include the "first_usage" column using an updated SQL join; adjusted resolveFilter.
internal/storage/ledger/volumes_test.go	Introduced two new test cases in TestVolumesList to ensure correct volume retrieval with the "first_usage" filter, with one test including a Point In Time (PIT) scenario.

Sequence Diagram(s)

sequenceDiagram
  participant C as Client
  participant H as VolumesResourceHandler
  participant Q as Query Builder
  participant DB as Database

  C->>H: Request volumes list (with first_usage filter)
  H->>H: Apply filters() including "first_usage"
  H->>Q: Call buildDataset with accountsQuery adjustments
  Q->>H: Execute resolveFilter for "first_usage"
  H->>DB: Run SQL query with updated join and filter condition
  DB-->>H: Return query result
  H-->>C: Deliver filtered volumes list

Loading

Suggested reviewers

• flemzord
• Dav-14

Poem

I'm a rabbit in the codeyard, hopping through the night,
Tweaking hooks and filters, everything feels just right.
With "first_usage" bounds leaping like a joyful spree,
My little paws tap out a clever melody.
Here's to our changes—bright as a carrot's delight!
🐇🥕✨

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a929bff and 897c56e.

📒 Files selected for processing (3)

• internal/storage/ledger/main_test.go (2 hunks)
• internal/storage/ledger/resource_volumes.go (4 hunks)
• internal/storage/ledger/volumes_test.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Tests

🔇 Additional comments (9)

internal/storage/ledger/main_test.go (1)

47-49: Great refactoring of the query hook initialization.

This change improves code readability by separating the hook creation from its configuration. The previous implementation likely conditionally created and added the hook in a single step, while this approach is clearer by:

1. Creating the hook unconditionally
2. Setting the Debug property based on the environment variable
3. Adding the configured hook to the database

internal/storage/ledger/volumes_test.go (2)

106-133: Well-structured test case for the new first_usage filter.

The test effectively validates that the first_usage filter correctly identifies accounts that were first used before a specific timestamp. The assertions verify both the returned data count and the expected volume data for each relevant account.

---

135-163: Good coverage with PIT filter combination test.

This test thoroughly verifies the interaction between the first_usage filter and PIT functionality. The test cases logically build on each other, starting with basic filter verification and then adding the time-based constraint to ensure proper functionality in more complex scenarios.

internal/storage/ledger/resource_volumes.go (6)

32-37: Well-implemented filter definition for first_usage.

The implementation follows the established pattern for filters, supporting the standard operators ($lt, $gt, $lte, $gte, $match). This consistency makes the code more maintainable.

---

77-78: Correctly updated conditional logic to include first_usage filter.

The condition now properly checks if the first_usage filter is being used, maintaining the same pattern as other filters.

---

92-95: Good implementation of first_usage column selection.

The code correctly adds the first_usage column to both the accountsQuery and the selection when needed, following the same pattern as other dynamic columns.

---

97-99: Nice refactoring of the join clause.

This change improves the code by using accountsQuery directly in the join instead of a separate subquery, making the implementation more consistent.

---

129-144: Well-structured conditional handling for complex queries.

The implementation correctly handles Point-In-Time (PIT) queries with the first_usage filter, maintaining a consistent approach for generating lateral joins and column expressions.

---

174-175: Clean implementation of resolveFilter for first_usage.

The conversion of the filter operator to SQL syntax is handled consistently with other filters, generating the appropriate WHERE clause condition.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.55%. Comparing base (a929bff) to head (897c56e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #712      +/-   ##
==========================================
+ Coverage   81.49%   81.55%   +0.06%     
==========================================
  Files         133      133              
  Lines        7170     7180      +10     
==========================================
+ Hits         5843     5856      +13     
+ Misses       1023     1021       -2     
+ Partials      304      303       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.