responses.go

package courier

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"strings"
	"time"

	"github.com/nyaruka/gocommon/urns"
	validator "gopkg.in/go-playground/validator.v9"
)

const statusMsgNotFoundDetail = "message not found, ignored"

// WriteError writes a JSON response for the passed in error
func WriteError(ctx context.Context, w http.ResponseWriter, r *http.Request, err error) error {
	errors := []interface{}{NewErrorData(err.Error())}

	vErrs, isValidation := err.(validator.ValidationErrors)
	if isValidation {
		for i := range vErrs {
			errors = append(errors, NewErrorData(fmt.Sprintf("field '%s' %s", strings.ToLower(vErrs[i].Field()), vErrs[i].Tag())))
		}
	}
	return WriteDataResponse(ctx, w, http.StatusBadRequest, "Error", errors)
}

// WriteAndLogRequestError writes a JSON response for the passed in message and logs an info messages
func WriteAndLogRequestError(ctx context.Context, w http.ResponseWriter, r *http.Request, c Channel, err error) error {
	LogRequestError(r, c, err)
	return WriteError(ctx, w, r, err)
}

// WriteAndLogRequestIgnored writes a JSON response for the passed in message and logs an info message
func WriteAndLogRequestIgnored(ctx context.Context, w http.ResponseWriter, r *http.Request, c Channel, details string) error {
	LogRequestIgnored(r, c, details)
	return WriteDataResponse(ctx, w, http.StatusOK, "Ignored", []interface{}{NewInfoData(details)})
}

// WriteAndLogStatusMsgNotFound writes a JSON response for the passed in message and logs an info message
func WriteAndLogStatusMsgNotFound(ctx context.Context, w http.ResponseWriter, r *http.Request, c Channel) error {
	LogRequestIgnored(r, c, statusMsgNotFoundDetail)
	return WriteDataResponse(ctx, w, http.StatusOK, "Ignored", []interface{}{NewInfoData(statusMsgNotFoundDetail)})
}

// WriteChannelEventSuccess writes a JSON response for the passed in event indicating we handled it
func WriteChannelEventSuccess(ctx context.Context, w http.ResponseWriter, r *http.Request, event ChannelEvent) error {
	return WriteDataResponse(ctx, w, http.StatusOK, "Event Accepted", []interface{}{NewEventReceiveData(event)})
}

// WriteMsgSuccess writes a JSON response for the passed in msg indicating we handled it
func WriteMsgSuccess(ctx context.Context, w http.ResponseWriter, r *http.Request, msgs []Msg) error {
	data := []interface{}{}
	for _, msg := range msgs {
		data = append(data, NewMsgReceiveData(msg))
	}

	return WriteDataResponse(ctx, w, http.StatusOK, "Message Accepted", data)
}

// WriteStatusSuccess writes a JSON response for the passed in status update indicating we handled it
func WriteStatusSuccess(ctx context.Context, w http.ResponseWriter, r *http.Request, statuses []MsgStatus) error {
	data := []interface{}{}
	for _, status := range statuses {
		data = append(data, NewStatusData(status))
	}

	return WriteDataResponse(ctx, w, http.StatusOK, "Status Update Accepted", data)
}

// WriteDataResponse writes a JSON formatted response with the passed in status code, message and data
func WriteDataResponse(ctx context.Context, w http.ResponseWriter, statusCode int, message string, data []interface{}) error {
	return writeJSONResponse(ctx, w, statusCode, &dataResponse{message, data})
}

// MsgReceiveData is our response payload for a received message
type MsgReceiveData struct {
	Type        string      `json:"type"`
	ChannelUUID ChannelUUID `json:"channel_uuid"`
	MsgUUID     MsgUUID     `json:"msg_uuid"`
	Text        string      `json:"text"`
	URN         urns.URN    `json:"urn"`
	Attachments []string    `json:"attachments,omitempty"`
	ExternalID  string      `json:"external_id,omitempty"`
	ReceivedOn  *time.Time  `json:"received_on,omitempty"`
}

// NewMsgReceiveData creates a new data response for the passed in msg parameters
func NewMsgReceiveData(msg Msg) MsgReceiveData {
	return MsgReceiveData{
		"msg",
		msg.Channel().UUID(),
		msg.UUID(),
		msg.Text(),
		msg.URN(),
		msg.Attachments(),
		msg.ExternalID(),
		msg.ReceivedOn(),
	}
}

// EventReceiveData is our response payload for a channel event
type EventReceiveData struct {
	Type        string           `json:"type"`
	ChannelUUID ChannelUUID      `json:"channel_uuid"`
	EventType   ChannelEventType `json:"event_type"`
	URN         urns.URN         `json:"urn"`
	ReceivedOn  time.Time        `json:"received_on"`
}

// NewEventReceiveData creates a new receive data for the passed in event
func NewEventReceiveData(event ChannelEvent) EventReceiveData {
	return EventReceiveData{
		"event",
		event.ChannelUUID(),
		event.EventType(),
		event.URN(),
		event.OccurredOn(),
	}
}

// StatusData is our response payload for a status update
type StatusData struct {
	Type        string         `json:"type"`
	ChannelUUID ChannelUUID    `json:"channel_uuid"`
	Status      MsgStatusValue `json:"status"`
	MsgID       MsgID          `json:"msg_id,omitempty"`
	ExternalID  string         `json:"external_id,omitempty"`
}

// NewStatusData creates a new status data object for the passed in status
func NewStatusData(status MsgStatus) StatusData {
	return StatusData{
		"status",
		status.ChannelUUID(),
		status.Status(),
		status.ID(),
		status.ExternalID(),
	}
}

// ErrorData is our response payload for an error
type ErrorData struct {
	Type  string `json:"type"`
	Error string `json:"error"`
}

// NewErrorData creates a new data segment for the passed in error string
func NewErrorData(err string) ErrorData {
	return ErrorData{"error", err}
}

// InfoData is our response payload for an informational message
type InfoData struct {
	Type string `json:"type"`
	Info string `json:"info"`
}

// NewInfoData creates a new data segment for the passed in info string
func NewInfoData(info string) InfoData {
	return InfoData{"info", info}
}

type dataResponse struct {
	Message string        `json:"message"`
	Data    []interface{} `json:"data"`
}

func writeJSONResponse(ctx context.Context, w http.ResponseWriter, statusCode int, response interface{}) error {
	w.Header().Set("Content-Type", "application/json")
	w.WriteHeader(statusCode)
	return json.NewEncoder(w).Encode(response)
}