fix(git-673) - Moves recording impressions and counts to an io thread

[Anush-Shand]

https://github.com/CleverTap/clevertap-android-sdk/issues/673

After an InApp is displayed, it's impressions are recorded on the main thread. Even though it's simply accessing the shared prefs, this comes up in the StrictModeViolation

Clients are concerned this may be causing ANRs in the worst case. There's a possibility that for InApps linked to the AppLaunch event, the prefs might not be loaded into memory yet. This along with slow app startup time might be leading to ANRs

There could be concerns regarding race conditions here?

Summary by CodeRabbit

• New Features
  • Enhanced in-app notifications for a more responsive and consistent user experience.
  • Streamlined the notification delivery process to ensure timely displays while effectively managing notification frequency.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)

• \b(master|main|develop)(_\w*)?

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request refactors two components of the in-app notification system to introduce asynchronous task execution. In the in-app frequency controller, impression recording and count increments are now executed in a background task. In the controller for in-app notifications, the logic for checking frequency limits is isolated into a new asynchronous method that determines if a notification should be shown. Additionally, method visibilities were updated from static to instance methods to align with the new control flow.

Changes

File(s) Changed	Change Summary
clevertap-core/src/main/java/com/clevertap/android/sdk/InAppFCManager.java	Modified didShow method to encapsulate impression recording and count increment operations within an asynchronous task executed via CTExecutorFactory.executors(config).ioTask(). Retrieval and storage of today’s count have also been moved into the task.
clevertap-core/.../inapp/InAppController.java	Refactored in-app notification flow by introducing a new method checkLimitsBeforeShowing that asynchronously verifies frequency limits before displaying notifications. Updated method visibilities from static to instance for checkPendingNotifications and showInApp.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant InAppFCManager
    participant TaskExecutor
    participant ImpressionManager
    participant PersistentStore

    Client->>InAppFCManager: didShow(id)
    InAppFCManager->>TaskExecutor: execute("recordInAppImpressionsAndCounts", lambda)
    TaskExecutor->>ImpressionManager: recordImpression(id)
    TaskExecutor->>PersistentStore: incrementInAppCounts(id)
    TaskExecutor->>PersistentStore: update today's count in shared preferences
    InAppFCManager-->>Client: returns null

sequenceDiagram
    participant Caller
    participant InAppController
    participant TaskExecutor
    participant NotificationManager

    Caller->>InAppController: checkPendingNotifications()
    InAppController->>InAppController: checkLimitsBeforeShowing()
    InAppController->>TaskExecutor: execute async check task
    TaskExecutor-->>InAppController: return boolean result
    alt Notification allowed
        InAppController->>InAppController: showInApp()
    else Notification not allowed
        InAppController->>NotificationManager: showNotificationIfAvailable()
    end

Suggested Reviewers

• CTLalit

---

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.