feat(scim): rename WriteError to SendError

Author: xlgmokha

internal/api/scim/middleware.go

@@ -41,7 +41,7 @@ func (srv *Server) tenant(w http.ResponseWriter, r *http.Request) (context.Conte
 // unauthorized answers a request with no valid tenant, per RFC 7644, Section 3.12 and RFC 6750, Section 3.
 func (srv *Server) unauthorized(w http.ResponseWriter) error {
 	w.Header().Set("WWW-Authenticate", `Bearer realm="SCIM"`)
-	return protocol.WriteError(w, protocol.ErrUnauthorized("Bearer token is missing or invalid"))
+	return protocol.SendError(w, protocol.ErrUnauthorized("Bearer token is missing or invalid"))
 }
 
 // credential is the bearer token a SCIM client authenticates with, per RFC 7644,

internal/api/scim/protocol/protocol.go

@@ -32,8 +32,8 @@ func Send(w http.ResponseWriter, status int, obj any) error {
 	return err
 }
 
-// WriteError answers the request with err in the error form of RFC 7644, Section 3.12.
-func WriteError(w http.ResponseWriter, err error) error {
+// SendError answers the request with err in the error form of RFC 7644, Section 3.12.
+func SendError(w http.ResponseWriter, err error) error {
 	var scimErr *Error
 	if !errors.As(err, &scimErr) {
 		scimErr = ErrInternal("Internal server error")

internal/api/scim/protocol/protocol_test.go

@@ -43,11 +43,11 @@ func TestSend(t *testing.T) {
 	})
 }
 
-func TestWriteError(t *testing.T) {
+func TestSendError(t *testing.T) {
 	t.Run("writes the error in the SCIM error form", func(t *testing.T) {
 		w := httptest.NewRecorder()
 
-		require.NoError(t, WriteError(w, ErrUniqueness(`userName "bjensen" is already in use`)))
+		require.NoError(t, SendError(w, ErrUniqueness(`userName "bjensen" is already in use`)))
 
 		assert.Equal(t, http.StatusConflict, w.Code)
 		assert.Equal(t, MediaType, w.Header().Get("Content-Type"))
@@ -62,7 +62,7 @@ func TestWriteError(t *testing.T) {
 	t.Run("finds the SCIM error inside a wrapped error", func(t *testing.T) {
 		w := httptest.NewRecorder()
 
-		require.NoError(t, WriteError(w, fmt.Errorf("reading users: %w", ErrNotFound("Endpoint or resource does not exist"))))
+		require.NoError(t, SendError(w, fmt.Errorf("reading users: %w", ErrNotFound("Endpoint or resource does not exist"))))
 
 		assert.Equal(t, http.StatusNotFound, w.Code)
 		assert.Contains(t, w.Body.String(), "Endpoint or resource does not exist")
@@ -71,7 +71,7 @@ func TestWriteError(t *testing.T) {
 	t.Run("reports an error it does not recognise without disclosing it", func(t *testing.T) {
 		w := httptest.NewRecorder()
 
-		require.NoError(t, WriteError(w, errors.New("pq: password authentication failed for user")))
+		require.NoError(t, SendError(w, errors.New("pq: password authentication failed for user")))
 
 		assert.Equal(t, http.StatusInternalServerError, w.Code)
 		assert.Equal(t, MediaType, w.Header().Get("Content-Type"))

internal/api/scim/server.go

@@ -69,7 +69,7 @@ func (srv *Server) Users(w http.ResponseWriter, r *http.Request) error {
 
 	query, err := srv.limits.ParseSearchRequest(r.URL.Query())
 	if err != nil {
-		return protocol.WriteError(w, err)
+		return protocol.SendError(w, err)
 	}
 
 	items, total, err := srv.users.List(ctx, query)
@@ -104,10 +104,10 @@ func (srv *Server) CreateUser(w http.ResponseWriter, r *http.Request) error {
 
 	user, err := srv.decodeUser(r)
 	if err != nil {
-		return protocol.WriteError(w, err)
+		return protocol.SendError(w, err)
 	}
 	if err := srv.validateUser(user); err != nil {
-		return protocol.WriteError(w, err)
+		return protocol.SendError(w, err)
 	}
 
 	created, err := srv.users.Create(ctx, user)
@@ -129,10 +129,10 @@ func (srv *Server) ReplaceUser(w http.ResponseWriter, r *http.Request) error {
 
 	user, err := srv.decodeUser(r)
 	if err != nil {
-		return protocol.WriteError(w, err)
+		return protocol.SendError(w, err)
 	}
 	if err := srv.validateUser(user); err != nil {
-		return protocol.WriteError(w, err)
+		return protocol.SendError(w, err)
 	}
 
 	replaced, err := srv.users.Replace(ctx, id.String(), user)
@@ -163,7 +163,7 @@ func (srv *Server) DeleteUser(w http.ResponseWriter, r *http.Request) error {
 }
 
 func (srv *Server) NotFound(w http.ResponseWriter, r *http.Request) error {
-	return protocol.WriteError(w, protocol.ErrNotFound("Endpoint or resource does not exist"))
+	return protocol.SendError(w, protocol.ErrNotFound("Endpoint or resource does not exist"))
 }
 
 func (srv *Server) validateUser(user *core.User) *protocol.Error {
@@ -213,21 +213,21 @@ func (srv *Server) byID[T core.Resource](w http.ResponseWriter, r *http.Request,
 
 func (srv *Server) sendError(w http.ResponseWriter, r *http.Request, err error) error {
 	if scimErr, ok := errors.AsType[*protocol.Error](err); ok {
-		return protocol.WriteError(w, scimErr)
+		return protocol.SendError(w, scimErr)
 	}
 	return srv.internalError(w, r, err)
 }
 
 func (srv *Server) internalError(w http.ResponseWriter, r *http.Request, err error) error {
 	observability.LogEntrySetField(r, "error", err.Error())
-	return protocol.WriteError(w, protocol.ErrInternal("Internal server error"))
+	return protocol.SendError(w, protocol.ErrInternal("Internal server error"))
 }
 
 func (srv *Server) rejectFilter(w http.ResponseWriter, r *http.Request, unsupported *protocol.Error) (bool, error) {
 	if !r.URL.Query().Has("filter") {
 		return false, nil
 	}
-	return true, protocol.WriteError(w, unsupported)
+	return true, protocol.SendError(w, unsupported)
 }
 
 func newUserSchema(baseURL string) *core.Schema {
@@ -239,8 +239,7 @@ func newUserSchema(baseURL string) *core.Schema {
 				AsRequired().
 				UniqueOn(core.UniquenessServer),
 
-			core.NewAttribute("name", core.TypeComplex,
-				"The components of the user's name.").
+			core.NewAttribute("name", core.TypeComplex, "The components of the user's name.").
 				With(
 					core.NewAttribute("formatted", core.TypeString, "The name formatted for display."),
 					core.NewAttribute("familyName", core.TypeString, "The family name of the User."),