Merge error.go into client.go

`codersdk.Response` lived in `error.go`, which is wrong.
coder · kylecarbs · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023
commit 267fedafe23d5b10fb198f8a8cf3b33fdc59b9f8
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"io"
 	"mime"
+	"net"
 	"net/http"
 	"net/url"
 	"strings"
@@ -341,6 +342,56 @@ func parseMimeType(contentType string) string {
 	return mimeType
 }
 
+// Response represents a generic HTTP response.
+type Response struct {
+	// Message is an actionable message that depicts actions the request took.
+	// These messages should be fully formed sentences with proper punctuation.
+	// Examples:
+	// - "A user has been created."
+	// - "Failed to create a user."
+	Message string `json:"message"`
+	// Detail is a debug message that provides further insight into why the
+	// action failed. This information can be technical and a regular golang
+	// err.Error() text.
+	// - "database: too many open connections"
+	// - "stat: too many open files"
+	Detail string `json:"detail,omitempty"`
+	// Validations are form field-specific friendly error messages. They will be
+	// shown on a form field in the UI. These can also be used to add additional
+	// context if there is a set of errors in the primary 'Message'.
+	Validations []ValidationError `json:"validations,omitempty"`
+}
+
+// ValidationError represents a scoped error to a user input.
+type ValidationError struct {
+	Field  string `json:"field" validate:"required"`
+	Detail string `json:"detail" validate:"required"`
+}
+
+func (e ValidationError) Error() string {
+	return fmt.Sprintf("field: %s detail: %s", e.Field, e.Detail)
+}
+
+var _ error = (*ValidationError)(nil)
+
+// IsConnectionError is a convenience function for checking if the source of an
+// error is due to a 'connection refused', 'no such host', etc.
+func IsConnectionError(err error) bool {
+	var (
+		// E.g. no such host
+		dnsErr *net.DNSError
+		// Eg. connection refused
+		opErr *net.OpError
+	)
+
+	return xerrors.As(err, &dnsErr) || xerrors.As(err, &opErr)
+}
+
+func AsError(err error) (*Error, bool) {
+	var e *Error
+	return e, xerrors.As(err, &e)
+}
+
 // RequestOption is a function that can be used to modify an http.Request.
 type RequestOption func(*http.Request)
 

diff --git a/codersdk/client_internal_test.go b/codersdk/client_internal_test.go
@@ -6,9 +6,11 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"net"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
+	"os"
 	"strconv"
 	"strings"
 	"testing"
@@ -31,6 +33,59 @@ import (
 
 const jsonCT = "application/json"
 
+func TestIsConnectionErr(t *testing.T) {
+	t.Parallel()
+
+	type tc = struct {
+		name           string
+		err            error
+		expectedResult bool
+	}
+
+	cases := []tc{
+		{
+			// E.g. "no such host"
+			name: "DNSError",
+			err: &net.DNSError{
+				Err:         "no such host",
+				Name:        "foofoo",
+				Server:      "1.1.1.1:53",
+				IsTimeout:   false,
+				IsTemporary: false,
+				IsNotFound:  true,
+			},
+			expectedResult: true,
+		},
+		{
+			// E.g. "connection refused"
+			name: "OpErr",
+			err: &net.OpError{
+				Op:     "dial",
+				Net:    "tcp",
+				Source: nil,
+				Addr:   nil,
+				Err:    &os.SyscallError{},
+			},
+			expectedResult: true,
+		},
+		{
+			name:           "OpaqueError",
+			err:            xerrors.Errorf("I'm opaque!"),
+			expectedResult: false,
+		},
+	}
+
+	for _, c := range cases {
+		c := c
+
+		t.Run(c.name, func(t *testing.T) {
+			t.Parallel()
+
+			require.Equal(t, c.expectedResult, IsConnectionError(c.err))
+		})
+	}
+}
+
 func Test_Client(t *testing.T) {
 	t.Parallel()
 

diff --git a/codersdk/error.go b/codersdk/error.go
diff --git a/codersdk/error_test.go b/codersdk/error_test.go