notif ios: Handle opening of conversation on tap; take 2 #1379
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| # Testing Push Notifications on iOS Simulator | ||
|
|
||
| For documentation on testing push notifications on Android or a real | ||
| iOS Device, see https://github.com/zulip/zulip-mobile/blob/main/docs/howto/push-notifications.md | ||
|
|
||
| This doc describes how to test client side changes on iOS Simulator. | ||
| It will demonstrate how to use APNs payloads the server sends to | ||
| Apple's Push Notification service to show notifications on iOS | ||
| Simulator. | ||
|
|
||
| ## 1. (Optional) Setup dev server | ||
|
|
||
| _Skip to step 6 in which you will use canned notification payloads, | ||
| these intermediate steps records how to get those payloads, which may | ||
| be useful in future._ | ||
|
|
||
| Follow | ||
| [this setup tutorial](https://zulip.readthedocs.io/en/latest/development/setup-recommended.html) | ||
| to setup and run the dev server on same the Mac machine that hosts | ||
| the iOS Simulator. | ||
|
|
||
| If you want to run the dev server on a different machine than the Mac | ||
| host, you'll need to follow extra steps | ||
| [documented here](https://github.com/zulip/zulip-mobile/blob/main/docs/howto/dev-server.md) | ||
| to make it possible for the app running on the iOS Simulator to | ||
| connect to the dev server. | ||
|
|
||
| ## 2. (Optional) Setup the dev user to receive mobile notifications. | ||
|
|
||
| We'll use the devlogin user `[email protected]` to test notifications, | ||
| log in to that user by going to `/devlogin` on that server on Web. | ||
|
|
||
| And then follow the steps [here](https://zulip.com/help/mobile-notifications) | ||
| to enable Mobile Notifications for "Channels". | ||
|
|
||
| ## 3. (Optional) Login to the dev user on zulip-flutter. | ||
|
|
||
| <!-- TODO(#405) Guide to use the new devlogin page instead --> | ||
|
|
||
| To login to this user in the Flutter app, you'll need the password | ||
| that was generated by the development server. You can print the | ||
| password by running this command inside your `vagrant ssh` shell: | ||
| ``` | ||
| $ ./manage.py print_initial_password [email protected] | ||
| ``` | ||
|
|
||
| Then run the app on the iOS Simulator, accept the permission to | ||
| receive push notifications, and then login to the dev user | ||
| (`[email protected]`). | ||
|
|
||
| ## 4. (Optional) Edit the server code to log the notification payload. | ||
|
|
||
| We need to retrieve the APNs payload the server generates and sends | ||
| to the bouncer. To do that we can add a log statement after the | ||
| server completes generating the APNs in `zerver/lib/push_notifications.py`: | ||
|
|
||
| ```diff | ||
| apns_payload = get_message_payload_apns( | ||
| user_profile, | ||
| message, | ||
| trigger, | ||
| mentioned_user_group_id, | ||
| mentioned_user_group_name, | ||
| can_access_sender, | ||
| ) | ||
| gcm_payload, gcm_options = get_message_payload_gcm( | ||
| user_profile, message, mentioned_user_group_id, mentioned_user_group_name, can_access_sender | ||
| ) | ||
| logger.info("Sending push notifications to mobile clients for user %s", user_profile_id) | ||
| + logger.info("APNS payload %s", orjson.dumps(apns_payload)) | ||
|
|
||
| android_devices = list( | ||
| PushDeviceToken.objects.filter(user=user_profile, kind=PushDeviceToken.FCM).order_by("id") | ||
| ``` | ||
|
|
||
| ## 5. (Optional) Send messages to the dev user | ||
|
|
||
| To generate notifications to the dev user `[email protected]` we need to | ||
| send messages from another user. For a variety of different types of | ||
| payloads try sending a message in a topic, a message in a group DM, | ||
| and one in one-one DM. Then look for the payloads in the server logs | ||
| by searching for "APNS payload". | ||
|
|
||
| The logged payload JSON will have different structure than what an | ||
| iOS device actually receives, to fix that, run the payload through | ||
| the following command: | ||
|
|
||
| ```shell-session | ||
| $ echo '{"alert":{"title": ...' | jq '{aps: {alert: .alert, sound: .sound, badge: .badge}, zulip: .custom.zulip}' | ||
| ``` | ||
|
|
||
| ## 6. Push APNs payload to iOS Simulator | ||
|
|
||
| _If you skipped steps 2-5, you'll need pre-forged APNs payloads for | ||
| existing messages in a default development server messages for the | ||
| user `[email protected]`:_ | ||
|
Comment on lines
+94
to
+96
There was a problem hiding this comment. These worked great for me (because I haven't gotten the dev server working with the bouncer — see question above), with one change: I replaced the string (If my dev server were located on the Mac where the simulator is running, then For me that looked like: There was a problem hiding this comment. bump — I'd like this information to not get lost for the next person. Here's a version that could go in verbatim:
|
||
|
|
||
| These canned payloads were generated from Zulip Server 11.0-dev+git | ||
| 8fd04b0f0, API Feature Level 377, in April 2025. | ||
|
There was a problem hiding this comment. ah, thanks for adding the 9th digit here :-) |
||
|
|
||
| These canned payloads assume that EXTERNAL_HOST has its default value | ||
| for the dev server. If you've | ||
| [set EXTERNAL_HOST to use an IP address](https://github.com/zulip/zulip-mobile/blob/main/docs/howto/dev-server.md#4-set-external_host) | ||
| in order to enable your device to connect to the dev server, you'll | ||
| need to adjust the `realm_url` fields. You can do this by a | ||
| find-and-replace for `localhost`; for example, | ||
| `perl -i -0pe s/localhost/10.0.2.2/g tmp/*.json` after saving the | ||
| canned payloads to files `tmp/*.json`. | ||
|
|
||
| <details> | ||
| <summary>Payload: dm.json</summary> | ||
|
|
||
| ```json | ||
| { | ||
| "aps": { | ||
| "alert": { | ||
| "title": "Zoe", | ||
| "subtitle": "", | ||
| "body": "But wouldn't that show you contextually who is in the audience before you have to open the compose box?" | ||
| }, | ||
| "sound": "default", | ||
| "badge": 0, | ||
| }, | ||
| "zulip": { | ||
| "server": "zulipdev.com:9991", | ||
| "realm_id": 2, | ||
| "realm_uri": "http://localhost:9991", | ||
| "realm_url": "http://localhost:9991", | ||
| "realm_name": "Zulip Dev", | ||
| "user_id": 11, | ||
| "sender_id": 7, | ||
| "sender_email": "[email protected]", | ||
| "time": 1740890583, | ||
| "recipient_type": "private", | ||
| "message_ids": [ | ||
| 87 | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Payload: group_dm.json</summary> | ||
|
|
||
| ```json | ||
| { | ||
| "aps": { | ||
| "alert": { | ||
| "title": "Othello, the Moor of Venice, Polonius (guest), Iago", | ||
| "subtitle": "Othello, the Moor of Venice:", | ||
| "body": "Sit down awhile; And let us once again assail your ears, That are so fortified against our story What we have two nights seen." | ||
| }, | ||
| "sound": "default", | ||
| "badge": 0, | ||
| }, | ||
| "zulip": { | ||
| "server": "zulipdev.com:9991", | ||
| "realm_id": 2, | ||
| "realm_uri": "http://localhost:9991", | ||
| "realm_url": "http://localhost:9991", | ||
| "realm_name": "Zulip Dev", | ||
| "user_id": 11, | ||
| "sender_id": 12, | ||
| "sender_email": "[email protected]", | ||
| "time": 1740533641, | ||
| "recipient_type": "private", | ||
| "pm_users": "11,12,13", | ||
| "message_ids": [ | ||
| 17 | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Payload: stream.json</summary> | ||
|
|
||
| ```json | ||
| { | ||
| "aps": { | ||
| "alert": { | ||
| "title": "#devel > plotter", | ||
| "subtitle": "Desdemona:", | ||
| "body": "Despite the fact that such a claim at first glance seems counterintuitive, it is derived from known results. Electrical engineering follows a cycle of four phases: location, refinement, visualization, and evaluation." | ||
| }, | ||
| "sound": "default", | ||
| "badge": 0, | ||
| }, | ||
| "zulip": { | ||
| "server": "zulipdev.com:9991", | ||
| "realm_id": 2, | ||
| "realm_uri": "http://localhost:9991", | ||
| "realm_url": "http://localhost:9991", | ||
| "realm_name": "Zulip Dev", | ||
| "user_id": 11, | ||
| "sender_id": 9, | ||
| "sender_email": "[email protected]", | ||
| "time": 1740558997, | ||
| "recipient_type": "stream", | ||
| "stream": "devel", | ||
| "stream_id": 11, | ||
| "topic": "plotter", | ||
| "message_ids": [ | ||
| 40 | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| To receive a notification on the iOS Simulator, we need to push | ||
| the APNs payload to the specific running iOS Simulator by using it's | ||
| device ID, you can get the device ID by running the following command: | ||
|
|
||
| ```shell-session | ||
| $ xcrun simctl list devices booted | ||
| ``` | ||
|
|
||
| <details> | ||
| <summary>Example output:</summary> | ||
|
|
||
| ```shell-session | ||
| $ xcrun simctl list devices booted | ||
| == Devices == | ||
| -- iOS 18.3 -- | ||
| iPhone 16 Pro (90CC33B2-679B-4053-B380-7B986A29F28C) (Booted) | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| And then push the payload using the following command: | ||
|
|
||
| ```shell-session | ||
| $ xcrun simctl push [device-id] com.zulip.flutter [payload json path] | ||
| ``` | ||
|
|
||
| <details> | ||
| <summary>Example output:</summary> | ||
|
|
||
| ```shell-session | ||
| $ xcrun simctl push 90CC33B2-679B-4053-B380-7B986A29F28C com.zulip.flutter ./dm.json | ||
| Notification sent to 'com.zulip.flutter' | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| Now, on the iOS Simulator you should have a notification and tapping | ||
| on it should route to the specific conversation. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Commit-message nit:
I think the "to" should be deleted? Or moved to replace the "->"?
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.
commit-message nit: limit summary line length to 76 (this is 85).