Skip to content

HTTP: return relative path for downloaded file#1951

Open
lvoloshyn-sekoia wants to merge 1 commit intodevelopfrom
lv/http_action_download_file_return_relative_path
Open

HTTP: return relative path for downloaded file#1951
lvoloshyn-sekoia wants to merge 1 commit intodevelopfrom
lv/http_action_download_file_return_relative_path

Conversation

@lvoloshyn-sekoia
Copy link
Collaborator

@lvoloshyn-sekoia lvoloshyn-sekoia commented Jan 22, 2026

Summary by Sourcery

Return a relative path for downloaded HTTP files and bump the module version.

Bug Fixes:

  • Adjust the download file action to return a path relative to the data directory instead of an absolute path.

Documentation:

  • Add changelog entry documenting the change to return a relative path for downloaded files.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 22, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates the HTTP module’s download action to return a path relative to the module’s data directory instead of an absolute path, and bumps the module version and changelog accordingly.

Class diagram for updated HTTP download file action

classDiagram
    class DownloadFileAction {
        +Path data_path
        -dict _save_file(Response response)
    }
Loading

Flow diagram for saving downloaded file and returning relative path

flowchart TD
    A["HTTP response received"] --> B["Determine filename from Response"]
    B --> C["Build absolute file_path = data_path / uuid / filename"]
    C --> D["Create parent directory for file_path"]
    D --> E["Write response content to file_path"]
    E --> F["Compute result_path = file_path relative to data_path"]
    F --> G["Return { file_path: str(result_path) }"]
Loading

File-Level Changes

Change Details Files
Return a relative file path from the HTTP download action instead of an absolute path.
  • Use the public data_path attribute instead of the private _data_path attribute when constructing the download destination path.
  • Compute the result path as file_path relative to data_path before returning it.
  • Keep the on-disk save location unchanged while altering only the value returned in the action result payload.
HTTP/http_module/download_file_action.py
Document and version the behavior change of the HTTP module.
  • Add a new 1.120.1 entry to the changelog describing that the downloaded file path is now relative.
  • Bump manifest.json version from 1.120.0 to 1.120.1 to match the changelog.
HTTP/CHANGELOG.md
HTTP/manifest.json

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Double-check the use of self.data_path vs self._data_path in this class/module to keep attribute access consistent and avoid potential attribute errors at runtime.
  • Since the return value for file_path is now relative, consider updating any in-code comments or variable names in this action that still imply an absolute path to reduce confusion for future maintainers.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Double-check the use of `self.data_path` vs `self._data_path` in this class/module to keep attribute access consistent and avoid potential attribute errors at runtime.
- Since the return value for `file_path` is now relative, consider updating any in-code comments or variable names in this action that still imply an absolute path to reduce confusion for future maintainers.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant