Add error_reason response

Author: tomoya-yokota

README.md

@@ -986,7 +986,8 @@ See the following error format.
       "platform": "android",
       "token": "*******",
       "message": "Hello World Android!",
-      "error": "InvalidRegistration"
+      "error":"invalid registration token",
+      "error_reason":"InvalidRegistration"
     },
     {
       "type": "failed-push",

logx/log.go

@@ -23,12 +23,13 @@ var (
 
 // LogPushEntry is push response log
 type LogPushEntry struct {
-	ID       string `json:"notif_id,omitempty"`
-	Type     string `json:"type"`
-	Platform string `json:"platform"`
-	Token    string `json:"token"`
-	Message  string `json:"message"`
-	Error    string `json:"error"`
+	ID          string `json:"notif_id,omitempty"`
+	Type        string `json:"type"`
+	Platform    string `json:"platform"`
+	Token       string `json:"token"`
+	Message     string `json:"message"`
+	Error       string `json:"error"`
+	ErrorReason string `json:"error_reason,omitempty"`
 }
 
 var isTerm bool
@@ -175,25 +176,27 @@ func GetLogPushEntry(input *InputLog) LogPushEntry {
 	}
 
 	return LogPushEntry{
-		ID:       input.ID,
-		Type:     input.Status,
-		Platform: plat,
-		Token:    token,
-		Message:  input.Message,
-		Error:    errMsg,
+		ID:          input.ID,
+		Type:        input.Status,
+		Platform:    plat,
+		Token:       token,
+		Message:     input.Message,
+		Error:       errMsg,
+		ErrorReason: input.ErrorReason,
 	}
 }
 
 // InputLog log request
 type InputLog struct {
-	ID        string
-	Status    string
-	Token     string
-	Message   string
-	Platform  int
-	Error     error
-	HideToken bool
-	Format    string
+	ID          string
+	Status      string
+	Token       string
+	Message     string
+	Platform    int
+	Error       error
+	ErrorReason string
+	HideToken   bool
+	Format      string
 }
 
 // LogPush record user push request and server response.

notify/notification_apns.go

@@ -12,7 +12,6 @@ import (
 	"time"
 
 	"github.com/appleboy/gorush/config"
-	"github.com/appleboy/gorush/core"
 	"github.com/appleboy/gorush/logx"
 	"github.com/appleboy/gorush/status"
 
@@ -427,7 +426,7 @@ Retry:
 				}
 
 				// apns server error
-				errLog := logPush(cfg, core.FailedPush, token, req, err)
+				errLog := logErrorPush(cfg, token, req, err, res.Reason)
 				resp.Logs = append(resp.Logs, errLog)
 
 				status.StatStorage.AddIosError(1)
@@ -439,7 +438,7 @@ Retry:
 			}
 
 			if res != nil && res.Sent() {
-				logPush(cfg, core.SucceededPush, token, req, nil)
+				logErrorPush(cfg, token, req, nil, res.Reason)
 				status.StatStorage.AddIosSuccess(1)
 			}
 

notify/notification_fcm.go

@@ -148,12 +148,12 @@ Retry:
 		logx.LogError.Error("FCM server send message error: " + err.Error())
 
 		if req.IsTopic() {
-			errLog := logPush(cfg, core.FailedPush, req.To, req, err)
+			errLog := logErrorPush(cfg, req.To, req, err, "")
 			resp.Logs = append(resp.Logs, errLog)
 			status.StatStorage.AddAndroidError(1)
 		} else {
 			for _, token := range req.Tokens {
-				errLog := logPush(cfg, core.FailedPush, token, req, err)
+				errLog := logErrorPush(cfg, token, req, err, "")
 				resp.Logs = append(resp.Logs, errLog)
 			}
 			status.StatStorage.AddAndroidError(int64(len(req.Tokens)))
@@ -185,12 +185,12 @@ Retry:
 				newTokens = append(newTokens, to)
 			}
 
-			errLog := logPush(cfg, core.FailedPush, to, req, result.Error)
+			errLog := logErrorPush(cfg, to, req, result.Error, result.ErrorResponseCode)
 			resp.Logs = append(resp.Logs, errLog)
 			continue
 		}
 
-		logPush(cfg, core.SucceededPush, to, req, nil)
+		logSuccessPush(cfg, to, req)
 	}
 
 	// result from Send messages to topics
@@ -204,10 +204,10 @@ Retry:
 		logx.LogAccess.Debug("Send Topic Message: ", to)
 		// Success
 		if res.MessageID != 0 {
-			logPush(cfg, core.SucceededPush, to, req, nil)
+			logSuccessPush(cfg, to, req)
 		} else {
 			// failure
-			errLog := logPush(cfg, core.FailedPush, to, req, res.Error)
+			errLog := logErrorPush(cfg, to, req, res.Error, res.ErrorResponseCode)
 			resp.Logs = append(resp.Logs, errLog)
 		}
 	}
@@ -217,7 +217,7 @@ Retry:
 		newTokens = append(newTokens, res.FailedRegistrationIDs...)
 
 		// nolint
-		errLog := logPush(cfg, core.FailedPush, notification.To, req, errors.New("device group: partial success or all fails"))
+		errLog := logErrorPush(cfg, notification.To, req, errors.New("device group: partial success or all fails"), res.ErrorResponseCode)
 		resp.Logs = append(resp.Logs, errLog)
 	}
 
@@ -232,14 +232,28 @@ Retry:
 	return resp, nil
 }
 
-func logPush(cfg *config.ConfYaml, status, token string, req *PushNotification, err error) logx.LogPushEntry {
+func logErrorPush(cfg *config.ConfYaml, token string, req *PushNotification, err error, errorReason string) logx.LogPushEntry {
+	return logx.LogPush(&logx.InputLog{
+		ID:          req.ID,
+		Status:      core.FailedPush,
+		Token:       token,
+		Message:     req.Message,
+		Platform:    req.Platform,
+		Error:       err,
+		ErrorReason: errorReason,
+		HideToken:   cfg.Log.HideToken,
+		Format:      cfg.Log.Format,
+	})
+}
+
+func logSuccessPush(cfg *config.ConfYaml, token string, req *PushNotification) logx.LogPushEntry {
 	return logx.LogPush(&logx.InputLog{
 		ID:        req.ID,
-		Status:    status,
+		Status:    core.SucceededPush,
 		Token:     token,
 		Message:   req.Message,
 		Platform:  req.Platform,
-		Error:     err,
+		Error:     nil,
 		HideToken: cfg.Log.HideToken,
 		Format:    cfg.Log.Format,
 	})

notify/notification_hms.go

@@ -6,7 +6,6 @@ import (
 	"sync"
 
 	"github.com/appleboy/gorush/config"
-	"github.com/appleboy/gorush/core"
 	"github.com/appleboy/gorush/logx"
 	"github.com/appleboy/gorush/status"
 	c "github.com/msalihkarakasli/go-hms-push/push/config"
@@ -199,7 +198,7 @@ Retry:
 	res, err := client.SendMessage(context.Background(), notification)
 	if err != nil {
 		// Send Message error
-		errLog := logPush(cfg, core.FailedPush, req.To, req, err)
+		errLog := logErrorPush(cfg, req.To, req, err, "")
 		resp.Logs = append(resp.Logs, errLog)
 		logx.LogError.Error("HMS server send message error: " + err.Error())
 		return