[ECO-5119] Opt out default push handler

[maratal]

Closes #557

Some users use APNs via FCM, so there should be an option to turn-off default handling of push notifications in iOS Ably Flutter to give user an ability to handle it themselves or via FCM framework (similar opt-out exists in android's Ably Flutter via AndroidManifest).

Summary by CodeRabbit

• New Features

  • Added configuration option for handling push notifications in iOS app
  • Introduced ability to conditionally enable Apple Push Notifications (APNs)

• Improvements

  • Enhanced push notification handling flexibility
  • Updated iOS application entry point annotation

[coderabbitai[bot]]

Walkthrough

The changes focus on enhancing push notification handling in an iOS application using the Ably Flutter plugin. The modifications include updating the AppDelegate.swift with a new method for handling remote notifications, adding a configuration key in Info.plist to control push notification handling, and modifying the AblyFlutter.m to conditionally initialize push notification event handlers based on a new configuration parameter.

Changes

File	Change Summary
example/ios/Runner/AppDelegate.swift	- Replaced @UIApplicationMain with @main annotation - Added deprecated method application(_:didReceiveRemoteNotification:fetchCompletionHandler:) for logging notifications
example/ios/Runner/Info.plist	- Added AblyFlutterHandlePushNotifications key with true value
ios/Classes/AblyFlutter.m	- Updated initWithChannel:streamsChannel:registrar: method signature - Added handleAPNs parameter to conditionally handle push notifications

Assessment against linked issues

Objective	Addressed	Explanation
Resolve app crash when opening notification [#557, ECO-5119]	❓	The changes add conditional push notification handling and logging but do not explicitly address crash root cause or fix

Poem

🐰 A rabbit's tale of push notification glee,
Code dancing swift, setting notifications free
From @UIApplicationMain to @main we leap
Ably's Flutter plugin, no more crashes to keep!
Hop, hop, hooray for smoother notification play! 🚀

---

📜 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 4399f09e46a9401f62534d9806b69ebe8ea808bd and 9c0bc132b0ba88c05b79a7fd3b7fab3212d5ff54.

📒 Files selected for processing (3)

• example/ios/Runner/AppDelegate.swift (1 hunks)
• example/ios/Runner/Info.plist (1 hunks)
• ios/Classes/AblyFlutter.m (2 hunks)

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

• example/ios/Runner/Info.plist
• example/ios/Runner/AppDelegate.swift
• ios/Classes/AblyFlutter.m

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

• GitHub Check: android
• GitHub Check: ios (iPhone 15)
• GitHub Check: android (29)
• GitHub Check: android (24)
• GitHub Check: ios

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

🧪 Generate Unit Tests

• [ ] Create PR with Unit Tests
• [ ] Commit Unit Tests in branch fix/557-opt-out-push-handler
• [ ] Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests 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.

[lawrence-forooghian]

Hey @maratal, I'm here in response to us being asked if we intend to merge this into main. I haven't been following this issue closely, but as I understand it:

• the Flutter SDK has some code that is called in response to some iOS lifecycle event (which?)
• this code was causing a crash

So, my questions:

• did we fix the crash?
• why do we need to give the option of disabling this handling of the iOS lifecycle event? is it because this handling causes a crash, or is it because this handling prevents users from handling push notifications themselves, or both?

[maratal]

Hey @maratal, I'm here in response to us being asked if we intend to merge this into main. I haven't been following this issue closely, but as I understand it:

* the Flutter SDK has some code that is called in response to _some_ iOS lifecycle event (which?)

* this code was causing a crash

So, my questions:

* did we fix the crash?

* why do we need to give the option of disabling this handling of the iOS lifecycle event? is it because this handling causes a crash, or is it because this handling prevents users from handling push notifications themselves, or both?

Both FCM and Ably Flutter intercept incoming push. It wasn't causing crash in my experiments, but looks like for some users it does. FCM has similar option to opt-out, so I think it makes sense to give users this option in Ably Flutter too. It will help for some users, but turned out that at least one client doesn't have the control over his client's code, that's why I've made it to be opted out by default.

[lawrence-forooghian]

If we make the handling opt-out, what guidance would we give to customers for this option? It would have to be something like "some users have experienced crashes that may be related to this SDK's default handling of push notifications; here's how to opt out". Is that the plan?

If we were to make it opt-in, what would be the consequences for the existing users of the library?

As for reproducing the crash, do we have any customer who has been able to reproduce it?

[Hadii1]

Hello! I'm still not sure how to opt out of using PN on Flutter iOS? Currently, I can't use Ably for the WebSocket services because I'm using Firebase messaging for PN.

Edit: After checking the commit comments, it turns out this flag must be added in the Info.plist:

<key>AblyFlutterHandlePushNotifications</key>
<false/>