errors/impl.go

/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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

    http://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 errors

import (
	"errors"
	"fmt"
	"os"
	"strconv"
	"strings"
)
import cerror "github.com/cockroachdb/errors"

type (
	crdbErrorImpl struct {
		wrappedRaw error
		wrapped    *crdbErrorImpl
		msg        *errMessage
		data       interface{}
		t          *Type
	}
)

var enableStacktraces = false

func init() {
	enable, exists := os.LookupEnv("ENABLE_STACKTRACE")
	if !exists {
		return
	}
	enableStacktraces, _ = strconv.ParseBool(enable)
}

func (e *crdbErrorImpl) Error() string {
	//crdb spits out a bunch of excess strings, so do some cleanup
	rawMsg := fmt.Sprintf("%+v", e.wrappedRaw)
	parts := strings.Split(rawMsg, "\n(1) ")
	if len(parts) == 1 {
		return parts[0]
	}
	return parts[1]
}

func (e *crdbErrorImpl) Messages() Messages {
	return e.getMessages(func(err *crdbErrorImpl) *errMessage {
		return err.msg
	})
}

func (e *crdbErrorImpl) Unwrap() error {
	if e.wrapped != nil {
		return e.wrapped
	}
	return cerror.Cause(e.wrappedRaw)
}

func (e *crdbErrorImpl) GetType() *Type {
	return e.t
}

func (e *crdbErrorImpl) GetData() interface{} {
	return e.data
}

func (e *crdbErrorImpl) As(t *Type) Error {
	err := e
	for {
		if err.t == t {
			return e
		}
		lakeErr := AsLakeErrorType(err.Unwrap())
		if lakeErr == nil {
			return nil
		}
		err = lakeErr.(*crdbErrorImpl)
	}
}

func (e *crdbErrorImpl) getMessages(getMessage func(*crdbErrorImpl) *errMessage) []*errMessage {
	msgs := []*errMessage{}
	err := e
	ok := false
	for {
		msg := getMessage(err)
		if len(msg.msgs) > 0 {
			msgs = append(msgs, msg)
		}
		unwrapped := err.Unwrap()
		if unwrapped == nil {
			break
		}
		err, ok = unwrapped.(*crdbErrorImpl)
		if !ok {
			// don't append the message if the error is "external"
			break
		}
	}
	return msgs
}

func newSingleCrdbError(t *Type, err error, message string, opts ...Option) Error {
	cfg := &options{}
	for _, opt := range opts {
		opt(cfg)
	}
	cfg.stackOffset += 1
	msg := &errMessage{}
	if cast, ok := err.(*crdbErrorImpl); ok {
		if t == Default { // inherit wrapped error's type
			t = cast.GetType()
		}
	}
	msg.addMessage(t, message)
	return newCrdbError(t, err, msg, cfg)
}

func newCombinedCrdbError(t *Type, errs []error) Error {
	msg := &errMessage{}
	for _, e := range errs {
		if le, ok := e.(*crdbErrorImpl); ok {
			msg.appendMessage(le.msg.getMessage())
		} else {
			msg.appendMessage(e.Error())
		}
	}
	opts := &options{}
	opts.stackOffset += 1
	return newCrdbError(t, nil, msg, opts)
}

func newCrdbError(t *Type, err error, msg *errMessage, opts *options) *crdbErrorImpl {
	errType := t
	var wrappedErr *crdbErrorImpl
	var wrappedRaw error
	opts.stackOffset += 2
	if err == nil {
		if enableStacktraces {
			wrappedRaw = cerror.NewWithDepth(int(opts.stackOffset), msg.getPrettifiedMessage())
		} else {
			wrappedRaw = errors.New(msg.getPrettifiedMessage())
		}
	} else {
		if cast, ok := err.(*crdbErrorImpl); ok {
			err = cast.wrappedRaw
			wrappedErr = cast
		}
		if enableStacktraces {
			wrappedRaw = cerror.WrapWithDepth(int(opts.stackOffset), err, msg.getPrettifiedMessage())
		} else {
			wrappedRaw = cerror.WithDetail(err, msg.getPrettifiedMessage())
		}
	}
	impl := &crdbErrorImpl{
		wrappedRaw: wrappedRaw,
		wrapped:    wrappedErr,
		msg:        msg,
		data:       opts.data,
		t:          errType,
	}
	return impl
}

var _ Error = (*crdbErrorImpl)(nil)