Repository navigation
fix(forecast): validate query field parameter and reject invalid values with 400 (closes #891) - #917
Closed
mopxam-art wants to merge 1 commit into
Closed
mopxam-art wants to merge 1 commit into
mopxam-art wants to merge 1 commit into
Conversation
…es with 400 (closes Heliobond#891)
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.
Overview
Closes #891 by validating the
fieldquery parameter across forecast routes (/:id,/seasonal/:id, and/accuracy/:id) and rejecting unknown metrics with400 Bad Requestlisting valid options (power_output_kw,efficiency_pct), eliminating silent data substitution.Problem & Motivation
Previously,
parseForecastFielddefaulted any string other than"efficiency_pct"to"power_output_kw". A typo such as?field=efficiencyor?field=powerwas silently coerced topower_output_kw, returning 200 OK with unexpected data. Sibling endpoints uniformly reject unrecognized query enums with 400 Bad Request.Changes
src/routes/forecast.ts:VALID_FORECAST_FIELDS = ["power_output_kw", "efficiency_pct"] as const.parseForecastField, preserved default"power_output_kw"for omitted or emptyfieldparameters.badRequestwhen an unknown metric name is supplied, explicitly listing valid options in the error message.src/__tests__/forecastFieldValidation.test.ts:Verification
npx jest src/__tests__/forecast.test.ts src/__tests__/forecastFieldValidation.test.ts --forceExit).npx tsc --noEmit).npx eslint src/routes/forecast.ts).npm run build).