@marktiderman/genesis-native 0.2.0 → 0.4.0

package/ios/notification-service/NotificationService.swift

@@ -0,0 +1,309 @@
+// Genesis rich push: the Notification Service Extension that
+// `@marktiderman/genesis-native/rich-push-plugin` adds to an Expo app.
+//
+// iOS runs it for a push with `mutable-content: 1` (Expo: `mutableContent: true`).
+// It reads only the payload: it never fetches a message, so a push sent with
+// hidden previews (neutral text, no sender fields) stays neutral.
+//
+// - `data.image` / `data.senderAvatar` (https only, and only from the hosts in
+//   the Info.plist's `GenesisRichPushImageHosts` when the plugin's `imageHosts`
+//   set it) are downloaded within the time limit and attached. A download that fails or runs late is skipped:
+//   the notification is always shown, with what the payload already said.
+// - A push in the `messages` category becomes a Communication Notification:
+//   an incoming INSendMessageIntent with the sender (`senderName`,
+//   `senderAvatar`, `senderId`), the conversation (`threadId`, else
+//   `data.conversationId`) and, in a group, `groupName`. The sender's photo
+//   shows on the notification, and Focus treats it as a message.
+//
+// `data` is where Expo's push service puts it (`body` in the APNs payload),
+// or the payload's top level for a push sent to APNs directly.
+//
+// Nothing here logs what a notification says.
+
+import Intents
+import UserNotifications
+import os
+
+private let messagesCategory = "messages"
+private let maxImageBytes = 10 * 1024 * 1024
+// The extension has about 24 MB; only the avatar is read into memory, and small.
+private let maxAvatarBytes = 1024 * 1024
+private let maxURLLength = 1024
+private let log = Logger(subsystem: "genesis.rich-push", category: "service")
+
+final class NotificationService: UNNotificationServiceExtension {
+  private let lock = NSLock()
+  private var contentHandler: ((UNNotificationContent) -> Void)?
+  private var bestAttempt: UNNotificationContent?
+  private var session: URLSession?
+
+  override func didReceive(
+    _ request: UNNotificationRequest,
+    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
+  ) {
+    lock.lock()
+    self.contentHandler = contentHandler
+    self.bestAttempt = request.content
+    lock.unlock()
+
+    guard let content = request.content.mutableCopy() as? UNMutableNotificationContent else {
+      deliver(request.content)
+      return
+    }
+    let data = payloadData(request.content.userInfo)
+    let isMessage = content.categoryIdentifier == messagesCategory
+    let imageURL = httpsURL(data["image"])
+    let avatarURL = httpsURL(data["senderAvatar"])
+
+    if imageURL == nil && avatarURL == nil && !isMessage {
+      deliver(content)
+      return
+    }
+
+    let configuration = URLSessionConfiguration.ephemeral
+    configuration.timeoutIntervalForRequest = 8
+    configuration.timeoutIntervalForResource = 15
+    configuration.httpCookieStorage = nil
+    configuration.urlCache = nil
+    let session = URLSession(configuration: configuration)
+    lock.lock()
+    self.session = session
+    lock.unlock()
+
+    let group = DispatchGroup()
+    var imageFile: URL?
+    var avatarData: Data?
+    var avatarFile: URL?
+    if let imageURL {
+      group.enter()
+      download(imageURL, session: session, keepBytes: false) { file, _ in
+        imageFile = file
+        group.leave()
+      }
+    }
+    if let avatarURL {
+      group.enter()
+      download(avatarURL, session: session, keepBytes: true) { file, bytes in
+        avatarFile = file
+        avatarData = bytes
+        group.leave()
+      }
+    }
+
+    group.notify(queue: .global(qos: .userInitiated)) { [weak self] in
+      // Already shown (the time ran out): don't donate or build anything more.
+      guard let self, !self.delivered else { return }
+      var attachments: [UNNotificationAttachment] = []
+      if let imageFile, let attachment = self.attachment("image", imageFile) {
+        attachments.append(attachment)
+      }
+      // On a message the avatar is the sender's photo (the intent's); on anything else it is attached.
+      if !isMessage, let avatarFile, let attachment = self.attachment("avatar", avatarFile) {
+        attachments.append(attachment)
+      }
+      content.attachments = attachments
+      self.keep(content)
+
+      guard isMessage else {
+        self.deliver(content)
+        return
+      }
+      self.communication(content, data: data, avatar: avatarData, avatarFile: avatarFile)
+    }
+  }
+
+  override func serviceExtensionTimeWillExpire() {
+    // Out of time: show what we have (at worst the push as it arrived), never nothing.
+    lock.lock()
+    let content = bestAttempt
+    session?.invalidateAndCancel()
+    lock.unlock()
+    if let content { deliver(content) }
+  }
+
+  // MARK: Communication Notifications
+
+  private func communication(_ content: UNMutableNotificationContent, data: [String: Any], avatar: Data?, avatarFile: URL?) {
+    // Not a communication notification after all: the avatar is the picture, as on any other push.
+    let plain = { [weak self] in
+      guard let self else { return }
+      if content.attachments.isEmpty, let avatarFile, let attachment = self.attachment("avatar", avatarFile) {
+        content.attachments = [attachment]
+      }
+      self.deliver(content)
+    }
+    guard let name = text(data["senderName"]) else {
+      // No sender (hidden previews send none): a plain notification, as sent.
+      plain()
+      return
+    }
+    let conversationId = text(content.threadIdentifier) ?? text(data["conversationId"])
+    let senderId = text(data["senderId"]) ?? name
+    let sender = INPerson(
+      personHandle: INPersonHandle(value: senderId, type: .unknown),
+      nameComponents: nil,
+      displayName: name,
+      image: avatar.map { INImage(imageData: $0) },
+      contactIdentifier: nil,
+      customIdentifier: senderId
+    )
+    let groupName = text(data["groupName"])
+    var recipients: [INPerson]?
+    if groupName != nil {
+      // iOS draws a group (its name over the sender) when the message has more than one recipient.
+      let me = INPerson(
+        personHandle: INPersonHandle(value: "me", type: .unknown),
+        nameComponents: nil,
+        displayName: nil,
+        image: nil,
+        contactIdentifier: nil,
+        customIdentifier: nil,
+        isMe: true
+      )
+      recipients = [me, sender]
+    }
+    let intent = INSendMessageIntent(
+      recipients: recipients,
+      outgoingMessageType: .outgoingMessageText,
+      content: content.body,
+      speakableGroupName: groupName.map { INSpeakableString(spokenPhrase: $0) },
+      conversationIdentifier: conversationId,
+      serviceName: nil,
+      sender: sender,
+      attachments: nil
+    )
+    let interaction = INInteraction(intent: intent, response: nil)
+    interaction.direction = .incoming
+    interaction.donate { [weak self] error in
+      guard let self else { return }
+      if error != nil { log.error("donate failed") }
+      do {
+        let updated = try content.updating(from: intent)
+        self.deliver(updated)
+      } catch {
+        // Without the entitlement (or on an iOS that refuses), the plain notification still shows.
+        log.error("communication update failed")
+        plain()
+      }
+    }
+  }
+
+  // MARK: Delivery
+
+  private var delivered: Bool {
+    lock.lock()
+    defer { lock.unlock() }
+    return contentHandler == nil
+  }
+
+  /// What `serviceExtensionTimeWillExpire` shows if the time runs out from here on.
+  private func keep(_ content: UNNotificationContent) {
+    lock.lock()
+    bestAttempt = content.copy() as? UNNotificationContent
+    lock.unlock()
+  }
+
+  private func deliver(_ content: UNNotificationContent) {
+    lock.lock()
+    let handler = contentHandler
+    contentHandler = nil
+    session?.finishTasksAndInvalidate()
+    session = nil
+    lock.unlock()
+    handler?(content)
+  }
+
+  // MARK: Downloads
+
+  private func download(_ url: URL, session: URLSession, keepBytes: Bool, done: @escaping (URL?, Data?) -> Void) {
+    let task = session.downloadTask(with: url) { location, response, error in
+      guard error == nil, let location,
+        let http = response as? HTTPURLResponse, http.statusCode == 200,
+        let mime = http.mimeType?.lowercased(), let ext = imageExtension(mime)
+      else {
+        log.error("image download skipped")
+        done(nil, nil)
+        return
+      }
+      do {
+        let size = (try FileManager.default.attributesOfItem(atPath: location.path)[.size] as? NSNumber)?.intValue ?? 0
+        guard size > 0, size <= maxImageBytes else {
+          done(nil, nil)
+          return
+        }
+        let dir = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString, isDirectory: true)
+        try FileManager.default.createDirectory(at: dir, withIntermediateDirectories: true)
+        let file = dir.appendingPathComponent("image.\(ext)")
+        try FileManager.default.moveItem(at: location, to: file)
+        // Bytes only for the avatar (the intent's INImage), and only a small one.
+        done(file, keepBytes && size <= maxAvatarBytes ? try? Data(contentsOf: file) : nil)
+      } catch {
+        log.error("image save failed")
+        done(nil, nil)
+      }
+    }
+    task.resume()
+  }
+
+  private func attachment(_ id: String, _ file: URL) -> UNNotificationAttachment? {
+    do {
+      return try UNNotificationAttachment(identifier: id, url: file, options: nil)
+    } catch {
+      log.error("attachment refused")
+      return nil
+    }
+  }
+}
+
+// MARK: Payload
+
+/// `data`: Expo puts it under `body`; a push sent to APNs directly has it at the top level.
+private func payloadData(_ userInfo: [AnyHashable: Any]) -> [String: Any] {
+  if let body = userInfo["body"] as? [String: Any] { return body }
+  if let body = userInfo["body"] as? String, let bytes = body.data(using: .utf8),
+    let parsed = try? JSONSerialization.jsonObject(with: bytes) as? [String: Any]
+  {
+    return parsed
+  }
+  var top: [String: Any] = [:]
+  for (key, value) in userInfo {
+    if let key = key as? String, key != "aps" { top[key] = value }
+  }
+  return top
+}
+
+private func text(_ value: Any?) -> String? {
+  guard let string = value as? String else { return nil }
+  let trimmed = string.trimmingCharacters(in: .whitespacesAndNewlines)
+  return trimmed.isEmpty ? nil : String(trimmed.prefix(200))
+}
+
+/// The hosts images may come from (the plugin's `imageHosts`); none set means any https host.
+private let imageHosts: [String] = ((Bundle.main.object(forInfoDictionaryKey: "GenesisRichPushImageHosts") as? [String]) ?? [])
+  .map { $0.lowercased() }
+
+private func allowedHost(_ host: String) -> Bool {
+  if imageHosts.isEmpty { return true }
+  let h = host.lowercased()
+  return imageHosts.contains { h == $0 || h.hasSuffix("." + $0) }
+}
+
+/// Only https, with a host and no credentials, at most 1024 characters (the JS `isRichPushUrl`).
+private func httpsURL(_ value: Any?) -> URL? {
+  guard let string = value as? String, string.count <= maxURLLength,
+    let components = URLComponents(string: string),
+    components.scheme?.lowercased() == "https",
+    let host = components.host, !host.isEmpty, allowedHost(host),
+    components.user == nil, components.password == nil
+  else { return nil }
+  return components.url
+}
+
+private func imageExtension(_ mime: String) -> String? {
+  switch mime {
+  case "image/jpeg", "image/jpg": return "jpg"
+  case "image/png": return "png"
+  case "image/gif": return "gif"
+  default: return nil
+  }
+}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@marktiderman/genesis-native",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "private": false,
   "type": "module",
   "sideEffects": false,
-  "description": "The native app shell for Genesis Expo apps: one GenesisNativeApp root that runs boot steps behind the splash, catches errors into a fatal screen with retry, persists the query cache, gates on the Supabase session and normalizes deep links. An optional updates block (/updates) adds force upgrade, maintenance, an update banner and what's new. Every part is a slot and is also exported on its own. Part of the Genesis framework.",
+  "description": "The native app shell for Genesis Expo apps: one GenesisNativeApp root that runs boot steps behind the splash, catches errors into a fatal screen with retry, persists the query cache, gates on the Supabase session and normalizes deep links. An optional updates block (/updates) adds force upgrade, maintenance, an update banner and what's new; an optional push block (/push) adds push registration, tap routing, the badge and a notification settings screen with quiet hours and private previews; the observability block (/observability) reports errors, breadcrumbs, typed analytics events and timings through vendor-neutral sinks (Sentry, EAS Observe, console) with PII scrubbed on the device; the devtools overlay (/devtools) is a debug sheet for development and preview builds. Blocks (defineBlock declarations, through `blocks`) add boot steps, roots, slot fills and Settings rows. Every part is a slot and is also exported on its own. Part of the Genesis framework.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/marktiderman/genesis.git",
@@ -18,48 +18,103 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "source": "./src/index.ts",
+  "react-native": "./src/index.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.ts",
+      "react-native": "./src/index.ts",
       "import": "./dist/index.js"
     },
     "./persist": {
       "types": "./dist/persist.d.ts",
+      "react-native": "./src/persist.ts",
       "import": "./dist/persist.js"
     },
     "./updates": {
       "types": "./dist/updates.d.ts",
+      "react-native": "./src/updates/index.ts",
       "import": "./dist/updates.js"
+    },
+    "./push": {
+      "types": "./dist/push.d.ts",
+      "react-native": "./src/push/index.ts",
+      "import": "./dist/push.js"
+    },
+    "./push-payload": {
+      "types": "./dist/push-payload.d.ts",
+      "import": "./dist/push-payload.js",
+      "default": "./dist/push-payload.js"
+    },
+    "./observability": {
+      "types": "./dist/observability.d.ts",
+      "react-native": "./src/observability/index.ts",
+      "import": "./dist/observability.js"
+    },
+    "./devtools": {
+      "types": "./dist/devtools.d.ts",
+      "react-native": "./src/devtools/index.ts",
+      "import": "./dist/devtools.js"
+    },
+    "./dev-warnings": {
+      "types": "./dist/dev-warnings.d.ts",
+      "react-native": "./src/dev-warnings.ts",
+      "import": "./dist/dev-warnings.js"
+    },
+    "./rich-push-plugin": {
+      "types": "./dist/rich-push-plugin.d.ts",
+      "import": "./dist/rich-push-plugin.js",
+      "default": "./dist/rich-push-plugin.js"
     }
   },
   "files": [
     "dist",
+    "src",
+    "ios",
+    "!src/**/__tests__",
     "README.md"
   ],
   "dependencies": {
     "@marktiderman/genesis-core": "^1.7.0",
-    "@marktiderman/genesis-design-system": "^1.4.1",
-    "@marktiderman/genesis-ui-native": "^2.2.0"
+    "@marktiderman/genesis-design-system": "^1.5.0",
+    "@marktiderman/genesis-features": "^0.3.0",
+    "@marktiderman/genesis-ui-native": "^2.4.0"
   },
   "peerDependencies": {
     "@tanstack/query-async-storage-persister": "^5.0.0",
     "@tanstack/query-persist-client-core": "^5.0.0",
     "@tanstack/react-query": "^5.0.0",
+    "expo": ">=54",
     "react": "^19.0.0",
     "react-native": ">=0.76.0",
     "react-native-safe-area-context": ">=4.0.0"
   },
   "peerDependenciesMeta": {
+    "@sentry/react-native": {
+      "optional": true
+    },
     "@tanstack/query-async-storage-persister": {
       "optional": true
     },
     "@tanstack/query-persist-client-core": {
       "optional": true
     },
+    "expo": {
+      "optional": true
+    },
     "expo-application": {
       "optional": true
     },
+    "expo-notifications": {
+      "optional": true
+    },
+    "expo-observe": {
+      "optional": true
+    },
+    "expo-sensors": {
+      "optional": true
+    },
     "expo-updates": {
       "optional": true
     }
@@ -71,13 +126,191 @@
     "@tanstack/react-query": "^5.75.0",
     "@testing-library/react": "^16.3.2",
     "@types/react": "^19.2.14",
+    "expo": "~58.0.19",
     "happy-dom": "^20.9.0",
     "react": "^19.2.5",
     "react-dom": "^19.2.5",
     "tsup": "^8.3.0",
-    "typescript": "^5.9.3",
+    "typescript": "~6.0.3",
     "vitest": "^4.1.12"
   },
+  "genesis": {
+    "blocks": {
+      "push": {
+        "feature": {
+          "name": "Push and notification preferences",
+          "summary": "Registers this device's push token for whoever signs in, routes taps, and edits per-category preferences, quiet hours and previews.",
+          "keywords": [
+            "notifications",
+            "push token",
+            "quiet hours"
+          ],
+          "audience": [
+            "person"
+          ]
+        },
+        "platforms": [
+          "native"
+        ],
+        "packages": [
+          "@marktiderman/genesis-native",
+          "@marktiderman/genesis-supabase"
+        ],
+        "migrations": [
+          {
+            "package": "@marktiderman/genesis-supabase",
+            "file": "migrations/0005_genesis_push.sql",
+            "test": "migrations/tests/0005_genesis_push.test.sql"
+          }
+        ],
+        "functions": [
+          {
+            "package": "@marktiderman/genesis-supabase",
+            "dir": "functions/genesis-push-send",
+            "verifyJwt": false,
+            "secrets": [
+              "GENESIS_PUSH_SECRET",
+              "EXPO_ACCESS_TOKEN"
+            ]
+          }
+        ],
+        "routes": [
+          {
+            "path": "/settings/notifications",
+            "description": "Notification settings: categories, quiet hours, previews",
+            "signedIn": true
+          }
+        ],
+        "steps": [
+          "npx expo install expo-notifications, and add \"expo-notifications\" to the plugins in app.config.",
+          "Create the block with createPush (@marktiderman/genesis-native/push) and pass it to <GenesisNativeApp blocks>; render NotificationSettings on the /settings/notifications screen (genesis-native README, Push).",
+          "A push token needs an EAS project id (eas init)."
+        ],
+        "privacy": {
+          "collects": [
+            {
+              "type": "device ID",
+              "purposes": [
+                "app functionality"
+              ],
+              "linked": true,
+              "tracking": false
+            }
+          ]
+        }
+      },
+      "app-updates": {
+        "feature": {
+          "name": "App updates",
+          "summary": "Force upgrade, a maintenance screen, an update banner and a what's new sheet, from the app_release_policy row.",
+          "keywords": [
+            "force upgrade",
+            "maintenance",
+            "ota"
+          ],
+          "audience": [
+            "person"
+          ]
+        },
+        "platforms": [
+          "native"
+        ],
+        "packages": [
+          "@marktiderman/genesis-native",
+          "@marktiderman/genesis-supabase"
+        ],
+        "migrations": [
+          {
+            "package": "@marktiderman/genesis-supabase",
+            "file": "migrations/0002_genesis_app_release_policy.sql",
+            "test": "migrations/tests/0002_genesis_app_release_policy.test.sql"
+          }
+        ],
+        "steps": [
+          "npx expo install expo-updates expo-application.",
+          "Create the block with createUpdates (@marktiderman/genesis-native/updates) and pass it to <GenesisNativeApp updates> (genesis-native README, Updates)."
+        ]
+      },
+      "observability": {
+        "feature": {
+          "name": "Observability",
+          "summary": "Crash reports, breadcrumbs, timings and typed analytics events, scrubbed on the device, through vendor-neutral sinks (Sentry included).",
+          "keywords": [
+            "crash reporting",
+            "sentry",
+            "analytics",
+            "breadcrumbs"
+          ],
+          "audience": [
+            "developer"
+          ]
+        },
+        "platforms": [
+          "native"
+        ],
+        "steps": [
+          "npx expo install @sentry/react-native if you report to Sentry, and set the DSN in your environment (genesis-native README, Observability).",
+          "Create the block with createObservability (@marktiderman/genesis-native/observability) at module scope, pass it to <GenesisNativeApp blocks>, and export observability.wrap(RootLayout)."
+        ],
+        "privacy": {
+          "collects": [
+            {
+              "type": "crash data",
+              "purposes": [
+                "app functionality"
+              ],
+              "linked": true,
+              "tracking": false
+            },
+            {
+              "type": "performance data",
+              "purposes": [
+                "app functionality"
+              ],
+              "linked": true,
+              "tracking": false
+            },
+            {
+              "type": "other diagnostic data",
+              "purposes": [
+                "app functionality"
+              ],
+              "linked": true,
+              "tracking": false
+            },
+            {
+              "type": "user id",
+              "purposes": [
+                "app functionality"
+              ],
+              "linked": true,
+              "tracking": false
+            }
+          ]
+        }
+      },
+      "devtools-overlay": {
+        "feature": {
+          "name": "Devtools overlay",
+          "summary": "An on-device overlay for development, preview and internal builds: what the app knows about itself, recent activity, a crash test.",
+          "keywords": [
+            "debug menu",
+            "devtools",
+            "shake to debug"
+          ],
+          "audience": [
+            "developer"
+          ]
+        },
+        "platforms": [
+          "native"
+        ],
+        "steps": [
+          "Create the block with createDevtools (@marktiderman/genesis-native/devtools), enabled only outside production builds, and pass it to <GenesisNativeApp blocks> (genesis-native README)."
+        ]
+      }
+    }
+  },
   "scripts": {
     "build": "tsup && node ../../scripts/check-exports-resolve.mjs",
     "clean": "rm -rf dist",