[Refactor] Memoize username function#7931
Conversation
|
👋 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/os.d.ts@@ -3,6 +3,10 @@
* @returns The username of the current user.
*/
export declare function username(platform?: typeof process.platform): Promise<string | null>;
+/**
+ * Resets the username cache.
+ */
+export declare function _resetUsernameCache(): void;
type PlatformArch = Exclude<typeof process.arch, 'x64' | 'ia32'> | 'amd64' | '386';
type PlatformStrings = Exclude<typeof process.platform, 'win32'> | 'windows';
/**
|
WHY are these changes introduced?
The
usernamefunction in@shopify/cli-kitis used in several places, including during app initialization. Since the username is unlikely to change during the execution of a CLI command, memoizing it avoids repeated system calls (environment variable lookups,os.userInfo(), or executingwhoami/id).WHAT is this pull request doing?
usernamefunction inpackages/cli-kit/src/public/node/os.tsusing a module-level promise._resetUsernameCachefunction for test isolation.packages/cli-kit/src/public/node/os.test.tsto verify memoization and cache reset behavior.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 4653242786229501269 started by @gonzaloriestra