Add cache for ArangoSearchView Link and StoredValue types and primarySortCache for ArangoSearchView type (#449)

* Add `cache` for ArangoSearchView Link and StoredValue types and `primarySortCache` for ArangoSearchView type

* Add PrimaryKeyCache field support too, rework and refactor tests

* Adjust tests - cache properties are immutable. Allow running for 3.10.2 and newer versions

Author: nikita-vanyasin

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [master](https://github.com/arangodb/go-driver/tree/master) (N/A)
 - Add support for `checksum` in Collections
 - Fix reusing same connection with different Authentication parameters passed via driver.NewClient
+- Add `cache` for ArangoSearchView Link and StoredValue types and `primarySortCache`, `primaryKeyCache` for ArangoSearchView type
 
 ## [1.4.0](https://github.com/arangodb/go-driver/tree/v1.4.0) (2022-10-04)
 - Add `hex` property to analyzer's properties

test/arangosearch_analyzers_test.go

@@ -364,7 +364,7 @@ func TestArangoSearchAnalyzerEnsureAnalyzer(t *testing.T) {
 				if testCase.MaxVersion == nil {
 					skipBelowVersion(c, *testCase.MinVersion, t)
 				} else {
-					skipBetweenVersion(c, *testCase.MinVersion, *testCase.MaxVersion, t)
+					skipVersionNotInRange(c, *testCase.MinVersion, *testCase.MaxVersion, t)
 				}
 			}
 			if testCase.EnterpriseOnly {

test/client_test.go

@@ -93,9 +93,9 @@ func skipNoEnterprise(t *testing.T) {
 	}
 }
 
-// skipBetweenVersion skips the test if the current server version is less than
+// skipVersionNotInRange skips the test if the current server version is less than
 // the min version or higher/equal max version
-func skipBetweenVersion(c driver.Client, minVersion, maxVersion driver.Version, t *testing.T) driver.VersionInfo {
+func skipVersionNotInRange(c driver.Client, minVersion, maxVersion driver.Version, t *testing.T) driver.VersionInfo {
 	x, err := c.Version(nil)
 	if err != nil {
 		t.Fatalf("Failed to get version info: %s", describe(err))
@@ -109,6 +109,18 @@ func skipBetweenVersion(c driver.Client, minVersion, maxVersion driver.Version,
 	return x
 }
 
+// skipBetweenVersions skips test if DB version is in interval (close-ended)
+func skipBetweenVersions(c driver.Client, minVersion, maxVersion driver.Version, t *testing.T) driver.VersionInfo {
+	x, err := c.Version(nil)
+	if err != nil {
+		t.Fatalf("Failed to get version info: %s", describe(err))
+	}
+	if x.Version.CompareTo(minVersion) >= 0 && x.Version.CompareTo(maxVersion) <= 0 {
+		t.Skipf("Skipping between version '%s' and '%s': got version '%s'", minVersion, maxVersion, x.Version)
+	}
+	return x
+}
+
 // skipBelowVersion skips the test if the current server version is less than
 // the given version.
 func skipBelowVersion(c driver.Client, version driver.Version, t *testing.T) driver.VersionInfo {

test/view_test.go

@@ -80,21 +80,6 @@ func tryAddArangoSearchLink(ctx context.Context, db driver.Database, view driver
 	return checkLinkExists(ctx, view, colName, t)
 }
 
-// assertArangoSearchView is a helper to check if an arangosearch view exists and fail if it does not.
-func assertArangoSearchView(ctx context.Context, db driver.Database, name string, t *testing.T) driver.ArangoSearchView {
-	v, err := db.View(ctx, name)
-	if driver.IsNotFound(err) {
-		t.Fatalf("View '%s': does not exist", name)
-	} else if err != nil {
-		t.Fatalf("Failed to open view '%s': %s", name, describe(err))
-	}
-	result, err := v.ArangoSearchView()
-	if err != nil {
-		t.Fatalf("Failed to open view '%s' as arangosearch view: %s", name, describe(err))
-	}
-	return result
-}
-
 // TestCreateArangoSearchView creates an arangosearch view and then checks that it exists.
 func TestCreateArangoSearchView(t *testing.T) {
 	ctx := context.Background()
@@ -906,3 +891,97 @@ func TestArangoSearchViewProperties353(t *testing.T) {
 	require.EqualValues(t, analyzer.Properties.Case, driver.ArangoSearchCaseLower)
 	require.Equal(t, newBool(true), link.IncludeAllFields)
 }
+
+func TestArangoSearchViewLinkAndStoredValueCache(t *testing.T) {
+	ctx := context.Background()
+	c := createClientFromEnv(t, true)
+	// feature was introduced in 3.9.5 and in 3.10.2:
+	skipBelowVersion(c, "3.9.5", t)
+	skipBetweenVersions(c, "3.10.0", "3.10.1", t)
+	skipNoEnterprise(t)
+	db := ensureDatabase(ctx, c, "view_test_links_stored_value_cache", nil, t)
+	linkedColName := "linkedColumn"
+	ensureCollection(ctx, db, linkedColName, nil, t)
+	name := "test_create_asview"
+	opts := &driver.ArangoSearchViewProperties{
+		StoredValues: []driver.StoredValue{
+			{
+				Fields: []string{"f1", "f2"},
+				Cache:  newBool(true),
+			},
+		},
+		Links: driver.ArangoSearchLinks{
+			linkedColName: driver.ArangoSearchElementProperties{
+				Cache: newBool(false),
+			},
+		},
+	}
+	v, err := db.CreateArangoSearchView(ctx, name, opts)
+	require.NoError(t, err)
+
+	// check props
+	p, err := v.Properties(ctx)
+	require.NoError(t, err)
+	require.Len(t, p.StoredValues, 1)
+	require.Equal(t, newBool(true), p.StoredValues[0].Cache)
+	linkedColumnProps := p.Links[linkedColName]
+	require.NotNil(t, linkedColumnProps)
+	require.Nil(t, linkedColumnProps.Cache)
+	// update props: set to cached
+	p.Links[linkedColName] = driver.ArangoSearchElementProperties{Cache: newBool(true)}
+	err = v.SetProperties(ctx, p)
+	require.NoError(t, err)
+
+	// check updates applied
+	p, err = v.Properties(ctx)
+	require.NoError(t, err)
+	linkedColumnProps = p.Links[linkedColName]
+	require.NotNil(t, linkedColumnProps)
+	require.Equal(t, newBool(true), linkedColumnProps.Cache)
+}
+
+func TestArangoSearchViewInMemoryCache(t *testing.T) {
+	ctx := context.Background()
+	c := createClientFromEnv(t, true)
+
+	skipNoEnterprise(t)
+	db := ensureDatabase(ctx, c, "view_test_in_memory_cache", nil, t)
+
+	t.Run("primarySortCache", func(t *testing.T) {
+		// feature was introduced in 3.9.5 and in 3.10.2:
+		skipBelowVersion(c, "3.9.5", t)
+		skipBetweenVersions(c, "3.10.0", "3.10.1", t)
+
+		name := "test_create_asview"
+		opts := &driver.ArangoSearchViewProperties{
+			PrimarySortCache: newBool(true),
+		}
+		v, err := db.CreateArangoSearchView(ctx, name, opts)
+		require.NoError(t, err)
+
+		p, err := v.Properties(ctx)
+		require.NoError(t, err)
+		// bug in arangod: the primarySortCache field is not returned in response. Fixed only in 3.9.6+:
+		t.Run("must-be-returned-in-response", func(t *testing.T) {
+			skipBelowVersion(c, "3.9.6", t)
+			require.Equal(t, newBool(true), p.PrimarySortCache)
+		})
+	})
+
+	t.Run("primaryKeyCache", func(t *testing.T) {
+		// feature was introduced in 3.9.6 and 3.10.2:
+		skipBelowVersion(c, "3.9.6", t)
+		skipBetweenVersions(c, "3.10.0", "3.10.1", t)
+
+		name := "test_view_"
+		opts := &driver.ArangoSearchViewProperties{
+			PrimaryKeyCache: newBool(true),
+		}
+		v, err := db.CreateArangoSearchView(ctx, name, opts)
+		require.NoError(t, err)
+
+		p, err := v.Properties(ctx)
+		require.NoError(t, err)
+		require.Equal(t, newBool(true), p.PrimaryKeyCache)
+	})
+}

view_arangosearch.go

@@ -345,6 +345,16 @@ type ArangoSearchViewProperties struct {
 	// ArangoDB v3.5 and v3.6 always compress the index using LZ4. This option is immutable.
 	PrimarySortCompression PrimarySortCompression `json:"primarySortCompression,omitempty"`
 
+	// PrimarySortCache If you enable this option, then the primary sort columns are always cached in memory.
+	// Can't be changed after creating View.
+	// Introduced in v3.9.5, Enterprise Edition only
+	PrimarySortCache *bool `json:"primarySortCache,omitempty"`
+
+	// PrimaryKeyCache If you enable this option, then the primary key columns are always cached in memory.
+	// Introduced in v3.9.6, Enterprise Edition only
+	// Can't be changed after creating View.
+	PrimaryKeyCache *bool `json:"primaryKeyCache,omitempty"`
+
 	// StoredValues An array of objects to describe which document attributes to store in the View index (introduced in v3.7.1).
 	// It can then cover search queries, which means the data can be taken from the index directly and accessing the storage engine can be avoided.
 	// This option is immutable.
@@ -366,6 +376,9 @@ const (
 type StoredValue struct {
 	Fields      []string               `json:"fields,omitempty"`
 	Compression PrimarySortCompression `json:"compression,omitempty"`
+	// Cache attribute allows you to always cache stored values in memory
+	// Introduced in v3.9.5, Enterprise Edition only
+	Cache *bool `json:"cache,omitempty"`
 }
 
 // ArangoSearchSortDirection describes the sorting direction
@@ -479,6 +492,9 @@ type ArangoSearchElementProperties struct {
 	// so that it remains basically available. inBackground is an option that can be set when adding links.
 	// It does not get persisted as it is not a View property, but only a one-off option
 	InBackground *bool `json:"inBackground,omitempty"`
+	// Cache If you enable this option, then field normalization values are always cached in memory.
+	// Introduced in v3.9.5, Enterprise Edition only
+	Cache *bool `json:"cache,omitempty"`
 }
 
 // ArangoSearchStoreValues is the type of the StoreValues option of an ArangoSearch element.