refactor(analytics): obfuscate android id

[jo-elimu]

#1863

Technical Details

Testing Instructions

Screenshots

---

Format Checks

Note

Files in PRs are automatically checked for format violations with mvn spotless:check.

If this PR contains files with format violations, run mvn spotless:apply to fix them.

[coderabbitai]

Warning

Rate limit exceeded

@jo-elimu has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 20 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between f4f6e6a and bef81b5.

Walkthrough

The changes involve modifications to the getAndroidId method in the LearningEvent class to enhance privacy by masking parts of the returned Android ID unless it is already marked. Additionally, the handleRequest method in the StoryBookLearningEventCsvExportController class was updated to include a call to close the csvPrinter resource after flushing, ensuring proper resource management.

Changes

File	Change Summary
src/main/java/ai/elimu/model/analytics/LearningEvent.java	Modified getAndroidId method to conditionally mask the Android ID based on its content.
src/main/java/ai/elimu/web/analytics/StoryBookLearningEventCsvExportController.java	Added csvPrinter.close() after csvPrinter.flush() in handleRequest method to ensure resource closure.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LearningEvent
    participant StoryBookLearningEventCsvExportController
    participant CsvPrinter

    Client->>LearningEvent: Request Android ID
    LearningEvent->>LearningEvent: Get androidId
    alt androidId contains "***"
        LearningEvent-->>Client: Return androidId
    else androidId does not contain "***"
        LearningEvent-->>Client: Return masked androidId
    end

    Client->>StoryBookLearningEventCsvExportController: Request CSV export
    StoryBookLearningEventCsvExportController->>CsvPrinter: Print data
    StoryBookLearningEventCsvExportController->>CsvPrinter: Flush data
    StoryBookLearningEventCsvExportController->>CsvPrinter: Close printer

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 Configuration 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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 15.05%. Comparing base (bdfc51d) to head (bef81b5).
Report is 5 commits behind head on main.

Files	Patch %	Lines
...ics/StoryBookLearningEventCsvExportController.java	0.00%	4 Missing ⚠️
...n/java/ai/elimu/model/analytics/LearningEvent.java	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1868      +/-   ##
============================================
- Coverage     15.06%   15.05%   -0.01%     
  Complexity      456      456              
============================================
  Files           250      250              
  Lines          7721     7725       +4     
  Branches        808      808              
============================================
  Hits           1163     1163              
- Misses         6508     6512       +4     
  Partials         50       50              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 1