[Performance] Memoize isWsl result#7910
Conversation
This change memoizes the result of the `isWsl` function in `@shopify/cli-kit`. Since `isWsl` involves a dynamic import and potential filesystem checks, memoizing the promise ensures that these operations are only performed once per process. This is particularly beneficial in high-frequency paths like analytics collection. A `_resetIsWsl` function is also provided for test isolation. Added regression tests in `system.test.ts`.
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/public/node/system.d.ts@@ -111,6 +111,11 @@ export declare function isCI(): boolean;
* @returns True if the current environment is a WSL environment.
*/
export declare function isWsl(): Promise<boolean>;
+/**
+ * Resets the memoized value of isWsl.
+ * This is only used for testing.
+ */
+export declare function _resetIsWsl(): void;
/**
* Check if stdin has piped data available.
* This distinguishes between actual piped input (e.g., )
|
Goals
Implement a small performance optimization by memoizing the
isWslcheck result.Changes
packages/cli-kit/src/public/node/system.tsto memoize the promise returned byisWsl._resetIsWslfor testing.packages/cli-kit/src/public/node/system.test.ts.Performance Impact
Avoids repeated dynamic imports and environment detection logic for WSL. This saves a small amount of CPU and I/O on every call after the first one.
How to test your changes?
CI
PR created automatically by Jules for task 7833433675125110132 started by @gonzaloriestra