care partner alerts

Makefile

@@ -236,7 +236,7 @@ ci-test-watch: ginkgo
 go-test:
 	. ./env.test.sh && $(TIMING_CMD) go test $(GOTEST_FLAGS) $(GOTEST_PKGS)
 
-go-ci-test: GOTEST_FLAGS += -count=1 -race -shuffle=on -cover
+go-ci-test: override GOTEST_FLAGS += -count=1 -race -shuffle=on -cover
 go-ci-test: GOTEST_PKGS = ./...
 go-ci-test: go-test
 

alerts/client.go

@@ -3,11 +3,12 @@ package alerts
 import (
 	"context"
 	"net/http"
+	"time"
 
 	"github.com/kelseyhightower/envconfig"
 
-	"github.com/tidepool-org/platform/auth"
 	"github.com/tidepool-org/platform/client"
+	"github.com/tidepool-org/platform/errors"
 	platformlog "github.com/tidepool-org/platform/log"
 	"github.com/tidepool-org/platform/log/null"
 	"github.com/tidepool-org/platform/platform"
@@ -16,22 +17,20 @@ import (
 
 // Client for managing alerts configs.
 type Client struct {
-	client        PlatformClient
-	logger        platformlog.Logger
-	tokenProvider auth.ServerSessionTokenProvider
+	client PlatformClient
+	logger platformlog.Logger
 }
 
 // NewClient builds a client for interacting with alerts API endpoints.
 //
 // If no logger is provided, a null logger is used.
-func NewClient(client PlatformClient, tokenProvider auth.ServerSessionTokenProvider, logger platformlog.Logger) *Client {
+func NewClient(client PlatformClient, logger platformlog.Logger) *Client {
 	if logger == nil {
 		logger = null.NewLogger()
 	}
 	return &Client{
-		client:        client,
-		logger:        logger,
-		tokenProvider: tokenProvider,
+		client: client,
+		logger: logger,
 	}
 }
 
@@ -44,34 +43,69 @@ type PlatformClient interface {
 
 // request performs common operations before passing a request off to the
 // underlying platform.Client.
-func (c *Client) request(ctx context.Context, method, url string, body any) error {
+func (c *Client) request(ctx context.Context, method, url string, reqBody, resBody any) error {
 	// Platform's client.Client expects a logger to exist in the request's
 	// context. If it doesn't exist, request processing will panic.
 	loggingCtx := platformlog.NewContextWithLogger(ctx, c.logger)
-	// Make sure the auth token is injected into the request's headers.
-	return c.requestWithAuth(loggingCtx, method, url, body)
-}
-
-// requestWithAuth injects an auth token before calling platform.Client.RequestData.
-//
-// At time of writing, this is the only way to inject credentials into
-// platform.Client. It might be nice to be able to use a mutator, but the auth
-// is specifically handled by the platform.Client via the context field, and
-// if left blank, platform.Client errors.
-func (c *Client) requestWithAuth(ctx context.Context, method, url string, body any) error {
-	return c.client.RequestData(auth.NewContextWithServerSessionTokenProvider(ctx, c.tokenProvider), method, url, nil, body, nil)
+	return c.client.RequestData(loggingCtx, method, url, nil, reqBody, resBody)
 }
 
 // Upsert updates cfg if it exists or creates it if it doesn't.
 func (c *Client) Upsert(ctx context.Context, cfg *Config) error {
 	url := c.client.ConstructURL("v1", "users", cfg.FollowedUserID, "followers", cfg.UserID, "alerts")
-	return c.request(ctx, http.MethodPost, url, cfg)
+	return c.request(ctx, http.MethodPost, url, cfg, nil)
 }
 
 // Delete the alerts config.
 func (c *Client) Delete(ctx context.Context, cfg *Config) error {
 	url := c.client.ConstructURL("v1", "users", cfg.FollowedUserID, "followers", cfg.UserID, "alerts")
-	return c.request(ctx, http.MethodDelete, url, nil)
+	return c.request(ctx, http.MethodDelete, url, nil, nil)
+}
+
+// Get a user's alerts configuration for the followed user.
+func (c *Client) Get(ctx context.Context, followedUserID, userID string) (*Config, error) {
+	url := c.client.ConstructURL("v1", "users", followedUserID, "followers", userID, "alerts")
+	config := &Config{}
+	err := c.request(ctx, http.MethodGet, url, nil, config)
+	if err != nil {
+		return nil, errors.Wrap(err, "Unable to request alerts config")
+	}
+	return config, nil
+}
+
+// List the alerts configurations that follow the given user.
+//
+// This method should only be called via an authenticated service session.
+func (c *Client) List(ctx context.Context, followedUserID string) ([]*Config, error) {
+	url := c.client.ConstructURL("v1", "users", followedUserID, "followers", "alerts")
+	configs := []*Config{}
+	err := c.request(ctx, http.MethodGet, url, nil, &configs)
+	if err != nil {
+		c.logger.Debugf("unable to request alerts configs list: %+v %T", err, err)
+		return nil, errors.Wrap(err, "Unable to request alerts configs list")
+	}
+	return configs, nil
+}
+
+// OverdueCommunications are those that haven't communicated in some time.
+//
+// This method should only be called via an authenticated service session.
+func (c *Client) OverdueCommunications(ctx context.Context) ([]LastCommunication, error) {
+	url := c.client.ConstructURL("v1", "overdue_communications")
+	lastComms := []LastCommunication{}
+	err := c.request(ctx, http.MethodGet, url, nil, &lastComms)
+	if err != nil {
+		c.logger.Debugf("getting users overdue to communicate: \"%+v\" %T", err, err)
+		return nil, errors.Wrap(err, "Unable to list overdue communications")
+	}
+	return lastComms, nil
+}
+
+// LastCommunication records the last time data was received from a user.
+type LastCommunication struct {
+	UserID                 string    `bson:"userId" json:"userId"`
+	DataSetID              string    `bson:"dataSetId" json:"dataSetId"`
+	LastReceivedDeviceData time.Time `bson:"lastReceivedDeviceData" json:"lastReceivedDeviceData"`
 }
 
 // ConfigLoader abstracts the method by which config values are loaded.

alerts/client_test.go

@@ -8,18 +8,20 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
-	"github.com/tidepool-org/platform/auth"
 	"github.com/tidepool-org/platform/client"
 	"github.com/tidepool-org/platform/log"
 	"github.com/tidepool-org/platform/log/null"
 	"github.com/tidepool-org/platform/platform"
 )
 
 const testToken = "auth-me"
+const testUserID = "test-user-id"
+const testFollowedUserID = "test-followed-user-id"
+const testDataSetID = "upid_000000000000"
 
 var _ = Describe("Client", func() {
-	var test404Server, test200Server *httptest.Server
-	var testAuthServer func(*string) *httptest.Server
+	var test404Server *httptest.Server
+	var test200Server func(string) *httptest.Server
 
 	BeforeEach(func() {
 		t := GinkgoT()
@@ -28,87 +30,118 @@ var _ = Describe("Client", func() {
 		test404Server = testServer(t, func(w http.ResponseWriter, r *http.Request) {
 			http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
 		})
-		test200Server = testServer(t, func(w http.ResponseWriter, r *http.Request) {
-			w.WriteHeader(http.StatusOK)
-		})
-		testAuthServer = func(token *string) *httptest.Server {
+		test200Server = func(resp string) *httptest.Server {
 			return testServer(t, func(w http.ResponseWriter, r *http.Request) {
-				*token = r.Header.Get(auth.TidepoolSessionTokenHeaderKey)
 				w.WriteHeader(http.StatusOK)
+				w.Write([]byte(resp))
 			})
 		}
 	})
 
-	Context("Delete", func() {
-		It("returns an error on non-200 responses", func() {
+	ItReturnsAnErrorOnNon200Responses := func(f func(context.Context, *Client) error) {
+		GinkgoHelper()
+		It("returns an error on non-200 respnoses", func() {
 			client, ctx := newAlertsClientTest(test404Server)
-			err := client.Delete(ctx, &Config{})
+			err := f(ctx, client)
 			Expect(err).Should(HaveOccurred())
 			Expect(err).To(MatchError(ContainSubstring("resource not found")))
 		})
+	}
 
-		It("returns nil on success", func() {
-			client, ctx := newAlertsClientTest(test200Server)
-			err := client.Delete(ctx, &Config{})
-			Expect(err).ShouldNot(HaveOccurred())
+	ItReturnsANilErrorOnSuccess := func(resp string, f func(context.Context, *Client) error) {
+		GinkgoHelper()
+		It("returns a nil error on success", func() {
+			client, ctx := newAlertsClientTest(test200Server(resp))
+			err := f(ctx, client)
+			Expect(err).To(Succeed())
+		})
+	}
+
+	Context("Delete", func() {
+		ItReturnsAnErrorOnNon200Responses(func(ctx context.Context, client *Client) error {
+			return client.Delete(ctx, &Config{})
 		})
 
-		It("injects an auth token", func() {
-			token := ""
-			client, ctx := newAlertsClientTest(testAuthServer(&token))
-			_ = client.Delete(ctx, &Config{})
-			Expect(token).To(Equal(testToken))
+		ItReturnsANilErrorOnSuccess("", func(ctx context.Context, client *Client) error {
+			return client.Delete(ctx, &Config{})
 		})
 	})
 
 	Context("Upsert", func() {
-		It("returns an error on non-200 responses", func() {
-			client, ctx := newAlertsClientTest(test404Server)
-			err := client.Upsert(ctx, &Config{})
-			Expect(err).Should(HaveOccurred())
-			Expect(err).To(MatchError(ContainSubstring("resource not found")))
+		ItReturnsAnErrorOnNon200Responses(func(ctx context.Context, client *Client) error {
+			return client.Upsert(ctx, &Config{})
+		})
+
+		ItReturnsANilErrorOnSuccess("", func(ctx context.Context, client *Client) error {
+			return client.Upsert(ctx, &Config{})
+		})
+	})
+
+	Context("Get", func() {
+		ItReturnsAnErrorOnNon200Responses(func(ctx context.Context, client *Client) error {
+			_, err := client.Get(ctx, testFollowedUserID, testUserID)
+			return err
 		})
 
-		It("returns nil on success", func() {
-			client, ctx := newAlertsClientTest(test200Server)
-			err := client.Upsert(ctx, &Config{})
-			Expect(err).ShouldNot(HaveOccurred())
+		ret := `{
+                  "userId": "14ee703f-ca9b-4a6b-9ce3-41d886514e7f",
+                  "followedUserId": "ce5863bc-cc0b-4177-97d7-e8de0c558820",
+                  "uploadId": "upid_00000000000000000000000000000000"
+                }`
+		ItReturnsANilErrorOnSuccess(ret, func(ctx context.Context, client *Client) error {
+			_, err := client.Get(ctx, testFollowedUserID, testUserID)
+			return err
 		})
+	})
 
-		It("injects an auth token", func() {
-			token := ""
-			client, ctx := newAlertsClientTest(testAuthServer(&token))
-			_ = client.Upsert(ctx, &Config{})
-			Expect(token).To(Equal(testToken))
+	Context("List", func() {
+		ItReturnsAnErrorOnNon200Responses(func(ctx context.Context, client *Client) error {
+			_, err := client.List(ctx, "")
+			return err
+		})
+
+		ItReturnsANilErrorOnSuccess("[]", func(ctx context.Context, client *Client) error {
+			_, err := client.List(ctx, "")
+			return err
+		})
+	})
+
+	Context("OverdueCommunications", func() {
+		ItReturnsAnErrorOnNon200Responses(func(ctx context.Context, client *Client) error {
+			_, err := client.OverdueCommunications(ctx)
+			return err
+		})
+
+		ItReturnsANilErrorOnSuccess("[]", func(ctx context.Context, client *Client) error {
+			_, err := client.OverdueCommunications(ctx)
+			return err
 		})
 	})
 })
 
 func buildTestClient(s *httptest.Server) *Client {
 	pCfg := &platform.Config{
-		Config: &client.Config{
-			Address: s.URL,
-		},
+		Config:        &client.Config{Address: s.URL},
+		ServiceSecret: "auth-me",
 	}
-	token := mockTokenProvider(testToken)
 	pc, err := platform.NewClient(pCfg, platform.AuthorizeAsService)
 	Expect(err).ToNot(HaveOccurred())
-	client := NewClient(pc, token, null.NewLogger())
+	client := NewClient(pc, null.NewLogger())
 	return client
 }
 
 func newAlertsClientTest(server *httptest.Server) (*Client, context.Context) {
 	return buildTestClient(server), contextWithNullLogger()
 }
 
-func contextWithNullLogger() context.Context {
-	return log.NewContextWithLogger(context.Background(), null.NewLogger())
+func contextWithNullLoggerDeluxe() (context.Context, log.Logger) {
+	lgr := null.NewLogger()
+	return log.NewContextWithLogger(context.Background(), lgr), lgr
 }
 
-type mockTokenProvider string
-
-func (p mockTokenProvider) ServerSessionToken() (string, error) {
-	return string(p), nil
+func contextWithNullLogger() context.Context {
+	ctx, _ := contextWithNullLoggerDeluxe()
+	return ctx
 }
 
 func testServer(t GinkgoTInterface, handler http.HandlerFunc) *httptest.Server {