Conversation
|
@ekwe7 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 branch has not been deployed
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 #470
Summary
Replaces undocumented magic numbers (0.05 and 0.5) in
src/routes/investor.ts with named, exported, and documented constants
(CARBON_OFFSET_FACTOR and CARBON_CREDIT_FACTOR), following the codebase's
existing pattern established in src/lib/scoring.ts.
Context & Motivation
Previously, the carbon calculation math in investor.ts used bare float
literals directly inside .reduce() and .map() callbacks. These numbers are
key inputs in converting solar power output and green impact scores into
investor-facing metric figures (total_carbon_offsets_tonnes and
carbon_credits_issued).
By extracting these as named constants:
• The intent behind the formula is clear and self-documenting.
• Any future adjustment to carbon offset or credit factors can land in a
single place.
Changes Made
• src/routes/investor.ts:
• Exported and documented CARBON_OFFSET_FACTOR = 0.05 (used in GET
/dashboard).
• Exported and documented CARBON_CREDIT_FACTOR = 0.5 (used in GET
/compliance-report and POST /custom-report).
• Updated carbon offset and credit calculations to reference these
constants.
• src/tests/investor.test.ts:
• Imported CARBON_OFFSET_FACTOR and CARBON_CREDIT_FACTOR.
• Added unit test suite verifying constant exports.