Moved client id logging into createBasicLogEvent

[owenofbrien]

Summary

Moved client id logging into createBasicLogEvent to ensure that extension events include a client identifier.

Details

The lack of a client identifier may be causing the Clearcut pipeline to drop these events.

Related Issues

How to Validate

• Install or uninstall an extension.
• Wait ~8 hrs
• Check for a matching extension log event in Concord.

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed)
• Noted breaking changes (if any)
• Validated on required platforms/methods:
  • MacOS
    • npm run
    • npx
    • Docker
    • Podman
    • Seatbelt
  • Windows
    • npm run
    • npx
    • Docker
  • Linux
    • npm run
    • npx
    • Docker

[gemini-code-assist]

Summary of Changes

Hello @owenofbrien, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the telemetry logging mechanism to ensure that all extension-related events are properly attributed with a client identifier. By centralizing the client ID assignment logic within the createBasicLogEvent function, the system guarantees that these crucial identifiers are always present, thereby preventing potential data loss in the Clearcut pipeline and improving the reliability of telemetry data.

Highlights

• Refactored Client Identifier Logging: The logic responsible for determining and attaching a client identifier (either a user's email or an installation ID) to log events has been moved.
• Enhanced Event Reliability: This change ensures that all extension-related events consistently include a client identifier, which is crucial for preventing these events from being dropped by the Clearcut pipeline.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request correctly refactors the client identifier logic into createBasicLogEvent to ensure all telemetry events, including those for extensions, contain a client identifier. This centralization fixes the bug of missing identifiers and improves code maintainability. However, this change highlights a performance concern with repeated synchronous file I/O, for which I've left a comment.

[gemini-code-assist]

The method getCachedGoogleAccount() performs a synchronous file read on every call. Since createBasicLogEvent is now called for every telemetry event, this synchronous I/O could block the Node.js event loop and cause performance issues, especially when many events are logged in quick succession. This could impact the application's responsiveness.

To mitigate this, consider caching the email within the ClearcutLogger instance. A more robust solution would be to add in-memory caching to the UserAccountManager itself to avoid repeated file reads across the application.

[github-actions]

Size Change: -2 B (0%)

Total Size: 21.1 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	21.1 MB	-2 B (0%)
./bundle/sandbox-macos-permissive-closed.sb	1.03 kB	0 B
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-closed.sb	3.29 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B

_{compressed-size-action}