tasks/internal/protocol/naming.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package protocol

import (
	"fmt"
	"strings"

	"github.com/gogo/protobuf/types"
	protocolpb "go.temporal.io/api/protocol/v1"
)

type (
	// Type is a protocol type of which there may be many instances like the
	// update protocol or the query protocol.
	Type string

	// MessageType is the type of a message within a protocol.
	MessageType string

	constErr string
)

const (
	MessageTypeUnknown = MessageType("__message_type_unknown")
	TypeUnknown        = Type("__protocol_type_unknown")

	errNilMsg   = constErr("nil message")
	errNilBody  = constErr("nil message body")
	errProtoFmt = constErr("failed to extract protocol type")
)

// String transforms a MessageType into a string
func (mt MessageType) String() string {
	return string(mt)
}

// String tranforms a Type into a string
func (pt Type) String() string {
	return string(pt)
}

// Identify is a function that given a protocol message gives the specific
// message type of the body and the type of the protocol to which this message
// belongs.
func Identify(msg *protocolpb.Message) (Type, MessageType, error) {
	if msg == nil {
		return TypeUnknown, MessageTypeUnknown, errNilMsg
	}
	if msg.Body == nil {
		return TypeUnknown, MessageTypeUnknown, errNilBody
	}
	bodyTypeName, err := types.AnyMessageName(msg.Body)
	if err != nil {
		return TypeUnknown, MessageTypeUnknown, err
	}
	msgType := MessageType(bodyTypeName)

	lastDot := strings.LastIndex(bodyTypeName, ".")
	if lastDot < 0 {
		err := fmt.Errorf("%w: no . found in %q", errProtoFmt, bodyTypeName)
		return TypeUnknown, msgType, err
	}
	return Type(bodyTypeName[0:lastDot]), msgType, nil
}

// IdentifyOrUnknown wraps Identify to return TypeUnknown and/or
// MessageTypeUnknown in the case where either one cannot be determined due to
// an error.
func IdentifyOrUnknown(msg *protocolpb.Message) (Type, MessageType) {
	pt, mt, _ := Identify(msg)
	return pt, mt
}

func (cerr constErr) Error() string {
	return string(cerr)
}