feat: Change user custom data field type from any to json.RawMessage to facilitate easier retrieval from db. (#109)

* feat: Type the custom data field on the user model as json.RawMessage so mongo doesn't unmarshal to bson, therefore allowing a custom type to be correctly added and retrieved from the db. Otherwise, you need to convert the bson to your custom struct manually.

* fix: return bytes.Equal directly to please golint

* feat: Type wrap json.RawMessage and add Marshal and Unmarshal methods to streamline implementation of custom data.

* feat: Add CustomData type to client Data field.

Author: KeesTucker

client.go

@@ -1,7 +1,7 @@
 package storage
 
 import (
-	"reflect"
+	"bytes"
 
 	"github.com/ory/fosite"
 )
@@ -116,7 +116,7 @@ type Client struct {
 	Published bool `bson:"published" json:"published" xml:"published"`
 
 	// Data enables stuffing in extra client data that can be typechecked at a later point.
-	Data any `bson:"data" json:"data,omitempty" xml:"data,omitempty"`
+	Data CustomData `bson:"data" json:"data,omitempty" xml:"data,omitempty"`
 }
 
 // GetID returns the client's Client ID.
@@ -386,7 +386,7 @@ func (c *Client) Equal(x Client) bool {
 		return false
 	}
 
-	return reflect.DeepEqual(c.Data, x.Data)
+	return bytes.Equal(c.Data, x.Data)
 }
 
 // IsEmpty returns whether or not the client resource is an empty record.

custom_data.go

@@ -0,0 +1,22 @@
+package storage
+
+import "encoding/json"
+
+type CustomData json.RawMessage
+
+func (c *CustomData) Marshal(v any) error {
+	b, err := json.Marshal(v)
+	if err != nil {
+		return err
+	}
+	*c = b
+	return nil
+}
+
+func (c *CustomData) Unmarshal(v any) error {
+	err := json.Unmarshal(*c, v)
+	if err != nil {
+		return err
+	}
+	return nil
+}

user.go

@@ -2,9 +2,9 @@ package storage
 
 import (
 	// Standard Library Imports
+	"bytes"
 	"context"
 	"fmt"
-	"reflect"
 	"strings"
 
 	// External Imports
@@ -82,8 +82,8 @@ type User struct {
 	// MFAFactors contains the MFA Factor ID to the type of factor the user is signed up to.
 	MFAFactors map[string]MultiFactorType `bson:"mfaFactors" json:"mfaFactors,omitempty" xml:"mfaFactors,omitempty"`
 
-	// Data enables stuffing in extra user data that can be typechecked at a later point.
-	Data any `bson:"data" json:"data,omitempty" xml:"data,omitempty"`
+	// Data enables stuffing in extra user data that can be unmarshalled at a later point.
+	Data CustomData `bson:"data" json:"data,omitempty" xml:"data,omitempty"`
 }
 
 // MultiFactorType specifies the types of authentication a user can enrol in;
@@ -253,7 +253,7 @@ func (u User) Equal(x User) bool {
 		}
 	}
 
-	return reflect.DeepEqual(u.Data, x.Data)
+	return bytes.Equal(u.Data, x.Data)
 }
 
 // IsEmpty returns true if the current user holds no data.

user_test.go

@@ -1121,36 +1121,20 @@ func TestUser_Equal(t *testing.T) {
 		{
 			description: "custom data differences should report not equal",
 			x: User{
-				Data: struct {
-					birthday string
-				}{
-					birthday: "1999-01-01",
-				},
+				Data: CustomData(`{"birthday":"1999-01-01"}`),
 			},
 			y: User{
-				Data: struct {
-					birthday string
-				}{
-					birthday: "2000-01-01",
-				},
+				Data: CustomData(`{"birthday":"2001-01-01"}`),
 			},
 			expected: false,
 		},
 		{
 			description: "custom data should report equal",
 			x: User{
-				Data: struct {
-					birthday string
-				}{
-					birthday: "1999-01-01",
-				},
+				Data: CustomData(`{"birthday":"1999-01-01"}`),
 			},
 			y: User{
-				Data: struct {
-					birthday string
-				}{
-					birthday: "1999-01-01",
-				},
+				Data: CustomData(`{"birthday":"1999-01-01"}`),
 			},
 			expected: true,
 		},