Refactor code

Author: minhduc140583

README.md

@@ -5,12 +5,68 @@
 go run main.go
 ```
 
+## Architecture
+### Architecture
+![Architecture](https://camo.githubusercontent.com/c17d4dfaab39cf7223f7775c9e973bb936e4169e8bd0011659e83cec755c8f26/68747470733a2f2f63646e2d696d616765732d312e6d656469756d2e636f6d2f6d61782f3830302f312a42526b437272622d5f417637395167737142556b48672e706e67)
+
+### Architecture with standard features: config, health check, logging, middleware log tracing
+![Architecture with standard features: config, health check, logging, middleware log tracing](https://camo.githubusercontent.com/bd77867d332213b6d54d80b19f46c3dd0f1b8e0b9bb155f8ff502d9fc3bdcded/68747470733a2f2f63646e2d696d616765732d312e6d656469756d2e636f6d2f6d61782f3830302f312a476d306479704c7559615077474d38557a727a5637772e706e67)
+#### [core-go/search](https://github.com/core-go/search)
+- Build the search model at http handler
+- Build dynamic SQL for search
+  - Build SQL for paging by page index (page) and page size (limit)
+  - Build SQL to count total of records
+### Search users: Support both GET and POST 
+#### POST /users/search
+##### *Request:* POST /users/search
+In the below sample, search users with these criteria:
+- get users of page "1", with page size "20"
+- email="tony": get users with email starting with "tony"
+- dateOfBirth between "min" and "max" (between 1953-11-16 and 1976-11-16)
+- sort by phone ascending, id descending
+```json
+{
+    "page": 1,
+    "limit": 20,
+    "sort": "phone,-id",
+    "email": "tony",
+    "dateOfBirth": {
+        "min": "1953-11-16T00:00:00+07:00",
+        "max": "1976-11-16T00:00:00+07:00"
+    }
+}
+```
+##### GET /users/search?page=1&limit=2&email=tony&dateOfBirth.min=1953-11-16T00:00:00+07:00&dateOfBirth.max=1976-11-16T00:00:00+07:00&sort=phone,-id
+In this sample, search users with these criteria:
+- get users of page "1", with page size "20"
+- email="tony": get users with email starting with "tony"
+- dateOfBirth between "min" and "max" (between 1953-11-16 and 1976-11-16)
+- sort by phone ascending, id descending
+
+#### *Response:*
+- total: total of users, which is used to calculate numbers of pages at client 
+- list: list of users
+```json
+{
+    "list": [
+        {
+            "id": "ironman",
+            "username": "tony.stark",
+            "email": "[email protected]",
+            "phone": "0987654321",
+            "dateOfBirth": "1963-03-24T17:00:00Z"
+        }
+    ],
+    "total": 1
+}
+```
+
 ## API Design
 ### Common HTTP methods
 - GET: retrieve a representation of the resource
 - POST: create a new resource
 - PUT: update the resource
-- PATCH: perform a partial update of a resource
+- PATCH: perform a partial update of a resource, refer to [service](https://github.com/core-go/service) and [mongo](https://github.com/core-go/mongo)  
 - DELETE: delete a resource
 
 ## API design for health check
@@ -21,7 +77,7 @@ To check if the service is available.
 {
     "status": "UP",
     "details": {
-        "sql": {
+        "mongo": {
             "status": "UP"
         }
     }
@@ -103,6 +159,56 @@ PUT /users/wolverine
 1
 ```
 
+### Patch one user by id
+Perform a partial update of user. For example, if you want to update 2 fields: email and phone, you can send the request body of below.
+#### *Request:* PATCH /users/:id
+```shell
+PATCH /users/wolverine
+```
+```json
+{
+    "email": "[email protected]",
+    "phone": "0987654321"
+}
+```
+#### *Response:* 1: success, 0: not found, -1: error
+```json
+1
+```
+
+#### Problems for patch
+If we pass a struct as a parameter, we cannot control what fields we need to update. So, we must pass a map as a parameter.
+```go
+type UserService interface {
+    Update(ctx context.Context, user *User) (int64, error)
+    Patch(ctx context.Context, user map[string]interface{}) (int64, error)
+}
+```
+We must solve 2 problems:
+1. At http handler layer, we must convert the user struct to map, with json format, and make sure the nested data types are passed correctly.
+2. At repository layer, from json format, we must convert the json format to database format (in this case, we must convert to bson of Mongo)
+
+#### Solutions for patch  
+At http handler layer, we use [core-go/service](https://github.com/core-go/service), to convert the user struct to map, to make sure we just update the fields we need to update
+```go
+import server "github.com/core-go/service"
+
+func (h *UserHandler) Patch(w http.ResponseWriter, r *http.Request) {
+    var user User
+    userType := reflect.TypeOf(user)
+    _, jsonMap := sv.BuildMapField(userType)
+    body, _ := sv.BuildMapAndStruct(r, &user)
+    json, er1 := sv.BodyToJson(r, user, body, ids, jsonMap, nil)
+
+    result, er2 := h.service.Patch(r.Context(), json)
+    if er2 != nil {
+        http.Error(w, er2.Error(), http.StatusInternalServerError)
+        return
+    }
+    respond(w, result)
+}
+```
+
 ### Delete a new user by id
 #### *Request:* DELETE /users/:id
 ```shell
@@ -191,7 +297,7 @@ func main() {
 
     log.Initialize(conf.Log)
     r.Use(m.BuildContext)
-    logger := m.NewStructuredLogger()
+    logger := m.NewLogger()
     r.Use(m.Logger(conf.MiddleWare, log.InfoFields, logger))
     r.Use(m.Recover(log.ErrorMsg))
 }

configs/config.yml

@@ -1,6 +1,6 @@
 server:
-  name: go-sql-rest-api
-  port: 8082
+  name: go-sql-modular-sample
+  port: 8080
 
 sql:
   driver: mysql
@@ -36,17 +36,3 @@ client:
     status: status
     request: request
     response: response
-
-status:
-  not_found: 0
-  duplicate_key: 0
-  success: 1
-  version_error: 2
-  validation_error: 4
-  error: 4
-
-action:
-  create: create
-  update: update
-  patch: patch
-  delete: delete