-
Notifications
You must be signed in to change notification settings - Fork 55
Release v3.3.1 #308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release v3.3.1 #308
Conversation
- Supports core iOS v7.1.1
[SDK-4600] Fix App Freeze issue while define variables
WalkthroughThis update increments the CleverTap Flutter plugin version to 3.3.1, reflecting compatibility with CleverTap iOS SDK v7.1.1. The changelog and documentation are updated accordingly. iOS platform-specific bug fixes are applied to the Changes
Sequence Diagram(s)sequenceDiagram
participant App
participant CleverTapPlugin (Dart)
participant CleverTapPlugin (iOS)
participant CleverTap SDK
App->>CleverTapPlugin (Dart): defineVariables(variables)
CleverTapPlugin (Dart)->>CleverTapPlugin (iOS): defineVariables(variables)
alt variables nil or empty
CleverTapPlugin (iOS)->>CleverTapPlugin (Dart): result(nil)
else variables present
CleverTapPlugin (iOS)->>CleverTap SDK: define variable(s)
CleverTapPlugin (iOS)->>CleverTapPlugin (Dart): result(nil)
end
sequenceDiagram
participant Dart
participant Native Android
participant Executor (Background Thread)
Dart->>Native Android: renderNotification(extras)
alt cleverTapAPI is null
Native Android->>Dart: error("CleverTap API is null")
else cleverTapAPI not null
alt on main thread
Native Android->>Executor: execute processNotification(extras)
Executor->>Native Android: process notification
Native Android->>Dart: success or error
else not main thread
Native Android->>Native Android: processNotification(extras)
Native Android->>Dart: success or error
end
end
Suggested reviewers
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CHANGELOG.md (1)
7-8
: Refine wording for clarity
Consider revising the "What's new" entry for consistency:- * Adds `dismissInAppNotification` action to dismiss custom HTML in-Apps + * Adds `dismissInAppNotification` action to dismiss custom HTML in-app notifications
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
CHANGELOG.md
(1 hunks)README.md
(1 hunks)ios/Classes/CleverTapPlugin.m
(1 hunks)ios/clevertap_plugin.podspec
(2 hunks)lib/clevertap_plugin.dart
(1 hunks)pubspec.yaml
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md
3-3: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
5-5: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
10-10: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
🔇 Additional comments (9)
README.md (1)
24-24
: Version bump in README
The version snippet in the quick start section has been correctly updated to3.3.1
, matching the release.pubspec.yaml (1)
3-3
: Package version updated
Thepubspec.yaml
version has been bumped to3.3.1
in line with the new release.ios/clevertap_plugin.podspec (2)
6-6
: Podspec version bumped
The podspec version is correctly updated to3.3.1
.
16-16
: iOS SDK dependency updated
TheCleverTap-iOS-SDK
dependency is correctly set to version7.1.1
.lib/clevertap_plugin.dart (2)
76-78
: Library version constant updated
ThelibVersion
constant has been incremented from30300
to30301
, aligning with the 3.3.1 release.
76-140
: Inconsistent summary: missing API fordismissInAppNotification
The PR summary mentions a new actiondismissInAppNotification
, but I don't see a corresponding Dart wrapper method in this file. Please verify whether the Dart API for dismissing custom HTML in-app notifications has been implemented or if it needs to be added.Likely an incorrect or invalid review comment.
CHANGELOG.md (1)
10-13
: Bug fixes description is accurate
The fixes for the freezing issue withdefineVariables()
and the custom in-app orientation check are clearly described and match the PR objectives.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
ios/Classes/CleverTapPlugin.m (2)
1475-1478
: Proper nil check and result callback for empty variablesThis is a good fix for preventing app freezing when passing nil or empty variables. It ensures that the result callback is properly called before returning from the method when there's nothing to process.
1493-1499
: Proper result callback handling for file variablesThis change ensures that the result callback is always called, even when the fileVariable is nil or when processing is complete. This properly fixes the freezing issue when using
await
with this method.
* task(SDK-4506) - Moves renderNotification to an executor thread - The core SDK API expected to be called only on a worker thread - This ensures the images are downloaded correctly * task(SDK-4506) - Resolves PR comments * task(SDK-4506) - Adds changelog and bumps versions
…tion task(SDK-4506) - Fixes indentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
CHANGELOG.md (4)
3-4
: Consider using ATX-style headings for version entries
The current setext-style underline for version headings triggers markdownlint (MD003). For consistency and better readability, you could rewrite this as:- Version 3.3.1 *(18 April 2025)* - ------------------------------------------- + ### Version 3.3.1 (18 April 2025)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Heading style
Expected: atx; Actual: setext(MD003, heading-style)
5-5
: Use heading syntax instead of emphasis for section titles
Markdownlint flags (MD036) on using emphasis (**What's new**
) as a heading. Consider converting to a heading, e.g.:- **What's new** + #### What's new🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
6-8
: Verify in-app casing consistency
The entry mentions “custom HTML in‑Apps” (line 8) with mixed casing. To maintain consistency with other changelog entries (e.g., “in-apps” or “InApps”), choose one style, for example:- * Adds `dismissInAppNotification` action to dismiss custom HTML in‑Apps + * Adds `dismissInAppNotification` action to dismiss custom HTML in‑apps
10-11
: Use heading syntax instead of emphasis for section titles
Similarly to the “What’s new” section, the “Bug Fixes” title is marked as emphasis. Using a proper heading (e.g.,#### Bug Fixes
) will improve consistency and satisfy markdownlint (MD036).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md
3-3: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
5-5: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
10-10: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
CHANGELOG.md (2)
11-12
: [Android] Bug fix description matches PR objectives
The Android bug fix correctly documents the rendering issue in push templates when using a custom FCM integration.
14-16
: [iOS] Bug fix entries accurately reflect fixes
The two iOS fixes (app freezing withdefineVariables()
and custom in‑app orientation check) match the PR description.
What's new
dismissInAppNotification
action to dismiss custom HTML in-AppsBug Fixes
defineVariables()
.Summary by CodeRabbit
New Features
Bug Fixes
Improvements
Documentation