[Performance] Memoize isShopify#7773
Conversation
Memoize the result of the `isShopify` check to avoid repeated filesystem I/O. The result is cached as a promise to handle concurrent calls safely. An internal reset function is provided for test isolation.
|
👋 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@@ -173,4 +173,9 @@ export declare function getThemeKitAccessDomain(env?: NodeJS.ProcessEnv): string
* @returns The domain to send OTEL metrics to.
*/
export declare function opentelemetryDomain(env?: NodeJS.ProcessEnv): string;
+/**
+ * This function is only used during UnitTesting.
+ * It resets the memoized value of the shopify check.
+ */
+export declare function _resetIsShopifyCache(): void;
export type CIMetadata = Metadata;
\ No newline at end of file
|
WHY are these changes introduced?
isShopifyis called frequently (e.g., during analytics reporting) and performs a filesystem check to see if thedevexecutable exists. This I/O operation can be costly when repeated across the CLI lifecycle.WHAT is this pull request doing?
Memoizes the result of the
isShopifycheck when using the defaultprocess.env. It caches the promise of the operation to ensure concurrent calls await the same operation and avoid race conditions. An internal_resetIsShopifyCachefunction is exported and used in tests to ensure isolation.How to test your changes?
CI
Post-release steps
Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset addPR created automatically by Jules for task 16016265137240540030 started by @gonzaloriestra