TemplateContext debugDescription: fallback to action type name

[nzagorchev]

Summary by CodeRabbit

• New Features

  • Added a method to retrieve action names for in-app notifications with improved logic for name resolution.

• Refactor

  • Enhanced the way action names are determined and displayed in the SDK.

[coderabbitai]

Walkthrough

The changes introduce a new method actionName: in the CTTemplateContext class to retrieve the name of a CTNotificationAction. This method provides a centralized approach to determining an action's name by first checking custom template in-app data and then falling back to the action type string. The debugDescription method is also updated to use this new method, improving code consistency and maintainability.

Changes

File	Change Summary
CleverTapSDK/InApps/CustomTemplates/CTTemplateContext.m	Added actionName: method to retrieve notification action name with fallback logic

Poem

🐰 A rabbit's tale of code so bright,
Where action names now shine just right
With fallback logic, clean and neat
Our method makes the naming sweet
In CleverTap's SDK delight! 🔍

---

🪧 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CleverTapSDK/InApps/CustomTemplates/CTTemplateContext.m (1)

264-273: Add input validation and documentation for the new method.

The method implementation looks good, but could benefit from:

1. Input validation for nil action parameter
2. Documentation explaining the method's purpose and fallback behavior

Consider adding validation and documentation:

+/**
+ * Returns the name for the given notification action.
+ * @param action The notification action (must not be nil)
+ * @return The action name, falling back to action type if template name is not available,
+ *         or empty string if both are unavailable
+ */
 - (NSString *)actionName:(CTNotificationAction *)action {
+    if (!action) {
+        CleverTapLogStaticDebug(@"%@: Cannot get action name for nil action", [self class]);
+        return @"";
+    }
     NSString *name = action.customTemplateInAppData.templateName;
     if (!name) {
         name = [CTInAppUtils inAppActionTypeString:action.type];
     }
     if (!name) {
         name = @"";
     }
     return name;
 }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9965acc and bdb342a.

📒 Files selected for processing (1)

• CleverTapSDK/InApps/CustomTemplates/CTTemplateContext.m (1 hunks)

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

• GitHub Check: build

🔇 Additional comments (1)

CleverTapSDK/InApps/CustomTemplates/CTTemplateContext.m (1)

281-281: LGTM! Good refactoring to use the centralized method.

The change improves code consistency by using the new actionName: method instead of directly accessing the template name.

[nishant-clevertap]

Base branch should be develop

[nishant-clevertap]

LGTM