-
Notifications
You must be signed in to change notification settings - Fork 0
fix(seed): guarantee every displayed month of Monthly Revenue is in-band #38
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import { createTestApp, type TestAppContext } from '../setup/test-app'; | ||
| import { resetDatabase } from '../setup/db-utils'; | ||
| import { DashboardRepository } from '../../src/modules/organizations/dashboard.repository'; | ||
| import { demoSeed } from '../../src/database/seeds/seed'; | ||
| import { SEED_ORG_ID } from '../../src/database/seeds/fixtures/organizations'; | ||
|
|
||
| // Documented Monthly Revenue band — kept in lockstep with the baseline | ||
| // comment block in src/database/seeds/seed.ts. | ||
| const REVENUE_FLOOR = 40_000; | ||
| const REVENUE_CEILING = 200_000; | ||
| const DISPLAYED_MONTHS = 6; | ||
|
|
||
| describe('Integration: dashboard Monthly Revenue is healthy on every reseed', () => { | ||
| let ctx: TestAppContext; | ||
|
|
||
| beforeAll(async () => { | ||
| ctx = await createTestApp(); | ||
| // The demo seed clears every table itself, but reset first so a prior | ||
| // suite's data can never bleed into the aggregation under test. | ||
| await resetDatabase(ctx.pool); | ||
| await demoSeed(); | ||
| }, 180_000); | ||
|
|
||
| afterAll(async () => { | ||
| await ctx.close(); | ||
| }); | ||
|
|
||
| it('every month in the displayed window has revenue inside the documented band', async () => { | ||
| const repo = ctx.app.get(DashboardRepository); | ||
| const rows = await repo.getMonthlyRevenue(SEED_ORG_ID, DISPLAYED_MONTHS); | ||
|
|
||
| expect(rows).toHaveLength(DISPLAYED_MONTHS); | ||
|
|
||
| for (const row of rows) { | ||
| // No zero-start / mid-window gap on any reseed. | ||
| expect(row.total).toBeGreaterThan(0); | ||
| // Floor: chart always reads as an established business. | ||
| expect(row.total).toBeGreaterThanOrEqual(REVENUE_FLOOR); | ||
| // Ceiling: no single month spikes off the top of the axis. | ||
| expect(row.total).toBeLessThanOrEqual(REVENUE_CEILING); | ||
| } | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
UPDATEquery is inefficient as it executes the same subquery twice for every baseline invoice. More importantly, iftax_amountisNULLin the database (which is likely since it is not specified in the precedingINSERTstatement), thetotal_amountcalculation (subtotal + tax_amount) will result inNULL. This would cause the dashboard revenue aggregation to return 0 for that month, defeating the purpose of this baseline fix. Since we know the subtotal for these specific baseline invoices is exactlyperInvoice, we can optimize the query and useCOALESCEto ensure the total is correctly calculated.