Configure pwa and add notifications

.github/workflows/notification_service.yml

@@ -0,0 +1,16 @@
+name: Notification Service
+
+on:
+  pull_request:
+    branches: [ main ]
+    paths:
+    - 'backend/services/notification/**'
+    - 'backend/store/**'
+
+jobs:
+  build-notification:
+    uses: ./.github/workflows/build_service.yml
+    with:
+      image-name: kioku_notification
+      path: ./backend/services/notification
+      context: ./backend

.github/workflows/release.yml

@@ -52,4 +52,11 @@ jobs:
       image-name: kioku_srs
       image-tag: prod
       path: ./backend/services/srs
-      context: ./backend
+      context: ./backend
+  build-notification:
+    uses: ./.github/workflows/build_service.yml
+    with:
+      image-name: kioku_notification
+      image-tag: prod
+      path: ./backend/services/notification
+      context: ./backend

.gitignore

@@ -3,4 +3,3 @@
 *secret.yaml
 private_key.yaml
 .DS_STORE
-frontend/build-storybook.log

README.md

@@ -120,6 +120,12 @@ You can generate the `JWT_PRIVATE_KEY` with the following command
 openssl ecparam -name secp521r1 -genkey -noout -out my.key.pem
 ```
 
+To enable notification support, you will have to generate a VAPID keypair and add the public and private key to the frontend and backend `.env` files.
+To do this, you can type the following command in the frontend folder:
+```bash
+npx web-push generate-vapid-keys
+```
+
 > [!WARNING]
 > The example environment file is populated with default values, be sure to change all values before using the application in production!
 

backend/.env.example

@@ -16,3 +16,5 @@ TRACING_ENABLED=false
 JWT_PRIVATE_KEY="
 # generate with: `openssl ecparam -name secp521r1 -genkey -noout -out my.key.pem`
 "
+VAPID_PUBLIC_KEY=""
+VAPID_PRIVATE_KEY=""

backend/api-documentation/user/delete user.bru

@@ -1,7 +1,7 @@
 meta {
   name: delete user
   type: http
-  seq: 7
+  seq: 9
 }
 
 delete {

backend/api-documentation/user/get notification subscriptions.bru

@@ -0,0 +1,23 @@
+meta {
+  name: get notification subscriptions
+  type: http
+  seq: 4
+}
+
+get {
+  url: {{baseUrl}}/api/user/notification
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{accessToken}}
+}
+
+body:json {
+  {
+    "endpoint": "",
+    "auth": "",
+    "p256dh": ""
+  }
+}

backend/api-documentation/user/modify user.bru

@@ -1,7 +1,7 @@
 meta {
   name: modify user
   type: http
-  seq: 6
+  seq: 8
 }
 
 put {

backend/api-documentation/user/register.bru

@@ -1,7 +1,7 @@
 meta {
   name: register
   type: http
-  seq: 4
+  seq: 6
 }
 
 post {

backend/api-documentation/user/subscribe notifications.bru

@@ -0,0 +1,23 @@
+meta {
+  name: subscribe notifications
+  type: http
+  seq: 7
+}
+
+post {
+  url: {{baseUrl}}/api/user/notification
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{accessToken}}
+}
+
+body:json {
+  {
+    "endpoint": "",
+    "auth": "",
+    "p256dh": ""
+  }
+}

backend/api-documentation/user/unsubscribe notifications.bru

@@ -0,0 +1,15 @@
+meta {
+  name: unsubscribe notifications
+  type: http
+  seq: 10
+}
+
+delete {
+  url: {{baseUrl}}/api/user/notification/{{subscriptionID}}
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{accessToken}}
+}

backend/go.mod

@@ -3,13 +3,15 @@ module github.com/kioku-project/kioku
 go 1.20
 
 require (
+	github.com/SherClockHolmes/webpush-go v1.3.0
 	github.com/go-micro/plugins/v4/client/grpc v1.2.1
 	github.com/go-micro/plugins/v4/registry/kubernetes v1.1.2
 	github.com/go-micro/plugins/v4/server/grpc v1.2.0
 	github.com/gofiber/fiber/v2 v2.52.0
 	github.com/gofiber/jwt/v3 v3.3.10
 	github.com/golang-jwt/jwt/v4 v4.5.0
 	github.com/joho/godotenv v1.5.1
+	github.com/robfig/cron/v3 v3.0.0
 	go-micro.dev/v4 v4.10.2
 	go.opentelemetry.io/otel v1.22.0
 	golang.org/x/exp v0.0.0-20240119083558-1b970713d09a
@@ -25,6 +27,7 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.19.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect

backend/go.sum

@@ -5,6 +5,8 @@ github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migc
 github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM=
 github.com/ProtonMail/go-crypto v1.0.0 h1:LRuvITjQWX+WIfr930YHG2HNfjR1uOfyf5vE0kC2U78=
 github.com/ProtonMail/go-crypto v1.0.0/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0=
+github.com/SherClockHolmes/webpush-go v1.3.0 h1:CAu3FvEE9QS4drc3iKNgpBWFfGqNthKlZhp5QpYnu6k=
+github.com/SherClockHolmes/webpush-go v1.3.0/go.mod h1:AxRHmJuYwKGG1PVgYzToik1lphQvDnqFYDqimHvwhIw=
 github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
 github.com/andybalholm/brotli v1.1.0 h1:eLKJA0d02Lf0mVpIDgYnqXcUn0GqVmEFny3VuID1U3M=
 github.com/andybalholm/brotli v1.1.0/go.mod h1:sms7XGricyQI9K10gOSf56VKKWS4oLer58Q+mhRPtnY=
@@ -72,6 +74,8 @@ github.com/gofiber/fiber/v2 v2.52.0 h1:S+qXi7y+/Pgvqq4DrSmREGiFwtB7Bu6+QFLuIHYw/
 github.com/gofiber/fiber/v2 v2.52.0/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
 github.com/gofiber/jwt/v3 v3.3.10 h1:0bpWtFKaGepjwYTU4efHfy0o+matSqZwTxGMo5a+uuc=
 github.com/gofiber/jwt/v3 v3.3.10/go.mod h1:GJorFVaDyfMPSK9RB8RG4NQ3s1oXKTmYaoL/ny08O1A=
+github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
+github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang-jwt/jwt/v4 v4.5.0 h1:7cYmW1XlMY7h7ii7UhUyChSgS5wUJEnm9uZVTGqOWzg=
 github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0=
 github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE=
@@ -146,6 +150,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
 github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/robfig/cron/v3 v3.0.0 h1:kQ6Cb7aHOHTSzNVNEhmp8EcWKLb4CbiMW9h9VyIhO4E=
+github.com/robfig/cron/v3 v3.0.0/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
@@ -214,6 +220,7 @@ golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5y
 golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4=
 golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
+golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0=
 golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
 golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
 golang.org/x/exp v0.0.0-20240119083558-1b970713d09a h1:Q8/wZp0KX97QFTc2ywcOE0YRjZPVIx+MXInMzdvQqcA=
@@ -234,6 +241,7 @@ golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
 golang.org/x/net v0.3.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE=
 golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc=
+golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
 golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
 golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -268,6 +276,7 @@ golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
 golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
 golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U=
+golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
 golang.org/x/term v0.16.0 h1:m+B6fahuftsE9qjo0VWp2FW0mB3MTJvR0BaMQrq0pmE=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
@@ -277,6 +286,7 @@ golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

backend/pkg/converter/fiberSerializerTypes.go

@@ -81,3 +81,7 @@ type FiberGetGroupMemberRequestsResponseBody struct {
 type FiberGetInvitationsForGroupResponseBody struct {
 	MemberRequests []FiberGroupMemberAdmission `json:"groupInvitations"`
 }
+
+type FiberGetUserSubscriptionsResponseBody struct {
+	UserSubscriptions []string `json:"userSubscriptions"`
+}

backend/pkg/converter/typeConverter.go

@@ -235,3 +235,16 @@ func ProtoUserWithRoleToFiberGroupMember(groupMembers *pbCommon.User) FiberGroup
 		GroupRole: groupMembers.GroupRole.String(),
 	}
 }
+
+func StoreNotificationSubscriptionToProtoNotificationSubscriptionConverter(subscription *model.PushSubscription) *pbCommon.PushSubscription {
+	return &pbCommon.PushSubscription{
+		SubscriptionID: subscription.ID,
+		Endpoint:       subscription.Endpoint,
+		P256Dh:         subscription.P256DH,
+		Auth:           subscription.Auth,
+	}
+}
+
+func ProtoNotificationSubscriptionToIDStringConverter(subscription *pbCommon.PushSubscription) string {
+	return subscription.SubscriptionID
+}

backend/pkg/helper/errors.go

@@ -15,6 +15,7 @@ const (
 	FrontendServiceID      ClientID = "services.frontend"
 	UserServiceID          ClientID = "services.user"
 	SrsServiceID           ClientID = "services.srs"
+	NotificationServiceID  ClientID = "services.notification"
 )
 
 var (

backend/pkg/helper/validation.go

@@ -0,0 +1,10 @@
+package helper
+
+func SomeEmpty(fields ...string) bool {
+	for _, field := range fields {
+		if field == "" {
+			return true
+		}
+	}
+	return false
+}

backend/pkg/model/notification.go

@@ -0,0 +1,34 @@
+package model
+
+import gorm "gorm.io/gorm"
+import "github.com/kioku-project/kioku/pkg/helper"
+
+type PushNotification struct {
+	Title   string                  `json:"title"`
+	Options PushNotificationOptions `json:"options"`
+}
+
+type PushNotificationOptions struct {
+	Body    string              `json:"body"`
+	Actions []map[string]string `json:"actions"`
+	Vibrate []int               `json:"vibrate"`
+	Tag     string              `json:"tag"`
+}
+
+type PushSubscription struct {
+	ID       string `gorm:"primaryKey"`
+	UserID   string `gorm:"not null"`
+	User     User
+	Endpoint string `gorm:"not null"`
+	P256DH   string `gorm:"not null"`
+	Auth     string `gorm:"not null"`
+}
+
+func (c *PushSubscription) BeforeCreate(db *gorm.DB) (err error) {
+	newID, err := helper.FindFreeID(db, 10, func() (helper.PublicID, *PushSubscription) {
+		id := helper.GenerateID('N')
+		return id, &PushSubscription{ID: id.GetStringRepresentation()}
+	})
+	c.ID = newID.GetStringRepresentation()
+	return
+}