fix(gap-analysis): handle empty result dictionary correctly#733
Open
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
Open
fix(gap-analysis): handle empty result dictionary correctly#733PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
Conversation
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.
Fix GAP analysis job result handling for empty-but-valid results
Description
This PR fixes an issue where successful GAP analysis background jobs could incorrectly return a 500 error when the computed result was empty.
The RQ worker correctly completes the job and stores a result in the cache, but the web layer previously treated empty results as invalid and raised an internal error.
Problem
When fetching GAP analysis results via
/rest/v1/ma_job_results, the web layer checked the result using a truthiness check:{"result": {}}Since an empty dictionary evaluates to
False, the API incorrectly entered the error branch and raised:This occurred even though:
Root Cause
The API was conflating:
An empty GAP analysis is a valid outcome (e.g. no paths found between two standards).
Solution
The API now checks for presence of the result key, not its truthiness:
The API now checks for presence of the result key, not its truthiness:
This allows empty-but-valid results to be returned to the frontend instead of triggering a 500 error.
The same logic is applied consistently across:
/rest/v1/map_analysis/rest/v1/map_analysis_weak_links/rest/v1/ma_job_resultsBehavior After This Change
{ "result": {} }Related Issue
Fixes #583 – Running a GAP background job does not return a result