Unfurl profile name on remote push notifications
This commit adds support for the unfurling of author profile names on remote push notifications It also makes the following changes: - Notification extension now uses NdbNote - Some of the logic between push notifications and local notifications was unified Testing ------- Device: iPhone 15 Pro simulator iOS: 17.0.1 Damus: This commit Coverage: 1. Basic smoke tests on the app by browsing different notes and different tabs 2. Sent test push notifications for mentions and DMs to check the unfurling of profile names 3. Ran unit tests Closes: https://github.com/damus-io/damus/issues/1703 Changelog-Added: Unfurl profile name on remote push notifications Signed-off-by: Daniel D’Aquino <daniel@daquino.me> Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
Daniel D’Aquino
committed by
William Casarin
William Casarin
parent
460f536fa3
commit
4171252b18
@@ -1,49 +0,0 @@
|
||||
//
|
||||
// NostrEventInfoFromPushNotification.swift
|
||||
// DamusNotificationService
|
||||
//
|
||||
// Created by Daniel D’Aquino on 2023-11-13.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
|
||||
/// The representation of a JSON-encoded Nostr Event used by the push notification server
|
||||
/// Needs to match with https://gitlab.com/soapbox-pub/strfry-policies/-/raw/433459d8084d1f2d6500fdf916f22caa3b4d7be5/src/types.ts
|
||||
struct NostrEventInfoFromPushNotification: Codable {
|
||||
let id: String // Hex-encoded
|
||||
let sig: String // Hex-encoded
|
||||
let kind: NostrKind
|
||||
let tags: [[String]]
|
||||
let pubkey: String // Hex-encoded
|
||||
let content: String
|
||||
let created_at: Int
|
||||
|
||||
static func from(dictionary: [AnyHashable: Any]) -> NostrEventInfoFromPushNotification? {
|
||||
guard let id = dictionary["id"] as? String,
|
||||
let sig = dictionary["sig"] as? String,
|
||||
let kind_int = dictionary["kind"] as? UInt32,
|
||||
let kind = NostrKind(rawValue: kind_int),
|
||||
let tags = dictionary["tags"] as? [[String]],
|
||||
let pubkey = dictionary["pubkey"] as? String,
|
||||
let content = dictionary["content"] as? String,
|
||||
let created_at = dictionary["created_at"] as? Int else {
|
||||
return nil
|
||||
}
|
||||
return NostrEventInfoFromPushNotification(id: id, sig: sig, kind: kind, tags: tags, pubkey: pubkey, content: content, created_at: created_at)
|
||||
}
|
||||
|
||||
func reactionEmoji() -> String? {
|
||||
guard self.kind == NostrKind.like else {
|
||||
return nil
|
||||
}
|
||||
|
||||
switch self.content {
|
||||
case "", "+":
|
||||
return "❤️"
|
||||
case "-":
|
||||
return "👎"
|
||||
default:
|
||||
return self.content
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,16 +11,57 @@ import UserNotifications
|
||||
struct NotificationFormatter {
|
||||
static var shared = NotificationFormatter()
|
||||
|
||||
// TODO: These is a very generic notification formatter. Once we integrate NostrDB into the extension, we should reuse various functions present in `HomeModel.swift`
|
||||
func formatMessage(event: NostrEventInfoFromPushNotification) -> UNNotificationContent? {
|
||||
// MARK: - Formatting with NdbNote
|
||||
|
||||
// TODO: Prepare a `LocalNotification` object from `NdbNote` to reuse Notification formatting code from Local notifications
|
||||
func format_message(event: NdbNote, ndb: Ndb?) -> UNMutableNotificationContent? {
|
||||
guard let txn = ndb?.lookup_profile(event.pubkey),
|
||||
let display_name = txn.unsafeUnownedValue?.profile?.display_name
|
||||
else {
|
||||
return self.format_message(event: event)
|
||||
}
|
||||
|
||||
return self.format_message(event: event, display_name: display_name)
|
||||
}
|
||||
|
||||
func format_message(event: NdbNote, display_name: String) -> UNMutableNotificationContent? {
|
||||
guard let best_attempt_content: UNMutableNotificationContent = self.format_message(event: event) else { return nil }
|
||||
|
||||
switch event.known_kind {
|
||||
case .text:
|
||||
best_attempt_content.title = String(format: NSLocalizedString("%@ posted a note", comment: "Title label for push notification where a user posted a note"), display_name)
|
||||
break
|
||||
case .dm:
|
||||
best_attempt_content.title = String(format: NSLocalizedString("New message from %@", comment: "Title label for push notifications where a direct message was sent to the user"), display_name)
|
||||
break
|
||||
case .like:
|
||||
guard let reaction_emoji = to_reaction_emoji(ev: event) else {
|
||||
best_attempt_content.title = String(format: NSLocalizedString("%@ reacted to your note", comment: "Reaction heading in local/push notification"), display_name)
|
||||
best_attempt_content.body = ""
|
||||
break
|
||||
}
|
||||
best_attempt_content.title = String(format: NSLocalizedString("%@ reacted with %@", comment: "Reacted by heading in local notification"), display_name, reaction_emoji)
|
||||
best_attempt_content.body = ""
|
||||
break
|
||||
case .zap:
|
||||
best_attempt_content.title = String(format: NSLocalizedString("%@ zapped you ⚡️", comment: "Title label for a push notification where someone zapped the user"), display_name)
|
||||
break
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
|
||||
return best_attempt_content
|
||||
}
|
||||
|
||||
func format_message(event: NdbNote) -> UNMutableNotificationContent? {
|
||||
let content = UNMutableNotificationContent()
|
||||
if let event_json_data = try? JSONEncoder().encode(event), // Must be encoded, as the notification completion handler requires this object to conform to `NSSecureCoding`
|
||||
let event_json_string = String(data: event_json_data, encoding: .utf8) {
|
||||
content.userInfo = [
|
||||
"nostr_event_info": event_json_string
|
||||
NDB_NOTE_JSON_USER_INFO_KEY: event_json_string
|
||||
]
|
||||
}
|
||||
switch event.kind {
|
||||
switch event.known_kind {
|
||||
case .text:
|
||||
content.title = NSLocalizedString("Someone posted a note", comment: "Title label for push notification where someone posted a note")
|
||||
content.body = event.content
|
||||
@@ -30,7 +71,7 @@ struct NotificationFormatter {
|
||||
content.body = NSLocalizedString("(Contents are encrypted)", comment: "Label on push notification indicating that the contents of the message are encrypted")
|
||||
break
|
||||
case .like:
|
||||
guard let reactionEmoji = event.reactionEmoji() else {
|
||||
guard let reactionEmoji = to_reaction_emoji(ev: event) else {
|
||||
content.title = NSLocalizedString("Someone reacted to your note", comment: "Generic title label for push notifications where someone reacted to the user's post")
|
||||
break
|
||||
}
|
||||
@@ -45,4 +86,36 @@ struct NotificationFormatter {
|
||||
}
|
||||
return content
|
||||
}
|
||||
|
||||
// MARK: - Formatting with LocalNotification
|
||||
|
||||
func format_message(displayName: String, notify: LocalNotification) -> (content: UNMutableNotificationContent, identifier: String) {
|
||||
let content = UNMutableNotificationContent()
|
||||
var title = ""
|
||||
var identifier = ""
|
||||
|
||||
switch notify.type {
|
||||
case .mention:
|
||||
title = String(format: NSLocalizedString("Mentioned by %@", comment: "Mentioned by heading in local notification"), displayName)
|
||||
identifier = "myMentionNotification"
|
||||
case .repost:
|
||||
title = String(format: NSLocalizedString("Reposted by %@", comment: "Reposted by heading in local notification"), displayName)
|
||||
identifier = "myBoostNotification"
|
||||
case .like:
|
||||
title = String(format: NSLocalizedString("%@ reacted with %@", comment: "Reacted by heading in local notification"), displayName, to_reaction_emoji(ev: notify.event) ?? "")
|
||||
identifier = "myLikeNotification"
|
||||
case .dm:
|
||||
title = displayName
|
||||
identifier = "myDMNotification"
|
||||
case .zap, .profile_zap:
|
||||
// not handled here
|
||||
break
|
||||
}
|
||||
content.title = title
|
||||
content.body = notify.content
|
||||
content.sound = UNNotificationSound.default
|
||||
content.userInfo = notify.to_lossy().to_user_info()
|
||||
|
||||
return (content, identifier)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -19,19 +19,19 @@ class NotificationService: UNNotificationServiceExtension {
|
||||
let ndb: Ndb? = try? Ndb(owns_db_file: false)
|
||||
|
||||
// Modify the notification content here...
|
||||
guard let nostrEventInfoDictionary = request.content.userInfo["nostr_event"] as? [AnyHashable: Any],
|
||||
let nostrEventInfo = NostrEventInfoFromPushNotification.from(dictionary: nostrEventInfoDictionary) else {
|
||||
guard let nostrEventJSON = request.content.userInfo["nostr_event"] as? String,
|
||||
let nostrEvent = NdbNote.owned_from_json(json: nostrEventJSON)
|
||||
else {
|
||||
contentHandler(request.content)
|
||||
return;
|
||||
}
|
||||
|
||||
// Log that we got a push notification
|
||||
if let pubkey = Pubkey(hex: nostrEventInfo.pubkey),
|
||||
let txn = ndb?.lookup_profile(pubkey) {
|
||||
Log.debug("Got push notification from %s (%s)", for: .push_notifications, (txn.unsafeUnownedValue?.profile?.display_name ?? "Unknown"), nostrEventInfo.pubkey)
|
||||
if let txn = ndb?.lookup_profile(nostrEvent.pubkey) {
|
||||
Log.debug("Got push notification from %s (%s)", for: .push_notifications, (txn.unsafeUnownedValue?.profile?.display_name ?? "Unknown"), nostrEvent.pubkey.hex())
|
||||
}
|
||||
|
||||
if let improvedContent = NotificationFormatter.shared.formatMessage(event: nostrEventInfo) {
|
||||
if let improvedContent = NotificationFormatter.shared.format_message(event: nostrEvent, ndb: ndb) {
|
||||
contentHandler(improvedContent)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user