NOISSUE - Add Readers and Consumers SDK (#33)

* refactor: aligh bootstrap with new supermq architecture Signed-off-by: Felix Gateru <[email protected]> * refactor: rename env variables Signed-off-by: Felix Gateru <[email protected]> * style: add empty line to config files and bootstrap docker compose file Signed-off-by: Felix Gateru <[email protected]> * refactor: add supermq sdk to magistrala sdk Signed-off-by: Felix Gateru <[email protected]> * refactor: extend supermq sdk in magistrala sdk Signed-off-by: Felix Gateru <[email protected]> * reafctor: update responses Signed-off-by: Felix Gateru <[email protected]> * feat: add readers and consumers sdk Signed-off-by: Felix Gateru <[email protected]> * ci(messages.go): fix filename Signed-off-by: Felix Gateru <[email protected]> * feat: add readers sdk Signed-off-by: Felix Gateru <[email protected]> * refactor: remove notifier interface Signed-off-by: Felix Gateru <[email protected]> * refactor: remove notifier interface Signed-off-by: Felix Gateru <[email protected]> --------- Signed-off-by: Felix Gateru <[email protected]>
absmach · Jan 13, 2025 · cd528e7 · cd528e7
1 parent ec71a5e
commit cd528e7
Show file tree

Hide file tree

Showing 35 changed files with 5,365 additions and 273 deletions.
diff --git a/apidocs/openapi/notifiers.yml b/apidocs/openapi/notifiers.yml
@@ -13,7 +13,7 @@ info:
   license:
     name: Apache 2.0
     url: https://github.com/absmach/magistrala/blob/main/LICENSE
-  version: 0.14.0
+  version: 0.15.1
 
 servers:
   - url: http://localhost:9014
@@ -44,7 +44,7 @@ paths:
         "400":
           description: Failed due to malformed JSON.
         "401":
-          description: Missing or invalid access token provided.          
+          description: Missing or invalid access token provided.
         "403":
           description: Failed to perform authorization over the entity.
         "409":
@@ -278,7 +278,7 @@ components:
       content:
         application/health+json:
           schema:
-            $ref: "./schemas/HealthInfo.yml"
+            $ref: "./schemas/health_info.yml"
 
   securitySchemes:
     bearerAuth:

diff --git a/apidocs/openapi/readers.yml b/apidocs/openapi/readers.yml
@@ -13,7 +13,7 @@ info:
   license:
     name: Apache 2.0
     url: https://github.com/absmach/magistrala/blob/main/LICENSE
-  version: 0.14.0
+  version: 0.15.1
 
 servers:
   - url: http://localhost:9003
@@ -292,7 +292,7 @@ components:
       content:
         application/health+json:
           schema:
-            $ref: "./schemas/HealthInfo.yml"
+            $ref: "./schemas/health_info.yml"
 
   securitySchemes:
     bearerAuth:

diff --git a/cmd/postgres-reader/main.go b/cmd/postgres-reader/main.go
@@ -12,6 +12,7 @@ import (
 	"os"
 
 	chclient "github.com/absmach/callhome/pkg/client"
+	httpapi "github.com/absmach/magistrala/readers/api"
 	"github.com/absmach/magistrala/readers/postgres"
 	"github.com/absmach/supermq"
 	smqlog "github.com/absmach/supermq/logger"
@@ -23,7 +24,6 @@ import (
 	httpserver "github.com/absmach/supermq/pkg/server/http"
 	"github.com/absmach/supermq/pkg/uuid"
 	"github.com/absmach/supermq/readers"
-	httpapi "github.com/absmach/supermq/readers/api"
 	"github.com/caarlos0/env/v11"
 	"github.com/jmoiron/sqlx"
 	"golang.org/x/sync/errgroup"

diff --git a/cmd/timescale-reader/main.go b/cmd/timescale-reader/main.go
@@ -12,6 +12,7 @@ import (
 	"os"
 
 	chclient "github.com/absmach/callhome/pkg/client"
+	httpapi "github.com/absmach/magistrala/readers/api"
 	"github.com/absmach/magistrala/readers/timescale"
 	"github.com/absmach/supermq"
 	smqlog "github.com/absmach/supermq/logger"
@@ -23,7 +24,6 @@ import (
 	httpserver "github.com/absmach/supermq/pkg/server/http"
 	"github.com/absmach/supermq/pkg/uuid"
 	"github.com/absmach/supermq/readers"
-	httpapi "github.com/absmach/supermq/readers/api"
 	"github.com/caarlos0/env/v11"
 	"github.com/jmoiron/sqlx"
 	"golang.org/x/sync/errgroup"

diff --git a/consumers/notifiers/api/endpoint.go b/consumers/notifiers/api/endpoint.go
@@ -6,8 +6,8 @@ package api
 import (
 	"context"
 
+	notifiers "github.com/absmach/magistrala/consumers/notifiers"
 	apiutil "github.com/absmach/supermq/api/http/util"
-	notifiers "github.com/absmach/supermq/consumers/notifiers"
 	"github.com/absmach/supermq/pkg/errors"
 	"github.com/go-kit/kit/endpoint"
 )

diff --git a/consumers/notifiers/api/endpoint_test.go b/consumers/notifiers/api/endpoint_test.go
@@ -13,11 +13,11 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/absmach/magistrala/consumers/notifiers/api"
 	"github.com/absmach/magistrala/consumers/notifiers/mocks"
 	"github.com/absmach/magistrala/internal/testsutil"
 	apiutil "github.com/absmach/supermq/api/http/util"
-	"github.com/absmach/supermq/consumers/notifiers"
 	smqlog "github.com/absmach/supermq/logger"
 	svcerr "github.com/absmach/supermq/pkg/errors/service"
 	"github.com/absmach/supermq/pkg/uuid"

diff --git a/consumers/notifiers/api/logging.go b/consumers/notifiers/api/logging.go
@@ -10,7 +10,7 @@ import (
 	"log/slog"
 	"time"
 
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/magistrala/consumers/notifiers"
 )
 
 var _ notifiers.Service = (*loggingMiddleware)(nil)

diff --git a/consumers/notifiers/api/metrics.go b/consumers/notifiers/api/metrics.go
@@ -9,7 +9,7 @@ import (
 	"context"
 	"time"
 
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/go-kit/kit/metrics"
 )
 

diff --git a/consumers/notifiers/api/transport.go b/consumers/notifiers/api/transport.go
@@ -10,10 +10,10 @@ import (
 	"net/http"
 	"strings"
 
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/absmach/supermq"
 	api "github.com/absmach/supermq/api/http"
 	apiutil "github.com/absmach/supermq/api/http/util"
-	"github.com/absmach/supermq/consumers/notifiers"
 	"github.com/absmach/supermq/pkg/errors"
 	"github.com/go-chi/chi/v5"
 	kithttp "github.com/go-kit/kit/transport/http"

diff --git a/consumers/notifiers/mocks/notifier.go b/consumers/notifiers/mocks/notifier.go
diff --git a/consumers/notifiers/mocks/repository.go b/consumers/notifiers/mocks/repository.go
diff --git a/consumers/notifiers/mocks/service.go b/consumers/notifiers/mocks/service.go
diff --git a/consumers/notifiers/postgres/subscriptions.go b/consumers/notifiers/postgres/subscriptions.go
@@ -9,7 +9,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/absmach/supermq/pkg/errors"
 	repoerr "github.com/absmach/supermq/pkg/errors/repository"
 	"github.com/jackc/pgerrcode"

diff --git a/consumers/notifiers/postgres/subscriptions_test.go b/consumers/notifiers/postgres/subscriptions_test.go
@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/absmach/magistrala/consumers/notifiers/postgres"
-	"github.com/absmach/supermq/consumers/notifiers"
 	"github.com/absmach/supermq/pkg/errors"
 	repoerr "github.com/absmach/supermq/pkg/errors/repository"
 	"github.com/stretchr/testify/assert"

diff --git a/consumers/notifiers/service.go b/consumers/notifiers/service.go
@@ -9,7 +9,6 @@ import (
 
 	"github.com/absmach/supermq"
 	"github.com/absmach/supermq/consumers"
-	notif "github.com/absmach/supermq/consumers/notifiers"
 	smqauthn "github.com/absmach/supermq/pkg/authn"
 	"github.com/absmach/supermq/pkg/errors"
 	svcerr "github.com/absmach/supermq/pkg/errors/service"
@@ -47,13 +46,13 @@ type notifierService struct {
 	authn    smqauthn.Authentication
 	subs     SubscriptionsRepository
 	idp      supermq.IDProvider
-	notifier notif.Notifier
+	notifier consumers.Notifier
 	errCh    chan error
 	from     string
 }
 
 // New instantiates the subscriptions service implementation.
-func New(authn smqauthn.Authentication, subs SubscriptionsRepository, idp supermq.IDProvider, notifier notif.Notifier, from string) Service {
+func New(authn smqauthn.Authentication, subs SubscriptionsRepository, idp supermq.IDProvider, notifier consumers.Notifier, from string) Service {
 	return &notifierService{
 		authn:    authn,
 		subs:     subs,
@@ -132,7 +131,7 @@ func (ns *notifierService) ConsumeBlocking(ctx context.Context, message interfac
 	if len(to) > 0 {
 		err := ns.notifier.Notify(ns.from, to, msg)
 		if err != nil {
-			return errors.Wrap(notif.ErrNotify, err)
+			return errors.Wrap(consumers.ErrNotify, err)
 		}
 	}
 
@@ -166,7 +165,7 @@ func (ns *notifierService) ConsumeAsync(ctx context.Context, message interface{}
 	}
 	if len(to) > 0 {
 		if err := ns.notifier.Notify(ns.from, to, msg); err != nil {
-			ns.errCh <- errors.Wrap(notif.ErrNotify, err)
+			ns.errCh <- errors.Wrap(consumers.ErrNotify, err)
 		}
 	}
 }

diff --git a/consumers/notifiers/service_test.go b/consumers/notifiers/service_test.go
@@ -8,9 +8,11 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"github.com/absmach/magistrala/consumers/notifiers/mocks"
 	"github.com/absmach/magistrala/internal/testsutil"
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/supermq/consumers"
+	smqmocks "github.com/absmach/supermq/consumers/mocks"
 	smqauthn "github.com/absmach/supermq/pkg/authn"
 	authnmocks "github.com/absmach/supermq/pkg/authn/mocks"
 	"github.com/absmach/supermq/pkg/errors"
@@ -32,7 +34,7 @@ const (
 func newService() (notifiers.Service, *authnmocks.Authentication, *mocks.SubscriptionsRepository) {
 	repo := new(mocks.SubscriptionsRepository)
 	auth := new(authnmocks.Authentication)
-	notifier := new(mocks.Notifier)
+	notifier := new(smqmocks.Notifier)
 	idp := uuid.NewMock()
 	from := "exampleFrom"
 	return notifiers.New(auth, repo, idp, notifier, from), auth, repo
@@ -346,7 +348,7 @@ func TestConsume(t *testing.T) {
 		{
 			desc: "test fail",
 			msg:  &errMsg,
-			err:  notifiers.ErrNotify,
+			err:  consumers.ErrNotify,
 		},
 	}
 

diff --git a/consumers/notifiers/smpp/notifier.go b/consumers/notifiers/smpp/notifier.go
@@ -6,7 +6,7 @@ package smpp
 import (
 	"time"
 
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/supermq/consumers"
 	"github.com/absmach/supermq/pkg/messaging"
 	"github.com/absmach/supermq/pkg/transformers"
 	"github.com/absmach/supermq/pkg/transformers/json"
@@ -15,7 +15,7 @@ import (
 	"github.com/fiorix/go-smpp/smpp/pdu/pdutext"
 )
 
-var _ notifiers.Notifier = (*notifier)(nil)
+var _ consumers.Notifier = (*notifier)(nil)
 
 type notifier struct {
 	transmitter   *smpp.Transmitter
@@ -27,7 +27,7 @@ type notifier struct {
 }
 
 // New instantiates SMTP message notifier.
-func New(cfg Config) notifiers.Notifier {
+func New(cfg Config) consumers.Notifier {
 	t := &smpp.Transmitter{
 		Addr:        cfg.Address,
 		User:        cfg.Username,

diff --git a/consumers/notifiers/smtp/notifier.go b/consumers/notifiers/smtp/notifier.go
@@ -7,7 +7,7 @@ import (
 	"fmt"
 
 	"github.com/absmach/magistrala/internal/email"
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/supermq/consumers"
 	"github.com/absmach/supermq/pkg/messaging"
 )
 
@@ -16,14 +16,14 @@ const (
 	contentTemplate = "A publisher with an id %s sent the message over %s with the following values \n %s"
 )
 
-var _ notifiers.Notifier = (*notifier)(nil)
+var _ consumers.Notifier = (*notifier)(nil)
 
 type notifier struct {
 	agent *email.Agent
 }
 
 // New instantiates SMTP message notifier.
-func New(agent *email.Agent) notifiers.Notifier {
+func New(agent *email.Agent) consumers.Notifier {
 	return &notifier{agent: agent}
 }
 

diff --git a/consumers/notifiers/tracing/subscriptions.go b/consumers/notifiers/tracing/subscriptions.go
@@ -8,7 +8,7 @@ package tracing
 import (
 	"context"
 
-	"github.com/absmach/supermq/consumers/notifiers"
+	"github.com/absmach/magistrala/consumers/notifiers"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/trace"
 )

diff --git a/go.mod b/go.mod
@@ -6,13 +6,12 @@ require (
 	github.com/0x6flab/namegenerator v1.4.0
 	github.com/absmach/callhome v0.14.0
 	github.com/absmach/certs v0.0.0-20241209153600-91270de67b5a
-	github.com/absmach/supermq v0.16.1-0.20250110085603-df5d752c4b50
+	github.com/absmach/supermq v0.16.1-0.20250113091433-3a11b54394b2
 	github.com/authzed/authzed-go v1.2.1
 	github.com/authzed/grpcutil v0.0.0-20240123194739-2ea1e3d2d98b
 	github.com/caarlos0/env/v11 v11.3.1
 	github.com/eclipse/paho.mqtt.golang v1.5.0
 	github.com/fiorix/go-smpp v0.0.0-20210403173735-2894b96e70ba
-	github.com/go-chi/chi v4.1.2+incompatible
 	github.com/go-chi/chi/v5 v5.2.0
 	github.com/go-kit/kit v0.13.0
 	github.com/gofrs/uuid/v5 v5.3.0
@@ -37,7 +36,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.33.0
 	golang.org/x/sync v0.10.0
 	gonum.org/v1/gonum v0.15.1
-	google.golang.org/grpc v1.69.2
+	google.golang.org/grpc v1.69.4
 	gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df
 	moul.io/http2curl v1.0.0
 )