Add property tests for the billing fee engine's decimal money arithmetic in services/billing/feeEngine.ts#656
Open
barnabasolutayo-lgtm wants to merge 1 commit into
Conversation
…rithmetic Verifies fee+net==gross, add commutativity/associativity, and monotonicity across generated decimal inputs in services/billing/feeEngine.ts.
|
@barnabasolutayo-lgtm Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
##closes #630
Description
This PR introduces robust, deterministic property-based testing using
fast-checkto assert the algebraic invariants of the billing fee engine (src/services/billing/feeEngine.ts). By replacing simple example-based testing with randomized inputs spanning edge cases, we ensure mathematical correctness and prevent IEEE-754 precision drift or carry bugs in our financial logic.Invariants Asserted
applyFeesInvariant (fee + net == gross): Asserts thatbaseAmount.amount + feeAmount.amount === totalAmount.amountacross all inputs.addMoneyStringsAlgebraic Properties (tested via public proxycalculateFeeanddecimalMathhelpers):add(a, b) == add(b, a)add(add(a, b), c) == add(a, add(b, c))calculateFeeis monotonic non-decreasing in the amount for any fixed rate.parseNonNegativeDecimalrejects negative numbers, NaN values, and malformed structures.base * rate / 100is exactly representable within the target currency's configured scale, the returned fee matches it exactly.Verification Results
Automated Test Runs
Tests were verified using
vitest:npx vitest run src/services/billing/feeEngine.property.test.ts src/services/billing/feeEngine.test.ts Verifies fee+net==gross, add commutativity/associativity, and monotonicity across generated decimal inputs in services/billing/feeEngine.ts.