RHINENG-21212: Return 404 when remediation system issues when system doesn't exist

[marleystipich2]

Summary by Sourcery

Return 404 when requesting issues for a system that is not part of a remediation plan

Bug Fixes:

• Ensure the system issues endpoint returns 404 instead of an empty list when the requested system is not associated with the remediation plan

Tests:

• Add integration coverage verifying 200 for existing systems and 404 for systems not present in the remediation plan

[sourcery-ai]

Reviewer's Guide

Adjusts the remediation system issues endpoint so that requesting issues for a system not present in the remediation plan returns HTTP 404 instead of an empty 200 response, and adds an integration test to lock in the new behavior.

Sequence diagram for getSystemIssues 404 behavior when system not in remediation

sequenceDiagram
    actor Client
    participant API as ApiServer
    participant Ctrl as RemediationsController
    participant DB as Database
    participant Err as ErrorHandlers

    Client->>API: GET /v1/remediations/{plan_id}/systems/{system_id}/issues
    API->>Ctrl: getSystemIssues(req, res)

    Ctrl->>DB: querySystemIssues(plan_id, system_id, limit, offset)
    DB-->>Ctrl: rows

    alt system_has_issues_in_plan
        Ctrl->>Ctrl: formatSystemIssues(rows)
        Ctrl-->>API: res.json({...}) status 200
        API-->>Client: 200 OK with issues list
    else system_not_in_plan_or_no_rows
        Ctrl->>Err: notFound(res)
        Err-->>API: res.status(404)
        API-->>Client: 404 Not Found
    end

Loading

File-Level Changes

Change	Details	Files
Change getSystemIssues controller to return 404 when the requested system is not part of the remediation plan.	Update getSystemIssues to call notFound(res) when no rows are returned for the requested system/remediation combination instead of returning an empty issues list with 200 Clarify behavior with an inline comment explaining that no rows indicates the system is not in the remediation plan	src/remediations/controller.read.js
Add integration coverage for 404 response when requesting issues for a non-existent system within a remediation plan.	Create a remediation with a single issue and associate it to one system_id via issue_system.bulkCreate Verify that requesting issues for the existing system_id returns 200 Verify that requesting issues for a different, non-associated system_id returns 404	src/remediations/read.integration.js

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}