Unique anonymous ID statistics tracking by seanbudd · Pull Request #16710 · nvaccess/nvda

seanbudd · 2024-06-17T06:29:26Z

Link to issue number:

Summary of the issue:

Right now NV access is unable to gauge monthly or weekly users, only daily users.
Each day NVDA performs an update check and optionally sends more usage data information.
We are unable to differentiate copies performing update checks, meaning we only know X users who checked for an update on a given day.

Description of user facing changes

None

Description of development approach

A unique ID is stored to user config when initializing the update check.
This creates a unique ID per user of NVDA, counting portable copies and each Windows user's profile of an installation.

When checking for update, NVDA now sends the unique ID if usage tracking is enabled.

Testing strategy:

Tested running NVDA from installed copy, ensured unique ID persisted. Set lastCheckUpdate time to trigger new unique ID.

Known issues with pull request:

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

Summary by CodeRabbit

New Features
- Added a unique anonymous ID for improved NVDA usage statistics gathering.
Documentation
- Updated user guide to clarify data usage statistics dialog and user consent process.
Enhancements
- Improved update checking functionality with monthly unique ID updates.
Bug Fixes
- Refined NVDA behavior in the Python console for better performance.

coderabbitai · 2024-06-18T02:57:52Z

Walkthrough

Recent changes in the NVDA screen reader enhance the update checking functionality by including a unique, anonymous installation ID in telemetry data. This improves user statistics collection and resource allocation. User consent remains central, with an emphasis on transparency in data usage as documented in user guides. Debug logging was also introduced to track the NVDA user ID during initialization, ensuring better visibility into the process.

Changes

File(s)	Change Summary
`source/core.py`	Added debug log statement to print NVDA user ID during initialization in the `Notify` method.
`source/updateCheck.py`	Integrated `datetime` and `uuid4`, utilized `id` in `extraParams`, added monthly unique ID update logic.
`user_docs/en/changes.md`	Updated description to include changes in telemetry data, specifically the addition of a unique ID.
`user_docs/en/userGuide.md`	Enhanced explanations on user consent and data gathering settings, detailing the purpose and data types.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NVDA
    participant UpdateCheck
    participant NVAccess

    User->>NVDA: Start NVDA
    NVDA->>UpdateCheck: Check state
    alt State ID not present
        UpdateCheck->>UpdateCheck: Initialize State ID (uuid4)
    end
    User->>NVDA: Continue using NVDA
    NVDA->>UpdateCheck: Request update
    UpdateCheck->>NVAccess: Send telemetry data with unique ID
    NVAccess->>UpdateCheck: Process update
    UpdateCheck->>NVDA: Confirm update or latest version

Assessment against linked issues

Objective	Addressed	Explanation
Addition of a unique anonymous installation ID with monthly rotation (#16266)	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Qchristensen

Looks good. Made one minor suggestion re the changes file, but otherwise fine.

codeofdusk · 2024-06-19T00:39:06Z

Is there a protocol for rotating unique IDs on a regular schedule, so these IDs still provide usage statistics without being linkable to individual users?

seanbudd · 2024-06-19T01:15:50Z

@codeofdusk , yes it resets once a month on the first check of the month

seanbudd added 6 commits June 17, 2024 15:56

Unique anonymous ID tracking

1e436e5

add ARM check

3a8a37c

fix config for userID being set

5a3a7af

Merge remote-tracking branch 'origin/master' into uniqueID

9eeff0f

make rotating

f8d9f14

simplify

4c4a9c2

seanbudd commented Jun 17, 2024

View reviewed changes

Comment thread source/updateCheck.py Outdated

remove redundant ARM check

8a7c514

seanbudd changed the title ~~Unique anonymous ID and ARM usage tracking~~ Unique anonymous ID statistics tracking Jun 17, 2024

make id creation safer

4aa7214

seanbudd marked this pull request as ready for review June 18, 2024 02:57

seanbudd requested review from a team as code owners June 18, 2024 02:57

seanbudd requested review from Qchristensen and gerald-hartig June 18, 2024 02:57

coderabbitai Bot reviewed Jun 18, 2024

View reviewed changes

Comment thread source/core.py

gerald-hartig approved these changes Jun 18, 2024

View reviewed changes

Qchristensen approved these changes Jun 18, 2024

View reviewed changes

Comment thread user_docs/en/changes.md Outdated

Update user_docs/en/changes.md

5a72f6d

seanbudd merged commit 0dafa8a into master Jun 18, 2024

seanbudd deleted the uniqueID branch June 18, 2024 22:59

Adriani90 mentioned this pull request Jul 1, 2024

Difficulties installing NVDA 2024.3beta1 #16784

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Unique anonymous ID statistics tracking#16710

Unique anonymous ID statistics tracking#16710
seanbudd merged 9 commits into
masterfrom
uniqueID

seanbudd commented Jun 17, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Qchristensen left a comment

Uh oh!

Uh oh!

codeofdusk commented Jun 19, 2024 •

edited

Loading

Uh oh!

seanbudd commented Jun 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

seanbudd commented Jun 17, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Summary by CodeRabbit

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Qchristensen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codeofdusk commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seanbudd commented Jun 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

seanbudd commented Jun 17, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 18, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codeofdusk commented Jun 19, 2024 •

edited

Loading