mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-09 17:52:57 +01:00
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
83 lines
2.3 KiB
Go
83 lines
2.3 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package vizerror provides types and utility funcs for handling visible errors
|
|
// that are safe to display to end users.
|
|
package vizerror
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
)
|
|
|
|
// Error is an error that is safe to display to end users.
|
|
type Error struct {
|
|
publicErr error // visible to end users
|
|
wrapped error // internal
|
|
}
|
|
|
|
// Error implements the error interface. The returned string is safe to display
|
|
// to end users.
|
|
func (e Error) Error() string {
|
|
return e.publicErr.Error()
|
|
}
|
|
|
|
// New returns an error that formats as the given text. It always returns a vizerror.Error.
|
|
func New(publicMsg string) error {
|
|
err := errors.New(publicMsg)
|
|
return Error{
|
|
publicErr: err,
|
|
wrapped: err,
|
|
}
|
|
}
|
|
|
|
// Errorf returns an Error with the specified publicMsgFormat and values. It always returns a vizerror.Error.
|
|
//
|
|
// Warning: avoid using an error as one of the format arguments, as this will cause the text
|
|
// of that error to be displayed to the end user (which is probably not what you want).
|
|
func Errorf(publicMsgFormat string, a ...any) error {
|
|
err := fmt.Errorf(publicMsgFormat, a...)
|
|
return Error{
|
|
publicErr: err,
|
|
wrapped: err,
|
|
}
|
|
}
|
|
|
|
// Unwrap returns the underlying error.
|
|
//
|
|
// If the Error was constructed using [WrapWithMessage], this is the wrapped (internal) error
|
|
// and not the user-visible error message.
|
|
func (e Error) Unwrap() error {
|
|
return e.wrapped
|
|
}
|
|
|
|
// Wrap wraps publicErr with a vizerror.Error.
|
|
//
|
|
// Deprecated: this is almost always the wrong thing to do. Are you really sure
|
|
// you know exactly what err.Error() will stringify to and be safe to show to
|
|
// users? [WrapWithMessage] is probably what you want.
|
|
func Wrap(publicErr error) error {
|
|
if publicErr == nil {
|
|
return nil
|
|
}
|
|
return Error{publicErr: publicErr, wrapped: publicErr}
|
|
}
|
|
|
|
// WrapWithMessage wraps the given error with a message that's safe to display
|
|
// to end users. The text of the wrapped error will not be displayed to end
|
|
// users.
|
|
//
|
|
// WrapWithMessage should almost always be preferred to [Wrap].
|
|
func WrapWithMessage(wrapped error, publicMsg string) error {
|
|
return Error{
|
|
publicErr: errors.New(publicMsg),
|
|
wrapped: wrapped,
|
|
}
|
|
}
|
|
|
|
// As returns the first vizerror.Error in err's chain.
|
|
func As(err error) (e Error, ok bool) {
|
|
ok = errors.As(err, &e)
|
|
return
|
|
}
|