Supports Grakn Core 1.8 (#298)

## What is the goal of this PR?
This PR introduces the changes required to support Grakn 1.8. Addinitially, users are now notified via an error notification, when they try to explain an inferred concept, whose corresponding rule definition contains at least one unassigned relation within the rule's `when` body.

This PR also marks the `1.3.0` release of Workbase.

## What are the changes implemented in this PR?
resolves #290

Following graknlabs/client-nodejs@b85668f
- added query option `{ explain: true }`
- `dataType` to `valueType`
- `datatype` to `value`
- `date` to `datetime`
- removing all references to `isImplicit`
- bump `client-nodejs` and `grakn-core` dependencies

Author: Soroush Saffari

VERSION

@@ -1 +1 @@
-1.2.10
+1.3.0

dependencies/graknlabs/dependencies.bzl

@@ -29,12 +29,12 @@ def graknlabs_grakn_core():
     git_repository(
         name = "graknlabs_grakn_core",
         remote = "https://github.com/graknlabs/grakn",
-        tag = "1.7.2", # sync-marker: do not remove this comment, this is used for sync-dependencies by @graknlabs_grakn_core
+        tag = "1.8.0", # sync-marker: do not remove this comment, this is used for sync-dependencies by @graknlabs_grakn_core
     )
 
 def graknlabs_client_nodejs():
     git_repository(
         name = "graknlabs_client_nodejs",
         remote = "https://github.com/graknlabs/client-nodejs",
-        tag = "1.7.0", # sync-marker: do not remove this comment, this is used for sync-dependencies by @graknlabs_client_nodejs
+        tag = "1.8.0", # sync-marker: do not remove this comment, this is used for sync-dependencies by @graknlabs_client_nodejs
     )

package.json

@@ -51,7 +51,7 @@
         "@blueprintjs/table": "^3.1.1",
         "codemirror": "^5.38.0",
         "electron-store": "^1.3.0",
-        "grakn-client": "1.7.0",
+        "grakn-client": "1.8.0",
         "grpc": "^1.18.0",
         "hex-to-hsl": "^1.0.2",
         "image-data-uri": "^1.1.1",
@@ -165,5 +165,5 @@
         "prebuild": "node version.js",
         "unit": "node ./node_modules/jest/bin/jest.js ./test/unit"
     },
-    "version": "1.2.10"
+    "version": "1.3.0"
 }

src/renderer/components/SchemaDesign/LeftBar/NewAttributePanel.vue

@@ -24,12 +24,12 @@
         <div class="row">
           <div class="data-type-options">
             <div class="list-label">data type</div>
-            <div v-if="superType === 'attribute'" class="btn data-type-btn" :class="(showDataTypeList) ? 'type-list-shown' : ''" @click="toggleDataList"><div class="type-btn-text" >{{dataType}}</div><div class="type-btn-caret"><vue-icon className="vue-icon" icon="caret-down"></vue-icon></div></div>
-            <div v-else class="inherited-data-type">{{dataType}}</div>
+            <div v-if="superType === 'attribute'" class="btn data-type-btn" :class="(showDataTypeList) ? 'type-list-shown' : ''" @click="toggleDataList"><div class="type-btn-text" >{{valueType}}</div><div class="type-btn-caret"><vue-icon className="vue-icon" icon="caret-down"></vue-icon></div></div>
+            <div v-else class="inherited-data-type">{{valueType}}</div>
 
             <div class="data-type-list" v-show="showDataTypeList">
-                <ul v-for="type in dataTypes" :key=type>
-                    <li class="type-item" @click="selectDataType(type)" :class="[(type === dataType) ? 'type-item-selected' : '']">{{type}}</li>
+                <ul v-for="type in valueTypes" :key=type>
+                    <li class="type-item" @click="selectDataType(type)" :class="[(type === valueType) ? 'type-item-selected' : '']">{{type}}</li>
                 </ul>
             </div>
           </div> 
@@ -371,8 +371,8 @@
         superTypes: [],
         superType: undefined,
         showDataTypeList: false,
-        dataTypes: ['string', 'long', 'double', 'boolean', 'date'],
-        dataType: undefined,
+        valueTypes: ['string', 'long', 'double', 'boolean', 'datetime'],
+        valueType: undefined,
         showSpinner: false,
         toggledAttributeTypes: [],
         toggledRoleTypes: [],
@@ -411,15 +411,15 @@
         if (val !== 'attribute') { // if super type is not 'attribute' set data type of super type
           const graknTx = await this[OPEN_GRAKN_TX]();
           const attributeType = await graknTx.getSchemaConcept(val);
-          this.dataType = (await attributeType.dataType()).toLowerCase();
+          this.valueType = (await attributeType.valueType()).toLowerCase();
           this.showDataTypeList = false;
 
           const sup = await graknTx.getSchemaConcept(val);
           this.supAttributes = await Promise.all((await (await sup.attributes()).collect()).map(async x => x.label()));
           this.hasAttributes = this.hasAttributes.filter(x => !this.supAttributes.includes(x));
           graknTx.close();
         } else {
-          this.dataType = this.dataTypes[0];
+          this.valueType = this.valueTypes[0];
 
           this.hasAttributes = this.metaTypeInstances.attributes;
           this.supAttributes = [];
@@ -433,7 +433,7 @@
         } else {
           this.showSpinner = true;
           this[DEFINE_ATTRIBUTE_TYPE]({
-            attributeLabel: this.attributeLabel, superType: this.superType, dataType: this.dataType, attributeTypes: this.toggledAttributeTypes, roleTypes: this.toggledRoleTypes,
+            attributeLabel: this.attributeLabel, superType: this.superType, valueType: this.valueType, attributeTypes: this.toggledAttributeTypes, roleTypes: this.toggledRoleTypes,
           })
             .then(() => {
               this.showSpinner = false;
@@ -452,7 +452,7 @@
         this.showAttributeTypeList = false;
       },
       selectDataType(type) {
-        this.dataType = type;
+        this.valueType = type;
         this.showDataTypeList = false;
       },
       resetPanel() {
@@ -461,7 +461,7 @@
         this.showDataTypeList = false;
         this.superTypes = ['attribute', ...this.metaTypeInstances.attributes];
         this.superType = this.superTypes[0];
-        this.dataType = this.dataTypes[0];
+        this.valueType = this.valueTypes[0];
         this.toggledAttributeTypes = [];
         this.toggledRoleTypes = [];
         this.showHasPanel = false;

src/renderer/components/SchemaDesign/RightBar/ConceptInfoTab/AttributesPanel.vue

@@ -12,7 +12,7 @@
 
                 <div v-for="(value, index) in attributes" :key="index">
                     <div class="content-item">
-                        <div class="label">{{value.type}}: {{value.dataType}}</div>
+                        <div class="label">{{value.type}}: {{value.valueType}}</div>
                         <div class="btn right-bar-btn reset-setting-btn" @click="removeAttributeType(value.type, index)"><vue-icon icon="trash" className="vue-icon" iconSize="12"></vue-icon></div>
                     </div>
                 </div>

src/renderer/components/SchemaDesign/SchemaHandler.js

@@ -1,19 +1,19 @@
-import { dataType } from 'grakn-client';
+import { valueType } from 'grakn-client';
 
 let tx;
 
 function SchemaHandler(graknTx) {
   tx = graknTx;
 }
 
-function toGraknDatatype(dataTypeParam) {
-  switch (dataTypeParam) {
-    case 'string': return dataType.STRING;
-    case 'date': return dataType.DATETIME;
-    case 'boolean': return dataType.BOOLEAN;
-    case 'long': return dataType.LONG;
-    case 'double': return dataType.DOUBLE;
-    default: throw new Error(`Datatype not recognised. Received [${dataTypeParam}]`);
+function toGraknDatatype(valueTypeParam) {
+  switch (valueTypeParam) {
+    case 'string': return valueType.STRING;
+    case 'datetime': return valueType.DATETIME;
+    case 'boolean': return valueType.BOOLEAN;
+    case 'long': return valueType.LONG;
+    case 'double': return valueType.DOUBLE;
+    default: throw new Error(`Datatype not recognised. Received [${valueTypeParam}]`);
   }
 }
 
@@ -37,8 +37,8 @@ SchemaHandler.prototype.defineRelationType = async function define({ relationLab
   return type;
 };
 
-SchemaHandler.prototype.defineAttributeType = async function define({ attributeLabel, superType, dataType }) {
-  const type = await tx.putAttributeType(attributeLabel, toGraknDatatype(dataType));
+SchemaHandler.prototype.defineAttributeType = async function define({ attributeLabel, superType, valueType }) {
+  const type = await tx.putAttributeType(attributeLabel, toGraknDatatype(valueType));
   const directSuper = await tx.getSchemaConcept(superType);
   await type.sup(directSuper);
 };

src/renderer/components/SchemaDesign/SchemaUtils.js

@@ -27,15 +27,15 @@ export async function loadMetaTypeInstances(graknTx) {
     .then(labels => labels.filter(l => l !== 'entity')
       .concat()
       .sort());
-  metaTypeInstances.relations = await Promise.all(rels.map(async type => ((!await type.isImplicit()) ? type.label() : null)))
+  metaTypeInstances.relations = await Promise.all(rels.map(async type => type.label()))
     .then(labels => labels.filter(l => l && l !== 'relation')
       .concat()
       .sort());
   metaTypeInstances.attributes = await Promise.all(attributes.map(type => type.label()))
     .then(labels => labels.filter(l => l !== 'attribute')
       .concat()
       .sort());
-  metaTypeInstances.roles = await Promise.all(roles.map(async type => ((!await type.isImplicit()) ? type.label() : null)))
+  metaTypeInstances.roles = await Promise.all(roles.map(async type => type.label()))
     .then(labels => labels.filter(l => l && l !== 'role')
       .concat()
       .sort());
@@ -47,7 +47,7 @@ export async function computeAttributes(nodes, graknTx) {
   return Promise.all(nodes.map(async (node) => {
     const concept = await graknTx.getSchemaConcept(node.label);
     const attributes = await (await concept.attributes()).collect();
-    node.attributes = await Promise.all(attributes.map(async concept => ({ type: await concept.label(), dataType: await concept.dataType() })));
+    node.attributes = await Promise.all(attributes.map(async concept => ({ type: await concept.label(), valueType: await concept.valueType() })));
     return node;
   }));
 }
@@ -57,7 +57,7 @@ export async function computeRoles(nodes, graknTx) {
   return Promise.all(nodes.map(async (node) => {
     const concept = await graknTx.getSchemaConcept(node.label);
     const roles = await (await concept.playing()).collect();
-    node.roles = await Promise.all(roles.map(async concept => ((await concept.isImplicit()) ? null : concept.label()))).then(nodes => nodes.filter(x => x));
+    node.roles = await Promise.all(roles.map(concept => concept.label())).then(nodes => nodes.filter(x => x));
     return node;
   }));
 }

src/renderer/components/Visualiser/TopBar/GraqlEditor/GraqlCodeMirror.js

@@ -7,7 +7,7 @@ CodeMirror.defineSimpleMode('graql', {
   start: [
     { regex: /#.*/, token: 'comment' },
     { regex: /".*?"/, token: 'string' },
-    { regex: /(match|insert|delete|select|isa|sub|plays|relates|datatype|abstract|has|value|id|of|limit|offset|order|by|compute|from|to|in|aggregate|label|get|using|where)(?![-a-zA-Z_0-9])/, // eslint-disable-line max-len
+    { regex: /(match|isa|isa!|sub|sub!|has|id|type|limit|offset|sort|asc|desc|get|compute|path|from|to)(?![-a-zA-Z_0-9])/, // eslint-disable-line max-len
       token: 'keyword' },
     { regex: /true|false/, token: 'number' },
     { regex: /\$[-a-zA-Z_0-9]+/, token: 'variable' },

src/renderer/components/Visualiser/VisualiserUtils.js

@@ -87,15 +87,15 @@ export async function loadMetaTypeInstances(graknTx) {
     .then(labels => labels.filter(l => l !== 'entity')
       .concat()
       .sort());
-  metaTypeInstances.relations = await Promise.all(rels.map(async type => ((!await type.isImplicit()) ? type.label() : null)))
+  metaTypeInstances.relations = await Promise.all(rels.map(type => type.label()))
     .then(labels => labels.filter(l => l && l !== 'relation')
       .concat()
       .sort());
   metaTypeInstances.attributes = await Promise.all(attributes.map(type => type.label()))
     .then(labels => labels.filter(l => l !== 'attribute')
       .concat()
       .sort());
-  metaTypeInstances.roles = await Promise.all(roles.map(async type => ((!await type.isImplicit()) ? type.label() : null)))
+  metaTypeInstances.roles = await Promise.all(roles.map(type => type.label()))
     .then(labels => labels.filter(l => l && l !== 'role')
       .concat()
       .sort());
@@ -128,27 +128,6 @@ export function addResetGraphListener(dispatch, action) {
   });
 }
 
-/**
- * Checks if a ConceptMap inside the provided Answer contains at least one implicit concept
- * @param {Object} answer ConceptMap Answer to be inspected
- * @return {Boolean}
- */
-async function answerContainsImplicitType(answer) {
-  const concepts = Array.from(answer.map().values());
-  return Promise.all(concepts.map(async concept => ((concept.isThing()) ? (await concept.type()).isImplicit() : concept.isImplicit())))
-    .then(a => a.includes(true));
-}
-
-/**
- * Filters out Answers that contained inferred concepts in their ConceptMap
- * @param {Object[]} answers array of ConceptMap Answers to be inspected
- * @return {Object[]} filtered array of Answers
- */
-export async function filterMaps(answers) { // Filter out ConceptMaps that contain implicit relations
-  return Promise.all(answers.map(async x => ((await answerContainsImplicitType(x)) ? null : x)))
-    .then(maps => maps.filter(map => map));
-}
-
 /**
  * Executes query to load neighbours of given node and filters our all the answers that contain implicit concepts, given that we
  * don't want to show implicit concepts (relations to attributes) to the user, for now.
@@ -159,11 +138,5 @@ export async function filterMaps(answers) { // Filter out ConceptMaps that conta
 export async function getFilteredNeighbourAnswers(node, graknTx, limit) {
   const query = getNeighboursQuery(node, limit);
   const resultAnswers = await (await graknTx.query(query)).collect();
-  const filteredResult = await filterMaps(resultAnswers);
-  if (resultAnswers.length !== filteredResult.length) {
-    const offsetDiff = resultAnswers.length - filteredResult.length;
-    node.offset += QuerySettings.getNeighboursLimit();
-    return filteredResult.concat(await getFilteredNeighbourAnswers(node, graknTx, offsetDiff));
-  }
   return resultAnswers;
 }

src/renderer/components/Visualiser/store/actions.js

@@ -117,7 +117,7 @@ export default {
       validateQuery(query);
       commit('loadingQuery', true);
       const graknTx = global.graknTx[rootState.activeTab];
-      const result = await (await graknTx.query(query)).collect();
+      const result = await (await graknTx.query(query, { explain: true })).collect();
       if (!result.length) {
         commit('loadingQuery', false);
         return null;
@@ -223,42 +223,62 @@ export default {
       const queryPattern = node.queryPattern;
       const queryPatternVariales = Array.from(new Set(queryPattern.match(/\$[^\s|)|;|,]*/g))).map(x => x.substring(1));
 
-      const explanationAnswers = (await node.explanation()).getAnswers();
-
-      const explanationPromises = [];
-      const explanationResult = [];
-
-      explanationAnswers.forEach((answer) => {
-        const answerVariabes = Array.from(answer.map().keys());
+      const explanation = await node.explanation();
 
-        const isJointExplanation = answerVariabes.every(variable => queryPatternVariales.includes(variable));
-        if (answer.hasExplanation() && isJointExplanation) {
-          explanationPromises.push(answer.explanation());
-        } else if (!isJointExplanation) {
-          explanationResult.push(answer);
+      const when = await (await explanation.getRule()).getWhen();
+      const relRegex = /(\$[^\s]*|;|{)(\s*?\(.*?\))/g;
+      let isRelUnassigned = false;
+      let relMatches = relRegex.exec(when);
+      while (relMatches) {
+        if (!relMatches[1].includes('$')) {
+          isRelUnassigned = true;
+          break;
         }
-      });
-
-      (await Promise.all(explanationPromises)).map(expl => expl.getAnswers()).reduce(collect, []).forEach((expl) => {
-        explanationResult.push(expl);
-      });
-
-      if (explanationResult.length > 0) {
-        const data = await CDB.buildInstances(explanationResult);
-        const rpData = await CDB.buildRPInstances(explanationResult, data, false, graknTx);
-        data.nodes.push(...rpData.nodes);
-        data.edges.push(...rpData.edges);
-
-        state.visFacade.addToCanvas(data);
-        commit('updateCanvasData');
-        const nodesWithAttributes = await computeAttributes(data.nodes, graknTx);
+        relMatches = relRegex.exec(when);
+      }
 
-        state.visFacade.updateNode(nodesWithAttributes);
-        const styledEdges = data.edges.map(edge => ({ ...edge, label: edge.hiddenLabel, ...state.visStyle.computeExplanationEdgeStyle() }));
-        state.visFacade.updateEdge(styledEdges);
-        commit('loadingQuery', false);
+      if (isRelUnassigned) {
+        commit(
+          'setGlobalErrorMsg',
+          'The rule `when` definition for this inferred concept contains at least one unassigned relation. At the moment explanation cannot be provided for such a rule.',
+        );
       } else {
-        commit('setGlobalErrorMsg', 'The transaction has been refreshed since the loading of this node and, as a result, the explaination is incomplete.');
+        const explanationAnswers = explanation.getAnswers();
+        const explanationPromises = [];
+        const explanationResult = [];
+
+        explanationAnswers.forEach((answer) => {
+          const answerVariabes = Array.from(answer.map().keys());
+
+          const isJointExplanation = answerVariabes.every(variable => queryPatternVariales.includes(variable));
+          if (answer.hasExplanation() && isJointExplanation) {
+            explanationPromises.push(answer.explanation());
+          } else if (!isJointExplanation) {
+            explanationResult.push(answer);
+          }
+        });
+
+        (await Promise.all(explanationPromises)).map(expl => expl.getAnswers()).reduce(collect, []).forEach((expl) => {
+          explanationResult.push(expl);
+        });
+
+        if (explanationResult.length > 0) {
+          const data = await CDB.buildInstances(explanationResult);
+          const rpData = await CDB.buildRPInstances(explanationResult, data, false, graknTx);
+          data.nodes.push(...rpData.nodes);
+          data.edges.push(...rpData.edges);
+
+          state.visFacade.addToCanvas(data);
+          commit('updateCanvasData');
+          const nodesWithAttributes = await computeAttributes(data.nodes, graknTx);
+
+          state.visFacade.updateNode(nodesWithAttributes);
+          const styledEdges = data.edges.map(edge => ({ ...edge, label: edge.hiddenLabel, ...state.visStyle.computeExplanationEdgeStyle() }));
+          state.visFacade.updateEdge(styledEdges);
+          commit('loadingQuery', false);
+        } else {
+          commit('setGlobalErrorMsg', 'The transaction has been refreshed since the loading of this node and, as a result, the explaination is incomplete.');
+        }
       }
     } catch (e) {
       await reopenTransaction(rootState, commit);