ref: move httpapi.Reponse into codersdk (#2954)

codersdk/client.go

@@ -13,11 +13,11 @@ import (
 
 	"golang.org/x/xerrors"
 	"nhooyr.io/websocket"
-
-	"github.com/coder/coder/coderd/httpapi"
-	"github.com/coder/coder/coderd/httpmw"
 )
 
+// SessionTokenKey represents the name of the cookie or query parameter the API key is stored in.
+const SessionTokenKey = "session_token"
+
 // New creates a Coder client for the provided URL.
 func New(serverURL *url.URL) *Client {
 	return &Client{
@@ -64,7 +64,7 @@ func (c *Client) Request(ctx context.Context, method, path string, body interfac
 		return nil, xerrors.Errorf("create request: %w", err)
 	}
 	req.AddCookie(&http.Cookie{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	})
 	if body != nil {
@@ -99,7 +99,7 @@ func (c *Client) dialWebsocket(ctx context.Context, path string) (*websocket.Con
 	}
 	apiURL.Path = path
 	q := apiURL.Query()
-	q.Add(httpmw.SessionTokenKey, c.SessionToken)
+	q.Add(SessionTokenKey, c.SessionToken)
 	apiURL.RawQuery = q.Encode()
 
 	//nolint:bodyclose
@@ -113,7 +113,7 @@ func (c *Client) dialWebsocket(ctx context.Context, path string) (*websocket.Con
 	return conn, nil
 }
 
-// readBodyAsError reads the response as an httpapi.Message, and
+// readBodyAsError reads the response as an .Message, and
 // wraps it in a codersdk.Error type for easy marshaling.
 func readBodyAsError(res *http.Response) error {
 	contentType := res.Header.Get("Content-Type")
@@ -140,7 +140,7 @@ func readBodyAsError(res *http.Response) error {
 		}
 		return &Error{
 			statusCode: res.StatusCode,
-			Response: httpapi.Response{
+			Response: Response{
 				Message: string(resp),
 			},
 			Helper: helper,
@@ -148,7 +148,7 @@ func readBodyAsError(res *http.Response) error {
 	}
 
 	//nolint:varnamelen
-	var m httpapi.Response
+	var m Response
 	err := json.NewDecoder(res.Body).Decode(&m)
 	if err != nil {
 		if errors.Is(err, io.EOF) {
@@ -172,7 +172,7 @@ func readBodyAsError(res *http.Response) error {
 // Error represents an unaccepted or invalid request to the API.
 // @typescript-ignore Error
 type Error struct {
-	httpapi.Response
+	Response
 
 	statusCode int
 	method     string

codersdk/error.go

@@ -0,0 +1,27 @@
+package codersdk
+
+// 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"`
+}

codersdk/provisionerdaemons.go

@@ -14,8 +14,6 @@ import (
 	"github.com/google/uuid"
 	"golang.org/x/xerrors"
 	"nhooyr.io/websocket"
-
-	"github.com/coder/coder/coderd/httpmw"
 )
 
 type LogSource string
@@ -120,7 +118,7 @@ func (c *Client) provisionerJobLogsAfter(ctx context.Context, path string, after
 		return nil, xerrors.Errorf("create cookie jar: %w", err)
 	}
 	jar.SetCookies(followURL, []*http.Cookie{{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	}})
 	httpClient := &http.Client{

codersdk/workspaceagents.go

@@ -20,7 +20,6 @@ import (
 	"cdr.dev/slog"
 
 	"github.com/coder/coder/agent"
-	"github.com/coder/coder/coderd/httpmw"
 	"github.com/coder/coder/coderd/turnconn"
 	"github.com/coder/coder/peer"
 	"github.com/coder/coder/peer/peerwg"
@@ -189,7 +188,7 @@ func (c *Client) ListenWorkspaceAgent(ctx context.Context, logger slog.Logger) (
 		return agent.Metadata{}, nil, xerrors.Errorf("create cookie jar: %w", err)
 	}
 	jar.SetCookies(serverURL, []*http.Cookie{{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	}})
 	httpClient := &http.Client{
@@ -285,7 +284,7 @@ func (c *Client) WireguardPeerListener(ctx context.Context, logger slog.Logger)
 		return nil, nil, xerrors.Errorf("create cookie jar: %w", err)
 	}
 	jar.SetCookies(serverURL, []*http.Cookie{{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	}})
 	httpClient := &http.Client{
@@ -355,7 +354,7 @@ func (c *Client) DialWorkspaceAgent(ctx context.Context, agentID uuid.UUID, opti
 		return nil, xerrors.Errorf("create cookie jar: %w", err)
 	}
 	jar.SetCookies(serverURL, []*http.Cookie{{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	}})
 	httpClient := &http.Client{
@@ -443,7 +442,7 @@ func (c *Client) WorkspaceAgentReconnectingPTY(ctx context.Context, agentID, rec
 		return nil, xerrors.Errorf("create cookie jar: %w", err)
 	}
 	jar.SetCookies(serverURL, []*http.Cookie{{
-		Name:  httpmw.SessionTokenKey,
+		Name:  SessionTokenKey,
 		Value: c.SessionToken,
 	}})
 	httpClient := &http.Client{