feat(macos): add events for push notification registration

.changes/push-token.md

@@ -0,0 +1,5 @@
+---
+tao: patch
+---
+
+Add Events for Apple's Push Token registration.

src/event.rs

@@ -142,6 +142,19 @@ pub enum Event<'a, T: 'static> {
   /// - **Other**: Unsupported.
   #[non_exhaustive]
   Reopen { has_visible_windows: bool },
+
+  /// Emitted when registration completes and an application push token is made available; on Apple
+  /// platforms, this is the APNS token.
+  ///
+  /// ## Platform-specific
+  ///
+  /// - **macOS**: https://developer.apple.com/documentation/appkit/nsapplicationdelegate/application(_:didregisterforremotenotificationswithdevicetoken:)?language=objc
+  /// - **iOS**: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/application(_:didregisterforremotenotificationswithdevicetoken:)?language=objc
+  /// - **Other**: Unsupported.
+  PushRegistration(Vec<u8>),
+
+  /// Emitted when push token registration fails.
+  PushRegistrationError(String),
 }
 
 impl<T: Clone> Clone for Event<'static, T> {
@@ -170,6 +183,8 @@ impl<T: Clone> Clone for Event<'static, T> {
       } => Reopen {
         has_visible_windows: *has_visible_windows,
       },
+      PushRegistration(token) => PushRegistration(token.clone()),
+      PushRegistrationError(error) => PushRegistrationError(error.clone()),
     }
   }
 }
@@ -194,6 +209,8 @@ impl<'a, T> Event<'a, T> {
       } => Ok(Reopen {
         has_visible_windows,
       }),
+      PushRegistration(token) => Ok(PushRegistration(token)),
+      PushRegistrationError(error) => Ok(PushRegistrationError(error)),
     }
   }
 
@@ -220,6 +237,8 @@ impl<'a, T> Event<'a, T> {
       } => Some(Reopen {
         has_visible_windows,
       }),
+      PushRegistration(token) => Some(PushRegistration(token)),
+      PushRegistrationError(error) => Some(PushRegistrationError(error)),
     }
   }
 }

src/platform_impl/ios/view.rs

@@ -690,7 +690,83 @@ pub fn create_delegate_class() {
       sel!(applicationWillTerminate:),
       will_terminate as extern "C" fn(_, _, _),
     );
-
+    decl.add_method(
+      sel!(application:didRegisterForRemoteNotificationsWithDeviceToken:),
+      did_register_for_apns as extern "C" fn(_, _, _, _),
+    );
+    decl.add_method(
+      sel!(application:didFailToRegisterForRemoteNotificationsWithError:),
+      did_fail_to_register_for_apns as extern "C" fn(_, _, _, _),
+    );
     decl.register();
   }
 }
+
+// application(_:didRegisterForRemoteNotificationsWithDeviceToken:)
+extern "C" fn did_register_for_apns(_: &Object, _: Sel, _: id, token_data: id) {
+  trace!("Triggered `didRegisterForRemoteNotificationsWithDeviceToken`");
+  let token_bytes = unsafe {
+    if token_data.is_null() {
+      trace!("Token data is null; ignoring");
+      return;
+    }
+    let is_nsdata: bool = msg_send![token_data, isKindOfClass:class!(NSData)];
+    if !is_nsdata {
+      trace!("Token data is not an NSData object");
+      return;
+    }
+    let bytes: *const u8 = msg_send![token_data, bytes];
+    let length: usize = msg_send![token_data, length];
+    std::slice::from_raw_parts(bytes, length).to_vec()
+  };
+  did_register_push_token(token_bytes);
+  trace!("Completed `didRegisterForRemoteNotificationsWithDeviceToken`");
+}
+
+// application(_:didFailToRegisterForRemoteNotificationsWithError:)
+extern "C" fn did_fail_to_register_for_apns(_: &Object, _: Sel, _: id, err: *mut Object) {
+  trace!("Triggered `didFailToRegisterForRemoteNotificationsWithError`");
+
+  let error_string = unsafe {
+    if err.is_null() {
+      "Unknown error (null error object)".to_string()
+    } else {
+      // Verify it's an NSError
+      let is_error: bool = msg_send![err, isKindOfClass:class!(NSError)];
+      if !is_error {
+        trace!("Invalid error object type for push registration failure");
+        return;
+      }
+
+      // Get the localizedDescription
+      let description: *mut Object = msg_send![err, localizedDescription];
+      if description.is_null() {
+        trace!("Error had no description");
+        return;
+      }
+
+      // Convert NSString to str
+      let utf8: *const u8 = msg_send![description, UTF8String];
+      let len: usize = msg_send![description, lengthOfBytesUsingEncoding:4];
+      let bytes = std::slice::from_raw_parts(utf8, len);
+      String::from_utf8_lossy(bytes).to_string()
+    }
+  };
+
+  did_fail_to_register_push_token(error_string);
+  trace!("Completed `didFailToRegisterForRemoteNotificationsWithError`");
+}
+
+fn did_register_push_token(token_data: Vec<u8>) {
+  unsafe {
+    app_state::handle_nonuser_event(EventWrapper::StaticEvent(Event::PushRegistration(
+      token_data,
+    )));
+  }
+}
+
+fn did_fail_to_register_push_token(err: String) {
+  unsafe {
+    app_state::handle_nonuser_event(EventWrapper::StaticEvent(Event::PushRegistrationError(err)));
+  }
+}

src/platform_impl/macos/app_delegate.rs

@@ -16,6 +16,7 @@ use objc2::runtime::{
 use objc2_foundation::{
   NSArray, NSError, NSString, NSUserActivity, NSUserActivityTypeBrowsingWeb, NSURL,
 };
+
 use std::{
   cell::{RefCell, RefMut},
   ffi::{CStr, CString},
@@ -83,6 +84,14 @@ lazy_static! {
       sel!(applicationSupportsSecureRestorableState:),
       application_supports_secure_restorable_state as extern "C" fn(_, _, _) -> _,
     );
+    decl.add_method(
+      sel!(application:didRegisterForRemoteNotificationsWithDeviceToken:),
+      did_register_for_apns as extern "C" fn(_, _, _, _),
+    );
+    decl.add_method(
+      sel!(application:didFailToRegisterForRemoteNotificationsWithError:),
+      did_fail_to_register_for_apns as extern "C" fn(_, _, _, _),
+    );
     decl.add_ivar::<*mut c_void>(&CString::new(AUX_DELEGATE_STATE_NAME).unwrap());
 
     AppDelegateClass(decl.register())
@@ -125,6 +134,7 @@ extern "C" fn dealloc(this: &Object, _: Sel) {
 
 extern "C" fn did_finish_launching(this: &Object, _: Sel, _: id) {
   trace!("Triggered `applicationDidFinishLaunching`");
+
   AppState::launched(this);
   trace!("Completed `applicationDidFinishLaunching`");
 }
@@ -221,3 +231,58 @@ extern "C" fn application_supports_secure_restorable_state(_: &Object, _: Sel, _
   trace!("Completed `applicationSupportsSecureRestorableState`");
   YES
 }
+
+// application(_:didRegisterForRemoteNotificationsWithDeviceToken:)
+extern "C" fn did_register_for_apns(_: &Object, _: Sel, _: id, token_data: id) {
+  trace!("Triggered `didRegisterForRemoteNotificationsWithDeviceToken`");
+  let token_bytes = unsafe {
+    if token_data.is_null() {
+      trace!("Token data is null; ignoring");
+      return;
+    }
+    let is_nsdata: bool = msg_send![token_data, isKindOfClass:class!(NSData)];
+    if !is_nsdata {
+      trace!("Token data is not an NSData object");
+      return;
+    }
+    let bytes: *const u8 = msg_send![token_data, bytes];
+    let length: usize = msg_send![token_data, length];
+    std::slice::from_raw_parts(bytes, length).to_vec()
+  };
+  AppState::did_register_push_token(token_bytes);
+  trace!("Completed `didRegisterForRemoteNotificationsWithDeviceToken`");
+}
+
+// application(_:didFailToRegisterForRemoteNotificationsWithError:)
+extern "C" fn did_fail_to_register_for_apns(_: &Object, _: Sel, _: id, err: *mut Object) {
+  trace!("Triggered `didFailToRegisterForRemoteNotificationsWithError`");
+
+  let error_string = unsafe {
+    if err.is_null() {
+      "Unknown error (null error object)".to_string()
+    } else {
+      // Verify it's an NSError
+      let is_error: bool = msg_send![err, isKindOfClass:class!(NSError)];
+      if !is_error {
+        trace!("Invalid error object type for push registration failure");
+        return;
+      }
+
+      // Get the localizedDescription
+      let description: *mut Object = msg_send![err, localizedDescription];
+      if description.is_null() {
+        trace!("Error had no description");
+        return;
+      }
+
+      // Convert NSString to str
+      let utf8: *const u8 = msg_send![description, UTF8String];
+      let len: usize = msg_send![description, lengthOfBytesUsingEncoding:4];
+      let bytes = std::slice::from_raw_parts(utf8, len);
+      String::from_utf8_lossy(bytes).to_string()
+    }
+  };
+
+  AppState::did_fail_to_register_push_token(error_string);
+  trace!("Completed `didFailToRegisterForRemoteNotificationsWithError`");
+}

src/platform_impl/macos/app_state.rs

@@ -420,6 +420,16 @@ impl AppState {
       (_, ControlFlow::Poll) => HANDLER.waker().start(),
     }
   }
+
+  pub fn did_register_push_token(token_data: Vec<u8>) {
+    HANDLER.handle_nonuser_event(EventWrapper::StaticEvent(Event::PushRegistration(
+      token_data,
+    )));
+  }
+
+  pub fn did_fail_to_register_push_token(err: String) {
+    HANDLER.handle_nonuser_event(EventWrapper::StaticEvent(Event::PushRegistrationError(err)));
+  }
 }
 
 /// A hack to make activation of multiple windows work when creating them before