Merge pull request #49 from weaviate/add-group-by-argument

aliszka · web-flow · commit 7e6eaf153c82 · 2023-05-05T16:18:00.000+02:00
Add support for groupBy argument
diff --git a/ci/docker-compose-azure-cc.yml b/ci/docker-compose-azure-cc.yml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     ports:
       - 8081:8081
     restart: on-failure:0
diff --git a/ci/docker-compose-cluster.yml b/ci/docker-compose-cluster.yml
@@ -2,7 +2,7 @@
 version: '3.4'
 services:
   weaviate-node-1:
-    image: semitechnologies/weaviate:preview-gql-handler-consistency-level-integration-4a12f55
+    image: semitechnologies/weaviate:1.19.0
     restart: on-failure:0
     ports:
       - "8087:8080"
@@ -25,7 +25,7 @@ services:
     - '8080'
     - --scheme
     - http
-    image: semitechnologies/weaviate:preview-gql-handler-consistency-level-integration-4a12f55
+    image: semitechnologies/weaviate:1.19.0
     ports:
     - 8088:8080
     - 6061:6060
@@ -38,7 +38,7 @@ services:
       PERSISTENCE_DATA_PATH: './weaviate-node-2'
       DEFAULT_VECTORIZER_MODULE: text2vec-contextionary
       ENABLE_MODULES: text2vec-contextionary
-      CLUSTER_HOSTNAME: 'node2' 
+      CLUSTER_HOSTNAME: 'node2'
       CLUSTER_GOSSIP_BIND_PORT: '7112'
       CLUSTER_DATA_BIND_PORT: '7113'
       CLUSTER_JOIN: 'weaviate-node-1:7110'
diff --git a/ci/docker-compose-okta-cc.yml b/ci/docker-compose-okta-cc.yml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     ports:
       - 8082:8082
     restart: on-failure:0
diff --git a/ci/docker-compose-okta-users.yml b/ci/docker-compose-okta-users.yml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     ports:
       - 8083:8083
     restart: on-failure:0
diff --git a/ci/docker-compose-openai.yml b/ci/docker-compose-openai.yml
@@ -9,7 +9,7 @@ services:
       - '8086'
       - --scheme
       - http
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     ports:
       - 8086:8086
     restart: on-failure:0
diff --git a/ci/docker-compose-wcs.yml b/ci/docker-compose-wcs.yml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     ports:
       - 8085:8085
     restart: on-failure:0
diff --git a/ci/docker-compose.yml b/ci/docker-compose.yml
@@ -2,7 +2,7 @@
 version: '3.4'
 services:
   weaviate:
-    image: semitechnologies/weaviate:1.18.2
+    image: semitechnologies/weaviate:1.19.0
     restart: on-failure:0
     ports:
       - "8080:8080"
@@ -17,7 +17,7 @@ services:
       CLUSTER_GOSSIP_BIND_PORT: "7100"
       CLUSTER_DATA_BIND_PORT: "7101"
   contextionary:
-    image: semitechnologies/contextionary:en0.16.0-v1.2.0
+    image: semitechnologies/contextionary:en0.16.0-v1.2.1
     ports:
       - "9999:9999"
     environment:
diff --git a/src/batch/journey.test.ts b/src/batch/journey.test.ts
@@ -359,7 +359,7 @@ describe('batch deleting', () => {
       .withClassName(thingClassName)
       .withWhere({
         operator: 'Equal',
-        valueString: 'bar1',
+        valueText: 'bar1',
         path: ['stringProp'],
       })
       .withDryRun(true)
@@ -373,7 +373,7 @@ describe('batch deleting', () => {
           where: {
             operands: null,
             operator: 'Equal',
-            valueString: 'bar1',
+            valueText: 'bar1',
             path: ['stringProp'],
           },
         });
@@ -397,7 +397,7 @@ describe('batch deleting', () => {
       .withClassName(otherThingClassName)
       .withWhere({
         operator: 'Like',
-        valueString: 'foo3',
+        valueText: 'foo3',
         path: ['stringProp'],
       })
       .withDryRun(true)
@@ -411,7 +411,7 @@ describe('batch deleting', () => {
           where: {
             operands: null,
             operator: 'Like',
-            valueString: 'foo3',
+            valueText: 'foo3',
             path: ['stringProp'],
           },
         });
@@ -430,7 +430,7 @@ describe('batch deleting', () => {
       .withClassName(otherThingClassName)
       .withWhere({
         operator: 'Equal',
-        valueString: 'doesNotExist',
+        valueText: 'doesNotExist',
         path: ['stringProp'],
       })
       .do()
@@ -442,7 +442,7 @@ describe('batch deleting', () => {
           where: {
             operands: null,
             operator: 'Equal',
-            valueString: 'doesNotExist',
+            valueText: 'doesNotExist',
             path: ['stringProp'],
           },
         });
@@ -462,7 +462,7 @@ describe('batch deleting', () => {
       .withClassName(otherThingClassName)
       .withWhere({
         operator: 'LessThan',
-        valueString: inAMinute,
+        valueText: inAMinute,
         path: ['_creationTimeUnix'],
       })
       .withOutput('verbose')
@@ -476,7 +476,7 @@ describe('batch deleting', () => {
           where: {
             operands: null,
             operator: 'LessThan',
-            valueString: inAMinute,
+            valueText: inAMinute,
             path: ['_creationTimeUnix'],
           },
         });
diff --git a/src/cluster/journey.test.ts b/src/cluster/journey.test.ts
@@ -7,8 +7,8 @@ const {
   SOUP_CLASS_NAME,
 } = require('../utils/testData');
 
-const EXPECTED_WEAVIATE_VERSION = '1.18.2';
-const EXPECTED_WEAVIATE_GIT_HASH = '723b88a';
+const EXPECTED_WEAVIATE_VERSION = '1.19.0';
+const EXPECTED_WEAVIATE_GIT_HASH = '48456a1';
 
 describe('cluster nodes endpoint', () => {
   const client = weaviate.client({
diff --git a/src/data/journey.test.ts b/src/data/journey.test.ts
@@ -45,7 +45,7 @@ describe('data', () => {
       .do()
       .catch((e: Error) => {
         expect(e.message).toEqual(
-          `usage error (422): {"error":[{"message":"invalid object: invalid string property 'stringProp' on class 'DataJourneyTestThing': not a string, but json.Number"}]}`
+          `usage error (422): {"error":[{"message":"invalid object: invalid text property 'stringProp' on class 'DataJourneyTestThing': not a string, but json.Number"}]}`
         );
       });
   });
diff --git a/src/graphql/getter.test.ts b/src/graphql/getter.test.ts
@@ -119,6 +119,23 @@ describe('where filters', () => {
       query: jest.fn(),
     };
 
+    const expectedQuery = `{Get{Person(where:{operator:Equal,valueText:"John Doe",path:["name"]}){name}}}`;
+    const where: WhereFilter = {
+      operator: 'Equal',
+      valueText: 'John Doe',
+      path: ['name'],
+    };
+
+    new Getter(mockClient).withClassName('Person').withFields('name').withWhere(where).do();
+
+    expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
+  });
+
+  test('a query with a deprecated valueString', () => {
+    const mockClient: any = {
+      query: jest.fn(),
+    };
+
     const expectedQuery = `{Get{Person(where:{operator:Equal,valueString:"John Doe",path:["name"]}){name}}}`;
     const where: WhereFilter = {
       operator: 'Equal',
@@ -1243,9 +1260,9 @@ describe('generative search', () => {
     new Getter(mockClient)
       .withClassName('Mammal')
       .withGenerate({
-        singlePrompt: `Which mammals 
-can survive 
-in Antarctica?`,
+        singlePrompt: `Which mammals
+ can survive
+ in Antarctica?`,
       })
       .withFields('name taxonomy')
       .do();
@@ -1278,14 +1295,14 @@ in Antarctica?`,
       .withClassName('Mammal')
       .withFields('name taxonomy')
       .withGenerate({
-        groupedTask: `Tell 
-me 
-about 
-how 
-polar 
-bears 
-keep 
-warm`,
+        groupedTask: `Tell
+ me
+ about
+ how
+ polar
+ bears
+ keep
+ warm`,
       })
       .do();
 
@@ -1311,3 +1328,22 @@ warm`,
     expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
   });
 });
+
+describe('groupBy valid searchers', () => {
+  const mockClient: any = {
+    query: jest.fn(),
+  };
+
+  test('valid groupBy', () => {
+    const groupByQuery = `(groupBy:{path:["property"],groups:2,objectsPerGroup:3})`;
+    const expectedQuery = `{Get{Person` + groupByQuery + `{name}}}`;
+
+    new Getter(mockClient)
+      .withClassName('Person')
+      .withFields('name')
+      .withGroupBy({ path: ['property'], groups: 2, objectsPerGroup: 3 })
+      .do();
+
+    expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
+  });
+});
diff --git a/src/graphql/getter.ts b/src/graphql/getter.ts
@@ -13,6 +13,7 @@ import { CommandBase } from '../validation/commandBase';
 import { WhereFilter } from '../openapi/types';
 import { GenerateArgs, GraphQLGenerate } from './generate';
 import { ConsistencyLevel } from '../data';
+import GroupBy, { GroupByArgs } from './groupBy';
 
 export default class GraphQLGetter extends CommandBase {
   private after?: string;
@@ -33,6 +34,7 @@ export default class GraphQLGetter extends CommandBase {
   private whereString?: string;
   private generateString?: string;
   private consistencyLevel?: ConsistencyLevel;
+  private groupByString?: string;
 
   constructor(client: Connection) {
     super(client);
@@ -183,6 +185,15 @@ export default class GraphQLGetter extends CommandBase {
     return this;
   };
 
+  withGroupBy = (args: GroupByArgs) => {
+    try {
+      this.groupByString = new GroupBy(args).toString();
+    } catch (e: any) {
+      this.addError(e.toString());
+    }
+    return this;
+  };
+
   validateIsSet = (prop: string | undefined | null, name: string, setter: string) => {
     if (prop == undefined || prop == null || prop.length == 0) {
       this.addError(`${name} must be set - set with ${setter}`);
@@ -267,6 +278,10 @@ export default class GraphQLGetter extends CommandBase {
       args = [...args, `consistencyLevel:${this.consistencyLevel}`];
     }
 
+    if (this.groupByString) {
+      args = [...args, `groupBy:${this.groupByString}`];
+    }
+
     if (args.length > 0) {
       params = `(${args.join(',')})`;
     }
diff --git a/src/graphql/groupBy.ts b/src/graphql/groupBy.ts
@@ -0,0 +1,31 @@
+export interface GroupByArgs {
+  path: string[];
+  groups: number;
+  objectsPerGroup: number;
+}
+
+export default class GraphQLGroupBy {
+  private args: GroupByArgs;
+
+  constructor(args: GroupByArgs) {
+    this.args = args;
+  }
+
+  toString() {
+    let parts: string[] = [];
+
+    if (this.args.path) {
+      parts = [...parts, `path:${JSON.stringify(this.args.path)}`];
+    }
+
+    if (this.args.groups) {
+      parts = [...parts, `groups:${this.args.groups}`];
+    }
+
+    if (this.args.objectsPerGroup) {
+      parts = [...parts, `objectsPerGroup:${this.args.objectsPerGroup}`];
+    }
+
+    return `{${parts.join(',')}}`;
+  }
+}
diff --git a/src/graphql/journey.test.ts b/src/graphql/journey.test.ts
diff --git a/src/openapi/schema.ts b/src/openapi/schema.ts
diff --git a/src/schema/journey.test.ts b/src/schema/journey.test.ts
