feat: add direct APNS support

Author: FrenchGithubUser

.github/workflows/docker.yml

@@ -2,12 +2,12 @@ name: "Docker"
 
 on:
   push:
-    branches: [ "main" ]
-    tags: [ "*" ]
+    branches: ["main"]
+    tags: ["*"]
 
 jobs:
   build:
-    uses: famedly/backend-build-workflows/.github/workflows/docker-backend.yml@main
+    uses: famedly/backend-build-workflows/.github/workflows/docker-backend.yml@v2
     secrets: inherit
     with:
       name: hedwig

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "matrix-hedwig"
-version = "2.0.0"
+version = "2.2.0"
 authors = [
 	"Christian Pauly <c.pauly@famedly.com>",
 	"Kateřina Churanová <k.churanova@famedly.com>",
@@ -10,6 +10,7 @@ publish = false
 edition = "2021"
 
 [dependencies]
+a2 = { version = "0.10.0", git = "https://github.com/famedly/a2.git", branch = "thomast/owned-struct-params" }
 async-trait = "0.1.89"
 axum = { version = "0.8.6", features = ["macros"] }
 axum-tracing-opentelemetry = "0.32.1"

Cargo.toml

@@ -20,7 +20,7 @@ This project name aged badly, trans rights are human rights!
 Multiple configuration files must be setup :
 
 - `config.yaml` (from `config.sample.yaml`) for hedwig's config
-- authentication against GCP is done with `gcp_auth`, you need to setup one of the 4 authentication methods listed [here](https://github.com/djc/gcp_auth/blob/5a1e48db47784c9afdbad38a33907cb2e98bbfdd/README.md)
+- authentication against GCP is done with `gcp_auth`, you need to setup one of the 4 authentication methods listed [here](https://github.com/djc/gcp_auth/blob/5a1e48db47784c9afdbad38a33907cb2e98bbfdd/README.md). The setting value `fcm_credentials_file_path` will be set as the env var `GOOGLE_APPLICATION_CREDENTIALS`
 
 Hedwig's config `config.yaml` can be replaced by environment variables, which is used for the local kubernetes development setup. All variables are namespaced under `PUSHGW`, with a double underscore (`__`) being the separator between the prefix and all keys. As an example, `server.bind_address` would be represented as `PUSHGW__SERVER__BIND_ADDRESS`. See `deploy/config.properties.sample` for an example configuration.
 

README.md

@@ -13,16 +13,23 @@ server:
 hedwig:
   app_id: "org.matrix.awesome_client"
   # specifies how many attempts at pushing a notification to a device should be made before giving up and reporting the push key as dead
-  fcm_push_max_retries: 5
-  fcm_notification_click_action: "FLUTTER_NOTIFICATION_CLICK"
-  fcm_notification_title: "<count> unread rooms"
-  fcm_notification_body: "Open app to read the messages"
-  fcm_notification_sound: "default"
-  fcm_notification_icon: "notifications_icon"
-  fcm_notification_tag: "org.matrix.default_notification"
+  push_max_retries: 5
+  notification_click_action: "FLUTTER_NOTIFICATION_CLICK"
+  notification_title: "<count> unread rooms"
+  notification_body: "Open app to read the messages"
+  notification_sound: "default"
+  notification_icon: "notifications_icon"
+  notification_tag: "org.matrix.default_notification"
   fcm_notification_android_channel_id: "org.matrix.app.message"
   # https://developer.apple.com/documentation/usernotifications/sending-notification-requests-to-apns#Know-when-to-use-push-types
-  fcm_apns_push_type: background
+  apns_push_type: background
+  apns_topic: app.bundle.id
+  # leave blank if you don't want to use APNS directly
+  apns_key_file_path: "path/to/apns_key.p8"
+  fcm_credentials_file_path: "/path/to/fcm_credentials.json"
+  apns_team_id: "YOUR_TEAM_ID"
+  apns_key_id: "YOUR_KEY_ID"
+  apns_sandbox: true
   notification_request_body_size_limit: 15000
 
 # these are sample configuration options for the telemetry