Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run_before_script: Fix newlines #960

Merged
merged 2 commits into from
Feb 2, 2025
Merged

run_before_script: Fix newlines #960

merged 2 commits into from
Feb 2, 2025

Conversation

tony
Copy link
Member

@tony tony commented Feb 2, 2025

Follow up to #959

Summary by Sourcery

Enhancements:

  • Improve performance and provide real-time feedback during run_before_script execution.

Copy link

sourcery-ai bot commented Feb 2, 2025

Reviewer's Guide by Sourcery

This pull request refactors the run_before_script function to use chunk-based output, which prevents the function from hanging when the script produces a large amount of output. The original implementation of run_before_script is renamed to run_before_script2.

Sequence diagram for chunk-based script output processing

sequenceDiagram
    participant C as Caller
    participant R as run_before_script
    participant P as subprocess.Popen
    participant O as stdout
    participant E as stderr

    C->>R: run_before_script(script_file, cwd)
    R->>P: Create process
    activate P
    loop Until process ends
        R->>P: poll()
        R->>O: read(1024)
        alt has output
            O-->>R: chunk
            R->>R: buffer chunk
            R->>R: write to stdout if TTY
        end
        R->>E: read(1024)
        alt has error output
            E-->>R: chunk
            R->>R: buffer chunk
            R->>R: write to stderr if TTY
        end
    end
    R->>P: wait()
    P-->>R: return code
    alt return code != 0
        R->>R: raise BeforeLoadScriptError
    end
    R-->>C: return code
    deactivate P
Loading

File-Level Changes

Change Details Files
Refactor run_before_script to use chunk-based output.
  • The original implementation of run_before_script is renamed to run_before_script2.
  • The new run_before_script reads stdout and stderr in chunks of 1024 bytes.
  • The new run_before_script writes stdout and stderr to the terminal as it receives data.
  • The new run_before_script uses a loop to read from the subprocess until it exits.
src/tmuxp/util.py

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

Copy link

@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 @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The old implementation should be removed rather than kept as run_before_script2. Having both versions will create confusion and maintenance overhead.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

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.

src/tmuxp/util.py Outdated Show resolved Hide resolved
@tony tony force-pushed the improve-run-before-script-2 branch from 8adde79 to 99f0354 Compare February 2, 2025 15:48
Copy link

codecov bot commented Feb 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.11%. Comparing base (001b85c) to head (99f0354).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #960   +/-   ##
=======================================
  Coverage   73.11%   73.11%           
=======================================
  Files          26       26           
  Lines        1856     1856           
  Branches      352      352           
=======================================
  Hits         1357     1357           
  Misses        395      395           
  Partials      104      104           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tony tony changed the title run_before_script: Use chunk-based output run_before_script: Fix newlines Feb 2, 2025
@tony tony merged commit 9d4e52b into master Feb 2, 2025
16 checks passed
@tony tony deleted the improve-run-before-script-2 branch February 2, 2025 15:56
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