Merge pull request #609 from alfrunes/simplify-api-model

chore: Align internal Device and AuthSet model with the API model
mendersoftware · Aug 30, 2022 · db98c56 · db98c56
2 parents a5c5b06 + 8aaeebe
commit db98c56
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 154 deletions.
diff --git a/api/http/api_devauth.go b/api/http/api_devauth.go
@@ -317,11 +317,11 @@ func (d *DevAuthApiHandlers) SearchDevicesV2Handler(w rest.ResponseWriter, r *re
 		return
 	}
 
-	len := len(devs)
+	numDevs := len(devs)
 	hasNext := false
-	if uint64(len) > perPage {
+	if uint64(numDevs) > perPage {
 		hasNext = true
-		len = int(perPage)
+		numDevs = int(perPage)
 	}
 
 	links := rest_utils.MakePageLinkHdrs(r, page, perPage, hasNext)
@@ -330,13 +330,7 @@ func (d *DevAuthApiHandlers) SearchDevicesV2Handler(w rest.ResponseWriter, r *re
 		w.Header().Add("Link", l)
 	}
 
-	outDevs, err := devicesV2FromDbModel(devs[:len])
-	if err != nil {
-		rest_utils.RestErrWithLogInternal(w, r, l, err)
-		return
-	}
-
-	_ = w.WriteJson(outDevs)
+	_ = w.WriteJson(devs[:numDevs])
 }
 
 func (d *DevAuthApiHandlers) GetDevicesV2Handler(w rest.ResponseWriter, r *rest.Request) {
@@ -391,8 +385,7 @@ func (d *DevAuthApiHandlers) GetDeviceV2Handler(w rest.ResponseWriter, r *rest.R
 	case err == store.ErrDevNotFound:
 		rest_utils.RestErrWithLog(w, r, l, err, http.StatusNotFound)
 	case dev != nil:
-		apiDev, _ := deviceV2FromDbModel(dev)
-		_ = w.WriteJson(apiDev)
+		_ = w.WriteJson(dev)
 	default:
 		rest_utils.RestErrWithLogInternal(w, r, l, err)
 	}

diff --git a/api/http/api_devauth_test.go b/api/http/api_devauth_test.go
@@ -877,8 +877,6 @@ func TestApiV2GetDevice(t *testing.T) {
 		},
 	}
 
-	apiDev, _ := deviceV2FromDbModel(dev)
-
 	tcases := []struct {
 		req *http.Request
 
@@ -895,7 +893,7 @@ func TestApiV2GetDevice(t *testing.T) {
 			err:    nil,
 
 			code: http.StatusOK,
-			body: string(asJSON(apiDev)),
+			body: string(asJSON(dev)),
 		},
 		{
 			req: test.MakeSimpleRequest("GET",
@@ -978,8 +976,7 @@ func TestSearchDevices(t *testing.T) {
 				Status:    "accepted",
 				CreatedTs: time.Unix(1606942069, 0),
 			}}
-			devV2, _ := devicesV2FromDbModel(dev)
-			b, _ := json.Marshal(devV2)
+			b, _ := json.Marshal(dev)
 			return b
 		}(),
 	}, {
@@ -1013,8 +1010,7 @@ func TestSearchDevices(t *testing.T) {
 				Status:    "accepted",
 				CreatedTs: time.Unix(1606942069, 0),
 			}}
-			devV2, _ := devicesV2FromDbModel(dev)
-			b, _ := json.Marshal(devV2)
+			b, _ := json.Marshal(dev)
 			return b
 		}(),
 	}, {
@@ -1201,9 +1197,6 @@ func TestApiV2GetDevices(t *testing.T) {
 		},
 	}
 
-	outDevs, err := devicesV2FromDbModel(devs)
-	assert.NoError(t, err)
-
 	tcases := map[string]struct {
 		req     *http.Request
 		code    int
@@ -1221,7 +1214,7 @@ func TestApiV2GetDevices(t *testing.T) {
 			err:     nil,
 			skip:    0,
 			limit:   rest_utils.PerPageDefault + 1,
-			body:    string(asJSON(outDevs)),
+			body:    string(asJSON(devs)),
 		},
 		"no devices": {
 			req: test.MakeSimpleRequest("GET",
@@ -1243,7 +1236,7 @@ func TestApiV2GetDevices(t *testing.T) {
 			limit:   3,
 			code:    http.StatusOK,
 			// reqquested 2 devices per page, so expect only 2
-			body: string(asJSON(outDevs[:2])),
+			body: string(asJSON(devs[:2])),
 		},
 		"internal error": {
 			req: test.MakeSimpleRequest("GET",
@@ -2174,9 +2167,6 @@ func TestApiGetTenantDevicesV2(t *testing.T) {
 		},
 	}
 
-	outDevs, err := devicesV2FromDbModel(devs)
-	assert.NoError(t, err)
-
 	tcases := map[string]struct {
 		req       *http.Request
 		code      int
@@ -2197,7 +2187,7 @@ func TestApiGetTenantDevicesV2(t *testing.T) {
 			err:       nil,
 			skip:      0,
 			limit:     rest_utils.PerPageDefault + 1,
-			body:      string(asJSON(outDevs)),
+			body:      string(asJSON(devs)),
 			tenant_id: "powerpuff123",
 
 			filterMatch: mock.AnythingOfType("model.DeviceFilter"),
@@ -2210,7 +2200,7 @@ func TestApiGetTenantDevicesV2(t *testing.T) {
 			err:       nil,
 			skip:      0,
 			limit:     rest_utils.PerPageDefault + 1,
-			body:      string(asJSON(outDevs)),
+			body:      string(asJSON(devs)),
 			tenant_id: "powerpuff123",
 
 			filterMatch: mock.AnythingOfType("model.DeviceFilter"),
@@ -2223,7 +2213,7 @@ func TestApiGetTenantDevicesV2(t *testing.T) {
 			err:       nil,
 			skip:      0,
 			limit:     rest_utils.PerPageDefault + 1,
-			body:      string(asJSON(outDevs[:2])),
+			body:      string(asJSON(devs[:2])),
 			tenant_id: "powerpuff123",
 
 			filterMatch: mock.MatchedBy(func(filter model.DeviceFilter) bool {
@@ -2255,7 +2245,7 @@ func TestApiGetTenantDevicesV2(t *testing.T) {
 			limit:   3,
 			code:    http.StatusOK,
 			// reqquested 2 devices per page, so expect only 2
-			body:      string(asJSON(outDevs[:2])),
+			body:      string(asJSON(devs[:2])),
 			tenant_id: "powerpuff123",
 
 			filterMatch: mock.AnythingOfType("model.DeviceFilter"),

diff --git a/api/http/model_auth_set_v2.go b/api/http/model_auth_set_v2.go
diff --git a/api/http/model_device_v2.go b/api/http/model_device_v2.go
diff --git a/model/authset.go b/model/authset.go
@@ -1,4 +1,4 @@
-// Copyright 2021 Northern.tech AS
+// Copyright 2022 Northern.tech AS
 //
 //    Licensed under the Apache License, Version 2.0 (the "License");
 //    you may not use this file except in compliance with the License.
@@ -30,20 +30,15 @@ const (
 
 type AuthSet struct {
 	Id           string                 `json:"id" bson:"_id,omitempty"`
-	IdData       string                 `json:"id_data" bson:"id_data,omitempty"`
-	IdDataStruct map[string]interface{} `bson:"id_data_struct,omitempty"`
-	IdDataSha256 []byte                 `bson:"id_data_sha256,omitempty"`
+	IdData       string                 `json:"-" bson:"id_data,omitempty"`
+	IdDataStruct map[string]interface{} `json:"identity_data" bson:"id_data_struct,omitempty"`
+	IdDataSha256 []byte                 `json:"-" bson:"id_data_sha256,omitempty"`
 	PubKey       string                 `json:"pubkey" bson:"pubkey,omitempty"`
 	DeviceId     string                 `json:"-" bson:"device_id,omitempty"`
 	Timestamp    *time.Time             `json:"ts" bson:"ts,omitempty"`
 	Status       string                 `json:"status" bson:"status,omitempty"`
 }
 
-type DevAuthSet struct {
-	Id       string `json:"id" bson:"_id,omitempty"`
-	DeviceId string `json:"device_id" bson:"device_id,omitempty"`
-}
-
 type AuthSetUpdate struct {
 	Id           string                 `bson:"id,omitempty"`
 	IdData       string                 `bson:"id_data,omitempty"`

diff --git a/model/device.go b/model/device.go
@@ -50,10 +50,10 @@ var (
 // otherwise the underscore will be removed upon write to mongo
 type Device struct {
 	Id              string                 `json:"id" bson:"_id,omitempty"`
-	IdData          string                 `json:"id_data" bson:"id_data,omitempty"`
-	IdDataStruct    map[string]interface{} `bson:"id_data_struct,omitempty"`
-	IdDataSha256    []byte                 `bson:"id_data_sha256,omitempty"`
-	Status          string                 `json:"-" bson:",omitempty"`
+	IdData          string                 `json:"-" bson:"id_data,omitempty"`
+	IdDataStruct    map[string]interface{} `json:"identity_data" bson:"id_data_struct,omitempty"`
+	IdDataSha256    []byte                 `json:"-" bson:"id_data_sha256,omitempty"`
+	Status          string                 `json:"status" bson:",omitempty"`
 	Decommissioning bool                   `json:"decommissioning" bson:",omitempty"`
 	CreatedTs       time.Time              `json:"created_ts" bson:"created_ts,omitempty"`
 	UpdatedTs       time.Time              `json:"updated_ts" bson:"updated_ts,omitempty"`