Merge branch 'development' into development

Author: Sianao

docs/quick-start/add-rest-handlers/page.md

@@ -100,5 +100,6 @@ This method can be used to implement custom logic for filtering, sorting, or ret
 
 
 > Few Points to consider:
-> 1. Field Naming Convention: GoFr assumes the struct fields in snake-case match the database column names. For example, `IsEmployed` field in the struct matches `is_employed` column in the database, `Age` field matches `age` column, etc.
-> 2. Primary Key: The first field of the struct is typically used as the primary key for data operations. However, user can customize this behavior using GoFr's features. 
+> 1. The struct should always be passed by reference in the method `AddRESTHandlers`.
+> 2. Field Naming Convention: GoFr assumes the struct fields in snake-case match the database column names. For example, `IsEmployed` field in the struct matches `is_employed` column in the database, `Age` field matches `age` column, etc.
+> 3. Primary Key: The first field of the struct is typically used as the primary key for data operations. However, user can customize this behavior using GoFr's features. 

pkg/gofr/crud_handlers.go

@@ -10,8 +10,10 @@ import (
 )
 
 var (
-	errInvalidObject  = errors.New("unexpected object given for AddRESTHandlers")
-	errEntityNotFound = errors.New("entity not found")
+	errInvalidObject    = errors.New("unexpected object given for AddRESTHandlers")
+	errEntityNotFound   = errors.New("entity not found")
+	errObjectIsNil      = errors.New("object given for AddRESTHandlers is nil")
+	errNonPointerObject = errors.New("passed object is not pointer")
 )
 
 type Create interface {
@@ -61,7 +63,16 @@ type entity struct {
 
 // scanEntity extracts entity information for CRUD operations.
 func scanEntity(object interface{}) (*entity, error) {
-	entityType := reflect.TypeOf(object).Elem()
+	if object == nil {
+		return nil, errObjectIsNil
+	}
+
+	objType := reflect.TypeOf(object)
+	if objType.Kind() != reflect.Ptr {
+		return nil, fmt.Errorf("failed to register routes for '%s' struct, %w", objType.Name(), errNonPointerObject)
+	}
+
+	entityType := objType.Elem()
 	if entityType.Kind() != reflect.Struct {
 		return nil, errInvalidObject
 	}

pkg/gofr/crud_handlers_test.go

@@ -6,6 +6,7 @@ import (
 	"database/sql/driver"
 	"encoding/json"
 	"errors"
+	"fmt"
 	"net/http"
 	"net/http/httptest"
 	"reflect"
@@ -96,6 +97,12 @@ func Test_scanEntity(t *testing.T) {
 			resp:  nil,
 			err:   errInvalidObject,
 		},
+		{
+			desc:  "invalid object type",
+			input: userEntity{},
+			resp:  nil,
+			err:   fmt.Errorf("failed to register routes for 'userEntity' struct, %w", errNonPointerObject),
+		},
 	}
 
 	for i, tc := range tests {

pkg/gofr/gofr.go

@@ -484,11 +484,11 @@ func (a *App) Subscribe(topic string, handler SubscribeFunc) {
 	a.subscriptionManager.subscriptions[topic] = handler
 }
 
+// AddRESTHandlers creates and registers CRUD routes for the given struct, the struct should always be passed by reference.
 func (a *App) AddRESTHandlers(object interface{}) error {
 	cfg, err := scanEntity(object)
 	if err != nil {
-		a.container.Logger.Errorf("invalid object for AddRESTHandlers")
-
+		a.container.Logger.Errorf(err.Error())
 		return err
 	}
 

pkg/gofr/gofr_test.go

@@ -311,6 +311,8 @@ func Test_AddRESTHandlers(t *testing.T) {
 	}{
 		{"success case", &user{}, nil},
 		{"invalid object", &invalidObject, errInvalidObject},
+		{"invalid object", user{}, fmt.Errorf("failed to register routes for 'user' struct, %w", errNonPointerObject)},
+		{"invalid object", nil, errObjectIsNil},
 	}
 
 	for i, tc := range tests {