System In-app Functions

[vasct]

Summary by CodeRabbit

• New Features

  • Integrated an enhanced in-app review flow for swift app rating.
  • Enabled interactive in-app actions for launching links and prompting push notifications.
  • Introduced a structured approach for managing push notification permissions.

• Bug Fixes

  • Improved error handling and logging for the Play Store review process.

• Refactor

  • Streamlined push notification permission prompts and settings navigation for a more consistent user experience.
  • Consolidated in-app messaging processes, ensuring smoother interactions across devices.
  • Enhanced the structure of the in-app action handling and template management.
  • Removed deprecated classes and methods to simplify the codebase.

[coderabbitai[bot]]

Walkthrough

This pull request introduces a range of changes across the codebase to enhance the app’s push notification and in-app messaging functionalities. Key modifications include adding a Play Review dependency, refactoring push permission handling by replacing legacy components with a new PushPermissionHandler, and consolidating code in InAppActionHandler. Additionally, custom template creation has been updated to support system-defined templates. Several legacy classes and tests have been removed, and method signatures have been updated across multiple components to improve clarity and streamline control flows.

Changes

File(s)	Change Summary
clevertap-core/build.gradle gradle/libs.versions.toml	Added Play Review dependency (libs.play.review) with version 2.0.2 to support the app rating system.
clevertap-core/src/main/java/com/clevertap/android/sdk/CTPreferenceCache.kt	Added updateCacheToDisk method and updated firstTimeRequest variable to private, streamlining cache persistence logic.
clevertap-core/src/main/java/com/clevertap/android/sdk/CTStringResources.kt clevertap-core/src/test/java/com/clevertap/android/sdk/CTStringResourcesTest.kt sample/src/main/java/com/clevertap/demo/JavaToKtInterOp.java clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/AlertDialogPromptForSettings.kt clevertap-core/src/main/java/com/clevertap/android/sdk/PushPermissionManager.java	Removed legacy files managing string resources, alert dialog prompts, Java–Kotlin interoperability, and push permission management.
clevertap-core/src/main/java/com/clevertap/android/sdk/CleverTapAPI.java clevertap-core/src/main/java/com/clevertap/android/sdk/Utils.java clevertap-core/src/main/java/com/clevertap/android/sdk/PushPermissionResponseListener.java	Updated method signatures by adding @NonNull annotation, simplified push permission logic by removing Android version checks, and corrected documentation comments.
clevertap-core/src/main/java/com/clevertap/android/sdk/CleverTapFactory.kt clevertap-core/src/main/java/com/clevertap/android/sdk/InAppController.java clevertap-core/src/main/java/com/clevertap/android/sdk/CTInboxActivity.java clevertap-core/src/main/java/com/clevertap/android/sdk/CTInAppNotification.java clevertap-core/src/main/java/com/clevertap/android/sdk/InAppNotificationActivity.java clevertap-core/src/main/java/com/clevertap/android/sdk/PushPermissionHandler.kt	Refactored push permission and in-app messaging flow by replacing legacy managers with an integrated InAppActionHandler and PushPermissionHandler, consolidating permission prompts and control flow.
clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/InAppActionHandler.kt	Introduced a new class to handle in-app actions such as URL opening, launching the Play Store review flow, and prompting for push permissions.
clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/CustomTemplate.kt clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/TemplatesManager.kt clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/OpenUrlTemplate.kt clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/PlayStoreAppRatingTemplate.kt clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/PushPermissionTemplate.kt clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/SystemTemplates.kt	Modified and added custom template components to incorporate a new isSystemDefined flag, update template creation signatures, and integrate system templates via the InAppActionHandler.
clevertap-core/src/test/java/com/clevertap/android/sdk/inapp/InAppActionHandlerTest.kt clevertap-core/src/test/java/com/clevertap/android/sdk/inapp/customtemplates/TemplatesManagerTest.kt clevertap-core/src/test/java/com/clevertap/android/sdk/inapp/customtemplates/system/OpenUrlTemplateTest.kt clevertap-core/src/test/java/com/clevertap/android/sdk/inapp/customtemplates/system/SystemTemplatesTest.kt	Added new test classes to validate the functionality of the InAppActionHandler and custom template management processes.

Sequence Diagram(s)

sequenceDiagram
    participant Activity as InAppNotificationActivity/CTInboxActivity
    participant Handler as PushPermissionHandler
    participant System as Android OS

    Activity ->> Handler: onActivityResume(context)
    Handler ->> System: Check notification permission status
    System -->> Handler: Return permission status
    Handler -->> Activity: Update UI with result

sequenceDiagram
    participant Factory as CleverTapFactory
    participant ActionHandler as InAppActionHandler
    participant SystemTemplates as SystemTemplates
    participant Manager as TemplatesManager

    Factory ->> ActionHandler: Create instance for in-app actions
    Factory ->> SystemTemplates: getSystemTemplates(ActionHandler)
    SystemTemplates -->> Factory: System templates set
    Factory ->> Manager: createInstance(config, systemTemplates)
    Manager -->> Factory: Return TemplatesManager instance

Possibly related PRs

• CleverTap/clevertap-android-sdk#774: Addresses similar modifications in the build configuration for integrating the Play Review library, directly relating to the addition of the app rating system.

Suggested reviewers

• Anush-Shand
• piyush-kukadiya
• CTLalit

[!TIP]

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad2c9c2f4a331ee0b9698ba7d2fb8d262f630fcf and 2f084ecbe650a1373ca622482d237ead2419ddf5.

📒 Files selected for processing (1)

• clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/PlayStoreAppRatingTemplate.kt (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• clevertap-core/src/main/java/com/clevertap/android/sdk/inapp/customtemplates/system/PlayStoreAppRatingTemplate.kt

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: lint-staticChecks-test-build

---

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

[vasct]

@coderabbitai review

[coderabbitai[bot]]

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[CTLalit]

I have reviewed chained PRs, will take a look again at this later, lets raise separate prs for fixes @vasct

[vasct]

Addressed some comments in this PR: https://github.com/CleverTap/clevertap-android-sdk/pull/787