common: general improvements #713

dougsland · 2025-02-03T00:06:38Z

if timeout happens we try 5 times before sending Timeout error to users.
improve user experience when timeout occurs
Added console source tree for handling messages

Resolves: #693

Summary by Sourcery

Improve the reliability of file downloads and introduce logging with user-friendly messages.

Bug Fixes:

Retry file downloads up to five times if a timeout or network error occurs.

Enhancements:

Added logging for network errors, timeouts, and other download-related issues.
Improved user experience by providing more informative messages during file downloads.

sourcery-ai · 2025-02-03T00:06:41Z

Reviewer's Guide by Sourcery

This pull request introduces several improvements to the download process, including retries with exponential backoff, enhanced error messages, and the addition of a console module for consistent output formatting.

Sequence diagram for improved file download process with retries

sequenceDiagram
    participant C as Client
    participant D as download_file
    participant H as HttpClient
    participant S as Server

    C->>D: download_file(url, dest_path)
    activate D

    loop max_retries (5 times)
        D->>H: init(url, headers, output_file)
        activate H
        H->>S: HTTP Request

        alt Success
            S-->>H: File Data
            H-->>D: Success
            D-->>C: Return
        else HTTP 416 (Range Not Satisfiable)
            S-->>H: 416 Error
            H-->>D: Already downloaded
            D-->>C: Return
        else Network/Timeout Error
            S-->>H: Error/Timeout
            H-->>D: Error
            D->>D: Wait (exponential backoff)
            Note over D: Retry if attempts < 5
        end

        deactivate H
    end

    alt Max retries reached
        D-->>C: Exit with error message
    end

    deactivate D

Class diagram for new console module

classDiagram
    class console {
        +bool EMOJI
        +bool FORCE_EMOJI
        +is_locale_utf8()
        +supports_emoji()
        +error(msg)
        +warning(msg)
        +info(msg)
    }

    note for console "New module for consistent
formatted console output
with emoji support"

Flow diagram for emoji support detection

flowchart TD
    A[Check emoji support] --> B{RAMALAMA_FORCE_EMOJI set?}
    B -->|Yes| C{Value is 'true'?}
    C -->|Yes| D[Enable emoji]
    C -->|No| E[Disable emoji]
    B -->|No| F{Check TERM env}
    F -->|dumb/linux| E
    F -->|other| G{Check UTF-8 locale}
    G -->|Yes| D
    G -->|No| E

File-Level Changes

Change	Details	Files
Implement retries with exponential backoff for file downloads.	Added a retry mechanism for download failures. Implemented exponential backoff for retries. Limited the number of retries to 5. Improved error handling for network issues, timeouts, and I/O errors. Added a generic exception handler to catch unexpected errors. Added a message to the user when the download fails after multiple attempts.	`ramalama/common.py`
Improve user experience by providing more informative error messages.	Added a console module for handling messages. Added error, warning, and info functions to the console module. Added emoji support to the console module. Replaced print statements with console module functions. Added more descriptive error messages for download failures.	`ramalama/common.py` `ramalama/console.py`
Added a new console module for handling messages.	Added a new console module. Added functions for error, warning, and info messages. Added emoji support to the console module. Added a check for UTF-8 locale to enable emoji support.	`ramalama/console.py`
Added console.py to the list of files to install.	Added console.py to the list of files to install.	`install.sh`

Possibly linked issues

(Timeout download model): python3.13/ssl.py", line 1138, in read return self._sslobj.read(len, buffer) #693: The PR addresses the issue by retrying the download up to five times before raising a timeout error.

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!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

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.

dougsland · 2025-02-03T00:10:26Z

I believe the code is ready for review this time. Please let me know if I missed something.

- if timeout happens we try 5 times before sending Timeout error to users. - improve user experience when timeout occurs - Added console source tree for handling messages Resolves: containers#693 Signed-off-by: Douglas Schilling Landgraf <[email protected]>

ericcurtin · 2025-02-03T00:19:50Z

ramalama/console.py

+import logging
+
+
+def is_locale_utf8():


I tested this on macOS with alacritty it needs one more check to work, because this is the only env var (LC_ALL) of the 3 env vars populated on this platform:

$ echo $LC_ALL en_IE.UTF-8

So we need to add one more or:

return 'UTF-8' in os.getenv('LC_CTYPE', '') or 'UTF-8' in os.getenv('LANG', '') or 'UTF-8' in os.getenv('LC_ALL', '')

Could also do:

return any('UTF-8' in os.getenv(var, '') for var in ['LC_CTYPE', 'LANG', 'LC_ALL'])

to be less long-winded, as long as it works I don't mind too much. And it just checks these three env vars for UTF-8, I don't care after that point.

ericcurtin · 2025-02-03T00:20:31Z

ramalama/console.py

+# If RAMALAMA_FORCE_EMOJI is not set, it defaults to checking supports_emoji()
+RAMALAMA_FORCE_EMOJI = os.getenv("RAMALAMA_FORCE_EMOJI")
+FORCE_EMOJI = RAMALAMA_FORCE_EMOJI.lower() == "true" if RAMALAMA_FORCE_EMOJI else None
+EMOJI = FORCE_EMOJI if FORCE_EMOJI is not None else supports_emoji()


Lines 21-23 are long-winded it took me a while to read this and try and understand if it was correct, lets simplify:

EMOJI = os.getenv("RAMALAMA_FORCE_EMOJI") or supports_emoji()

Make lint is a good one to have. Signed-off-by: Douglas Schilling Landgraf <[email protected]>

ericcurtin · 2025-02-03T00:26:42Z

This PR is much easier to review, a much more focused PR. I think we are close.

ericcurtin · 2025-02-03T00:33:24Z

ramalama/console.py

+
+
+# Define emoji-aware logging messages
+def error(msg):


The spacing isn't consistent in the printed output in these three functions, some are double-space some are single-space.

If you are pushing new commits you might as well catch it here, we can also do in a follow on PR.

ericcurtin · 2025-02-03T00:42:56Z

I'll catch the changes in another PR I have the time

dougsland requested review from rhatdan, ericcurtin, bmahabirbu, maxamillion, swarajpande5 and jhjaggars as code owners February 3, 2025 00:06

dougsland force-pushed the commonimprovements branch from 9f86dec to e80d41d Compare February 3, 2025 00:07

dougsland force-pushed the commonimprovements branch from e80d41d to 018bd6f Compare February 3, 2025 00:12

common: general improvements

b0678aa

- if timeout happens we try 5 times before sending Timeout error to users. - improve user experience when timeout occurs - Added console source tree for handling messages Resolves: containers#693 Signed-off-by: Douglas Schilling Landgraf <[email protected]>

dougsland force-pushed the commonimprovements branch from 018bd6f to b0678aa Compare February 3, 2025 00:16

ericcurtin reviewed Feb 3, 2025

View reviewed changes

CI/CD: create a job for make lint

15c857d

Make lint is a good one to have. Signed-off-by: Douglas Schilling Landgraf <[email protected]>

ericcurtin reviewed Feb 3, 2025

View reviewed changes

ericcurtin merged commit 6706b26 into containers:main Feb 3, 2025
11 of 12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

common: general improvements #713

common: general improvements #713

dougsland commented Feb 3, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 3, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

dougsland commented Feb 3, 2025

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin commented Feb 3, 2025

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin commented Feb 3, 2025

		import logging


		def is_locale_utf8():

common: general improvements #713

common: general improvements #713

Conversation

dougsland commented Feb 3, 2025 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Feb 3, 2025 • edited Loading

Reviewer's Guide by Sourcery

Sequence diagram for improved file download process with retries

Class diagram for new console module

Flow diagram for emoji support detection

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

dougsland commented Feb 3, 2025

ericcurtin Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

ericcurtin Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

ericcurtin Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

ericcurtin commented Feb 3, 2025

ericcurtin Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

ericcurtin commented Feb 3, 2025

dougsland commented Feb 3, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading

ericcurtin Feb 3, 2025 •

edited

Loading