go.temporal.io/server@v1.23.0/common/serviceerror/current_branch_changed.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package serviceerror
    26  
    27  import (
    28  	"google.golang.org/grpc/codes"
    29  	"google.golang.org/grpc/status"
    30  
    31  	"go.temporal.io/server/api/errordetails/v1"
    32  )
    33  
    34  type (
    35  	// CurrentBranchChanged represents current branch changed error.
    36  	CurrentBranchChanged struct {
    37  		Message            string
    38  		CurrentBranchToken []byte
    39  		RequestBranchToken []byte
    40  		st                 *status.Status
    41  	}
    42  )
    43  
    44  // NewCurrentBranchChanged returns new CurrentBranchChanged error.
    45  // TODO: Update CurrentBranchChanged with event id and event version. Do not use branch token bytes as branch identity.
    46  func NewCurrentBranchChanged(currentBranchToken, requestBranchToken []byte) error {
    47  	return &CurrentBranchChanged{
    48  		Message:            "Current branch token and request branch token doesn't match.",
    49  		CurrentBranchToken: currentBranchToken,
    50  		RequestBranchToken: requestBranchToken,
    51  	}
    52  }
    53  
    54  // Error returns string message.
    55  func (e *CurrentBranchChanged) Error() string {
    56  	return e.Message
    57  }
    58  
    59  func (e *CurrentBranchChanged) Status() *status.Status {
    60  	if e.st != nil {
    61  		return e.st
    62  	}
    63  
    64  	st := status.New(codes.InvalidArgument, e.Message)
    65  	st, _ = st.WithDetails(
    66  		&errordetails.CurrentBranchChangedFailure{
    67  			CurrentBranchToken: e.CurrentBranchToken,
    68  			RequestBranchToken: e.RequestBranchToken,
    69  		},
    70  	)
    71  	return st
    72  }
    73  
    74  func newCurrentBranchChanged(st *status.Status, errDetails *errordetails.CurrentBranchChangedFailure) error {
    75  	return &CurrentBranchChanged{
    76  		Message:            st.Message(),
    77  		CurrentBranchToken: errDetails.GetCurrentBranchToken(),
    78  		RequestBranchToken: errDetails.GetRequestBranchToken(),
    79  		st:                 st,
    80  	}
    81  }