fix(icons): reduce max_url_length to 3550 and add camo limit warnings #109

Copilot · 2025-11-13T15:33:47Z

Fix failing camo length test

This PR fixes GitHub camo proxy URL length limit issues by reducing the max_url_length parameter from 3700 to 3550 characters and adding user-facing warnings when URLs exceed safe limits.

Changes Made

Reduced max_url_length: Changed default from 3700 to 3550 chars in svg_to_base64_data_uri() to account for badge URL overhead and provide 10% safety margin
Updated all call sites: Changed explicit calls to use 3550 instead of 3700
Improved docstring clarity: Explicitly labeled each overhead component (camo_overhead, hex_encoding, badge_url_overhead)
Docker-based CI testing: Tests now run inside the BadgeSort Docker container, ensuring consistent environment with all system dependencies (librsvg2-bin)
Console warnings: Added warnings when:
- Badge URLs exceed GitHub's 8192 char camo limit
- PNG fallback fails and oversized SVG is used despite exceeding limits

Technical Details

Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550

The tighter limit ensures that badge URLs with embedded SVG data URIs stay under GitHub's camo proxy 8192 character limit, preventing "limit exceeded" errors for large icons like the Amazon AWS icon. When PNG fallback is available (via rsvg-convert), oversized SVGs are automatically converted to compact PNGs.

Testing

✅ All 28 tests pass
✅ PNG fallback works correctly when rsvg-convert is available
✅ Warnings appear correctly when URLs exceed limits
✅ CI tests run in Docker container with all dependencies

Fixes #108

Original prompt

This section details on the original issue you should resolve

<issue_title>Fix failing camo length test</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Fix failing camo length test #108

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

github-actions · 2025-11-13T15:39:43Z

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

github-actions · 2025-11-13T15:39:45Z

🏷️ Test Badge Generation (Badgen.net)

hilbert

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

github-actions · 2025-11-13T15:45:16Z

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

github-actions · 2025-11-13T15:45:17Z

🏷️ Test Badge Generation (Badgen.net)

hilbert

github-actions · 2025-11-13T15:45:21Z

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

github-actions · 2025-11-13T15:45:22Z

🏷️ Test Badge Generation (Badgen.net)

hilbert

Copilot

Pull Request Overview

This PR fixes GitHub camo proxy URL length limit issues by reducing the max_url_length parameter from 3700 to 3550 characters. The tighter limit ensures that badge URLs with embedded SVG data URIs stay under GitHub's camo proxy 8192 character limit, preventing "limit exceeded" errors for large icons like the Amazon AWS icon.

Key Changes

Reduced default max_url_length from 3700 to 3550 in svg_to_base64_data_uri() function
Updated all explicit call sites to use 3550
Updated test assertions to reflect the new default value

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
badgesort/icons.py	Updated function signature default parameter, docstring calculation, and two explicit call sites to use 3550 char limit
tests/test_camo_url_limits.py	Updated test assertions and comments to verify the new 3550 char default value

Copilot · 2025-11-13T15:46:41Z

badgesort/icons.py

+                       Default 3550 chars ensures badge URLs stay under GitHub's camo proxy
                       8192 char limit (which hex-encodes URLs: 76 + url_len*2 <= 8192).
-                       Calculation: safe_url = (8192 - 76) / 2 - overhead ≈ 3850, with 150 char margin = 3700
+                       Calculation: safe_url = (8192 - 76) / 2 - overhead ≈ 3949, with 10% margin = 3550


[nitpick] The calculation in the docstring could be clearer. Consider specifying what "overhead" refers to:

Calculation: safe_url = (8192 - 76) / 2 - ~109 badge_url_overhead ≈ 3949, with 10% margin = 3550

or

Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550

This makes it clear that the ~109 char overhead is the badge URL structure (domain, path, parameters) excluding the actual data URI payload.

Suggested change

Calculation: safe_url = (8192 - 76) / 2 - overhead ≈ 3949, with 10% margin = 3550

Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550

(~109 char badge_url_overhead is the badge URL structure: domain, path, parameters, excluding the data URI payload)

Updated the docstring for better clarity in commit fb06706. The calculation now explicitly labels each overhead component and explains what badge_url_overhead represents.

ChipWolf · 2025-11-13T15:47:05Z

The test failed in CI @copilot

FAILED tests/test_camo_url_limits.py::test_shields_embedded_svg_urls_under_camo_limit - AssertionError: Badge URL would exceed camo limit: 8552 > 8192
  URL: https://img.shields.io/badge/Amazon%20AWS-232F3E.svg?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bx...
assert 8552 <= 8192

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

Copilot · 2025-11-13T15:52:05Z

The test failed in CI @copilot

...

Fixed in commit fb06706. The CI failure was due to missing librsvg2-bin system dependency in the test job. Added a step to install it before running tests. The PNG fallback now works correctly in CI, converting large SVGs (like AWS) to compact PNGs that stay under the camo limit.

ChipWolf · 2025-11-13T15:54:41Z

@copilot Use the BadgeSort container in CI instead of this

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

Copilot · 2025-11-13T16:00:16Z

@copilot Use the BadgeSort container in CI instead of this

Updated in commit 0ba8bc1. CI now builds and uses the BadgeSort Docker container to run tests, which includes all system dependencies (librsvg2-bin) by default. Also added console warnings when badge URLs exceed the GitHub camo limit or when PNG fallback fails.

Copilot

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Copilot · 2025-11-13T16:06:46Z

badgesort/icons.py

+                       Default 3550 chars ensures badge URLs stay under GitHub's camo proxy
                       8192 char limit (which hex-encodes URLs: 76 + url_len*2 <= 8192).
-                       Calculation: safe_url = (8192 - 76) / 2 - overhead ≈ 3850, with 150 char margin = 3700
+                       Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550


[nitpick] The calculation description states "with 10% margin = 3550" but this is slightly unclear. The actual calculation would be: 3949 × 0.9 ≈ 3554, but the code uses 3550 (which is even more conservative). Consider clarifying the description to either:

"with ~10% margin (rounded down) = 3550" or

"with 399 char safety margin (≈10%) = 3550"

This would make it clearer that 3550 is a rounded-down value for safety.

Suggested change

Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550

Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with ~10% margin (rounded down) = 3550

github-actions · 2025-11-13T16:33:16Z

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

github-actions · 2025-11-13T16:33:18Z

🏷️ Test Badge Generation (Badgen.net)

hilbert

github-actions · 2025-11-13T16:33:23Z

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

github-actions · 2025-11-13T16:33:25Z

🏷️ Test Badge Generation (Badgen.net)

hilbert

Initial plan

13f9e27

Copilot AI assigned Copilot and ChipWolf Nov 13, 2025

Copilot started work on behalf of ChipWolf November 13, 2025 15:34 View session

fix(icons): reduce max_url_length to 3550 to stay under camo limit

a6706d7

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix failing camo length test~~ fix(icons): reduce max_url_length to 3550 to prevent camo proxy limit exceeded Nov 13, 2025

Copilot AI requested a review from ChipWolf November 13, 2025 15:43

Copilot finished work on behalf of ChipWolf November 13, 2025 15:43

ChipWolf marked this pull request as ready for review November 13, 2025 15:44

Copilot AI review requested due to automatic review settings November 13, 2025 15:44

Copilot started reviewing on behalf of ChipWolf November 13, 2025 15:44 View session

Copilot finished reviewing on behalf of ChipWolf November 13, 2025 15:46

Copilot AI reviewed Nov 13, 2025

View reviewed changes

Copilot started work on behalf of ChipWolf November 13, 2025 15:47 View session

chore(ci): install librsvg2-bin for PNG fallback in tests

fb06706

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

Copilot finished work on behalf of ChipWolf November 13, 2025 15:54

Copilot started work on behalf of ChipWolf November 13, 2025 15:55 View session

feat(ci,icons): use Docker container for tests and add camo URL warnings

0ba8bc1

Co-authored-by: ChipWolf <3164166+ChipWolf@users.noreply.github.com>

Copilot AI changed the title ~~fix(icons): reduce max_url_length to 3550 to prevent camo proxy limit exceeded~~ fix(icons): reduce max_url_length to 3550 and add camo limit warnings Nov 13, 2025

Copilot finished work on behalf of ChipWolf November 13, 2025 16:02

ChipWolf requested a review from Copilot November 13, 2025 16:03

Copilot started reviewing on behalf of ChipWolf November 13, 2025 16:03 View session

Copilot finished reviewing on behalf of ChipWolf November 13, 2025 16:06

Copilot AI reviewed Nov 13, 2025

View reviewed changes

ChipWolf merged commit abc9f1a into main Nov 13, 2025
14 checks passed

ChipWolf deleted the copilot/fix-camo-length-test branch November 13, 2025 16:33

github-actions bot mentioned this pull request Nov 13, 2025

chore(main): release 3.3.1 #107

Merged

	Calculation: safe_url = (8192 - 76) / 2 - overhead ≈ 3949, with 10% margin = 3550
	Calculation: (8192 - 76 camo_overhead) / 2 hex_encoding - ~109 badge_url_overhead = 3949, with 10% margin = 3550
	(~109 char badge_url_overhead is the badge URL structure: domain, path, parameters, excluding the data URI payload)

fix(icons): reduce max_url_length to 3550 and add camo limit warnings #109

fix(icons): reduce max_url_length to 3550 and add camo limit warnings #109

Uh oh!

Conversation

Copilot AI commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix failing camo length test

Changes Made

Technical Details

Testing

Comments on the Issue (you are @copilot in this section)

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Badgen.net)

hilbert

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Badgen.net)

hilbert

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

step_invert

luminance

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Badgen.net)

hilbert

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

ChipWolf commented Nov 13, 2025

Uh oh!

Copilot AI commented Nov 13, 2025

Uh oh!

ChipWolf commented Nov 13, 2025

Uh oh!

Copilot AI commented Nov 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 13, 2025

🏷️ Test Badge Generation (Shields.io)

hilbert

hsv

step

Copilot AI commented Nov 13, 2025 •

edited

Loading