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

feat: add report analytics settings [HEAD-975] #394

Closed
wants to merge 2 commits into from

Conversation

cat2608
Copy link
Contributor

@cat2608 cat2608 commented Nov 18, 2023

Description

This PR introduces the analytics flag. yesAnalyticsReport enables users to opt-in to analytics reporting. This setting allows the extension to collect usage statistics to help improve the product.

Note: this is a continuation from #392. You can dismiss #392 changes by looking at the commits of this branch. Please merge that first :)

Checklist

  • Tests added and all succeed
  • Linted
  • CHANGELOG.md updated
  • README.md updated, if user-facing

Screenshots / GIFs

Analytics Enable Analytics Disabled
analytics-enabled analytics-disabled

@cat2608 cat2608 requested a review from a team as a code owner November 18, 2023 16:45
Comment on lines 24 to +27
// Reporting and telemetry
sendErrorReports?: string;
enableTelemetry?: string;
enableAnalytics?: boolean;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not really sure why the other flags are handled as string. I decided to handle enableAnalytics as boolean but more than happy to change to string if that's the correct way :)

Copy link
Contributor

Choose a reason for hiding this comment

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

A historical flaw/bug - using boolean here is correct.

Introduced `yesAnalyticsReport` flag to allow users to opt-in or opt-out of analytics reporting.
This setting is added to `package.json` for visibility in VS Code UI and integrated into the `IConfiguration` interface.
@cat2608 cat2608 force-pushed the feat/HEAD-975-add-report-analytics-flag branch from dea4974 to 13d2868 Compare November 20, 2023 09:11
@cat2608
Copy link
Contributor Author

cat2608 commented Nov 20, 2023

Change not relevant now 👋

@cat2608 cat2608 closed this Nov 20, 2023
@cat2608 cat2608 deleted the feat/HEAD-975-add-report-analytics-flag branch December 20, 2023 13:40
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.

2 participants