Skip to content

[Performance] Memoize shouldDisplayColors#7595

Open
gonzaloriestra wants to merge 1 commit into
mainfrom
jules-performance-memoize-should-display-colors-303941856508991664
Open

[Performance] Memoize shouldDisplayColors#7595
gonzaloriestra wants to merge 1 commit into
mainfrom
jules-performance-memoize-should-display-colors-303941856508991664

Conversation

@gonzaloriestra
Copy link
Copy Markdown
Contributor

@gonzaloriestra gonzaloriestra commented May 21, 2026

WHY are these changes introduced?

High-frequency logging paths call shouldDisplayColors repeatedly to determine if output should be colorized. Accessing process.env and checking TTY status on process.stdout involves small but measurable overhead that adds up over the lifecycle of a CLI command, especially when debug logging is enabled or many messages are processed.

WHAT is this pull request doing?

This PR introduces memoization for the shouldDisplayColors function in @shopify/cli-kit.

  • Results are cached in a module-level variable when called with the default process object.
  • Custom process objects (e.g., used in unit tests) bypass the cache to ensure isolation and correct behavior during testing.
  • The logic remains identical, preserving current behavior while improving efficiency for the common case.

How to test your changes?

CI

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

PR created automatically by Jules for task 303941856508991664 started by @gonzaloriestra

@google-labs-jules
Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label May 21, 2026
@gonzaloriestra gonzaloriestra added the Jules Created by Jules label May 21, 2026
Memoize the result of `shouldDisplayColors` when called with the default `process` to avoid redundant environment lookups and TTY checks in high-frequency logging paths.
@gonzaloriestra gonzaloriestra force-pushed the jules-performance-memoize-should-display-colors-303941856508991664 branch from d03d30d to 1037fd5 Compare May 21, 2026 15:40
@gonzaloriestra gonzaloriestra marked this pull request as ready for review May 21, 2026 15:56
@gonzaloriestra gonzaloriestra requested a review from a team as a code owner May 21, 2026 15:56
Copy link
Copy Markdown
Contributor

@ryancbahan ryancbahan left a comment

Choose a reason for hiding this comment

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

Do we know what the actual overhead is here? i'm a little wary of unmeasured optimizations.

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

Labels

Jules Created by Jules no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants