Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove extension telemetry setting and use VS Code setting instead #3853

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

koesie10
Copy link
Member

@koesie10 koesie10 commented Dec 5, 2024

This removes the codeQL.telemetry.enableTelemetry setting and uses the VS Code settings instead. This is done automatically in the vscode-extension-telemetry package, so we don't need to check the VS Code settings.

Since this changes the telemetry when you currently have the extension telemetry disabled, but the VS Code telemetry enabled, this also adds a non-dismissable notification when starting the extension (if VS Code telemetry is enabled and codeQL.telemetry.enableTelemetry is false).

The E2E tests are expected to fail since it installs the released extension rather than the extension from the repo.

@koesie10 koesie10 marked this pull request as ready for review December 5, 2024 12:36
@koesie10 koesie10 requested a review from a team as a code owner December 5, 2024 12:36
Copy link
Contributor

@robertbrignull robertbrignull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM and I tried it out and the popup worked as expected (one non-blocking comment)

let chosenItem;

do {
chosenItem = await window.showInformationMessage(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's slightly annoying you get a "cancel" button but if you click it the dialog just comes back. Sadly I can't see a way to get rid of it and there's nothing sensible we can really do to "cancel" this update, so I agree I think we just leave it like this. Users will only see it once at least.

Screenshot 2024-12-05 at 16 41 03

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree that this is quite annoying, but I also couldn't find a way to hide it. An alternative solution would be to keep the old setting for a few releases while showing this dialog, where the cancel button would simply keep using the old setting. However, we hope this scenario is quite rare and don't think it's worth the effort to have a "transition" like that which would require some additional work in a few releases.

@koesie10 koesie10 merged commit ff95caf into main Dec 6, 2024
26 of 27 checks passed
@koesie10 koesie10 deleted the koesie10/remove-telemetry-setting branch December 6, 2024 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Less obtrusive way to ask users to collect telemetry
2 participants