Add new SetHmacKeys API method

pkg/api/api.go

@@ -140,6 +140,10 @@ func (s *ApiServer) Unsubscribe(
 	return connect.NewResponse(&emptypb.Empty{}), nil
 }
 
+func (s *ApiServer) SubscribeWithMetadata(ctx context.Context, req *connect.Request[proto.SubscribeWithMetadataRequest]) (*connect.Response[emptypb.Empty], error) {
+	return nil, nil
+}
+
 func convertDeliveryMechanism(mechanism *proto.DeliveryMechanism) *interfaces.DeliveryMechanism {
 	if mechanism == nil {
 		return nil
@@ -152,3 +156,23 @@ func convertDeliveryMechanism(mechanism *proto.DeliveryMechanism) *interfaces.De
 		return &interfaces.DeliveryMechanism{Kind: interfaces.FCM, Token: fcmToken}
 	}
 }
+
+// func convertHmacUpdates(protoUpdates []*proto.Subscription_HmacKey) (interfaces.HmacUpdates, error) {
+// 	out := make(interfaces.HmacUpdates)
+// 	for _, update := range protoUpdates {
+// 		if update == nil {
+// 			continue
+// 		}
+// 		if _, exists := out[update.Topic]; exists {
+// 			return nil, fmt.Errorf("duplicate topic: %s", update.Topic)
+// 		}
+// 		for _, key := range update.HmacKey {
+// 			out[update.Topic] = append(out[update.Topic], interfaces.HmacKey{
+// 				ThirtyDayPeriodsSinceEpoch: int(key.ThirtyDayPeriodsSinceEpoch),
+// 				Key:                        key.Key,
+// 			})
+// 		}
+// 	}
+
+// 	return out, nil
+// }

pkg/db/migrations/20240229061721_add-hmac-keys.down.sql

@@ -0,0 +1,13 @@
+SET statement_timeout = 0;
+
+--bun:split
+
+DROP TABLE subscription_hmac_keys;
+
+--bun:split
+
+ALTER TABLE subscriptions DROP COLUMN is_silent;
+
+--bun:split
+
+DROP INDEX CONCURRENTLY IF EXISTS subscriptions_installation_id_topic_idx;

pkg/db/migrations/20240229061721_add-hmac-keys.up.sql

@@ -0,0 +1,21 @@
+SET statement_timeout = 0;
+
+--bun:split
+
+CREATE TABLE subscription_hmac_keys (
+    subscription_id INTEGER NOT NULL,
+    thirty_day_periods_since_epoch INTEGER NOT NULL,
+    created_at TIMESTAMPTZ DEFAULT NOW(),
+    updated_at TIMESTAMPTZ DEFAULT NOW(),
+    key BYTEA NOT NULL,
+    PRIMARY KEY (subscription_id, thirty_day_periods_since_epoch),
+    FOREIGN KEY (subscription_id) REFERENCES subscriptions(id) ON DELETE CASCADE
+);
+
+--bun:split
+
+ALTER TABLE subscriptions ADD COLUMN is_silent BOOLEAN DEFAULT FALSE;
+
+--bun:split
+
+CREATE UNIQUE INDEX CONCURRENTLY subscriptions_installation_id_topic_idx ON subscriptions (installation_id, topic);

pkg/db/models.go

@@ -31,9 +31,20 @@ type DeviceDeliveryMechanism struct {
 type Subscription struct {
 	bun.BaseModel `bun:"table:subscriptions"`
 
-	Id             int64     `bun:",pk,autoincrement"`
-	CreatedAt      time.Time `bun:"created_at,notnull,default:current_timestamp"`
-	InstallationId string    `bun:"installation_id,notnull"`
-	Topic          string    `bun:"topic,notnull"`
-	IsActive       bool      `bun:"is_active,notnull"`
+	Id             int64                   `bun:",pk,autoincrement"`
+	CreatedAt      time.Time               `bun:"created_at,notnull"`
+	InstallationId string                  `bun:"installation_id,notnull"`
+	Topic          string                  `bun:"topic,notnull"`
+	IsActive       bool                    `bun:"is_active,notnull"`
+	IsSilent       bool                    `bun:"is_silent,notnull"`
+	HmacKeys       []*SubscriptionHmacKeys `bun:"rel:has-many,join:id=subscription_id"`
+}
+
+type SubscriptionHmacKeys struct {
+	bun.BaseModel              `bun:"table:subscription_hmac_keys"`
+	SubscriptionId             int64     `bun:"subscription_id,notnull,pk"`
+	ThirtyDayPeriodsSinceEpoch int32     `bun:"thirty_day_periods_since_epoch,notnull,pk"`
+	Key                        []byte    `bun:"key,notnull,type:bytea"`
+	CreatedAt                  time.Time `bun:"created_at,notnull"`
+	UpdatedAt                  time.Time `bun:"updated_at,notnull,default:current_timestamp"`
 }

pkg/interfaces/interfaces.go

@@ -41,6 +41,8 @@ type Subscription struct {
 	InstallationId string
 	Topic          string
 	IsActive       bool
+	IsSilent       bool
+	HmacKey        *HmacKey
 }
 
 type SendRequest struct {
@@ -49,18 +51,36 @@ type SendRequest struct {
 	Message        *v1.Envelope
 }
 
+type HmacKey struct {
+	ThirtyDayPeriodsSinceEpoch int
+	Key                        []byte
+}
+
+type SubscriptionInput struct {
+	Topic    string
+	IsSilent bool
+	HmacKeys []HmacKey
+}
+
+type HmacUpdates map[string][]HmacKey
+
 // Pluggable Installation Service interface
+//
+//go:generate mockery --dir ../interfaces --name Installations --output ../../mocks --outpkg mocks
 type Installations interface {
 	Register(ctx context.Context, installation Installation) (*RegisterResponse, error)
 	Delete(ctx context.Context, installationId string) error
 	GetInstallations(ctx context.Context, installationIds []string) ([]Installation, error)
 }
 
 // This interface is not expected to be pluggable
+//
+//go:generate mockery --dir ../interfaces --name Subscriptions --output ../../mocks --outpkg mocks
 type Subscriptions interface {
 	Subscribe(ctx context.Context, installationId string, topics []string) error
 	Unsubscribe(ctx context.Context, installationId string, topics []string) error
-	GetSubscriptions(ctx context.Context, topic string) ([]Subscription, error)
+	GetSubscriptions(ctx context.Context, topic string, thirtyDayPeriod int) ([]Subscription, error)
+	SubscribeWithMetadata(ctx context.Context, installationId string, subscriptions []SubscriptionInput) error
 }
 
 // Pluggable interface for sending push notifications