Merge pull request #30 from capcom6/feature/push-debounce

capcom6 · web-flow · commit cc41bfe5c59f · 2024-02-06T19:49:44.000+07:00
Added: push notifications debounce
diff --git a/api/requests.http b/api/requests.http
@@ -33,10 +33,10 @@ Content-Type: application/json
 Authorization: Basic {{credentials}}
 
 {
-    "message": "17wc9/ZRf1l84LHkEK3hgA==.aH1XrMHAeMyF4PeiavV3dk8o2fP0nSo92IqseLQfg14=",
+    "message": "$aes-256-cbc/pbkdf2-sha1$i=75000$pb+tpPcF0nabV46wDeDMig==$ucdVkMrRYLQ0LAeoXQsWhrD36I9nnop8rRIh3dNmBhvg7Wc4Cwu3h9Petvp1dN3x",
     "ttl": 600,
     "phoneNumbers": [
-        "xkQeXzSDFj2xP6JBUMK0pA==.PfUHEa9QZv8h7JnUoBlmWw=="
+        "$aes-256-cbc/pbkdf2-sha1$i=75000$ZWdiSMvGWJo/jixYGk+s+w==$tfP6sEeC4r/ux/JAglincQ=="
     ],
     "simNumber": 1,
     "withDeliveryReport": true,
diff --git a/api/swagger.json b/api/swagger.json
@@ -97,10 +97,16 @@
                     }
                 ],
                 "responses": {
-                    "201": {
+                    "202": {
                         "description": "Сообщение поставлено в очередь",
                         "schema": {
                             "$ref": "#/definitions/smsgateway.MessageState"
+                        },
+                        "headers": {
+                            "Location": {
+                                "type": "string",
+                                "description": "URL для получения состояния сообщения"
+                            }
                         }
                     },
                     "400": {
@@ -340,6 +346,11 @@
                     "maxLength": 36,
                     "example": "PyDmBQZZXYmyxMwED8Fzy"
                 },
+                "isEncrypted": {
+                    "description": "Зашифровано",
+                    "type": "boolean",
+                    "example": true
+                },
                 "message": {
                     "description": "Текст сообщения",
                     "type": "string",
@@ -390,6 +401,11 @@
                     "maxLength": 36,
                     "example": "PyDmBQZZXYmyxMwED8Fzy"
                 },
+                "isEncrypted": {
+                    "description": "Зашифровано",
+                    "type": "boolean",
+                    "example": false
+                },
                 "isHashed": {
                     "description": "Хэшировано",
                     "type": "boolean",
@@ -511,6 +527,7 @@
                 "phoneNumber": {
                     "description": "Номер телефона или первые 16 символов SHA256",
                     "type": "string",
+                    "maxLength": 128,
                     "minLength": 10,
                     "example": "79990001234"
                 },
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -19,6 +19,10 @@ definitions:
         example: PyDmBQZZXYmyxMwED8Fzy
         maxLength: 36
         type: string
+      isEncrypted:
+        description: Зашифровано
+        example: true
+        type: boolean
       message:
         description: Текст сообщения
         example: Hello World!
@@ -58,6 +62,10 @@ definitions:
         example: PyDmBQZZXYmyxMwED8Fzy
         maxLength: 36
         type: string
+      isEncrypted:
+        description: Зашифровано
+        example: false
+        type: boolean
       isHashed:
         description: Хэшировано
         example: false
@@ -150,6 +158,7 @@ definitions:
       phoneNumber:
         description: Номер телефона или первые 16 символов SHA256
         example: "79990001234"
+        maxLength: 128
         minLength: 10
         type: string
       state:
@@ -219,8 +228,12 @@ paths:
       produces:
       - application/json
       responses:
-        "201":
+        "202":
           description: Сообщение поставлено в очередь
+          headers:
+            Location:
+              description: URL для получения состояния сообщения
+              type: string
           schema:
             $ref: '#/definitions/smsgateway.MessageState'
         "400":
diff --git a/configs/config.example.yml b/configs/config.example.yml
@@ -14,6 +14,8 @@ fcm:
     {
     ...
     }
+  timeout_seconds: 1
+  debounce_seconds: 1
 tasks:
   hashing:
     interval_seconds: 15
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -23,6 +23,8 @@ type Database struct {
 
 type FCMConfig struct {
 	CredentialsJSON string `yaml:"credentials_json"`
+	DebounceSeconds uint16 `yaml:"debounce_seconds"`
+	TimeoutSeconds  uint16 `yaml:"timeout_seconds"`
 }
 
 type Tasks struct {
diff --git a/internal/config/module.go b/internal/config/module.go
@@ -42,6 +42,8 @@ var Module = fx.Module(
 	fx.Provide(func(cfg Config) services.PushServiceConfig {
 		return services.PushServiceConfig{
 			CredentialsJSON: cfg.FCM.CredentialsJSON,
+			Debounce:        time.Duration(cfg.FCM.DebounceSeconds) * time.Second,
+			Timeout:         time.Duration(cfg.FCM.TimeoutSeconds) * time.Second,
 		}
 	}),
 	fx.Provide(func(cfg Config) tasks.HashingTaskConfig {
diff --git a/internal/sms-gateway/app.go b/internal/sms-gateway/app.go
@@ -11,7 +11,6 @@ import (
 	"github.com/capcom6/go-infra-fx/validator"
 	appconfig "github.com/capcom6/sms-gateway/internal/config"
 	"github.com/capcom6/sms-gateway/internal/sms-gateway/handlers"
-	"github.com/capcom6/sms-gateway/internal/sms-gateway/models"
 	"github.com/capcom6/sms-gateway/internal/sms-gateway/repositories"
 	"github.com/capcom6/sms-gateway/internal/sms-gateway/services"
 	"github.com/capcom6/sms-gateway/internal/sms-gateway/tasks"
@@ -30,7 +29,6 @@ var Module = fx.Module(
 	handlers.Module,
 	services.Module,
 	repositories.Module,
-	models.Module,
 	db.Module,
 	tasks.Module,
 )
@@ -57,6 +55,7 @@ type StartParams struct {
 
 	Server      *http.Server
 	HashingTask *tasks.HashingTask
+	PushService *services.PushService
 }
 
 func Start(p StartParams) error {
@@ -65,12 +64,17 @@ func Start(p StartParams) error {
 	p.LC.Append(fx.Hook{
 		OnStart: func(_ context.Context) error {
 			wg.Add(1)
-
 			go func() {
 				defer wg.Done()
 				p.HashingTask.Run(ctx)
 			}()
 
+			wg.Add(1)
+			go func() {
+				defer wg.Done()
+				p.PushService.Run(ctx)
+			}()
+
 			wg.Add(1)
 			go func() {
 				defer wg.Done()
diff --git a/internal/sms-gateway/handlers/3rdparty.go b/internal/sms-gateway/handlers/3rdparty.go
@@ -13,6 +13,10 @@ import (
 	"go.uber.org/zap"
 )
 
+const (
+	route3rdPartyGetMessage = "3rdparty.get.message"
+)
+
 type thirdPartyHandler struct {
 	Handler
 
@@ -27,10 +31,11 @@ type thirdPartyHandler struct {
 //	@Accept			json
 //	@Produce		json
 //	@Param			request	body		smsgateway.Message			true	"Сообщение"
-//	@Success		201		{object}	smsgateway.MessageState		"Сообщение поставлено в очередь"
+//	@Success		202		{object}	smsgateway.MessageState		"Сообщение поставлено в очередь"
 //	@Failure		401		{object}	smsgateway.ErrorResponse	"Ошибка авторизации"
 //	@Failure		400		{object}	smsgateway.ErrorResponse	"Некорректный запрос"
 //	@Failure		500		{object}	smsgateway.ErrorResponse	"Внутренняя ошибка сервера"
+//	@Header			202		{string}	Location					"URL для получения состояния сообщения"
 //	@Router			/3rdparty/v1/message [post]
 //
 // Поставить сообщение в очередь
@@ -55,7 +60,16 @@ func (h *thirdPartyHandler) postMessage(user models.User, c *fiber.Ctx) error {
 		return err
 	}
 
-	return c.Status(fiber.StatusCreated).JSON(state)
+	location, err := c.GetRouteURL(route3rdPartyGetMessage, fiber.Map{
+		"id": state.ID,
+	})
+	if err != nil {
+		h.Logger.Error("Failed to get route URL", zap.String("route", route3rdPartyGetMessage), zap.Error(err))
+	} else {
+		c.Location(location)
+	}
+
+	return c.Status(fiber.StatusAccepted).JSON(state)
 }
 
 //	@Summary		Получить состояние сообщения
@@ -111,7 +125,7 @@ func (h *thirdPartyHandler) Register(router fiber.Router) {
 	}))
 
 	router.Post("/message", h.authorize(h.postMessage))
-	router.Get("/message/:id", h.authorize(h.getMessage))
+	router.Get("/message/:id", h.authorize(h.getMessage)).Name(route3rdPartyGetMessage)
 }
 
 func newThirdPartyHandler(logger *zap.Logger, validator *validator.Validate, authSvc *services.AuthService, messagesSvc *services.MessagesService) *thirdPartyHandler {
diff --git a/internal/sms-gateway/handlers/module.go b/internal/sms-gateway/handlers/module.go
@@ -3,10 +3,14 @@ package handlers
 import (
 	"github.com/capcom6/go-infra-fx/http"
 	"go.uber.org/fx"
+	"go.uber.org/zap"
 )
 
 var Module = fx.Module(
 	"handlers",
+	fx.Decorate(func(log *zap.Logger) *zap.Logger {
+		return log.Named("handlers")
+	}),
 	fx.Provide(
 		http.AsRootHandler(newRootHandler),
 		http.AsApiHandler(newThirdPartyHandler),
diff --git a/internal/sms-gateway/models/module.go b/internal/sms-gateway/models/module.go
@@ -2,11 +2,6 @@ package models
 
 import (
 	"github.com/capcom6/go-infra-fx/db"
-	"go.uber.org/fx"
-)
-
-var Module = fx.Module(
-	"models",
 )
 
 func init() {
diff --git a/internal/sms-gateway/repositories/module.go b/internal/sms-gateway/repositories/module.go
@@ -1,9 +1,15 @@
 package repositories
 
-import "go.uber.org/fx"
+import (
+	"go.uber.org/fx"
+	"go.uber.org/zap"
+)
 
 var Module = fx.Module(
 	"repositories",
+	fx.Decorate(func(log *zap.Logger) *zap.Logger {
+		return log.Named("repositories")
+	}),
 	fx.Provide(
 		NewDevicesRepository,
 		NewMessagesRepository,
diff --git a/internal/sms-gateway/services/messages.go b/internal/sms-gateway/services/messages.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"crypto/sha256"
 	"fmt"
-	"log"
 	"time"
 
 	"github.com/capcom6/sms-gateway/internal/sms-gateway/models"
@@ -14,6 +13,8 @@ import (
 	"github.com/capcom6/sms-gateway/pkg/types"
 	"github.com/jaevor/go-nanoid"
 	"github.com/nyaruka/phonenumbers"
+	"go.uber.org/fx"
+	"go.uber.org/zap"
 )
 
 const (
@@ -26,19 +27,29 @@ func (e ErrValidation) Error() string {
 	return string(e)
 }
 
+type MessagesServiceParams struct {
+	fx.In
+
+	Messages *repositories.MessagesRepository
+	PushSvc  *PushService
+	Logger   *zap.Logger
+}
+
 type MessagesService struct {
 	Messages *repositories.MessagesRepository
 	PushSvc  *PushService
+	Logger   *zap.Logger
 
 	idgen func() string
 }
 
-func NewMessagesService(pushSvc *PushService, messages *repositories.MessagesRepository) *MessagesService {
+func NewMessagesService(params MessagesServiceParams) *MessagesService {
 	idgen, _ := nanoid.Standard(21)
 
 	return &MessagesService{
-		Messages: messages,
-		PushSvc:  pushSvc,
+		Messages: params.Messages,
+		PushSvc:  params.PushSvc,
+		Logger:   params.Logger,
 		idgen:    idgen,
 	}
 }
@@ -168,8 +179,8 @@ func (s *MessagesService) Enqeue(device models.Device, message smsgateway.Messag
 		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 		defer cancel()
 
-		if err := s.PushSvc.Send(ctx, token, map[string]string{}); err != nil {
-			log.Printf("failed to send push to %s: %v", *device.PushToken, err)
+		if err := s.PushSvc.Enqueue(ctx, token, map[string]string{}); err != nil {
+			s.Logger.Error("Can't enqueue message", zap.String("token", token), zap.Error(err))
 		}
 	}(*device.PushToken)
 
diff --git a/internal/sms-gateway/services/module.go b/internal/sms-gateway/services/module.go
@@ -1,9 +1,15 @@
 package services
 
-import "go.uber.org/fx"
+import (
+	"go.uber.org/fx"
+	"go.uber.org/zap"
+)
 
 var Module = fx.Module(
 	"services",
+	fx.Decorate(func(log *zap.Logger) *zap.Logger {
+		return log.Named("services")
+	}),
 	fx.Provide(
 		NewAuthService,
 		NewMessagesService,
diff --git a/internal/sms-gateway/services/push.go b/internal/sms-gateway/services/push.go
diff --git a/pkg/types/cache/cache.go b/pkg/types/cache/cache.go
diff --git a/pkg/types/cache/cache_test.go b/pkg/types/cache/cache_test.go

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ fcm:`
`14`	`14`	`{`
`15`	`15`	`...`
`16`	`16`	`}`
	`17`	`+ timeout_seconds: 1`
	`18`	`+ debounce_seconds: 1`
`17`	`19`	`tasks:`
`18`	`20`	`hashing:`
`19`	`21`	`interval_seconds: 15`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ type Database struct {`
`23`	`23`
`24`	`24`	`type FCMConfig struct {`
`25`	`25`	CredentialsJSON string `yaml:"credentials_json"`
	`26`	+ DebounceSeconds uint16 `yaml:"debounce_seconds"`
	`27`	+ TimeoutSeconds uint16 `yaml:"timeout_seconds"`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`type Tasks struct {`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,8 @@ var Module = fx.Module(`
`42`	`42`	`fx.Provide(func(cfg Config) services.PushServiceConfig {`
`43`	`43`	`return services.PushServiceConfig{`
`44`	`44`	`CredentialsJSON: cfg.FCM.CredentialsJSON,`
	`45`	`+ Debounce: time.Duration(cfg.FCM.DebounceSeconds) * time.Second,`
	`46`	`+ Timeout: time.Duration(cfg.FCM.TimeoutSeconds) * time.Second,`
`45`	`47`	`}`
`46`	`48`	`}),`
`47`	`49`	`fx.Provide(func(cfg Config) tasks.HashingTaskConfig {`