msg -> sprintf

coadler · coadler · commit c70e40820252 · 2022-04-01T13:10:25.000-05:00
diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -118,9 +118,9 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool {
 
 const websocketCloseMaxLen = 123
 
-// WebsocketCloseMsg formats a websocket close message and ensures it is
+// WebsocketCloseSprintf formats a websocket close message and ensures it is
 // truncated to the maximum allowed length.
-func WebsocketCloseMsg(format string, vars ...any) string {
+func WebsocketCloseSprintf(format string, vars ...any) string {
 	msg := fmt.Sprintf(format, vars...)
 
 	// Cap msg length at 123 bytes. nhooyr/websocket only allows close messages
diff --git a/coderd/httpapi/httpapi_test.go b/coderd/httpapi/httpapi_test.go
@@ -152,15 +152,15 @@ func WebsocketCloseMsg(t *testing.T) {
 		t.Parallel()
 
 		msg := strings.Repeat("d", 255)
-		trunc := httpapi.WebsocketCloseMsg(msg)
+		trunc := httpapi.WebsocketCloseSprintf(msg)
 		assert.LessOrEqual(t, len(trunc), 123)
 	})
 
 	t.Run("TruncateMultiByteCharacters", func(t *testing.T) {
 		t.Parallel()
 
 		msg := strings.Repeat("こんにちは", 10)
-		trunc := httpapi.WebsocketCloseMsg(msg)
+		trunc := httpapi.WebsocketCloseSprintf(msg)
 		assert.LessOrEqual(t, len(trunc), 123)
 	})
 }
diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -56,7 +56,7 @@ func (api *api) provisionerDaemonsListen(rw http.ResponseWriter, r *http.Request
 		Provisioners: []database.ProvisionerType{database.ProvisionerTypeEcho, database.ProvisionerTypeTerraform},
 	})
 	if err != nil {
-		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("insert provisioner daemon: %s", err))
+		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("insert provisioner daemon: %s", err))
 		return
 	}
 
@@ -67,7 +67,7 @@ func (api *api) provisionerDaemonsListen(rw http.ResponseWriter, r *http.Request
 	config.LogOutput = io.Discard
 	session, err := yamux.Server(websocket.NetConn(r.Context(), conn, websocket.MessageBinary), config)
 	if err != nil {
-		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("multiplex server: %s", err))
+		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("multiplex server: %s", err))
 		return
 	}
 	mux := drpcmux.New()
@@ -80,13 +80,13 @@ func (api *api) provisionerDaemonsListen(rw http.ResponseWriter, r *http.Request
 		Logger:       api.Logger.Named(fmt.Sprintf("provisionerd-%s", daemon.Name)),
 	})
 	if err != nil {
-		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("drpc register provisioner daemon: %s", err))
+		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("drpc register provisioner daemon: %s", err))
 		return
 	}
 	server := drpcserver.New(mux)
 	err = server.Serve(r.Context(), session)
 	if err != nil {
-		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("serve: %s", err))
+		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("serve: %s", err))
 		return
 	}
 	_ = conn.Close(websocket.StatusGoingAway, "")
diff --git a/coderd/workspaceresources.go b/coderd/workspaceresources.go
@@ -108,7 +108,7 @@ func (api *api) workspaceResourceDial(rw http.ResponseWriter, r *http.Request) {
 		Pubsub:    api.Pubsub,
 	})
 	if err != nil {
-		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("serve: %s", err))
+		_ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("serve: %s", err))
 		return
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ func (api api) workspaceResourceDial(rw http.ResponseWriter, r http.Request) {`
`108`	`108`	`Pubsub: api.Pubsub,`
`109`	`109`	`})`
`110`	`110`	`if err != nil {`
`111`		`- _ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseMsg("serve: %s", err))`
	`111`	`+ _ = conn.Close(websocket.StatusInternalError, httpapi.WebsocketCloseSprintf("serve: %s", err))`
`112`	`112`	`return`
`113`	`113`	`}`
`114`	`114`	`}`