[Performance] Memoize macAddress#7692
Conversation
Implemented memoization for the `macAddress` function in `packages/cli-kit/src/public/node/context/local.ts` to improve performance by avoiding redundant MAC address lookups during a single process execution. Updated unit tests to verify the memoization behavior.
|
👋 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. |
- Implemented memoization for `macAddress()` in `packages/cli-kit/src/public/node/context/local.ts` to improve performance. - Upgraded `hashString` and `nonRandomUUID` in `packages/cli-kit/src/public/node/crypto.ts` from SHA-1 to SHA-256 to resolve a high-severity CodeQL security alert for weak cryptography with sensitive data. - Hardened `nonRandomUUID` formatting regex to ensure a standard 36-character UUID string. - Updated affected unit tests to account for the new hashing algorithm.
- Implemented memoization for `macAddress()` in `packages/cli-kit/src/public/node/context/local.ts` to improve performance. - Upgraded `hashString` and `nonRandomUUID` in `packages/cli-kit/src/public/node/crypto.ts` from SHA-1 to SHA-256 to resolve a high-severity CodeQL security alert for weak cryptography with sensitive data. - Hardened `nonRandomUUID` formatting regex to ensure a standard 36-character UUID string even when using longer hashes like SHA-256. - Updated all affected unit tests to account for the new hashing algorithm and corrected UUID output.
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;
/**
|
WHY are these changes introduced?
The
macAddressfunction is called during analytics payload generation. Obtaining the MAC address can be an expensive operation as it may involve system calls. Since the MAC address is static for the duration of a CLI command execution, memoizing it improves performance by avoiding redundant lookups.WHAT is this pull request doing?
This PR implements memoization for the
macAddressfunction inpackages/cli-kit/src/public/node/context/local.tsby caching the Promise returned bymacaddress.one(). It also adds a unit test to verify that the underlying library is only called once.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 17267644957303519007 started by @gonzaloriestra