[Performance] Memoize ciPlatform function#7995
Conversation
Memoize the `ciPlatform` function in `packages/cli-kit/src/public/node/context/local.ts` to avoid redundant environment variable lookups and metadata collection when using the default `process.env`. Added an exported `_resetCIPlatformCache` utility for test isolation. Added unit tests to verify memoization behavior and correct bypass when using custom environment objects.
|
👋 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/context/local.d.ts@@ -132,6 +132,11 @@ export declare function cloudEnvironment(env?: NodeJS.ProcessEnv): {
* @returns A promise that resolves with the value.
*/
export declare function hasGit(): Promise<boolean>;
+/**
+ * Resets the memoized CI platform value.
+ * This is useful for testing purposes.
+ */
+export declare function _resetCIPlatformCache(): void;
/**
* Gets info on the CI platform the CLI is running on, if applicable.
*
|
Why is this change necessary?
The
ciPlatformfunction is called frequently, especially during analytics collection, and performs multiple environment variable lookups and metadata assembly. Since these environment variables are static during a single CLI command execution, caching the result improves performance by avoiding repeated work.How to test your changes?
CI
Checkbox
Expected performance impact
Eliminates redundant environment variable scans and metadata object creation in high-frequency analytics paths. While the absolute time saved per call is small (micro-optimizations), the cumulative effect across all commands (which all report analytics) contributes to a snappier CLI experience.
PR created automatically by Jules for task 2348603642377422416 started by @gonzaloriestra