Chanel: Allow to send notifications without an active incident

Author: yhabteab

internal/channel/channel.go

@@ -3,15 +3,11 @@ package channel
 import (
 	"context"
 	"errors"
-	"fmt"
 	"github.com/icinga/icinga-notifications/internal/config/baseconf"
-	"github.com/icinga/icinga-notifications/internal/contracts"
 	"github.com/icinga/icinga-notifications/internal/event"
-	"github.com/icinga/icinga-notifications/internal/recipient"
 	"github.com/icinga/icinga-notifications/pkg/plugin"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
-	"net/url"
 )
 
 type Channel struct {
@@ -158,42 +154,33 @@ func (c *Channel) Restart() {
 	c.restartCh <- newConfig{c.Type, c.Config}
 }
 
-// Notify prepares and sends the notification request, returns a non-error on fails, nil on success
-func (c *Channel) Notify(contact *recipient.Contact, i contracts.Incident, ev *event.Event, icingaweb2Url string) error {
-	p := c.getPlugin()
-	if p == nil {
-		return errors.New("plugin could not be started")
+// Notify sends the provided notification request to the given *recipient.Contact.
+// If the *plugin.Contact field of the specified *plugin.NotificationRequest is not set, it
+// automatically determines the contact addresses and sets the notification request contact accordingly.
+//
+// Returns an error in all the following cases:
+//   - if the *plugin.Event of the provided notification request is not set,
+//   - the *plugin.Object of the provided notification request is not set,
+//   - trying to send a state change event without an associated *plugin.Incident,
+//   - the corresponding plugin of this channel cannot be started successfully,
+//   - or fails to successfully deliver the request to the corresponding recipient address(es).
+func (c *Channel) Notify(req *plugin.NotificationRequest) error {
+	if req.Event == nil {
+		return errors.New("invalid notification request: Event is nil")
 	}
-
-	contactStruct := &plugin.Contact{FullName: contact.FullName}
-	for _, addr := range contact.Addresses {
-		contactStruct.Addresses = append(contactStruct.Addresses, &plugin.Address{Type: addr.Type, Address: addr.Address})
+	if req.Object == nil {
+		return errors.New("invalid notification request: Object is nil")
+	}
+	if req.Contact == nil {
+		return errors.New("invalid notification request: Contact is nil")
+	}
+	if req.Incident == nil && req.Event.Type == event.TypeState {
+		return errors.New("invalid notification request: cannot send state notification without an incident")
 	}
 
-	baseUrl, _ := url.Parse(icingaweb2Url)
-	incidentUrl := baseUrl.JoinPath("/notifications/incident")
-	incidentUrl.RawQuery = fmt.Sprintf("id=%d", i.ID())
-	object := i.IncidentObject()
-
-	req := &plugin.NotificationRequest{
-		Contact: contactStruct,
-		Object: &plugin.Object{
-			Name:      object.DisplayName(),
-			Url:       ev.URL,
-			Tags:      object.Tags,
-			ExtraTags: object.ExtraTags,
-		},
-		Incident: &plugin.Incident{
-			Id:       i.ID(),
-			Url:      incidentUrl.String(),
-			Severity: i.SeverityString(),
-		},
-		Event: &plugin.Event{
-			Time:     ev.Time,
-			Type:     ev.Type,
-			Username: ev.Username,
-			Message:  ev.Message,
-		},
+	p := c.getPlugin()
+	if p == nil {
+		return errors.New("plugin could not be started")
 	}
 
 	return p.SendNotification(req)

internal/contracts/contracts.go

@@ -7,15 +7,16 @@ import (
 	"github.com/icinga/icinga-go-library/database"
 	"github.com/icinga/icinga-go-library/types"
 	"github.com/icinga/icinga-notifications/internal/config"
-	"github.com/icinga/icinga-notifications/internal/contracts"
 	"github.com/icinga/icinga-notifications/internal/daemon"
 	"github.com/icinga/icinga-notifications/internal/event"
 	"github.com/icinga/icinga-notifications/internal/object"
 	"github.com/icinga/icinga-notifications/internal/recipient"
 	"github.com/icinga/icinga-notifications/internal/rule"
 	"github.com/icinga/icinga-notifications/internal/utils"
+	"github.com/icinga/icinga-notifications/pkg/plugin"
 	"github.com/jmoiron/sqlx"
 	"go.uber.org/zap"
+	"net/url"
 	"sync"
 	"time"
 )
@@ -75,14 +76,6 @@ func NewIncident(
 	return i
 }
 
-func (i *Incident) IncidentObject() *object.Object {
-	return i.Object
-}
-
-func (i *Incident) SeverityString() string {
-	return i.Severity.String()
-}
-
 func (i *Incident) String() string {
 	return fmt.Sprintf("#%d", i.Id)
 }
@@ -559,14 +552,43 @@ func (i *Incident) triggerEscalations(ctx context.Context, tx *sqlx.Tx, ev *even
 // notifyContacts executes all the given pending notifications of the current incident.
 // Returns error on database failure or if the provided context is cancelled.
 func (i *Incident) notifyContacts(ctx context.Context, ev *event.Event, notifications []*NotificationEntry) error {
+	baseUrl, err := url.Parse(daemon.Config().Icingaweb2URL)
+	if err != nil {
+		i.logger.Errorw("Failed to parse Icinga Web 2 URL", zap.String("url", daemon.Config().Icingaweb2URL), zap.Error(err))
+		return err
+	}
+
+	incidentUrl := baseUrl.JoinPath("/notifications/incident")
+	incidentUrl.RawQuery = fmt.Sprintf("id=%d", i.ID())
+
+	req := &plugin.NotificationRequest{
+		Object: &plugin.Object{
+			Name:      i.Object.DisplayName(),
+			Url:       ev.URL,
+			Tags:      i.Object.Tags,
+			ExtraTags: i.Object.ExtraTags,
+		},
+		Incident: &plugin.Incident{
+			Id:       i.Id,
+			Url:      incidentUrl.String(),
+			Severity: i.Severity.String(),
+		},
+		Event: &plugin.Event{
+			Time:     ev.Time,
+			Type:     ev.Type,
+			Username: ev.Username,
+			Message:  ev.Message,
+		},
+	}
+
 	for _, notification := range notifications {
 		contact := i.runtimeConfig.Contacts[notification.ContactID]
 		if contact == nil {
 			i.logger.Debugw("Incident refers unknown contact, might got deleted", zap.Int64("contact_id", notification.ContactID))
 			continue
 		}
 
-		if i.notifyContact(contact, ev, notification.ChannelID) != nil {
+		if i.notifyContact(contact, req, notification.ChannelID) != nil {
 			notification.State = NotificationStateFailed
 		} else {
 			notification.State = NotificationStateSent
@@ -590,7 +612,7 @@ func (i *Incident) notifyContacts(ctx context.Context, ev *event.Event, notifica
 }
 
 // notifyContact notifies the given recipient via a channel matching the given ID.
-func (i *Incident) notifyContact(contact *recipient.Contact, ev *event.Event, chID int64) error {
+func (i *Incident) notifyContact(contact *recipient.Contact, req *plugin.NotificationRequest, chID int64) error {
 	ch := i.runtimeConfig.Channels[chID]
 	if ch == nil {
 		i.logger.Errorw("Could not find config for channel", zap.Int64("channel_id", chID))
@@ -599,16 +621,21 @@ func (i *Incident) notifyContact(contact *recipient.Contact, ev *event.Event, ch
 	}
 
 	i.logger.Infow(fmt.Sprintf("Notify contact %q via %q of type %q", contact.FullName, ch.Name, ch.Type),
-		zap.Int64("channel_id", chID), zap.String("event_type", ev.Type))
+		zap.Int64("channel_id", chID), zap.String("event_type", req.Event.Type))
 
-	err := ch.Notify(contact, i, ev, daemon.Config().Icingaweb2URL)
-	if err != nil {
+	contactStruct := &plugin.Contact{FullName: contact.FullName}
+	for _, addr := range contact.Addresses {
+		contactStruct.Addresses = append(contactStruct.Addresses, &plugin.Address{Type: addr.Type, Address: addr.Address})
+	}
+	req.Contact = contactStruct
+
+	if err := ch.Notify(req); err != nil {
 		i.logger.Errorw("Failed to send notification via channel plugin", zap.String("type", ch.Type), zap.Error(err))
 		return err
 	}
 
 	i.logger.Infow("Successfully sent a notification via channel plugin", zap.String("type", ch.Type),
-		zap.String("contact", contact.FullName), zap.String("event_type", ev.Type))
+		zap.String("contact", contact.FullName), zap.String("event_type", req.Event.Type))
 
 	return nil
 }
@@ -767,7 +794,3 @@ func (e *EscalationState) TableName() string {
 type RecipientState struct {
 	Role ContactRole
 }
-
-var (
-	_ contracts.Incident = (*Incident)(nil)
-)

internal/incident/incident.go

@@ -310,7 +310,11 @@ func FormatMessage(writer io.Writer, req *NotificationRequest) {
 		}
 	}
 
-	_, _ = fmt.Fprintf(writer, "\nIncident: %s", req.Incident.Url)
+	if req.Incident != nil {
+		_, _ = fmt.Fprintf(writer, "\nIncident: %s", req.Incident.Url)
+	} else {
+		_, _ = fmt.Fprint(writer, "\nIncident: No active incident found for this object")
+	}
 }
 
 // FormatSubject returns the formatted subject string based on the event type.
@@ -319,8 +323,16 @@ func FormatSubject(req *NotificationRequest) string {
 	case event.TypeState:
 		return fmt.Sprintf("[#%d] %s %s is %s", req.Incident.Id, req.Event.Type, req.Object.Name, req.Incident.Severity)
 	case event.TypeAcknowledgementCleared, event.TypeDowntimeRemoved:
-		return fmt.Sprintf("[#%d] %s from %s", req.Incident.Id, req.Event.Type, req.Object.Name)
+		if req.Incident != nil {
+			return fmt.Sprintf("[#%d] %s from %s", req.Incident.Id, req.Event.Type, req.Object.Name)
+		}
+
+		return fmt.Sprintf("%s from %s", req.Event.Type, req.Object.Name)
 	default:
-		return fmt.Sprintf("[#%d] %s on %s", req.Incident.Id, req.Event.Type, req.Object.Name)
+		if req.Incident != nil {
+			return fmt.Sprintf("[#%d] %s on %s", req.Incident.Id, req.Event.Type, req.Object.Name)
+		}
+
+		return fmt.Sprintf("%s on %s", req.Event.Type, req.Object.Name)
 	}
 }