feat(tools): add image support to read_file tool by samhvw8 · Pull Request #5172 · RooCodeInc/Roo-Code

samhvw8 · 2025-06-27T01:33:54Z

Related GitHub Issue

Closes: #5169

Description

Add support for reading and displaying image files (PNG, JPG, JPEG, GIF, WebP, SVG, BMP, ICO, TIFF)
Implement readImageAsDataUrl function to convert images to base64 data URLs with proper MIME types
Return multi-part responses containing both XML metadata and image data
Add dimension extraction for PNG files when possible
Add comprehensive test coverage for image reading functionality including format detection, error handling, and edge cases
Maintain backward compatibility for non-image binary files

Test Procedure

Pre-Submission Checklist

Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
Scope: My changes are focused on the linked issue (one major feature/fix per PR).
Self-Review: I have performed a thorough self-review of my code.
Testing: New and/or updated tests have been added to cover my changes (if applicable).
Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Screenshots / Videos

Documentation Updates

Additional Notes

Get in Touch

Important

Adds image support to read_file tool, enabling reading and displaying images as base64 data URLs with comprehensive test coverage.

Behavior:
- Adds image support to read_file tool in readFileTool.ts, supporting formats like PNG, JPG, GIF, etc.
- Implements readImageAsDataUrl() to convert images to base64 data URLs.
- Returns multi-part responses with XML metadata and image data.
- Extracts dimensions for PNG files when possible.
- Maintains backward compatibility for non-image binary files.
Tests:
- Adds tests in readFileTool.spec.ts for image reading, format detection, error handling, and edge cases.
- Mocks fs/promises and other dependencies for testing.
Misc:
- Updates SUPPORTED_IMAGE_FORMATS and MAX_IMAGE_FILE_SIZE_BYTES constants in readFileTool.ts.

^{This description was created by}^{for 3214f02b7b429926adb744e5911e9c1a4cc5858a. You can customize this summary. It will automatically update as commits are pushed.}

daniel-lxs

Hey @samhvw8, I know that different providers have different implementations for image handling, so I'm concerned this centralized approach might break with some providers.

Should we use the provider specific implementations for reading images?

Let me know what you think.

- Extract image-related constants and functions to src/core/tools/helpers/imageHelpers.ts - Keep readFileTool.ts focused on the main file reading logic - Update imports in test file to use the new helper module - All tests passing after refactoring

Co-authored-by: Daniel <57051444+daniel-lxs@users.noreply.github.com>

… images

daniel-lxs · 2025-07-25T17:55:08Z

Hey @samhvw8 thank you for addressing the review! I noticed an unit test is failing, can you take a look?

samhvw8 · 2025-07-26T08:54:10Z

@daniel-lxs i fixed the test can you review it again

- Replace maxTotalImageMemory with maxTotalImageSize throughout codebase - Update all translation files with new terminology - Fix incorrect key names in pt-BR, zh-CN, and zh-TW translations - Improve clarity of size limit messages - Update tests to reflect new terminology

- Extract image validation logic into validateImageForProcessing function - Extract image processing logic into processImageFile function - Add ImageMemoryTracker class to encapsulate memory tracking - Add proper TypeScript interfaces for validation and processing results - Reduce code duplication and improve separation of concerns

daniel-lxs

Thank you @samhvw8

samhvw8 requested review from cte, jr and mrubens as code owners June 27, 2025 01:33

github-project-automationBot added this to Roo Code Roadmap and Roo Code Roadmap Jun 27, 2025

github-project-automationBot moved this to New in Roo Code Roadmap Jun 27, 2025

github-project-automationBot moved this to Triage in Roo Code Roadmap Jun 27, 2025

samhvw8 marked this pull request as draft June 27, 2025 01:34

ellipsis-devBot reviewed Jun 27, 2025
View reviewed changes

Comment threadsrc/core/tools/readFileTool.ts Outdated

hannesrudolph added the Issue/PR - Triage New issue. Needs quick review to confirm validity and assign labels. label Jun 27, 2025

dosubotBot added size:L This PR changes 100-499 lines, ignoring generated files. Enhancement New feature or request labels Jun 27, 2025

daniel-lxs moved this from Triage to PR [Needs Prelim Review] in Roo Code Roadmap Jun 27, 2025

hannesrudolph added PR - Needs Preliminary Review and removed Issue/PR - Triage New issue. Needs quick review to confirm validity and assign labels. labels Jun 27, 2025

daniel-lxs moved this from PR [Needs Prelim Review] to PR [Draft / In Progress] in Roo Code Roadmap Jun 27, 2025

hannesrudolph added PR - Draft / In Progress and removed PR - Needs Preliminary Review labels Jun 27, 2025

samhvw8 force-pushed the feat/read-file-image branch from 0ad2410 to e85d4d5Compare July 1, 2025 15:26

samhvw8 marked this pull request as ready for review July 1, 2025 15:48

dosubotBot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jul 1, 2025

ellipsis-devBot reviewed Jul 1, 2025
View reviewed changes

Comment threadsrc/core/tools/readFileTool.ts Outdated
Comment threadsrc/core/tools/readFileTool.ts Outdated
Comment threadsrc/core/tools/readFileTool.ts Outdated

samhvw8 force-pushed the feat/read-file-image branch 2 times, most recently from 119bc82 to df342d7Compare July 2, 2025 13:58

daniel-lxs moved this from PR [Draft / In Progress] to PR [Needs Prelim Review] in Roo Code Roadmap Jul 2, 2025

hannesrudolph added PR - Needs Preliminary Review and removed PR - Draft / In Progress labels Jul 2, 2025

daniel-lxs reviewed Jul 2, 2025
View reviewed changes

Comment threadsrc/core/tools/readFileTool.ts Outdated
Comment threadsrc/core/tools/__tests__/readFileTool.spec.ts Outdated
Comment threadsrc/core/tools/readFileTool.ts Outdated

daniel-lxs moved this from PR [Needs Prelim Review] to PR [Changes Requested] in Roo Code Roadmap Jul 2, 2025

samhvw8and others added 12 commits July 25, 2025 23:54

test: enhance image support tests for path normalization
0b39158

fix pr comment
6badb51

add setting ui for max image file size
28e0b28

handle model don support image
c165fa4

add i18n
822a84f

add max memory for total file
7ec9ae6

refactor: consolidate MIME type mapping for image formats
ba397ce

fix: re-check model image support before including images in the result
802fa5d

fix test
ebca4ba

Update src/core/tools/readFileTool.ts
d018c30
Co-authored-by: Daniel <57051444+daniel-lxs@users.noreply.github.com>

test: enhance image memory limit checks and add new test for skipping…
1dc79ce
… images

samhvw8 force-pushed the feat/read-file-image branch from 85d7699 to 1dc79ceCompare July 25, 2025 16:56

remove unuse i18n
0fbdb9e

daniel-lxs moved this from PR [Changes Requested] to PR [Needs Prelim Review] in Roo Code Roadmap Jul 25, 2025

hannesrudolph added PR - Needs Preliminary Review and removed PR - Changes Requested labels Jul 25, 2025

daniel-lxs moved this from PR [Needs Prelim Review] to PR [Changes Requested] in Roo Code Roadmap Jul 25, 2025

hannesrudolph added PR - Changes Requested and removed PR - Needs Preliminary Review labels Jul 25, 2025

fix test fail
3038800

daniel-lxs added 4 commits July 28, 2025 11:30

fix: update test to use maxTotalImageSize instead of maxTotalImageMemory
1ead395

fix: update webview test to use maxTotalImageSize
701d5fc

daniel-lxs approved these changes Jul 28, 2025
View reviewed changes

mrubens approved these changes Jul 29, 2025
View reviewed changes

rwydaegh mentioned this pull request Aug 7, 2025
Support adding image with @ #6802
Closed
4 tasks

Navigation Menu

Uh oh!

feat(tools): add image support to read_file tool - #5172

feat(tools): add image support to read_file tool#5172
mrubens merged 21 commits into
RooCodeInc:mainfrom
samhvw8:feat/read-file-image

samhvw8 commented Jun 27, 2025•
edited by ellipsis-dev Bot
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daniel-lxs left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daniel-lxs commented Jul 25, 2025

Uh oh!

samhvw8 commented Jul 26, 2025

Uh oh!

daniel-lxs left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

samhvw8 commented Jun 27, 2025• edited by ellipsis-dev BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related GitHub Issue

Description

Test Procedure

Pre-Submission Checklist

Screenshots / Videos

Documentation Updates

Additional Notes

Get in Touch

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daniel-lxs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daniel-lxs commented Jul 25, 2025

Uh oh!

samhvw8 commented Jul 26, 2025

Uh oh!

daniel-lxs left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

samhvw8 commented Jun 27, 2025•
edited by ellipsis-dev Bot
Loading