Skip to content

Conversation

@turip
Copy link
Member

@turip turip commented May 6, 2025

Overview

Make sure we populate invoice_at.

Let's add testcases, let's have a basic backfill.

Summary by CodeRabbit

  • Bug Fixes

    • Ensured invoices are assigned an issuance timestamp when finalized, enhancing invoice record accuracy.
  • Tests

    • Added verification that invoices have an issuance timestamp upon reaching the paid status.
  • Chores

    • Added a database migration to backfill missing issuance timestamps for existing invoices.

@turip turip requested a review from a team as a code owner May 6, 2025 18:32
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 6, 2025

📝 Walkthrough

Walkthrough

A conditional update was added to set the invoice issuance timestamp during finalization in the billing service. A corresponding test assertion checks that this timestamp is set when an invoice reaches the paid state. Additionally, a new SQL migration backfills missing issuance timestamps for certain invoice statuses, with a no-op down migration.

Changes

Files/Paths Change Summary
openmeter/billing/service/invoicestate.go Added logic to set the IssuedAt timestamp to the current UTC time during invoice finalization if it was previously unset.
test/app/custominvoicing/invocing_test.go Added an assertion verifying the IssuedAt timestamp is not nil when the invoice status is paid in the invoicing flow test.
tools/migrate/migrations/20250506182753_backfill-invoice-at.up.sql Added migration script to backfill issued_at with updated_at for invoices with certain statuses where issued_at is NULL.
tools/migrate/migrations/20250506182753_backfill-invoice-at.down.sql Added a no-op down migration script for the backfill migration.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2


📜 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 d7d0853 and 459b971.

⛔ Files ignored due to path filters (1)
  • tools/migrate/migrations/atlas.sum is excluded by !**/*.sum
📒 Files selected for processing (4)
  • openmeter/billing/service/invoicestate.go (1 hunks)
  • test/app/custominvoicing/invocing_test.go (1 hunks)
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.down.sql (1 hunks)
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.up.sql (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.down.sql
  • test/app/custominvoicing/invocing_test.go
  • openmeter/billing/service/invoicestate.go
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.up.sql
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Quickstart
  • GitHub Check: E2E
  • GitHub Check: CI
  • GitHub Check: Developer environment
  • GitHub Check: Commit hooks
  • GitHub Check: Lint
  • GitHub Check: Test
  • GitHub Check: Migration Checks
  • GitHub Check: Build
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (go)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8c0b7bb and d7d0853.

⛔ Files ignored due to path filters (1)
  • tools/migrate/migrations/atlas.sum is excluded by !**/*.sum
📒 Files selected for processing (4)
  • openmeter/billing/service/invoicestate.go (1 hunks)
  • test/app/custominvoicing/invocing_test.go (1 hunks)
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.down.sql (1 hunks)
  • tools/migrate/migrations/20250506182753_backfill-invoice-at.up.sql (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: Artifacts / Benthos Collector Container image
  • GitHub Check: Artifacts / Container image
  • GitHub Check: Test
  • GitHub Check: Quickstart
  • GitHub Check: Migration Checks
  • GitHub Check: Lint
  • GitHub Check: E2E
  • GitHub Check: Developer environment
  • GitHub Check: CI
  • GitHub Check: Commit hooks
  • GitHub Check: Build
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (go)
🔇 Additional comments (3)
tools/migrate/migrations/20250506182753_backfill-invoice-at.down.sql (1)

1-1: Empty down migration is appropriate

This no-op down migration is appropriate since the backfill operation adds missing timestamp data that doesn't need to be reversed.

test/app/custominvoicing/invocing_test.go (1)

313-313: Good validation of invoice timestamp

This assertion ensures that invoices have their issuance timestamp properly set when they reach the paid state, which aligns with the PR objective.

tools/migrate/migrations/20250506182753_backfill-invoice-at.up.sql (1)

1-6: Comprehensive backfill for invoice timestamps

This migration properly updates the issued_at field for all relevant invoice statuses where the timestamp is missing. Using updated_at as the backfill value provides a reasonable approximation of when the invoice was issued.

@turip turip force-pushed the fix/populate-invoice-at branch from d7d0853 to 459b971 Compare May 6, 2025 18:35
@turip turip added the release-note/bug-fix Release note: Bug Fixes label May 6, 2025
@turip turip merged commit e6e6f3c into main May 6, 2025
29 of 30 checks passed
@turip turip deleted the fix/populate-invoice-at branch May 6, 2025 18:51
@coderabbitai coderabbitai bot mentioned this pull request Oct 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note/bug-fix Release note: Bug Fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants