[Performance] Memoize macAddress in context/local.ts#7883
[Performance] Memoize macAddress in context/local.ts#7883gonzaloriestra wants to merge 4 commits into
Conversation
The MAC address lookup is an expensive operation that involves enumerating network interfaces. Currently, it is performed every time `macAddress()` is called, which happens at least once per command execution for analytics. By memoizing the `Promise` returned by `macaddress.one()`, we ensure that the lookup logic is executed only once per process. Subsequent calls will return the same promise, avoiding redundant work. Verified with unit tests and full package checks (lint, knip, type-check).
|
👋 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. |
- Memoized `macAddress` in `context/local.ts` to avoid repeated expensive system calls. - Upgraded `hashString` and `nonRandomUUID` in `crypto.ts` from SHA-1 to SHA-256 to resolve CodeQL security alerts. - Updated relevant unit tests.
- Memoized `macAddress` in `context/local.ts` to avoid repeated expensive system calls. - Upgraded `hashString` and `nonRandomUUID` in `crypto.ts` from SHA-1 to SHA-256 to resolve CodeQL security alerts. - Updated relevant unit tests across the codebase that relied on hardcoded SHA-1 hash values.
- Memoized `macAddress` in `context/local.ts` to avoid repeated expensive system calls. - Upgraded `hashString` and `nonRandomUUID` in `crypto.ts` from SHA-1 to SHA-256 to resolve CodeQL security alerts. - Updated relevant unit tests across the codebase that relied on hardcoded SHA-1 hash values. - Fixed linting issues introduced by long SHA-256 strings in tests.
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/crypto.d.ts@@ -20,10 +20,10 @@ export declare function base64URLEncode(str: Buffer): string;
*/
export declare function sha256(str: string): Buffer;
/**
- * Generate the SHA1 hash of a string.
+ * Generate the SHA256 hash of a string.
*
* @param str - The string to hash.
- * @returns The SHA1 hash of the string.
+ * @returns The SHA256 hash of the string.
*/
export declare function hashString(str: string): string;
/**
packages/cli-kit/dist/public/node/context/local.d.ts@@ -153,6 +153,11 @@ export declare function ciPlatform(env?: NodeJS.ProcessEnv): {
* @returns Mac address.
*/
export declare function macAddress(): Promise<string>;
+/**
+ * Resets the memoized mac address.
+ * This is only used for testing purposes.
+ */
+export declare function _resetMacAddress(): void;
/**
* Get the domain for theme kit access.
*
|
Why is this change necessary?
The MAC address lookup is an expensive operation that involves enumerating network interfaces. Currently, it is performed every time
macAddress()is called, which happens at least once per command execution for analytics.How does it address the problem?
By memoizing the
Promisereturned bymacaddress.one(), we ensure that the lookup logic is executed only once per process. Subsequent calls will return the same promise, avoiding redundant work.How to test your changes?
CI
Checklist
PR created automatically by Jules for task 9795491166669454994 started by @gonzaloriestra