Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 54cc587

Browse files
authored
Updated PreconditionFailed status occurences to more appropriate statuses. (#5513)
1 parent 967d25f commit 54cc587

15 files changed

+37
-37
lines changed

coderd/httpmw/oauth2.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func ExtractOAuth2(config OAuth2Config, client *http.Client) func(http.Handler)
5050

5151
// Interfaces can hold a nil value
5252
if config == nil || reflect.ValueOf(config).IsNil() {
53-
httpapi.Write(ctx, rw, http.StatusPreconditionRequired, codersdk.Response{
53+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
5454
Message: "The oauth2 method requested is not configured!",
5555
})
5656
return

coderd/httpmw/oauth2_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func TestOAuth2(t *testing.T) {
4040
req := httptest.NewRequest("GET", "/", nil)
4141
res := httptest.NewRecorder()
4242
httpmw.ExtractOAuth2(nil, nil)(nil).ServeHTTP(res, req)
43-
require.Equal(t, http.StatusPreconditionRequired, res.Result().StatusCode)
43+
require.Equal(t, http.StatusBadRequest, res.Result().StatusCode)
4444
})
4545
t.Run("RedirectWithoutCode", func(t *testing.T) {
4646
t.Parallel()

coderd/provisionerjobs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ func (api *API) provisionerJobLogs(rw http.ResponseWriter, r *http.Request, job
193193
func (api *API) provisionerJobResources(rw http.ResponseWriter, r *http.Request, job database.ProvisionerJob) {
194194
ctx := r.Context()
195195
if !job.CompletedAt.Valid {
196-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
196+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
197197
Message: "Job hasn't completed!",
198198
})
199199
return

coderd/templates.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ func (api *API) deleteTemplate(rw http.ResponseWriter, r *http.Request) {
110110
return
111111
}
112112
if len(workspaces) > 0 {
113-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
113+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
114114
Message: "All workspaces must be deleted before a template can be removed.",
115115
})
116116
return

coderd/templates_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ func TestDeleteTemplate(t *testing.T) {
501501
err := client.DeleteTemplate(ctx, template.ID)
502502
var apiErr *codersdk.Error
503503
require.ErrorAs(t, err, &apiErr)
504-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
504+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
505505
})
506506
}
507507

coderd/templateversions.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ func (api *API) patchCancelTemplateVersion(rw http.ResponseWriter, r *http.Reque
9797
return
9898
}
9999
if job.CompletedAt.Valid {
100-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
100+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
101101
Message: "Job has already completed!",
102102
})
103103
return
104104
}
105105
if job.CanceledAt.Valid {
106-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
106+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
107107
Message: "Job has already been marked as canceled!",
108108
})
109109
return
@@ -161,7 +161,7 @@ func (api *API) templateVersionSchema(rw http.ResponseWriter, r *http.Request) {
161161
return
162162
}
163163
if !job.CompletedAt.Valid {
164-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
164+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
165165
Message: "Template version job hasn't completed!",
166166
})
167167
return
@@ -220,7 +220,7 @@ func (api *API) templateVersionParameters(rw http.ResponseWriter, r *http.Reques
220220
return
221221
}
222222
if !job.CompletedAt.Valid {
223-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
223+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
224224
Message: "Job hasn't completed!",
225225
})
226226
return
@@ -288,7 +288,7 @@ func (api *API) postTemplateVersionDryRun(rw http.ResponseWriter, r *http.Reques
288288
return
289289
}
290290
if !job.CompletedAt.Valid {
291-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
291+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
292292
Message: "Template version import job hasn't completed!",
293293
})
294294
return
@@ -432,13 +432,13 @@ func (api *API) patchTemplateVersionDryRunCancel(rw http.ResponseWriter, r *http
432432
}
433433

434434
if job.CompletedAt.Valid {
435-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
435+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
436436
Message: "Job has already completed.",
437437
})
438438
return
439439
}
440440
if job.CanceledAt.Valid {
441-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
441+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
442442
Message: "Job has already been marked as canceled.",
443443
})
444444
return

coderd/templateversions_test.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ func TestPatchCancelTemplateVersion(t *testing.T) {
206206
err := client.CancelTemplateVersion(ctx, version.ID)
207207
var apiErr *codersdk.Error
208208
require.ErrorAs(t, err, &apiErr)
209-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
209+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
210210
})
211211
t.Run("AlreadyCanceled", func(t *testing.T) {
212212
t.Parallel()
@@ -238,7 +238,7 @@ func TestPatchCancelTemplateVersion(t *testing.T) {
238238
err = client.CancelTemplateVersion(ctx, version.ID)
239239
var apiErr *codersdk.Error
240240
require.ErrorAs(t, err, &apiErr)
241-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
241+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
242242
require.Eventually(t, func() bool {
243243
var err error
244244
version, err = client.TemplateVersion(ctx, version.ID)
@@ -300,7 +300,7 @@ func TestTemplateVersionSchema(t *testing.T) {
300300
_, err := client.TemplateVersionSchema(ctx, version.ID)
301301
var apiErr *codersdk.Error
302302
require.ErrorAs(t, err, &apiErr)
303-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
303+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
304304
})
305305
t.Run("List", func(t *testing.T) {
306306
t.Parallel()
@@ -380,7 +380,7 @@ func TestTemplateVersionParameters(t *testing.T) {
380380
_, err := client.TemplateVersionParameters(ctx, version.ID)
381381
var apiErr *codersdk.Error
382382
require.ErrorAs(t, err, &apiErr)
383-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
383+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
384384
})
385385
t.Run("List", func(t *testing.T) {
386386
t.Parallel()
@@ -447,7 +447,7 @@ func TestTemplateVersionResources(t *testing.T) {
447447
_, err := client.TemplateVersionResources(ctx, version.ID)
448448
var apiErr *codersdk.Error
449449
require.ErrorAs(t, err, &apiErr)
450-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
450+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
451451
})
452452
t.Run("List", func(t *testing.T) {
453453
t.Parallel()
@@ -749,7 +749,7 @@ func TestTemplateVersionDryRun(t *testing.T) {
749749
})
750750
var apiErr *codersdk.Error
751751
require.ErrorAs(t, err, &apiErr)
752-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
752+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
753753
})
754754

755755
t.Run("Cancel", func(t *testing.T) {
@@ -828,7 +828,7 @@ func TestTemplateVersionDryRun(t *testing.T) {
828828
err = client.CancelTemplateVersionDryRun(ctx, version.ID, job.ID)
829829
var apiErr *codersdk.Error
830830
require.ErrorAs(t, err, &apiErr)
831-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
831+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
832832
})
833833

834834
t.Run("AlreadyCanceled", func(t *testing.T) {
@@ -873,7 +873,7 @@ func TestTemplateVersionDryRun(t *testing.T) {
873873
err = client.CancelTemplateVersionDryRun(ctx, version.ID, job.ID)
874874
var apiErr *codersdk.Error
875875
require.ErrorAs(t, err, &apiErr)
876-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
876+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
877877
})
878878
})
879879
}

coderd/userauth.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ func (api *API) userOAuth2Github(rw http.ResponseWriter, r *http.Request) {
161161
}
162162

163163
if verifiedEmail == nil {
164-
httpapi.Write(ctx, rw, http.StatusPreconditionRequired, codersdk.Response{
164+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
165165
Message: "Your primary email must be verified on GitHub!",
166166
})
167167
return

coderd/userauth_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ func TestUserOAuth2Github(t *testing.T) {
177177
})
178178
_ = coderdtest.CreateFirstUser(t, client)
179179
resp := oauth2Callback(t, client)
180-
require.Equal(t, http.StatusPreconditionRequired, resp.StatusCode)
180+
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
181181
})
182182
t.Run("BlockSignups", func(t *testing.T) {
183183
t.Parallel()
@@ -686,7 +686,7 @@ func TestUserOIDC(t *testing.T) {
686686
t.Parallel()
687687
client := coderdtest.New(t, nil)
688688
resp := oidcCallback(t, client, "asdf")
689-
require.Equal(t, http.StatusPreconditionRequired, resp.StatusCode)
689+
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
690690
})
691691

692692
t.Run("NoIDToken", func(t *testing.T) {

coderd/workspaceagents.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ func (api *API) workspaceAgentPTY(rw http.ResponseWriter, r *http.Request) {
237237
return
238238
}
239239
if apiAgent.Status != codersdk.WorkspaceAgentConnected {
240-
httpapi.Write(ctx, rw, http.StatusPreconditionRequired, codersdk.Response{
240+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
241241
Message: fmt.Sprintf("Agent state is %q, it must be in the %q state.", apiAgent.Status, codersdk.WorkspaceAgentConnected),
242242
})
243243
return
@@ -318,7 +318,7 @@ func (api *API) workspaceAgentListeningPorts(rw http.ResponseWriter, r *http.Req
318318
return
319319
}
320320
if apiAgent.Status != codersdk.WorkspaceAgentConnected {
321-
httpapi.Write(ctx, rw, http.StatusPreconditionRequired, codersdk.Response{
321+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
322322
Message: fmt.Sprintf("Agent state is %q, it must be in the %q state.", apiAgent.Status, codersdk.WorkspaceAgentConnected),
323323
})
324324
return

coderd/workspacebuilds.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -411,12 +411,12 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
411411
})
412412
return
413413
case codersdk.ProvisionerJobFailed:
414-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
414+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
415415
Message: fmt.Sprintf("The provided template version %q has failed to import: %q. You cannot build workspaces with it!", templateVersion.Name, templateVersionJob.Error.String),
416416
})
417417
return
418418
case codersdk.ProvisionerJobCanceled:
419-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
419+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
420420
Message: "The provided template version was canceled during import. You cannot builds workspaces with it!",
421421
})
422422
return
@@ -626,13 +626,13 @@ func (api *API) patchCancelWorkspaceBuild(rw http.ResponseWriter, r *http.Reques
626626
return
627627
}
628628
if job.CompletedAt.Valid {
629-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
629+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
630630
Message: "Job has already completed!",
631631
})
632632
return
633633
}
634634
if job.CanceledAt.Valid {
635-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
635+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
636636
Message: "Job has already been marked as canceled!",
637637
})
638638
return

coderd/workspaces.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,12 +406,12 @@ func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Req
406406
})
407407
return
408408
case codersdk.ProvisionerJobFailed:
409-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
409+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
410410
Message: fmt.Sprintf("The provided template version %q has failed to import. You cannot create workspaces using it!", templateVersion.Name),
411411
})
412412
return
413413
case codersdk.ProvisionerJobCanceled:
414-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
414+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
415415
Message: "The provided template version was canceled during import. You cannot create workspaces using it!",
416416
})
417417
return

coderd/workspaces_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1053,7 +1053,7 @@ func TestPostWorkspaceBuild(t *testing.T) {
10531053
})
10541054
var apiErr *codersdk.Error
10551055
require.ErrorAs(t, err, &apiErr)
1056-
require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
1056+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
10571057
})
10581058

10591059
t.Run("AlreadyActive", func(t *testing.T) {

enterprise/coderd/groups.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
144144
UserID: uuid.MustParse(id),
145145
})
146146
if xerrors.Is(err, sql.ErrNoRows) {
147-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
147+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
148148
Message: fmt.Sprintf("User %q must be a member of organization %q", id, group.ID),
149149
})
150150
return
@@ -215,14 +215,14 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
215215
return nil
216216
}, nil)
217217
if database.IsUniqueViolation(err) {
218-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
218+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
219219
Message: "Cannot add the same user to a group twice!",
220220
Detail: err.Error(),
221221
})
222222
return
223223
}
224224
if xerrors.Is(err, sql.ErrNoRows) {
225-
httpapi.Write(ctx, rw, http.StatusPreconditionFailed, codersdk.Response{
225+
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
226226
Message: "Failed to add or remove non-existent group member",
227227
Detail: err.Error(),
228228
})

enterprise/coderd/groups_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ func TestPatchGroup(t *testing.T) {
322322
require.Error(t, err)
323323
cerr, ok := codersdk.AsError(err)
324324
require.True(t, ok)
325-
require.Equal(t, http.StatusPreconditionFailed, cerr.StatusCode())
325+
require.Equal(t, http.StatusBadRequest, cerr.StatusCode())
326326
})
327327

328328
t.Run("MalformedUUID", func(t *testing.T) {
@@ -372,7 +372,7 @@ func TestPatchGroup(t *testing.T) {
372372
cerr, ok := codersdk.AsError(err)
373373
require.True(t, ok)
374374

375-
require.Equal(t, http.StatusPreconditionFailed, cerr.StatusCode())
375+
require.Equal(t, http.StatusBadRequest, cerr.StatusCode())
376376
})
377377

378378
t.Run("allUsers", func(t *testing.T) {

0 commit comments

Comments
 (0)