ziti/controller/apierror/api.go

/*
	Copyright NetFoundry, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

package apierror

import (
	"encoding/json"
	"fmt"
	"github.com/go-openapi/errors"
	"github.com/openziti/edge/controller/schema"
	"github.com/openziti/edge/rest_model"
)

type ApiError struct {
	Code        string `json:"code"`
	Message     string `json:"message"`
	Status      int    `json:"-"`
	Cause       error  `json:"cause"`
	AppendCause bool   `json:"-"`
}

func (e ApiError) Error() string {
	s := e.Code + ": " + e.Message

	if e.Cause != nil && e.AppendCause {
		s = s + ": " + e.Cause.Error()
	}
	return s
}

func (e ApiError) ToRestModel(requestId string) *rest_model.APIError {

	ret := &rest_model.APIError{
		Args:      nil,
		Code:      e.Code,
		Message:   e.Message,
		RequestID: requestId,
	}

	if e.Cause != nil {
		if causeApiError, ok := e.Cause.(*ApiError); ok {
			//standard apierror
			ret.Cause = &rest_model.APIErrorCause{
				APIError: *causeApiError.ToRestModel(requestId),
			}
		} else if causeJsonSchemaError, ok := e.Cause.(*schema.ValidationErrors); ok {
			//only possible from config type JSON schema validation
			ret.Cause = &rest_model.APIErrorCause{
				APIFieldError: rest_model.APIFieldError{
					Field:  causeJsonSchemaError.Errors[0].Field,
					Reason: causeJsonSchemaError.Errors[0].Error(),
					Value:  fmt.Sprintf("%v", causeJsonSchemaError.Errors[0].Value),
				},
			}
		} else if causeFieldErr, ok := e.Cause.(*FieldError); ok {
			//authenticator modules and enrollment only
			//todo: see if we can remove this by not using FieldError
			ret.Cause = &rest_model.APIErrorCause{
				APIFieldError: rest_model.APIFieldError{
					Field:  causeFieldErr.FieldName,
					Value:  fmt.Sprintf("%v", causeFieldErr.FieldValue),
					Reason: causeFieldErr.Reason,
				},
			}
			if ret.Code == InvalidFieldCode {
				ret.Code = CouldNotValidateCode
				ret.Message = CouldNotValidateMessage
			}

		} else if causeFieldErr, ok := e.Cause.(*errors.Validation); ok {
			//open api validation errors
			ret.Cause = &rest_model.APIErrorCause{
				APIFieldError: rest_model.APIFieldError{
					Field:  causeFieldErr.Name,
					Reason: causeFieldErr.Error(),
					Value:  fmt.Sprintf("%v", causeFieldErr.Value),
				},
			}
		} else {
			ret.Cause = &rest_model.APIErrorCause{
				APIError: rest_model.APIError{
					Code:    UnhandledCode,
					Message: e.Cause.Error(),
				},
			}
		}

	}

	return ret
}

type GenericCauseError struct {
	Message string
	DataMap map[string]interface{}
}

func (e GenericCauseError) Error() string {
	return e.Message
}

func (e *GenericCauseError) MarshalJSON() ([]byte, error) {
	return json.Marshal(e.DataMap)
}