Commit576aef4

authored

chore: Add linter rule to catch missing return after http writes (#2702)

1 parent09cb778 commit576aef4Copy full SHA for 576aef4

File tree

+25

-0

lines changed

+25

-0

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -663,6 +663,7 @@ func (api API) postLogin(rw http.ResponseWriter, r http.Request) {`
`663`	`663`	`httpapi.Write(rw,http.StatusInternalServerError, httpapi.Response{`
`664`	`664`	`Message:"Internal error.",`
`665`	`665`	`})`
	`666`	`+return`
`666`	`667`	`}`
`667`	`668`	`if!equal {`
`668`	`669`	`// This message is the same as above to remove ease in detecting whether`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ func (api API) workspaceAppsProxyPath(rw http.ResponseWriter, r http.Request)`
`80`	`80`	`httpapi.Write(rw,http.StatusBadRequest, httpapi.Response{`
`81`	`81`	`Message:"No agents exist.",`
`82`	`82`	`})`
	`83`	`+return`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`agent:=agents[0]`

Lines changed: 23 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,29 @@ func HttpAPIErrorMessage(m dsl.Matcher) {`
`151`	`151`	`Report("Field\"Message\" should be a proper sentence with a capitalized first letter and ending in punctuation. $m")`
`152`	`152`	`}`
`153`	`153`
	`154`	`+// HttpAPIReturn will report a linter violation if the http function is not`
	`155`	`+// returned after writing a response to the client.`
	`156`	`+funcHttpAPIReturn(m dsl.Matcher) {`
	`157`	`+m.Import("github.com/coder/coder/coderd/httpapi")`
	`158`	`+`
	`159`	`+// Manually enumerate the httpapi function rather then a 'Where' condition`
	`160`	`+// as this is a bit more efficient.`
	`161`	+m.Match(`
	`162`	`+if $*_ {`
	`163`	`+httpapi.Write($*a)`
	`164`	`+}`
	`165`	+`,`
	`166`	`+if $*_ {`
	`167`	`+httpapi.Forbidden($*a)`
	`168`	`+}`
	`169`	+`,`
	`170`	`+if $*_ {`
	`171`	`+httpapi.ResourceNotFound($*a)`
	`172`	`+}`
	`173`	+`).At(m["a"]).
	`174`	`+Report("Forgot to return early after writing to the http response writer.")`
	`175`	`+}`
	`176`	`+`
`154`	`177`	`// ProperRBACReturn ensures we always write to the response writer after a`
`155`	`178`	`// call to Authorize. If we just do a return, the client will get a status code`
`156`	`179`	`// 200, which is incorrect.`

Comments

(0)