Skip to content

Conversation

@turip
Copy link
Member

@turip turip commented May 26, 2025

Overview

Given that product catalog drives invoicing (we are not used as standalone invoicing engine) and flat price only supports qty=1 we are no longer allowing flat fee lines with other qty on the invoice's root.

Detailed lines are also represented as flat fee lines, there we allow qty to be anything positive.

Summary by CodeRabbit

  • Bug Fixes

    • Improved validation for invoice line quantities, enforcing stricter rules for valid lines to ensure accuracy in billing.
  • Tests

    • Updated test cases to reflect new quantity requirements for invoice lines, ensuring alignment with the revised validation logic.

Given that product catalog drives invoicing (we are not used as standalone
invoicing engine) and flat price only supports qty=1 we are no longer
allowing flat fee lines with other qty on the invoice's root.

Detailed lines are also represented as flat fee lines, there we allow qty
to be anything positive.
@turip turip requested a review from a team as a code owner May 26, 2025 11:36
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 26, 2025

📝 Walkthrough

Walkthrough

The changes update invoice line validation logic to enforce that valid flat fee lines must have a quantity of 1, while other statuses require only a positive quantity. Corresponding test data is updated to set affected invoice line quantities from 3 to 1, ensuring alignment with the new validation rules. No changes to function signatures occurred.

Changes

Files/Groups Change Summary
openmeter/billing/invoiceline.go Updated ValidateFee() logic: valid flat fee lines require quantity of 1; other statuses require positive quantity.
test/app/custominvoicing/invocing_test.go Updated test invoice line quantities from 3 to 1 and per-unit amount from 200 to 600 in two test functions.
test/billing/invoice_test.go Changed invoice line quantities from 3 to 1 in TestPendingLineCreation and TestCreateInvoice.
test/billing/suite.go Changed the second invoice line's quantity from 3 to 1 in CreateGatheringInvoice.

Possibly related PRs

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

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@turip turip added release-note/breaking-change Release note: Breaking Changes area/billing labels May 26, 2025
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: 0

🧹 Nitpick comments (1)
openmeter/billing/invoiceline.go (1)

518-531: Validation logic correctly implements the flat fee quantity requirements.

The conditional validation properly enforces:

  • Quantity = 1 for valid invoice lines (root level)
  • Positive quantity for other statuses (detailed lines)

The inline comments provide good context about the product catalog constraint driving this requirement.

Consider making the error message more descriptive to help users understand the constraint:

-			errs = append(errs, errors.New("quantity should be 1 for invoice's flat fee lines"))
+			errs = append(errs, errors.New("quantity must be exactly 1 for flat fee lines (product catalog constraint)"))
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 16960d1 and a165463.

📒 Files selected for processing (4)
  • openmeter/billing/invoiceline.go (1 hunks)
  • test/app/custominvoicing/invocing_test.go (2 hunks)
  • test/billing/invoice_test.go (2 hunks)
  • test/billing/suite.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: Artifacts / Container image
  • GitHub Check: E2E
  • GitHub Check: CI
  • GitHub Check: Quickstart
  • GitHub Check: Lint
  • GitHub Check: Developer environment
  • GitHub Check: Commit hooks
  • GitHub Check: Test
  • GitHub Check: Migration Checks
  • GitHub Check: Build
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (go)
🔇 Additional comments (5)
test/app/custominvoicing/invocing_test.go (2)

194-194: LGTM! Test data correctly updated for new validation rule.

The quantity has been properly changed from 3 to 1 to comply with the new validation rule that flat fee lines must have a quantity of exactly 1.


362-363: LGTM! Test data correctly updated to preserve total amount.

The changes correctly maintain the same total billing amount (3 × 200 = 1 × 600 = 600) while complying with the new validation rule that requires flat fee lines to have a quantity of 1. This ensures the test logic remains valid while adhering to the updated constraints.

test/billing/invoice_test.go (2)

180-182: LGTM! Test data updated to comply with new flat fee validation rule.

The quantity change from 3 to 1 correctly aligns with the new validation requirement that flat fee lines must have a quantity of exactly 1.


495-497: LGTM! Consistent update for flat fee quantity validation.

This change mirrors the previous update, ensuring all flat fee lines in the test suite comply with the new quantity=1 validation rule.

test/billing/suite.go (1)

370-370: Test data correctly updated to comply with new validation rules.

The quantity change from 3 to 1 aligns with the new requirement that flat fee lines at the invoice's root level must have a quantity of 1.

@turip turip enabled auto-merge (squash) May 26, 2025 11:39
@turip turip merged commit ff857f1 into main May 26, 2025
28 of 29 checks passed
@turip turip deleted the deprecation/only-allow-top-level-flat-fees-with-qty-1 branch May 26, 2025 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/billing release-note/breaking-change Release note: Breaking Changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants