[ Bugfix ] Satelite replication factor for shards information (#352)

Author: informalict

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## [master](https://github.com/arangodb/go-driver/tree/master) (N/A)
 - [V2] Add support for streaming the response body by the caller.
 - [V2] Bugfix with escaping the URL path twice.
+- Bugfix for the satellites' collection shard info.
+- [V2] Support for satellites' collections. 
 
 ## [1.2.1](https://github.com/arangodb/go-driver/tree/v1.2.1) (2021-09-21)
 - Add support for fetching shards' info by the given collection name.

collection.go

@@ -323,3 +323,75 @@ type CollectionShards struct {
 	// Available from 3.6 ArangoDB version.
 	WriteConcern int `json:"writeConcern,omitempty"`
 }
+
+type collectionShardsInternal struct {
+	CollectionInfo
+
+	// CacheEnabled set cacheEnabled option in collection properties
+	CacheEnabled bool `json:"cacheEnabled,omitempty"`
+
+	// Set to create a smart edge or vertex collection.
+	// This requires ArangoDB Enterprise Edition.
+	IsSmart bool `json:"isSmart,omitempty"`
+
+	KeyOptions struct {
+		// Type specifies the type of the key generator. The currently available generators are traditional and autoincrement.
+		Type KeyGeneratorType `json:"type,omitempty"`
+		// AllowUserKeys; if set to true, then it is allowed to supply own key values in the _key attribute of a document.
+		// If set to false, then the key generator is solely responsible for generating keys and supplying own key values in
+		// the _key attribute of documents is considered an error.
+		AllowUserKeys bool `json:"allowUserKeys,omitempty"`
+	} `json:"keyOptions,omitempty"`
+
+	// Deprecated: use 'WriteConcern' instead.
+	MinReplicationFactor int `json:"minReplicationFactor,omitempty"`
+
+	// NumberOfShards is the number of shards of the collection.
+	// Only available in cluster setup.
+	NumberOfShards int `json:"numberOfShards,omitempty"`
+
+	// This attribute specifies the name of the sharding strategy to use for the collection.
+	// Can not be changed after creation.
+	ShardingStrategy ShardingStrategy `json:"shardingStrategy,omitempty"`
+
+	// ShardKeys contains the names of document attributes that are used to determine the target shard for documents.
+	// Only available in cluster setup.
+	ShardKeys []string `json:"shardKeys,omitempty"`
+
+	// Shards is a list of shards that belong to the collection.
+	// Each shard contains a list of DB servers where the first one is the leader and the rest are followers.
+	Shards map[ShardID][]ServerID `json:"shards,omitempty"`
+
+	// StatusString represents status as a string.
+	StatusString string `json:"statusString,omitempty"`
+
+	// ReplicationFactor contains how many copies of each shard are kept on different DBServers.
+	// Only available in cluster setup.
+	ReplicationFactor replicationFactor `json:"replicationFactor,omitempty"`
+
+	// WaitForSync; If true then creating, changing or removing documents will wait
+	// until the data has been synchronized to disk.
+	WaitForSync bool `json:"waitForSync,omitempty"`
+
+	// WriteConcern contains how many copies must be available before a collection can be written.
+	// It is required that 1 <= WriteConcern <= ReplicationFactor.
+	// Default is 1. Not available for satellite collections.
+	// Available from 3.6 ArangoDB version.
+	WriteConcern int `json:"writeConcern,omitempty"`
+}
+
+func (p *CollectionShards) fromInternal(i collectionShardsInternal) {
+	p.CollectionInfo = i.CollectionInfo
+	p.CacheEnabled = i.CacheEnabled
+	p.IsSmart = i.IsSmart
+	p.KeyOptions = i.KeyOptions
+	p.MinReplicationFactor = i.MinReplicationFactor
+	p.NumberOfShards = i.NumberOfShards
+	p.ShardingStrategy = i.ShardingStrategy
+	p.ShardKeys = i.ShardKeys
+	p.Shards = i.Shards
+	p.StatusString = i.StatusString
+	p.ReplicationFactor = int(i.ReplicationFactor)
+	p.WaitForSync = i.WaitForSync
+	p.WriteConcern = i.WriteConcern
+}

collection_impl.go

@@ -210,13 +210,15 @@ func (c *collection) Shards(ctx context.Context, details bool) (CollectionShards
 		return CollectionShards{}, WithStack(err)
 	}
 
-	shards := CollectionShards{}
-	if err := resp.ParseBody("", &shards); err != nil {
+	shardsInternal := collectionShardsInternal{}
+	if err := resp.ParseBody("", &shardsInternal); err != nil {
 		return CollectionShards{}, WithStack(err)
 	}
 
-	return shards, nil
+	var shards CollectionShards
+	shards.fromInternal(shardsInternal)
 
+	return shards, nil
 }
 
 // Load the collection into memory.

test/collection_test.go

@@ -1007,4 +1007,16 @@ func Test_CollectionShards(t *testing.T) {
 	assert.Equal(t, 2, shards.ReplicationFactor)
 	assert.Equal(t, false, shards.WaitForSync)
 	assert.Equal(t, 1, shards.WriteConcern)
+
+	t.Run("Satellite collection", func(t *testing.T) {
+		skipNoEnterprise(t)
+		col, err := db.CreateCollection(nil, "satellite", &driver.CreateCollectionOptions{
+			ReplicationFactor: driver.ReplicationFactorSatellite,
+		})
+		require.NoError(t, err)
+
+		shards, err := col.Shards(context.Background(), true)
+		require.NoError(t, err)
+		assert.Equal(t, driver.ReplicationFactorSatellite, shards.ReplicationFactor)
+	})
 }

v2/arangodb/client_database.go

@@ -66,7 +66,7 @@ type CreateDatabaseOptions struct {
 // CreateDatabaseDefaultOptions contains options that change defaults for collections
 type CreateDatabaseDefaultOptions struct {
 	// Default replication factor for collections in database
-	ReplicationFactor int `json:"replicationFactor,omitempty"`
+	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
 	// Default write concern for collections in database
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database

v2/arangodb/collection_opts.go

@@ -24,9 +24,19 @@
 package arangodb
 
 import (
+	"encoding/json"
+	"reflect"
 	"time"
 )
 
+type ReplicationFactor int
+
+const (
+	// ReplicationFactorSatellite represents a satellite collection's replication factor
+	ReplicationFactorSatellite       ReplicationFactor = -1
+	replicationFactorSatelliteString string            = "satellite"
+)
+
 // CollectionInfo contains basic information about a collection.
 type CollectionInfo struct {
 	// The identifier of the collection.
@@ -69,7 +79,7 @@ type CollectionExtendedInfo struct {
 	ShardKeys []string `json:"shardKeys,omitempty"`
 	// ReplicationFactor contains how many copies of each shard are kept on different DBServers.
 	// Only available in cluster setup.
-	ReplicationFactor int `json:"replicationFactor,omitempty"`
+	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
 	// WaitForSync; If true then creating, changing or removing documents will wait
 	// until the data has been synchronized to disk.
 	WaitForSync bool `json:"waitForSync,omitempty"`
@@ -104,11 +114,6 @@ type CollectionProperties struct {
 	Schema *CollectionSchemaOptions `json:"schema,omitempty"`
 }
 
-const (
-	// ReplicationFactorSatellite represents a satellite collection's replication factor
-	ReplicationFactorSatellite int = -1
-)
-
 // IsSatellite returns true if the collection is a satellite collection
 func (p *CollectionProperties) IsSatellite() bool {
 	return p.ReplicationFactor == ReplicationFactorSatellite
@@ -122,7 +127,7 @@ type SetCollectionPropertiesOptions struct {
 	JournalSize int64 `json:"journalSize,omitempty"`
 	// ReplicationFactor contains how many copies of each shard are kept on different DBServers.
 	// Only available in cluster setup.
-	ReplicationFactor int `json:"replicationFactor,omitempty"`
+	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
 	// Deprecated: use 'WriteConcern' instead
 	MinReplicationFactor int `json:"minReplicationFactor,omitempty"`
 	// WriteConcern contains how many copies must be available before a collection can be written.
@@ -234,3 +239,40 @@ type CollectionShards struct {
 	// StatusString represents status as a string.
 	StatusString string `json:"statusString,omitempty"`
 }
+
+// MarshalJSON marshals InventoryCollectionParameters to arangodb json representation
+func (r ReplicationFactor) MarshalJSON() ([]byte, error) {
+	var replicationFactor interface{}
+
+	if r == ReplicationFactorSatellite {
+		replicationFactor = replicationFactorSatelliteString
+	} else {
+		replicationFactor = int(r)
+	}
+
+	return json.Marshal(replicationFactor)
+}
+
+// UnmarshalJSON marshals InventoryCollectionParameters to arangodb json representation
+func (r *ReplicationFactor) UnmarshalJSON(d []byte) error {
+	var internal interface{}
+
+	if err := json.Unmarshal(d, &internal); err != nil {
+		return err
+	}
+
+	if i, ok := internal.(float64); ok {
+		*r = ReplicationFactor(i)
+		return nil
+	} else if str, ok := internal.(string); ok {
+		if ok && str == replicationFactorSatelliteString {
+			*r = ReplicationFactor(ReplicationFactorSatellite)
+			return nil
+		}
+	}
+
+	return &json.UnmarshalTypeError{
+		Value: string(d),
+		Type:  reflect.TypeOf(r).Elem(),
+	}
+}

v2/arangodb/database_collection_opts.go

@@ -32,7 +32,7 @@ type CreateCollectionOptions struct {
 	// Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas,
 	// before the write operation is reported successful. If a server fails, this is detected automatically
 	// and one of the servers holding copies take over, usually without an error being reported.
-	ReplicationFactor int `json:"replicationFactor,omitempty"`
+	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
 	// Deprecated: use 'WriteConcern' instead
 	MinReplicationFactor int `json:"minReplicationFactor,omitempty"`
 	// WriteConcern contains how many copies must be available before a collection can be written.

v2/arangodb/database_opts.go

@@ -33,7 +33,7 @@ type DatabaseInfo struct {
 	// If true then the database is the _system database.
 	IsSystem bool `json:"isSystem,omitempty"`
 	// Default replication factor for collections in database
-	ReplicationFactor int `json:"replicationFactor,omitempty"`
+	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
 	// Default write concern for collections in database
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database

v2/tests/database_collection_operations_test.go

@@ -39,8 +39,9 @@ import (
 func Test_CollectionShards(t *testing.T) {
 	requireClusterMode(t)
 
+	rf := arangodb.ReplicationFactor(2)
 	options := arangodb.CreateCollectionOptions{
-		ReplicationFactor: 2,
+		ReplicationFactor: rf,
 		NumberOfShards:    2,
 	}
 
@@ -70,10 +71,24 @@ func Test_CollectionShards(t *testing.T) {
 					leaders = append(leaders, dbServers[0])
 				}
 				assert.NotEqualf(t, leaders[0], leaders[1], "the leader shard can not be on the same server")
-				assert.Equal(t, 2, shards.ReplicationFactor)
+				assert.Equal(t, rf, shards.ReplicationFactor)
 				assert.Equal(t, false, shards.WaitForSync)
 				assert.Equal(t, 1, shards.WriteConcern)
 			})
+
+			version, err := client.Version(context.Background())
+			require.NoError(t, err)
+
+			if version.IsEnterprise() {
+				optionsSatellite := arangodb.CreateCollectionOptions{
+					ReplicationFactor: arangodb.ReplicationFactorSatellite,
+				}
+				WithCollection(t, db, &optionsSatellite, func(col arangodb.Collection) {
+					shards, err := col.Shards(context.Background(), true)
+					require.NoError(t, err)
+					assert.Equal(t, arangodb.ReplicationFactorSatellite, shards.ReplicationFactor)
+				})
+			}
 		})
 	})
 }