Skip to content

[Refactor] Memoize username function#7931

Draft
gonzaloriestra wants to merge 2 commits into
mainfrom
refactor-memoize-username-4653242786229501269
Draft

[Refactor] Memoize username function#7931
gonzaloriestra wants to merge 2 commits into
mainfrom
refactor-memoize-username-4653242786229501269

Conversation

@gonzaloriestra

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

The username function in @shopify/cli-kit is 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 executing whoami/id).

WHAT is this pull request doing?

  • Memoizes the result of the username function in packages/cli-kit/src/public/node/os.ts using a module-level promise.
  • Exports a _resetUsernameCache function for test isolation.
  • Adds unit tests in packages/cli-kit/src/public/node/os.test.ts to verify memoization and cache reset behavior.

How to test your changes?

CI

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

PR created automatically by Jules for task 4653242786229501269 started by @gonzaloriestra

@google-labs-jules

Copy link
Copy Markdown

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Jun 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Differences in type declarations

We 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:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/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';
 /**

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant