[Performance] Memoize isWsl results#7861
Conversation
Memoize the result of the `isWsl` check in `@shopify/cli-kit`. Since the WSL status is constant for the duration of the process, we can safely cache the promise of the first check. This reduces redundant dynamic imports and promise allocations.
|
👋 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>;
+/**
+ * Reset the memoized WSL check.
+ * This is used for testing purposes.
+ */
+export declare function _resetIsWsl(): void;
/**
* Check if stdin has piped data available.
* This distinguishes between actual piped input (e.g., )
|
WHY are these changes introduced?
Checking for WSL environment involves a dynamic import which can be expensive if performed repeatedly, especially in high-frequency paths like analytics.
WHAT is this pull request doing?
Memoizes the result of the
isWslcheck in@shopify/cli-kit. Since the WSL status is constant for the duration of the process, we can safely cache the promise of the first check.Also adds a
_resetIsWslhelper for unit testing.Expected performance impact: Reduces redundant dynamic imports and promise allocations for the
is-wslpackage.How to test your changes?
CI
Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset addPR created automatically by Jules for task 14944177195766897558 started by @gonzaloriestra