Added more json fields to AlertStatus webhook notification (#4445)

* Added more json fields to webhook notifications
for AlertStatus updates:

	Summary     string
	Details     string
	ServiceID   string
	ServiceName string
	Meta        map[string]string

Before these fields were only available in Alert notifications and it was not possible to send them to the user with acknowledge or close events.

* Update contribution guidelines for testing command `make test`

* Added PublicURL field to json for webhook
notification for Alart and AlartStatus
Before was that field not available and it was not possible to send them to the user with messages.

* AlertBundle Webhook sends now PublicURL as well.

* cfg.PublicURL() gets used as cfg.General.PublicURL is deprecated.

Co-authored-by: Nathaniel Caza <mastercactapus@gmail.com>

* Changed PublicURL to AlertURL
AlertURL contains the full link to the alert page, or to the alarm list of the according service if it is an alert bundle.

* Replaced function calls for URL generation
fmt.Sprintf("%s/alerts/%d", pubURL, m.AlertID)
with
cfg.CallbackURL(fmt.Sprintf("/alerts/%d", m.AlertID))

* Address review feedback: rename AlertURL to GoAlertURL and clean up

- Rename AlertURL to GoAlertURL as suggested, since the URL points to
  GoAlert itself, not to anything notification-specific
- Remove unused pubURL variable (cfg.CallbackURL is used instead)
- Remove unused strings import

---------

Co-authored-by: Nathaniel Caza <mastercactapus@gmail.com>

Author: MichaelUray

CONTRIBUTING.md

@@ -26,7 +26,7 @@ Patches are welcome, but we ask that any significant change start as an [issue](
 
 More information is available for [complex features](./docs/complex-features.md).
 
-Be sure to run `make check` and tests before opening a PR to catch common errors.
+Be sure to run `make check` and `make test` before opening a PR to catch common errors.
 
 ### UI Change Guidelines
 

engine/sendmessage.go

@@ -104,6 +104,14 @@ func (p *Engine) sendMessage(ctx context.Context, msg *message.Message) (*notifi
 		if stat == nil {
 			return nil, fmt.Errorf("could not find original notification for alert %d to %s", msg.AlertID, msg.Dest.String())
 		}
+		name, _, err := p.a.ServiceInfo(ctx, a.ServiceID)
+		if err != nil {
+			return nil, errors.Wrap(err, "lookup service info")
+		}
+		meta, err := p.a.Metadata(ctx, p.b.db, msg.AlertID)
+		if err != nil {
+			return nil, errors.Wrap(err, "lookup alert metadata")
+		}
 
 		var status notification.AlertState
 		switch e.Type() {
@@ -124,6 +132,8 @@ func (p *Engine) sendMessage(ctx context.Context, msg *message.Message) (*notifi
 			Details:        a.Details,
 			NewAlertState:  status,
 			OriginalStatus: *stat,
+			ServiceName:    name,
+			Meta:           meta,
 		}
 	case notification.MessageTypeTest:
 		notifMsg = notification.Test{

notification/nfymsg/msgalertstatus.go

@@ -14,18 +14,27 @@ const (
 type AlertStatus struct {
 	Base
 
-	AlertID   int
-	LogEntry  string
-	ServiceID string
+	AlertID int
 
 	// Summary of the alert that this status is in regards to.
 	Summary string
+
 	// Details of the alert that this status is in regards to.
 	Details string
 
+	ServiceID string
+
+	// ServiceName of the alert that this status is in regards to.
+	ServiceName string
+
+	// Meta contains key/value pairs associated with the alert.
+	Meta map[string]string
+
 	// OriginalStatus is the status of the first Alert notification to this Dest for this AlertID.
 	OriginalStatus SendResult
 
 	// NewAlertState contains the most recent state of the alert.
 	NewAlertState AlertState
+
+	LogEntry string
 }

notification/webhook/sender.go

@@ -27,6 +27,7 @@ type POSTDataAlert struct {
 	ServiceID   string
 	ServiceName string
 	Meta        map[string]string
+	GoAlertURL string
 }
 
 // POSTDataAlertBundle represents fields in outgoing alert bundle notification.
@@ -36,23 +37,31 @@ type POSTDataAlertBundle struct {
 	ServiceID   string
 	ServiceName string
 	Count       int
+	GoAlertURL  string
 }
 
 // POSTDataAlertStatus represents fields in outgoing alert status notification.
 type POSTDataAlertStatus struct {
-	AppName  string
-	Type     string
-	AlertID  int
-	LogEntry string
+	AppName     string
+	Type        string
+	AlertID     int
+	Summary     string
+	Details     string
+	ServiceID   string
+	ServiceName string
+	Meta        map[string]string
+	LogEntry    string
+	GoAlertURL  string
 }
 
 // POSTDataAlertStatusBundle represents fields in outgoing alert status bundle notification.
 type POSTDataAlertStatusBundle struct {
-	AppName  string
-	Type     string
-	AlertID  int
-	LogEntry string
-	Count    int
+	AppName    string
+	Type       string
+	AlertID    int
+	LogEntry   string
+	Count      int
+	GoAlertURL string
 }
 
 // POSTDataVerification represents fields in outgoing verification notification.
@@ -119,6 +128,7 @@ func (s *Sender) SendMessage(ctx context.Context, msg notification.Message) (*no
 			ServiceID:   m.ServiceID,
 			ServiceName: m.ServiceName,
 			Meta:        m.Meta,
+			GoAlertURL:  cfg.CallbackURL(fmt.Sprintf("/alerts/%d", m.AlertID)),
 		}
 	case notification.AlertBundle:
 		payload = POSTDataAlertBundle{
@@ -127,13 +137,20 @@ func (s *Sender) SendMessage(ctx context.Context, msg notification.Message) (*no
 			ServiceID:   m.ServiceID,
 			ServiceName: m.ServiceName,
 			Count:       m.Count,
+			GoAlertURL:  cfg.CallbackURL(fmt.Sprintf("/services/%s/alerts", m.ServiceID)),
 		}
 	case notification.AlertStatus:
 		payload = POSTDataAlertStatus{
-			AppName:  cfg.ApplicationName(),
-			Type:     "AlertStatus",
-			AlertID:  m.AlertID,
-			LogEntry: m.LogEntry,
+			AppName:     cfg.ApplicationName(),
+			Type:        "AlertStatus",
+			Details:     m.Details,
+			AlertID:     m.AlertID,
+			Summary:     m.Summary,
+			ServiceID:   m.ServiceID,
+			ServiceName: m.ServiceName,
+			Meta:        m.Meta,
+			LogEntry:    m.LogEntry,
+			GoAlertURL:  cfg.CallbackURL(fmt.Sprintf("/alerts/%d", m.AlertID)),
 		}
 	case notification.ScheduleOnCallUsers:
 		// We use types defined in this package to insulate against unintended API