fixup! snapshot-service: persistent Condition storage

plgd-dev · May 17, 2024 · 02a9ec7 · 02a9ec7
1 parent 82c7726
commit 02a9ec7
Show file tree

Hide file tree

Showing 15 changed files with 323 additions and 89 deletions.
diff --git a/certificate-authority/store/mongodb/store.go b/certificate-authority/store/mongodb/store.go
@@ -10,6 +10,7 @@ import (
 	pkgMongo "github.com/plgd-dev/hub/v2/pkg/mongodb"
 	"github.com/plgd-dev/hub/v2/pkg/security/certManager/client"
 	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
 	"go.opentelemetry.io/otel/trace"
 )
 
@@ -18,18 +19,18 @@ type Store struct {
 	bulkWriter *bulkWriter
 }
 
-var DeviceIDKeyQueryIndex = bson.D{
-	{Key: store.DeviceIDKey, Value: 1},
-	{Key: store.OwnerKey, Value: 1},
+var deviceIDKeyQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: store.DeviceIDKey, Value: 1},
+		{Key: store.OwnerKey, Value: 1},
+	},
 }
 
-var CommonNameKeyQueryIndex = bson.D{
-	{Key: store.CommonNameKey, Value: 1},
-	{Key: store.OwnerKey, Value: 1},
-}
-
-var PublicKeyQueryIndex = bson.D{
-	{Key: store.CommonNameKey, Value: 1},
+var commonNameKeyQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: store.CommonNameKey, Value: 1},
+		{Key: store.OwnerKey, Value: 1},
+	},
 }
 
 func New(ctx context.Context, cfg *Config, fileWatcher *fsnotify.Watcher, logger log.Logger, tracerProvider trace.TracerProvider) (*Store, error) {
@@ -44,7 +45,7 @@ func New(ctx context.Context, cfg *Config, fileWatcher *fsnotify.Watcher, logger
 	}
 	bulkWriter := newBulkWriter(m.Collection(signingRecordsCol), cfg.BulkWrite.DocumentLimit, cfg.BulkWrite.ThrottleTime, cfg.BulkWrite.Timeout, logger)
 	s := Store{Store: m, bulkWriter: bulkWriter}
-	err = s.EnsureIndex(ctx, signingRecordsCol, CommonNameKeyQueryIndex, DeviceIDKeyQueryIndex)
+	err = s.EnsureIndex(ctx, signingRecordsCol, commonNameKeyQueryIndex, deviceIDKeyQueryIndex)
 	if err != nil {
 		certManager.Close()
 		return nil, err

diff --git a/cloud2cloud-gateway/store/mongodb/subscription.go b/cloud2cloud-gateway/store/mongodb/subscription.go
@@ -21,24 +21,32 @@ const (
 	initializedKey     = "initialized"
 )
 
-var typeQueryIndex = bson.D{
-	{Key: typeKey, Value: 1},
+var typeQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: typeKey, Value: 1},
+	},
 }
 
-var typeDeviceIDQueryIndex = bson.D{
-	{Key: typeKey, Value: 1},
-	{Key: deviceIDKey, Value: 1},
+var typeDeviceIDQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: typeKey, Value: 1},
+		{Key: deviceIDKey, Value: 1},
+	},
 }
 
-var typeResourceIDQueryIndex = bson.D{
-	{Key: typeKey, Value: 1},
-	{Key: deviceIDKey, Value: 1},
-	{Key: hrefKey, Value: 1},
+var typeResourceIDQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: typeKey, Value: 1},
+		{Key: deviceIDKey, Value: 1},
+		{Key: hrefKey, Value: 1},
+	},
 }
 
-var typeInitializedIDQueryIndex = bson.D{
-	{Key: "_id", Value: 1},
-	{Key: initializedKey, Value: 1},
+var typeInitializedIDQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: "_id", Value: 1},
+		{Key: initializedKey, Value: 1},
+	},
 }
 
 type DBSub struct {
@@ -160,7 +168,7 @@ func (s *Store) SetInitialized(ctx context.Context, subscriptionID string) error
 	}
 
 	opts := &options.UpdateOptions{}
-	opts.SetHint(typeInitializedIDQueryIndex)
+	opts.SetHint(typeInitializedIDQueryIndex.Keys)
 	_, err := col.UpdateOne(ctx, bson.D{{Key: "_id", Value: subscriptionID}, {Key: initializedKey, Value: false}}, bson.M{"$set": bson.M{initializedKey: true}}, opts)
 	if err != nil {
 		return fmt.Errorf("cannot set initialized for %v: %w", subscriptionID, err)
@@ -201,22 +209,22 @@ func (s *Store) LoadSubscriptions(ctx context.Context, query store.SubscriptionQ
 			hrefKey:     query.Href,
 		}
 		iter, err = col.Find(ctx, q, &options.FindOptions{
-			Hint: typeResourceIDQueryIndex,
+			Hint: typeResourceIDQueryIndex.Keys,
 		})
 	case query.DeviceID != "":
 		q := bson.M{
 			typeKey:     query.Type,
 			deviceIDKey: query.DeviceID,
 		}
 		iter, err = col.Find(ctx, q, &options.FindOptions{
-			Hint: typeDeviceIDQueryIndex,
+			Hint: typeDeviceIDQueryIndex.Keys,
 		})
 	default:
 		q := bson.M{
 			typeKey: query.Type,
 		}
 		iter, err = col.Find(ctx, q, &options.FindOptions{
-			Hint: typeQueryIndex,
+			Hint: typeQueryIndex.Keys,
 		})
 	}
 	if errors.Is(err, mongo.ErrNilDocument) {

diff --git a/identity-store/persistence/mongodb/persist.go b/identity-store/persistence/mongodb/persist.go
@@ -48,7 +48,7 @@ func (p *PersistenceTx) Retrieve(deviceID, userID string) (_ *persistence.Author
 
 	col := p.tx.Client().Database(p.dbname).Collection(userDevicesCName)
 	iter, err := col.Find(p.ctx, bson.M{deviceIDKey: deviceID, ownerKey: userID}, &options.FindOptions{
-		Hint: userDeviceQueryIndex,
+		Hint: userDeviceQueryIndex.Keys,
 	})
 
 	if errors.Is(err, mongo.ErrNilDocument) {
@@ -113,7 +113,7 @@ func (p *PersistenceTx) RetrieveByOwner(owner string) persistence.Iterator {
 
 	col := p.tx.Client().Database(p.dbname).Collection(userDevicesCName)
 	iter, err := col.Find(p.ctx, bson.M{ownerKey: owner}, &options.FindOptions{
-		Hint: userDevicesQueryIndex,
+		Hint: userDevicesQueryIndex.Keys,
 	})
 
 	if errors.Is(err, mongo.ErrNilDocument) {

diff --git a/identity-store/persistence/mongodb/store.go b/identity-store/persistence/mongodb/store.go
@@ -9,18 +9,23 @@ import (
 	pkgMongo "github.com/plgd-dev/hub/v2/pkg/mongodb"
 	"github.com/plgd-dev/hub/v2/pkg/security/certManager/client"
 	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
 	"go.opentelemetry.io/otel/trace"
 )
 
 const userDevicesCName = "userdevices"
 
-var userDeviceQueryIndex = bson.D{
-	{Key: ownerKey, Value: 1},
-	{Key: deviceIDKey, Value: 1},
+var userDeviceQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: ownerKey, Value: 1},
+		{Key: deviceIDKey, Value: 1},
+	},
 }
 
-var userDevicesQueryIndex = bson.D{
-	{Key: ownerKey, Value: 1},
+var userDevicesQueryIndex = mongo.IndexModel{
+	Keys: bson.D{
+		{Key: ownerKey, Value: 1},
+	},
 }
 
 type Store struct {

diff --git a/pkg/mongodb/store.go b/pkg/mongodb/store.go
@@ -8,7 +8,6 @@ import (
 
 	"github.com/hashicorp/go-multierror"
 	"github.com/plgd-dev/hub/v2/pkg/fn"
-	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 	"go.mongodb.org/mongo-driver/mongo/readpref"
@@ -59,7 +58,7 @@ func NewStore(ctx context.Context, cfg *Config, tls *tls.Config, tracerProvider
 	return s, nil
 }
 
-func NewStoreWithCollection(ctx context.Context, cfg *Config, tls *tls.Config, tracerProvider trace.TracerProvider, collection string, indexes ...bson.D) (*Store, error) {
+func NewStoreWithCollection(ctx context.Context, cfg *Config, tls *tls.Config, tracerProvider trace.TracerProvider, collection string, indexes ...mongo.IndexModel) (*Store, error) {
 	s, err := NewStore(ctx, cfg, tls, tracerProvider)
 	if err != nil {
 		return nil, err
@@ -76,7 +75,7 @@ func NewStoreWithCollection(ctx context.Context, cfg *Config, tls *tls.Config, t
 	return s, nil
 }
 
-func (s *Store) EnsureIndex(ctx context.Context, collection string, indexes ...bson.D) error {
+func (s *Store) EnsureIndex(ctx context.Context, collection string, indexes ...mongo.IndexModel) error {
 	if len(indexes) == 0 {
 		return nil
 	}
@@ -87,13 +86,8 @@ func (s *Store) EnsureIndex(ctx context.Context, collection string, indexes ...b
 	return nil
 }
 
-func ensureIndex(ctx context.Context, col *mongo.Collection, indexes ...bson.D) error {
-	for _, keys := range indexes {
-		opts := &options.IndexOptions{}
-		index := mongo.IndexModel{
-			Keys:    keys,
-			Options: opts,
-		}
+func ensureIndex(ctx context.Context, col *mongo.Collection, indexes ...mongo.IndexModel) error {
+	for _, index := range indexes {
 		_, err := col.Indexes().CreateOne(ctx, index)
 		if err != nil {
 			if strings.HasPrefix(err.Error(), "(IndexKeySpecsConflict)") {

diff --git a/snapshot-service/pb/README.md b/snapshot-service/pb/README.md
@@ -102,16 +102,20 @@ driven by resource change event
 | ----- | ---- | ----- | ----------- |
 | id | [string](#string) |  | Unique condition ID
 
-@gotags: bson:&#34;_id&#34; |
+@gotags: bson:&#34;id&#34; |
 | version | [uint64](#uint64) |  | @gotags: bson:&#34;version&#34; |
 | name | [string](#string) |  | @gotags: bson:&#34;name,omitempty&#34; |
 | enabled | [bool](#bool) |  | @gotags: bson:&#34;enabled,omitempty&#34; |
 | configuration_id | [string](#string) |  | ID of the configuration to be applied when the condition is satisfied
 
 @gotags: bson:&#34;configurationId&#34; |
-| device_id_filter | [string](#string) | repeated | @gotags: bson:&#34;deviceIdFilter,omitempty&#34; |
+| device_id_filter | [string](#string) | repeated | list of device IDs to which the condition applies
+
+@gotags: bson:&#34;deviceIdFilter,omitempty&#34; |
 | resource_type_filter | [string](#string) | repeated | @gotags: bson:&#34;resourceTypeFilter,omitempty&#34; |
-| resource_href_filter | [string](#string) | repeated | @gotags: bson:&#34;resourceHrefFilter,omitempty&#34; |
+| resource_href_filter | [string](#string) | repeated | list of resource hrefs to which the condition applies
+
+@gotags: bson:&#34;resourceHrefFilter,omitempty&#34; |
 | jq_expression_filter | [string](#string) |  | @gotags: bson:&#34;jqExpressionFilter,omitempty&#34; |
 | api_access_token | [string](#string) |  | Token used to update resources in the configuration
 

diff --git a/snapshot-service/pb/doc.html b/snapshot-service/pb/doc.html
@@ -430,7 +430,7 @@ <h3 id="snapshotservice.pb.Condition">Condition</h3>
                   <td></td>
                   <td><p>Unique condition ID
 
-@gotags: bson:&#34;_id&#34; </p></td>
+@gotags: bson:&#34;id&#34; </p></td>
                 </tr>
 
                 <tr>
@@ -467,7 +467,9 @@ <h3 id="snapshotservice.pb.Condition">Condition</h3>
                   <td>device_id_filter</td>
                   <td><a href="#string">string</a></td>
                   <td>repeated</td>
-                  <td><p>@gotags: bson:&#34;deviceIdFilter,omitempty&#34; </p></td>
+                  <td><p>list of device IDs to which the condition applies
+
+@gotags: bson:&#34;deviceIdFilter,omitempty&#34; </p></td>
                 </tr>
 
                 <tr>
@@ -481,7 +483,9 @@ <h3 id="snapshotservice.pb.Condition">Condition</h3>
                   <td>resource_href_filter</td>
                   <td><a href="#string">string</a></td>
                   <td>repeated</td>
-                  <td><p>@gotags: bson:&#34;resourceHrefFilter,omitempty&#34; </p></td>
+                  <td><p>list of resource hrefs to which the condition applies
+
+@gotags: bson:&#34;resourceHrefFilter,omitempty&#34; </p></td>
                 </tr>
 
                 <tr>

diff --git a/snapshot-service/pb/service.pb.go b/snapshot-service/pb/service.pb.go
diff --git a/snapshot-service/pb/service.proto b/snapshot-service/pb/service.proto
@@ -50,14 +50,16 @@ message IDFilter {
 
 message Condition { // driven by resource change event
   // Unique condition ID
-  string id = 1; // @gotags: bson:"_id"
+  string id = 1; // @gotags: bson:"id"
   uint64 version = 2; // @gotags: bson:"version"
   string name = 3; // @gotags: bson:"name,omitempty"
   bool enabled = 4; // @gotags: bson:"enabled,omitempty"
   // ID of the configuration to be applied when the condition is satisfied
   string configuration_id = 5; // @gotags: bson:"configurationId"
+  // list of device IDs to which the condition applies
   repeated string device_id_filter = 6; // @gotags: bson:"deviceIdFilter,omitempty"
   repeated string resource_type_filter = 7; // @gotags: bson:"resourceTypeFilter,omitempty"
+  // list of resource hrefs to which the condition applies
   repeated string resource_href_filter = 8; // @gotags: bson:"resourceHrefFilter,omitempty"
   string jq_expression_filter = 9; // @gotags: bson:"jqExpressionFilter,omitempty"
   // Token used to update resources in the configuration

diff --git a/snapshot-service/pb/service.swagger.json b/snapshot-service/pb/service.swagger.json
@@ -132,7 +132,7 @@
         "parameters": [
           {
             "name": "id",
-            "description": "Unique condition ID\n\n@gotags: bson:\"_id\"",
+            "description": "Unique condition ID\n\n@gotags: bson:\"id\"",
             "in": "path",
             "required": true,
             "type": "string"
@@ -472,7 +472,8 @@
           "items": {
             "type": "string"
           },
-          "title": "@gotags: bson:\"deviceIdFilter,omitempty\""
+          "description": "@gotags: bson:\"deviceIdFilter,omitempty\"",
+          "title": "list of device IDs to which the condition applies"
         },
         "resourceTypeFilter": {
           "type": "array",
@@ -486,7 +487,8 @@
           "items": {
             "type": "string"
           },
-          "title": "@gotags: bson:\"resourceHrefFilter,omitempty\""
+          "description": "@gotags: bson:\"resourceHrefFilter,omitempty\"",
+          "title": "list of resource hrefs to which the condition applies"
         },
         "jqExpressionFilter": {
           "type": "string",
@@ -617,7 +619,7 @@
       "properties": {
         "id": {
           "type": "string",
-          "description": "@gotags: bson:\"_id\"",
+          "description": "@gotags: bson:\"id\"",
           "title": "Unique condition ID"
         },
         "version": {
@@ -643,7 +645,8 @@
           "items": {
             "type": "string"
           },
-          "title": "@gotags: bson:\"deviceIdFilter,omitempty\""
+          "description": "@gotags: bson:\"deviceIdFilter,omitempty\"",
+          "title": "list of device IDs to which the condition applies"
         },
         "resourceTypeFilter": {
           "type": "array",
@@ -657,7 +660,8 @@
           "items": {
             "type": "string"
           },
-          "title": "@gotags: bson:\"resourceHrefFilter,omitempty\""
+          "description": "@gotags: bson:\"resourceHrefFilter,omitempty\"",
+          "title": "list of resource hrefs to which the condition applies"
         },
         "jqExpressionFilter": {
           "type": "string",

diff --git a/snapshot-service/store/condition.go b/snapshot-service/store/condition.go
@@ -5,8 +5,12 @@ import (
 )
 
 const (
-	DeviceIDFilterKey = "deviceIdFilter" // must match with pb.Condition.DeviceIdFilter tag
-	OwnerKey          = "owner"          // must match with pb.Condition.Owner tag
+	IDKey                 = "id"                 // must match with pb.Condition.Id tag
+	VersionKey            = "version"            // must match with pb.Condition.Version tag
+	DeviceIDFilterKey     = "deviceIdFilter"     // must match with pb.Condition.DeviceIdFilter tag
+	ResourceHrefFilterKey = "resourceHrefFilter" // must match with pb.Condition.ResourceHrefFilter tag
+	ResourceTypeFilterKey = "resourceTypeFilter" // must match with pb.Condition.ResourceTypeFilter tag
+	OwnerKey              = "owner"              // must match with pb.Condition.Owner tag
 )
 
 type Condition = pb.Condition