matrix-go-push

This is a Matrix Push Gateway following the Matrix Specification / Push Gateway API, This Push Gateway should archive the Problems we got with Matrix Sygnal.

Prerequirements

• go1.21
• Firebase Service Account Key
• Staticcheck
• make
• go-licenses

Create LICENSES.md

Report usage to LICENSES.md with template.

go-licenses report ./... --template ./third_party/go-licenses/licenses.tpl > LICENSES.MD 2> errors

Checking for forbidden and unknown licenses usage:

go-licenses check ./... 2> errors

Build

Build Docker image with Tests (prerequirements needed)

make docker-build IMG=matrix-go-push:v0.0.1

Build Docker image without Tests

make docker-build-gitlabci IMG=matrix-go-push:v0.0.1

Configure

The minimum configuration, that has to be done, is to set the ClientID from our app into the config.yaml

Server:
  Host: 0.0.0.0
  Port: 8080
  Timeout:
    Server: 30s
    Read: 15s
    Write: 15s
    Idle: 5s

Clients:
  - de.test.timref.messengerclient

RUN

Run in Docker

# Create Firebase Serviceaccount Token
mkdir develop
touch develop/serviceAccountKey.json
# Start the Container
docker run -p 8080:8080 -v $(pwd)/config/config.yaml:/config/config.yaml -v $(pwd)/develop/serviceAccountKey.json:/develop/serviceAccountKey.json matrix-go-push:v0.0.1 -config "config/config.yaml"

Run with docker-compose.yaml

# Create Firebase Serviceaccount Token
mkdir develop
touch develop/serviceAccountKey.json
# Start the Container
docker compose up

Run Locally

# Create Firebase Serviceaccount Token
mkdir develop
touch develop/serviceAccountKey.json
# Start the Application
go run ./... -config config/config.yaml

Test Locally

You need to get a PushKey from synapse Database:

select * from pushers;

After you got a Pushkey, you can insert the Pushkey in the Curl Request, you need the registered APP_ID in the folowwing curl request and in the config.yaml

curl -i -H "Content-Type: application/json" --request POST -d '@-' 127.0.0.1:8080/_matrix/push/v1/notify <<EOF
{
  "notification": {
    "event_id": "\$3957tyerfgewrf384",
    "room_id": "!slw48wfj34rtnrf:example.org",
    "type": "m.room.message",
    "sender": "@hmueller:matrix.example.org",
    "sender_display_name": "Major Tom",
    "room_name": "Mission Control",
    "room_alias": "#exampleroom:example.org",
    "prio": "high",
    "content": {
      "msgtype": "m.text",
      "body": "I'm floating in a most peculiar way."
    },
    "counts": {
      "unread": 2,
      "missed_calls": 1
    },
    "devices": [
      {
        "app_id": "de.test.timref.messengerclient",
        "pushkey": "$PUSHKEY",
        "pushkey_ts": 12345678,
        "data": {},
        "tweaks": {
          "sound": "bing"
        }
      }
    ]
  }
}
EOF

Architecture Overview

---
title: Messenger Proxy 
---
flowchart TB
    matrix-server --> matrix-go-push
    matrix-go-push --> google-firebase
    google-firebase --> checkDeviceType{Is Android?}
    checkDeviceType -->|YES| push-to-android-device
    checkDeviceType -->|NO| APNS
    APNS --> push-to-ios-device

Loading

Libraries

• Firebase Admin Go SDK; Apache License, version 2.0
• gorilla/mux; BSD licensed
• prometheus/client_golang; Apache License, version 2.0
• stretchr/testify; MIT license
• uber-go/zap; MIT license
• googleapis/google-api-go-client; BSD-3-Clause license
• go-yaml/yaml; MIT and Apache