MG-2426 - Replace generic Clients in Things service (#2476)

Signed-off-by: Musilah <[email protected]> Signed-off-by: Felix Gateru <[email protected]> Co-authored-by: Felix Gateru <[email protected]>
absmach · Nov 4, 2024 · 87c390d · 87c390d
1 parent ef8631b
commit 87c390d
Show file tree

Hide file tree

Showing 76 changed files with 2,454 additions and 4,621 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -160,9 +160,6 @@ jobs:
               - "logger/**"
               - "pkg/events/**"
 
-            pkg-clients:
-              - "pkg/clients/**"
-
             pkg-errors:
               - "pkg/errors/**"
 
@@ -178,7 +175,6 @@ jobs:
 
             pkg-sdk:
               - "pkg/sdk/**"
-              - "pkg/clients/**"
               - "pkg/errors/**"
               - "pkg/groups/**"
               - "auth/**"
@@ -226,7 +222,6 @@ jobs:
               - "auth.pb.go"
               - "auth_grpc.pb.go"
               - "auth/**"
-              - "pkg/clients/**"
               - "pkg/ulid/**"
               - "pkg/uuid/**"
               - "pkg/events/**"
@@ -237,7 +232,6 @@ jobs:
               - "auth.pb.go"
               - "auth_grpc.pb.go"
               - "auth/**"
-              - "pkg/clients/**"
               - "pkg/ulid/**"
               - "pkg/uuid/**"
               - "pkg/events/**"
@@ -314,11 +308,6 @@ jobs:
         run: |
           go test --race -v -count=1 -coverprofile=coverage/mqtt.out ./mqtt/...
 
-      - name: Run pkg clients tests
-        if: steps.changes.outputs.pkg-clients == 'true' || steps.changes.outputs.workflow == 'true'
-        run: |
-          go test --race -v -count=1 -coverprofile=coverage/pkg-clients.out ./pkg/clients/...
-
       - name: Run pkg errors tests
         if: steps.changes.outputs.pkg-errors == 'true' || steps.changes.outputs.workflow == 'true'
         run: |

diff --git a/auth/api/http/domains/endpoint.go b/auth/api/http/domains/endpoint.go
@@ -8,7 +8,6 @@ import (
 
 	"github.com/absmach/magistrala/auth"
 	"github.com/absmach/magistrala/pkg/apiutil"
-	"github.com/absmach/magistrala/pkg/clients"
 	"github.com/absmach/magistrala/pkg/errors"
 	"github.com/go-kit/kit/endpoint"
 )
@@ -72,7 +71,7 @@ func updateDomainEndpoint(svc auth.Service) endpoint.Endpoint {
 			return nil, err
 		}
 
-		var metadata clients.Metadata
+		var metadata auth.Metadata
 		if req.Metadata != nil {
 			metadata = *req.Metadata
 		}

diff --git a/auth/api/http/domains/endpoint_test.go b/auth/api/http/domains/endpoint_test.go
@@ -19,7 +19,6 @@ import (
 	"github.com/absmach/magistrala/internal/testsutil"
 	mglog "github.com/absmach/magistrala/logger"
 	"github.com/absmach/magistrala/pkg/apiutil"
-	mgclients "github.com/absmach/magistrala/pkg/clients"
 	"github.com/absmach/magistrala/pkg/errors"
 	svcerr "github.com/absmach/magistrala/pkg/errors/service"
 	policies "github.com/absmach/magistrala/pkg/policies"
@@ -29,7 +28,7 @@ import (
 )
 
 var (
-	validCMetadata = mgclients.Metadata{"role": "client"}
+	validCMetadata = auth.Metadata{"role": "client"}
 	ID             = testsutil.GenerateUUID(&testing.T{})
 	domain         = auth.Domain{
 		ID:       ID,
@@ -114,7 +113,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -128,7 +127,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -142,7 +141,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -157,7 +156,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -171,7 +170,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "",
 			},
@@ -185,7 +184,7 @@ func TestCreateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -646,7 +645,7 @@ func TestUpdateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -660,7 +659,7 @@ func TestUpdateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -674,7 +673,7 @@ func TestUpdateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -689,7 +688,7 @@ func TestUpdateDomain(t *testing.T) {
 			domain: auth.Domain{
 				ID:       ID,
 				Name:     "test",
-				Metadata: mgclients.Metadata{"role": "domain"},
+				Metadata: auth.Metadata{"role": "domain"},
 				Tags:     []string{"tag1", "tag2"},
 				Alias:    "test",
 			},
@@ -1301,11 +1300,11 @@ func TestListDomainsByUserID(t *testing.T) {
 }
 
 type respBody struct {
-	Err         string           `json:"error"`
-	Message     string           `json:"message"`
-	Total       int              `json:"total"`
-	Permissions []string         `json:"permissions"`
-	ID          string           `json:"id"`
-	Tags        []string         `json:"tags"`
-	Status      mgclients.Status `json:"status"`
+	Err         string      `json:"error"`
+	Message     string      `json:"message"`
+	Total       int         `json:"total"`
+	Permissions []string    `json:"permissions"`
+	ID          string      `json:"id"`
+	Tags        []string    `json:"tags"`
+	Status      auth.Status `json:"status"`
 }
diff --git a/auth/domains.go b/auth/domains.go
@@ -9,7 +9,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/absmach/magistrala/pkg/clients"
 	svcerr "github.com/absmach/magistrala/pkg/errors/service"
 	"github.com/absmach/magistrala/pkg/policies"
 )
@@ -87,41 +86,44 @@ func (s *Status) UnmarshalJSON(data []byte) error {
 }
 
 type DomainReq struct {
-	Name     *string           `json:"name,omitempty"`
-	Metadata *clients.Metadata `json:"metadata,omitempty"`
-	Tags     *[]string         `json:"tags,omitempty"`
-	Alias    *string           `json:"alias,omitempty"`
-	Status   *Status           `json:"status,omitempty"`
+	Name     *string   `json:"name,omitempty"`
+	Metadata *Metadata `json:"metadata,omitempty"`
+	Tags     *[]string `json:"tags,omitempty"`
+	Alias    *string   `json:"alias,omitempty"`
+	Status   *Status   `json:"status,omitempty"`
 }
 type Domain struct {
-	ID         string           `json:"id"`
-	Name       string           `json:"name"`
-	Metadata   clients.Metadata `json:"metadata,omitempty"`
-	Tags       []string         `json:"tags,omitempty"`
-	Alias      string           `json:"alias,omitempty"`
-	Status     Status           `json:"status"`
-	Permission string           `json:"permission,omitempty"`
-	CreatedBy  string           `json:"created_by,omitempty"`
-	CreatedAt  time.Time        `json:"created_at"`
-	UpdatedBy  string           `json:"updated_by,omitempty"`
-	UpdatedAt  time.Time        `json:"updated_at,omitempty"`
+	ID         string    `json:"id"`
+	Name       string    `json:"name"`
+	Metadata   Metadata  `json:"metadata,omitempty"`
+	Tags       []string  `json:"tags,omitempty"`
+	Alias      string    `json:"alias,omitempty"`
+	Status     Status    `json:"status"`
+	Permission string    `json:"permission,omitempty"`
+	CreatedBy  string    `json:"created_by,omitempty"`
+	CreatedAt  time.Time `json:"created_at"`
+	UpdatedBy  string    `json:"updated_by,omitempty"`
+	UpdatedAt  time.Time `json:"updated_at,omitempty"`
 }
 
+// Metadata represents arbitrary JSON.
+type Metadata map[string]interface{}
+
 type Page struct {
-	Total      uint64           `json:"total"`
-	Offset     uint64           `json:"offset"`
-	Limit      uint64           `json:"limit"`
-	Name       string           `json:"name,omitempty"`
-	Order      string           `json:"-"`
-	Dir        string           `json:"-"`
-	Metadata   clients.Metadata `json:"metadata,omitempty"`
-	Tag        string           `json:"tag,omitempty"`
-	Permission string           `json:"permission,omitempty"`
-	Status     Status           `json:"status,omitempty"`
-	ID         string           `json:"id,omitempty"`
-	IDs        []string         `json:"-"`
-	Identity   string           `json:"identity,omitempty"`
-	SubjectID  string           `json:"-"`
+	Total      uint64   `json:"total"`
+	Offset     uint64   `json:"offset"`
+	Limit      uint64   `json:"limit"`
+	Name       string   `json:"name,omitempty"`
+	Order      string   `json:"-"`
+	Dir        string   `json:"-"`
+	Metadata   Metadata `json:"metadata,omitempty"`
+	Tag        string   `json:"tag,omitempty"`
+	Permission string   `json:"permission,omitempty"`
+	Status     Status   `json:"status,omitempty"`
+	ID         string   `json:"id,omitempty"`
+	IDs        []string `json:"-"`
+	Identity   string   `json:"identity,omitempty"`
+	SubjectID  string   `json:"-"`
 }
 
 type DomainsPage struct {

diff --git a/auth/postgres/domains.go b/auth/postgres/domains.go
@@ -13,7 +13,6 @@ import (
 
 	"github.com/absmach/magistrala/auth"
 	"github.com/absmach/magistrala/pkg/apiutil"
-	"github.com/absmach/magistrala/pkg/clients"
 	"github.com/absmach/magistrala/pkg/errors"
 	repoerr "github.com/absmach/magistrala/pkg/errors/repository"
 	"github.com/absmach/magistrala/pkg/postgres"
@@ -473,7 +472,7 @@ func toDBDomain(d auth.Domain) (dbDomain, error) {
 }
 
 func toDomain(d dbDomain) (auth.Domain, error) {
-	var metadata clients.Metadata
+	var metadata auth.Metadata
 	if d.Metadata != nil {
 		if err := json.Unmarshal([]byte(d.Metadata), &metadata); err != nil {
 			return auth.Domain{}, errors.Wrap(errors.ErrMalformedEntity, err)

diff --git a/auth/postgres/domains_test.go b/auth/postgres/domains_test.go
@@ -12,7 +12,6 @@ import (
 	"github.com/absmach/magistrala/auth"
 	"github.com/absmach/magistrala/auth/postgres"
 	"github.com/absmach/magistrala/internal/testsutil"
-	"github.com/absmach/magistrala/pkg/clients"
 	"github.com/absmach/magistrala/pkg/errors"
 	repoerr "github.com/absmach/magistrala/pkg/errors/repository"
 	"github.com/absmach/magistrala/pkg/policies"
@@ -813,7 +812,7 @@ func TestUpdate(t *testing.T) {
 	})
 
 	updatedName := "test1"
-	updatedMetadata := clients.Metadata{
+	updatedMetadata := auth.Metadata{
 		"test1": "test1",
 	}
 	updatedTags := []string{"test1"}
@@ -917,7 +916,7 @@ func TestUpdate(t *testing.T) {
 			domainID: domainID,
 			d: auth.DomainReq{
 				Name:     &updatedName,
-				Metadata: &clients.Metadata{"key": make(chan int)},
+				Metadata: &auth.Metadata{"key": make(chan int)},
 			},
 			response: auth.Domain{},
 			err:      repoerr.ErrUpdateEntity,

diff --git a/bootstrap/configs.go b/bootstrap/configs.go
@@ -7,7 +7,7 @@ import (
 	"context"
 	"time"
 
-	"github.com/absmach/magistrala/pkg/clients"
+	"github.com/absmach/magistrala/things"
 )
 
 // Config represents Configuration entity. It wraps information about external entity
@@ -41,7 +41,7 @@ type Channel struct {
 	CreatedAt   time.Time              `json:"created_at"`
 	UpdatedAt   time.Time              `json:"updated_at,omitempty"`
 	UpdatedBy   string                 `json:"updated_by,omitempty"`
-	Status      clients.Status         `json:"status"`
+	Status      things.Status          `json:"status"`
 }
 
 // Filter is used for the search filters.

diff --git a/bootstrap/postgres/configs.go b/bootstrap/postgres/configs.go
@@ -13,10 +13,10 @@ import (
 	"time"
 
 	"github.com/absmach/magistrala/bootstrap"
-	"github.com/absmach/magistrala/pkg/clients"
 	"github.com/absmach/magistrala/pkg/errors"
 	repoerr "github.com/absmach/magistrala/pkg/errors/repository"
 	"github.com/absmach/magistrala/pkg/postgres"
+	"github.com/absmach/magistrala/things"
 	"github.com/jackc/pgerrcode"
 	"github.com/jackc/pgtype"
 	"github.com/jackc/pgx/v5/pgconn"
@@ -715,7 +715,7 @@ type dbChannel struct {
 	CreatedAt   time.Time      `db:"created_at"`
 	UpdatedAt   sql.NullTime   `db:"updated_at,omitempty"`
 	UpdatedBy   sql.NullString `db:"updated_by,omitempty"`
-	Status      clients.Status `db:"status"`
+	Status      things.Status  `db:"status"`
 }
 
 func toDBChannel(domainID string, ch bootstrap.Channel) (dbChannel, error) {

diff --git a/cli/groups.go b/cli/groups.go
@@ -6,7 +6,7 @@ package cli
 import (
 	"encoding/json"
 
-	mgclients "github.com/absmach/magistrala/pkg/clients"
+	"github.com/absmach/magistrala/internal/groups"
 	mgxsdk "github.com/absmach/magistrala/pkg/sdk/go"
 	"github.com/spf13/cobra"
 )
@@ -28,7 +28,7 @@ var cmdGroups = []cobra.Command{
 				logErrorCmd(*cmd, err)
 				return
 			}
-			group.Status = mgclients.EnabledStatus.String()
+			group.Status = groups.EnabledStatus.String()
 			group, err := sdk.CreateGroup(group, args[1], args[2])
 			if err != nil {
 				logErrorCmd(*cmd, err)

diff --git a/cli/things.go b/cli/things.go
@@ -6,8 +6,8 @@ package cli
 import (
 	"encoding/json"
 
-	mgclients "github.com/absmach/magistrala/pkg/clients"
 	mgxsdk "github.com/absmach/magistrala/pkg/sdk/go"
+	"github.com/absmach/magistrala/things"
 	"github.com/spf13/cobra"
 )
 
@@ -29,7 +29,7 @@ var cmdThings = []cobra.Command{
 				logErrorCmd(*cmd, err)
 				return
 			}
-			thing.Status = mgclients.EnabledStatus.String()
+			thing.Status = things.EnabledStatus.String()
 			thing, err := sdk.CreateThing(thing, args[1], args[2])
 			if err != nil {
 				logErrorCmd(*cmd, err)