Update crop residue biomass calculation and adjust related test cases by SvenVw · Pull Request #207 · nmi-agro/fdm

SvenVw · 2025-07-29T13:29:34Z

Summary by CodeRabbit

Bug Fixes
- Corrected the calculation of crop residue biomass in nitrogen balance computations, resulting in updated nitrogen removal and volatilization values.
Tests
- Updated test cases to reflect changes in calculation logic and adjusted expected results accordingly. Input data for tests now includes explicit date ranges for cultivations.

Closes #203

…ters

changeset-bot · 2025-07-29T13:29:38Z

🦋 Changeset detected

Latest commit: a088e0d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@svenvw/fdm-calculator	Patch
@svenvw/fdm-app	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-07-29T13:29:41Z

Walkthrough

The changes update the calculation of crop residue biomass in nitrogen balance and volatilization functions by dividing the yield by the harvest index before applying residue and nitrogen content factors. Corresponding test cases were updated to include explicit cultivation date ranges and adjusted expected values to match the revised calculation.

Changes

Cohort / File(s)	Change Summary
Calculation Logic: Nitrogen Residue & Volatilization `fdm-calculator/src/balance/nitrogen/removal/residue.ts`, `fdm-calculator/src/balance/nitrogen/volatization/residues.ts`	Modified formulas to divide yield by harvest index before multiplying by residue and nitrogen content factors in both nitrogen removal and volatilization calculations.
Test Updates: Nitrogen Removal & Residue `fdm-calculator/src/balance/nitrogen/removal/index.test.ts`, `fdm-calculator/src/balance/nitrogen/removal/residue.test.ts`	Added explicit `b_lu_start` and `b_lu_end` dates to cultivation objects; updated expected nitrogen removal values to reflect new calculation logic.
Test Updates: Nitrogen Volatilization `fdm-calculator/src/balance/nitrogen/volatization/residues.test.ts`	Added explicit cultivation date ranges and updated expected volatilization values to match new calculation.
Documentation/Changelog `.changeset/sour-kings-drive.md`	Added a changeset entry summarizing the fix to residue biomass calculation in nitrogen balance.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NitrogenRemoval
    participant NitrogenVolatilization
    participant CultivationData

    User->>NitrogenRemoval: Request nitrogen removal calculation
    NitrogenRemoval->>CultivationData: Fetch yield, harvest index, residue factors
    NitrogenRemoval->>NitrogenRemoval: Compute (yield / harvest index) * residue * N-content
    NitrogenRemoval-->>User: Return updated nitrogen removal

    User->>NitrogenVolatilization: Request volatilization calculation
    NitrogenVolatilization->>CultivationData: Fetch yield, harvest index, residue factors, emission factor
    NitrogenVolatilization->>NitrogenVolatilization: Compute (yield / harvest index) * residue * N-content * emission
    NitrogenVolatilization-->>User: Return updated volatilization value

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Fix calculation for residue biomass at nitrogen balance (#203)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Hotfix/20250618 nutrient balance #169: Also modifies nitrogen removal and volatilization residue calculations for robustness, affecting similar functions.
Correct the values for b_lu_yield at brp cultivation catalogue #202: Updates raw yield data used in the same calculations, but does not alter calculation logic.

Suggested labels

fdm-calculator

Suggested reviewers

gerardhros

Poem

In fields of code where residues lie,
A rabbit hopped by with a keen, bright eye.
"Divide by the index!" it thumped in delight,
Now nitrogen counts are finally right.
With harvest and yield in perfect array,
The bunny declares: "It's a balanced day!"
🐇🌾

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 26d1142 and a088e0d.

📒 Files selected for processing (6)

.changeset/sour-kings-drive.md (1 hunks)
fdm-calculator/src/balance/nitrogen/removal/index.test.ts (3 hunks)
fdm-calculator/src/balance/nitrogen/removal/residue.test.ts (8 hunks)
fdm-calculator/src/balance/nitrogen/removal/residue.ts (1 hunks)
fdm-calculator/src/balance/nitrogen/volatization/residues.test.ts (9 hunks)
fdm-calculator/src/balance/nitrogen/volatization/residues.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (7)

📓 Common learnings

Learnt from: SvenVw
PR: SvenVw/fdm#134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: SvenVw/fdm#156
File: fdm-calculator/src/norms/nl/2025/stikstofgebruiksnorm.ts:295-303
Timestamp: 2025-07-21T12:06:07.070Z
Learning: Functions in the fdm-calculator with "NL2025" in their names are specifically designed for Netherlands 2025 agricultural norms calculation and hardcoded 2025 dates are appropriate in this context, as different years would have separate calculation modules.

Learnt from: SvenVw
PR: SvenVw/fdm#134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

fdm-calculator/src/balance/nitrogen/volatization/residues.test.ts (8)

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: #9
File: fdm-data/src/cultivations/index.test.ts:57-59
Timestamp: 2024-11-27T12:15:36.425Z
Learning: In fdm-data/src/cultivations/index.test.ts, the fdm object created by drizzle does not have an .end() method. Cleanup code should not attempt to call fdm.end();.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

Learnt from: SvenVw
PR: #9
File: fdm-data/src/cultivations/index.test.ts:57-59
Timestamp: 2024-11-27T11:27:27.797Z
Learning: When cleaning up test data in afterAll hooks in fdm-data/src/cultivations/index.test.ts, use fdm.delete(schema.tableName).execute(); to delete rows from a table without dropping the table itself.

Learnt from: SvenVw
PR: #156
File: fdm-calculator/src/norms/nl/2025/stikstofgebruiksnorm.ts:295-303
Timestamp: 2025-07-21T12:06:07.070Z
Learning: Functions in the fdm-calculator with "NL2025" in their names are specifically designed for Netherlands 2025 agricultural norms calculation and hardcoded 2025 dates are appropriate in this context, as different years would have separate calculation modules.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/db/schema.ts:407-426
Timestamp: 2025-01-23T15:18:57.212Z
Learning: In the farm data model, each cultivation (b_lu) can have only one termination date but can have multiple harvest dates. This is enforced through the database schema where cultivationTerminating uses b_lu as primary key while cultivationHarvesting uses a composite primary key of b_id_harvestable and b_lu.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.cultivation.$b_lu.harvest.$b_id_harvesting.tsx:114-124
Timestamp: 2025-02-13T08:35:59.306Z
Learning: The HarvestForm component in fdm-app expects undefined (not 0) for b_lu_yield when no yield information is available, as 0 would incorrectly imply that yield data exists.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/cultivation.ts:625-671
Timestamp: 2025-01-24T11:39:57.805Z
Learning: Every cultivation has an associated cultivationTerminating record created by addCultivation, with b_terminate_date initially set to null. Therefore, updateCultivation can safely assume the record exists and only needs to handle updates.

fdm-calculator/src/balance/nitrogen/volatization/residues.ts (4)

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.cultivation.$b_lu.harvest.$b_id_harvesting.tsx:114-124
Timestamp: 2025-02-13T08:35:59.306Z
Learning: The HarvestForm component in fdm-app expects undefined (not 0) for b_lu_yield when no yield information is available, as 0 would incorrectly imply that yield data exists.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/db/schema.ts:407-426
Timestamp: 2025-01-23T15:18:57.212Z
Learning: In the farm data model, each cultivation (b_lu) can have only one termination date but can have multiple harvest dates. This is enforced through the database schema where cultivationTerminating uses b_lu as primary key while cultivationHarvesting uses a composite primary key of b_id_harvestable and b_lu.

.changeset/sour-kings-drive.md (7)

Learnt from: SvenVw
PR: #156
File: fdm-calculator/src/norms/nl/2025/stikstofgebruiksnorm.ts:295-303
Timestamp: 2025-07-21T12:06:07.070Z
Learning: Functions in the fdm-calculator with "NL2025" in their names are specifically designed for Netherlands 2025 agricultural norms calculation and hardcoded 2025 dates are appropriate in this context, as different years would have separate calculation modules.

Learnt from: SvenVw
PR: #6
File: fdm-app/vite.config.ts:5-9
Timestamp: 2024-11-25T12:42:32.783Z
Learning: In the fdm-app project, SvenVw is preparing for migration to Remix v3 and may include type declarations or configurations for v3 features in advance, such as in vite.config.ts.

Learnt from: SvenVw
PR: #75
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.fertilizer.tsx:68-71
Timestamp: 2025-02-14T09:56:37.606Z
Learning: The calculateDose function in @svenvw/fdm-calculator is a synchronous function that includes built-in validation for negative application amounts and nutrient rates.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: #88
File: fdm-calculator/src/doses/calculate-dose.ts:18-18
Timestamp: 2025-03-04T10:56:35.540Z
Learning: In the FDM calculator, fertilizer nutrient rates (p_n_rt, p_p_rt, p_k_rt) are measured in g/kg, and are converted to fractions by dividing by 10 during dose calculations.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.cultivation.$b_lu.harvest.$b_id_harvesting.tsx:114-124
Timestamp: 2025-02-13T08:35:59.306Z
Learning: The HarvestForm component in fdm-app expects undefined (not 0) for b_lu_yield when no yield information is available, as 0 would incorrectly imply that yield data exists.

fdm-calculator/src/balance/nitrogen/removal/residue.ts (4)

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.cultivation.$b_lu.harvest.$b_id_harvesting.tsx:114-124
Timestamp: 2025-02-13T08:35:59.306Z
Learning: The HarvestForm component in fdm-app expects undefined (not 0) for b_lu_yield when no yield information is available, as 0 would incorrectly imply that yield data exists.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/db/schema.ts:407-426
Timestamp: 2025-01-23T15:18:57.212Z
Learning: In the farm data model, each cultivation (b_lu) can have only one termination date but can have multiple harvest dates. This is enforced through the database schema where cultivationTerminating uses b_lu as primary key while cultivationHarvesting uses a composite primary key of b_id_harvestable and b_lu.

fdm-calculator/src/balance/nitrogen/removal/residue.test.ts (9)

Learnt from: SvenVw
PR: #9
File: fdm-data/src/cultivations/index.test.ts:57-59
Timestamp: 2024-11-27T12:15:36.425Z
Learning: In fdm-data/src/cultivations/index.test.ts, the fdm object created by drizzle does not have an .end() method. Cleanup code should not attempt to call fdm.end();.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:236-238
Timestamp: 2025-05-26T10:32:15.538Z
Learning: In nitrogen balance calculations for agricultural systems, removal and volatilization are calculated as negative values by definition since they represent nitrogen losses from the system. The balance calculation uses addition (.add()) for all components because removal and volatilization are already negative, so adding them effectively subtracts the losses from the supply.

Learnt from: SvenVw
PR: #9
File: fdm-data/src/cultivations/index.test.ts:57-59
Timestamp: 2024-11-27T11:27:27.797Z
Learning: When cleaning up test data in afterAll hooks in fdm-data/src/cultivations/index.test.ts, use fdm.delete(schema.tableName).execute(); to delete rows from a table without dropping the table itself.

Learnt from: SvenVw
PR: #134
File: fdm-calculator/src/balance/nitrogen/index.ts:162-168
Timestamp: 2025-05-26T10:32:00.674Z
Learning: In the nitrogen balance calculation system (fdm-calculator), removal and volatilization values are negative by definition. This means the balance calculation using supply.total.add(removal.total).add(volatilization.total) is correct, as it effectively computes supply - |removal| - |volatilization|.

Learnt from: SvenVw
PR: #156
File: fdm-calculator/src/norms/nl/2025/stikstofgebruiksnorm.ts:295-303
Timestamp: 2025-07-21T12:06:07.070Z
Learning: Functions in the fdm-calculator with "NL2025" in their names are specifically designed for Netherlands 2025 agricultural norms calculation and hardcoded 2025 dates are appropriate in this context, as different years would have separate calculation modules.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.create.$b_id_farm.cultivations.$b_lu_catalogue.crop.harvest._index.tsx:111-135
Timestamp: 2025-02-13T09:03:11.890Z
Learning: When adding multiple harvests in fdm-app, use Promise.all instead of Promise.allSettled to ensure atomic behavior - if one harvest addition fails, all should fail and rollback to maintain data consistency.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/db/schema.ts:407-426
Timestamp: 2025-01-23T15:18:57.212Z
Learning: In the farm data model, each cultivation (b_lu) can have only one termination date but can have multiple harvest dates. This is enforced through the database schema where cultivationTerminating uses b_lu as primary key while cultivationHarvesting uses a composite primary key of b_id_harvestable and b_lu.

Learnt from: SvenVw
PR: #71
File: fdm-app/app/routes/farm.$b_id_farm.field.$b_id.cultivation.$b_lu.harvest.$b_id_harvesting.tsx:114-124
Timestamp: 2025-02-13T08:35:59.306Z
Learning: The HarvestForm component in fdm-app expects undefined (not 0) for b_lu_yield when no yield information is available, as 0 would incorrectly imply that yield data exists.

Learnt from: SvenVw
PR: #49
File: fdm-core/src/cultivation.ts:625-671
Timestamp: 2025-01-24T11:39:57.805Z
Learning: Every cultivation has an associated cultivationTerminating record created by addCultivation, with b_terminate_date initially set to null. Therefore, updateCultivation can safely assume the record exists and only needs to handle updates.

fdm-calculator/src/balance/nitrogen/removal/index.test.ts (8)