Skip to content

chore(codersdk/workspacesdk): make dialer fail fast for authnz errors #19173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2025
Merged

chore(codersdk/workspacesdk): make dialer fail fast for authnz errors #19173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72b8701
chore: make workspace sdk dialer fail fast for authnz errors
ethanndickson Aug 5, 2025
b5a1cd6
review
ethanndickson Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions codersdk/workspacesdk/dialer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ var permanentErrorStatuses = []int{
http.StatusBadRequest, // returned if API mismatch
http.StatusNotFound, // returned if user doesn't have permission or agent doesn't exist
http.StatusInternalServerError, // returned if database is not reachable,
http.StatusForbidden, // returned if user is not authorized
// StatusUnauthorized is only a permanent error if the error is not due to
// an invalid resume token. See `checkResumeTokenFailure`.
http.StatusUnauthorized,
}

type WebsocketDialer struct {
Expand All @@ -39,6 +43,24 @@ type WebsocketDialer struct {
isFirst bool
}

// checkResumeTokenFailure checks if the parsed error indicates a resume token failure
// and updates the resumeTokenFailed flag accordingly. Returns true if a resume token
// failure was detected.
func (w *WebsocketDialer) checkResumeTokenFailure(ctx context.Context, sdkErr *codersdk.Error) bool {
if sdkErr == nil {
return false
}

for _, v := range sdkErr.Validations {
if v.Field == "resume_token" {
w.logger.Warn(ctx, "failed to dial tailnet v2+ API: server replied invalid resume token; unsetting for next connection attempt")
w.resumeTokenFailed = true
return true
}
}
return false
}

type WebsocketDialerOption func(*WebsocketDialer)

func WithWorkspaceUpdates(req *proto.WorkspaceUpdatesRequest) WebsocketDialerOption {
Expand Down Expand Up @@ -82,9 +104,14 @@ func (w *WebsocketDialer) Dial(ctx context.Context, r tailnet.ResumeTokenControl
if w.isFirst {
if res != nil && slices.Contains(permanentErrorStatuses, res.StatusCode) {
err = codersdk.ReadBodyAsError(res)
// A bit more human-readable help in the case the API version was rejected
var sdkErr *codersdk.Error
if xerrors.As(err, &sdkErr) {
// Check for resume token failure first
if w.checkResumeTokenFailure(ctx, sdkErr) {
return tailnet.ControlProtocolClients{}, err
}

// A bit more human-readable help in the case the API version was rejected
if sdkErr.Message == AgentAPIMismatchMessage &&
sdkErr.StatusCode() == http.StatusBadRequest {
sdkErr.Helper = fmt.Sprintf(
Expand All @@ -107,13 +134,8 @@ func (w *WebsocketDialer) Dial(ctx context.Context, r tailnet.ResumeTokenControl
bodyErr := codersdk.ReadBodyAsError(res)
var sdkErr *codersdk.Error
if xerrors.As(bodyErr, &sdkErr) {
for _, v := range sdkErr.Validations {
if v.Field == "resume_token" {
// Unset the resume token for the next attempt
w.logger.Warn(ctx, "failed to dial tailnet v2+ API: server replied invalid resume token; unsetting for next connection attempt")
w.resumeTokenFailed = true
return tailnet.ControlProtocolClients{}, err
}
if w.checkResumeTokenFailure(ctx, sdkErr) {
return tailnet.ControlProtocolClients{}, err
}
}
if !errors.Is(err, context.Canceled) {
Expand Down
40 changes: 40 additions & 0 deletions codersdk/workspacesdk/dialer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,46 @@ func TestWebsocketDialer_ResumeTokenFailure(t *testing.T) {
require.Error(t, err)
}

func TestWebsocketDialer_UnauthenticatedFailFast(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, &slogtest.Options{
IgnoreErrors: true,
}).Leveled(slog.LevelDebug)

svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, w, http.StatusUnauthorized, codersdk.Response{})
}))
defer svr.Close()
svrURL, err := url.Parse(svr.URL)
require.NoError(t, err)

uut := workspacesdk.NewWebsocketDialer(logger, svrURL, &websocket.DialOptions{})

_, err = uut.Dial(ctx, nil)
require.Error(t, err)
}

func TestWebsocketDialer_UnauthorizedFailFast(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, &slogtest.Options{
IgnoreErrors: true,
}).Leveled(slog.LevelDebug)

svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, w, http.StatusUnauthorized, codersdk.Response{})
}))
defer svr.Close()
svrURL, err := url.Parse(svr.URL)
require.NoError(t, err)

uut := workspacesdk.NewWebsocketDialer(logger, svrURL, &websocket.DialOptions{})

_, err = uut.Dial(ctx, nil)
require.Error(t, err)
}

func TestWebsocketDialer_UplevelVersion(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
Expand Down
Loading