Adjust Views API

The tests are failing though.

Author: pluma

CHANGELOG.md

@@ -9,11 +9,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- Changed experimental Views API `ArangoSearchViewConsolidationType`
+- Changed Views API to match 3.4 GA implementation
 
-  This release updates the experimental support for the Views API to the version
-  implemented in the current ArangoDB 3.4 release candidate. Please note that this API
-  is still subject to change and may indeed still change until the 3.4.0 GA release.
+  This release updates the Views API to the version implemented in the final
+  ArangoDB 3.4 GA release. Please note that these changes may break code
+  written for earlier ArangoDB 3.4 release candidates.
 
 ### Added
 

src/test/26-manipulating-views.ts

@@ -51,54 +51,38 @@ describe34("Manipulating views", function() {
   });
   describe("view.setProperties", () => {
     it("should change properties", async () => {
+      const initial = await view.properties();
+      expect(initial.cleanupIntervalStep).to.equal(10);
+      expect(initial.writebufferIdle).to.equal(64);
+      const oldProps = await view.setProperties({
+        cleanupIntervalStep: 20,
+        writebufferIdle: 48
+      });
+      expect(oldProps.cleanupIntervalStep).to.equal(20);
+      expect(oldProps.writebufferIdle).to.equal(48);
       const properties = await view.setProperties({
-        consolidationPolicy: {
-          type: "tier",
-          threshold: 0.123
-        }
+        writebufferIdle: 32
       });
-      expect(properties).to.have.property("name", view.name);
-      expect(properties).to.have.property("links");
-      expect(properties).to.have.property("consolidationPolicy");
-      expect(properties.consolidationPolicy).to.have.property("type", "tier");
-      expect(properties.consolidationPolicy).to.have.property("threshold");
-      expect(properties.consolidationPolicy.threshold.toFixed(3)).to.equal(
-        "0.123"
-      );
+      expect(properties.cleanupIntervalStep).to.equal(20);
+      expect(properties.writebufferIdle).to.equal(32);
     });
   });
   describe("view.replaceProperties", () => {
     it("should change properties", async () => {
       const initial = await view.properties();
-      expect(initial.consolidationPolicy).to.have.property("threshold");
-      const oldProps = await view.replaceProperties({
-        consolidationPolicy: {
-          type: "bytes_accum",
-          threshold: 0.123
-        }
+      expect(initial.cleanupIntervalStep).to.equal(10);
+      expect(initial.writebufferIdle).to.equal(64);
+      const oldProps = await view.setProperties({
+        cleanupIntervalStep: 20,
+        writebufferIdle: 48
       });
-      expect(oldProps.consolidationPolicy).to.have.property("threshold");
-      expect(oldProps.consolidationPolicy.threshold.toFixed(3)).to.equal(
-        "0.123"
-      );
-      expect(oldProps.consolidationPolicy).to.have.property(
-        "type",
-        "bytes_accum"
-      );
-      const properties = await view.replaceProperties({
-        consolidationPolicy: {
-          type: "tier",
-          threshold: 0.456
-        }
+      expect(oldProps.cleanupIntervalStep).to.equal(20);
+      expect(oldProps.writebufferIdle).to.equal(48);
+      const properties = await view.setProperties({
+        writebufferIdle: 32
       });
-      expect(properties).to.have.property("name", view.name);
-      expect(properties).to.have.property("links");
-      expect(properties).to.have.property("consolidationPolicy");
-      expect(properties.consolidationPolicy).to.have.property("type", "tier");
-      expect(properties.consolidationPolicy).to.have.property("threshold");
-      expect(properties.consolidationPolicy.threshold.toFixed(3)).to.equal(
-        "0.456"
-      );
+      expect(properties.cleanupIntervalStep).to.equal(10);
+      expect(properties.writebufferIdle).to.equal(32);
     });
   });
   describe("view.rename", () => {

src/view.ts

@@ -16,8 +16,6 @@ export interface ArangoViewResponse {
   type: ViewType;
 }
 
-type ArangoSearchViewConsolidationType = "bytes_accum" | "tier";
-
 interface ArangoSearchViewCollectionLink {
   analyzers?: string[];
   fields?: { [key: string]: ArangoSearchViewCollectionLink | undefined };
@@ -29,9 +27,17 @@ interface ArangoSearchViewCollectionLink {
 export interface ArangoSearchViewProperties {
   cleanupIntervalStep: number;
   consolidationIntervalMsec: number;
+  writebufferIdle: number;
+  writebufferActive: number;
+  writebufferSizeMax: number;
   consolidationPolicy: {
-    type: ArangoSearchViewConsolidationType;
-    threshold: number;
+    type: "bytes_accum" | "tier";
+    threshold?: number;
+    segments_min?: number;
+    segments_max?: number;
+    segments_bytes_max?: number;
+    segments_bytes_floor?: number;
+    lookahead?: number;
   };
   links: {
     [key: string]: ArangoSearchViewCollectionLink | undefined;
@@ -47,10 +53,22 @@ export interface ArangoSearchViewPropertiesResponse
 export interface ArangoSearchViewPropertiesOptions {
   cleanupIntervalStep?: number;
   consolidationIntervalMsec?: number;
-  consolidationPolicy?: {
-    type?: ArangoSearchViewConsolidationType;
-    threshold?: number;
-  };
+  writebufferIdle?: number;
+  writebufferActive?: number;
+  writebufferSizeMax?: number;
+  consolidationPolicy?:
+    | {
+        type: "bytes_accum";
+        threshold?: number;
+      }
+    | {
+        type: "tier";
+        lookahead?: number;
+        segments_min?: number;
+        segments_max?: number;
+        segments_bytes_max?: number;
+        segments_bytes_floor?: number;
+      };
   links?: {
     [key: string]: ArangoSearchViewCollectionLink | undefined;
   };