refactor: apply general code cleanups and consistency improvements

Perform general refactoring to improve consistency, readability, and
maintainability across the codebase.

Author: alansy-nscale

pkg/manager/reference.go

@@ -55,7 +55,7 @@ func GenerateResourceReference(client client.Client, resource client.Object) (st
 
 	gvr := mapping.Resource
 
-	// TODO: This is a legacy thing where the OG Kubernetes service is not corrcetly
+	// TODO: This is a legacy thing where the OG Kubernetes service is not correctly
 	// namespaced, much like Amazon regions :D  We really need to work out a migration
 	// strategy.
 	if gvr.Group == "unikorn-cloud.org" {
@@ -68,7 +68,7 @@ func GenerateResourceReference(client client.Client, resource client.Object) (st
 // GetResourceReferences returns all resource references attached to a resource.
 // This is used primarily to poll a resource to see if it's in use, and thus its
 // deletion will have consequences.  It may also be used to inhibit deletion in
-// certain cercumstances.
+// certain circumstances.
 func GetResourceReferences(object client.Object) []string {
 	ignored := []string{
 		// Our finalizer to inhibit deletion until we are finished.

pkg/messaging/consumer/cascadingdelete.go

@@ -98,7 +98,7 @@ func (c *CascadingDelete) Consume(ctx context.Context, envelope *messaging.Envel
 	}
 
 	if c.resourceLabel != "" {
-		opts.LabelSelector = labels.SelectorFromSet(map[string]string{
+		opts.LabelSelector = labels.SelectorFromSet(labels.Set{
 			c.resourceLabel: envelope.ResourceID,
 		})
 	}

pkg/openapi/common.spec.yaml

@@ -20,18 +20,11 @@ components:
       description: Represents a structured error response returned by the API. It consolidates both OAuth 2.0-related and general API errors into a unified format.
       type: object
       required:
-      - type
       - status
       - trace_id
       - error
       - error_description
       properties:
-        type:
-          description: Specifies whether the error originated from an OAuth 2.0 context or from the general API.
-          type: string
-          enum:
-          - oauth2_error
-          - api_error
         status:
           description: The HTTP status code returned with the response.
           type: integer
@@ -212,7 +205,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 400
             trace_id: 77ce9d4485f746b6
             error: invalid_request
@@ -225,7 +217,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 401
             trace_id: 77ce9d4485f746b6
             error: token_expired
@@ -240,7 +231,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 403
             trace_id: 77ce9d4485f746b6
             error: access_denied
@@ -253,7 +243,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 404
             trace_id: 77ce9d4485f746b6
             error: resource_missing
@@ -266,7 +255,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 409
             trace_id: 77ce9d4485f746b6
             error: conflict
@@ -280,7 +268,6 @@ components:
           schema:
             $ref: '#/components/schemas/error'
           example:
-            type: api_error
             status: 500
             trace_id: 77ce9d4485f746b6
             error: internal

pkg/openapi/schema.go

@@ -166,7 +166,7 @@ func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.Tag
 	return out
 }
 
-// ProjectScopedResourceReadMetadata extracts project scoped metdata from a resource for
+// ProjectScopedResourceReadMetadata extracts project scoped metadata from a resource for
 // GET APIs.
 //
 //nolint:errchkjson
@@ -304,12 +304,10 @@ func LogUpdate(ctx context.Context, current, required metav1.Object) error {
 }
 
 func ConvertTag(in unikornv1.Tag) openapi.Tag {
-	out := openapi.Tag{
+	return openapi.Tag{
 		Name:  in.Name,
 		Value: in.Value,
 	}
-
-	return out
 }
 
 func ConvertTags(in unikornv1.TagList) openapi.TagList {
@@ -327,12 +325,10 @@ func ConvertTags(in unikornv1.TagList) openapi.TagList {
 }
 
 func GenerateTag(in openapi.Tag) unikornv1.Tag {
-	out := unikornv1.Tag{
+	return unikornv1.Tag{
 		Name:  in.Name,
 		Value: in.Value,
 	}
-
-	return out
 }
 
 func GenerateTagList(in *openapi.TagList) unikornv1.TagList {

pkg/openapi/types.go

@@ -25,17 +25,11 @@ import (
 
 const (
 	HeaderWWWAuthenticate = "WWW-Authenticate"
+	HeaderErrorVersion    = "X-Error-Version"
 	HeaderOAuth2Error     = "X-Oauth2-Error"
 	HeaderAPIError        = "X-Api-Error"
 )
 
-type ErrorType string
-
-const (
-	ErrorTypeOAuth2Error ErrorType = "oauth2_error"
-	ErrorTypeAPIError    ErrorType = "api_error"
-)
-
 type OAuth2ErrorCode string
 
 const (
@@ -93,11 +87,10 @@ type Error struct {
 	OAuth2ErrorCode OAuth2ErrorCode `json:"-"`
 	APIErrorCode    APIErrorCode    `json:"-"`
 
-	Type             ErrorType `json:"type"`
-	Status           int       `json:"status"`
-	TraceID          string    `json:"trace_id"`
-	ErrorCode        string    `json:"error"`
-	ErrorDescription string    `json:"error_description"`
+	Status           int    `json:"status"`
+	TraceID          string `json:"trace_id"`
+	ErrorCode        string `json:"error"`
+	ErrorDescription string `json:"error_description"`
 }
 
 func (e *Error) Error() string {

pkg/server/conversion/conversion.go

@@ -66,6 +66,7 @@ func WriteErrorResponse(w http.ResponseWriter, r *http.Request, err error) {
 }
 
 func writeErrorCodeHeaders(w http.ResponseWriter, e *errorsv2.Error) {
+	w.Header().Set(errorsv2.HeaderErrorVersion, "2")
 	w.Header().Set(errorsv2.HeaderOAuth2Error, string(e.OAuth2ErrorCode))
 	w.Header().Set(errorsv2.HeaderAPIError, string(e.APIErrorCode))
 }
@@ -86,7 +87,6 @@ func WriteOAuth2ErrorResponse(w http.ResponseWriter, r *http.Request, err error)
 		response = errorsv2.NewInternalError().WithCause(err).Prefixed()
 	}
 
-	response.Type = errorsv2.ErrorTypeOAuth2Error
 	response.TraceID = trace.SpanContextFromContext(ctx).TraceID().String()
 	response.ErrorCode = string(response.OAuth2ErrorCode)
 
@@ -101,6 +101,10 @@ func writeWWWAuthenticateHeader(w http.ResponseWriter, e *errorsv2.Error) {
 		return
 	}
 
+	if e.OAuth2ErrorCode == "" {
+		return
+	}
+
 	var builder strings.Builder
 
 	builder.WriteString("Bearer error=")
@@ -130,7 +134,6 @@ func WriteAPIErrorResponse(w http.ResponseWriter, r *http.Request, err error) {
 		response = errorsv2.NewInternalError().WithCause(err).Prefixed()
 	}
 
-	response.Type = errorsv2.ErrorTypeAPIError
 	response.TraceID = trace.SpanContextFromContext(ctx).TraceID().String()
 	response.ErrorCode = string(response.APIErrorCode)