TypeDB Studio 2.4.0-alpha-3 (#477)

## What is the goal of this PR?

**Non-Debian Linux support**
- We've added a Java binary artifact (a gzipped shell runner) that runs on all Linux platforms. Please note that Java 11 must be installed in order to run it.

**Visualiser bugfixes**
- When there exist 2 (or more) edges between the same vertices, they are no longer superimposed, but are now rendered as curved edges
- `isa` edges are now displayed
- When dragging a roleplayer, its attributes and relations will now move with it
- Disconnected subgraphs are now less likely to be pushed far from the centre

**Concept Details bugfixes**
- Field values are now scrollable and selectable
- Internal ID is displayed correctly

**Other bugfixes**
- Fixed a possible crash on submitting the login form
- Fixed an issue causing code changes to be possibly ignored by the query runner

Author: alexjpwalker

.circleci/config.yml

@@ -22,7 +22,7 @@ commands:
 
   install-bazel-linux:
     steps:
-      - run: curl -OL https://raw.githubusercontent.com/graknlabs/dependencies/master/tool/bazelinstall/linux.sh
+      - run: curl -OL https://raw.githubusercontent.com/vaticle/dependencies/master/tool/bazelinstall/linux.sh
       - run: bash ./linux.sh && rm ./linux.sh
 
   install-bazel-mac:
@@ -82,9 +82,14 @@ jobs:
       - install-bazel-linux
       - checkout
       - run: bazel build //:application-image
+      - run: bazel build //:linux-java-binary
       - run: |
-          mkdir -p ~/src && cp bazel-bin/application-image.zip ~/src
-          mkdir -p ~/dist && cd ~/dist && jar xf ~/src/application-image.zip
+          mkdir -p ~/src
+          mkdir -p ~/dist
+          cp bazel-bin/typedb-studio-linux-java-binary.tar.gz ~/dist/typedb-studio-linux-java-binary-$(cat VERSION).tar.gz
+          cp bazel-bin/application-image.zip ~/src
+          cd ~/dist
+          jar xf ~/src/application-image.zip
       - persist_to_workspace:
           root: ~/dist
           paths:
@@ -133,7 +138,7 @@ jobs:
       image: ubuntu-1604:201903-01
     steps:
       - checkout
-      - run: git push --delete https://$REPO_GITHUB_TOKEN@github.com/graknlabs/workbase $CIRCLE_BRANCH
+      - run: git push --delete https://$REPO_GITHUB_TOKEN@github.com/vaticle/typedb-studio.git $CIRCLE_BRANCH
 
 workflows:
   release:

.grabl/automation.yml

@@ -31,6 +31,10 @@ build:
         # TODO: re-enable checkstyle tests
         # bazel run @vaticle_dependencies//tool/checkstyle:test-coverage
         # bazel test $(bazel query 'kind(checkstyle_test, //...)') --test_output=streamed
+    test-unit:
+      image: vaticle-ubuntu-20.04
+      command: |
+        bazel test //visualiser/...
 
 release:
 #  filter:

BUILD

@@ -27,31 +27,7 @@ load("@vaticle_bazel_distribution//github:rules.bzl", "deploy_github")
 load("@vaticle_bazel_distribution//brew:rules.bzl", "deploy_brew")
 load("@io_bazel_rules_kotlin//kotlin/internal:toolchains.bzl", "define_kt_toolchain")
 
-java_binary(
-    name = "hello",
-    srcs = ["Hello.java"],
-    main_class = "com.vaticle.typedb.studio.Hello",
-    deps = [
-#        "@maven//:org_jetbrains_compose_material_material_desktop",
-#        "@maven//:org_jetbrains_compose_material_material_icons_core_desktop"
-#        "@maven//:org_jetbrains_compose_ui_ui_desktop",
-    ],
-)
-
-java_deps(
-    name = "hello-deps",
-    target = ":hello",
-    java_deps_root = "lib/",
-    maven_name = False,
-)
 
-assemble_zip(
-    name = "hello-bundle",
-    targets = [":hello-deps"],
-    output_filename = "hello-assemble",
-)
-
-# TODO: If we remove some of these deps, IntelliJ starts to complain - we should investigate
 kt_jvm_library(
     name = "studio",
     srcs = ["main.kt"],
@@ -65,29 +41,12 @@ kt_jvm_library(
         "//workspace",
 
         # Maven
-#        "@maven//:androidx_annotation_annotation_1_2_0",
-#        "@maven//:androidx_annotation_annotation",
-#        "@maven//:org_jetbrains_annotations_13_0",
-#        "@maven//:org_jetbrains_annotations",
-#        "@maven//:org_jetbrains_compose_ui_ui_tooling_preview_desktop_1_0_0_alpha3",
-#        "@maven//:org_jetbrains_compose_desktop_desktop_jvm",
-#        "@maven//:org_jetbrains_compose_ui_ui_tooling_preview_desktop",
-#        "@maven//:org_jetbrains_compose_material_material_desktop",
-#        "@maven//:org_jetbrains_compose_material_material_ripple_desktop",
-#        "@maven//:org_jetbrains_compose_material_material_icons_core_desktop",
-#        "@maven//:org_jetbrains_compose_foundation_foundation_desktop",
-#        "@maven//:org_jetbrains_compose_animation_animation_desktop",
-#        "@maven//:org_jetbrains_compose_foundation_foundation_layout_desktop",
-#        "@maven//:org_jetbrains_compose_animation_animation_core_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_text_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_graphics_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_unit_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_geometry_desktop",
-#        "@maven//:org_jetbrains_compose_ui_ui_util_desktop",
-#        "@maven//:org_jetbrains_compose_runtime_runtime_saveable_desktop",
-#        "@maven//:org_jetbrains_compose_runtime_runtime_desktop",
-#        "@maven//:org_jetbrains_skiko_skiko_jvm",
+        # NOTE: These dependencies are not required to build the project, but IntelliJ needs them to offer autocompletion
+        "@maven//:org_jetbrains_compose_desktop_desktop_jvm",
+        "@maven//:org_jetbrains_compose_foundation_foundation_desktop",
+        "@maven//:org_jetbrains_compose_foundation_foundation_layout_desktop",
+        "@maven//:org_jetbrains_compose_ui_ui_desktop",
+        "@maven//:org_jetbrains_compose_ui_ui_geometry_desktop",
     ],
     resources = [
         "//resources:logback-xml",
@@ -198,6 +157,16 @@ jvm_application_image(
     mac_code_signing_cert = "@vaticle_apple_developer_id_application_cert//file",
 )
 
+# A little misleading. Because of the way our java_deps target is generated, this will actually produce a Mac runner
+# if built on Mac, and fail to produce anything useful if built on Windows.
+assemble_targz(
+    name = "linux-java-binary",
+    targets = [":application-image-deps", "//binary:assemble-bash-targz"],
+    additional_files = assemble_files,
+    output_filename = "typedb-studio-linux-java-binary",
+    visibility = ["//:__pkg__"]
+)
+
 deploy_github(
     name = "deploy-github",
     organisation = deployment_github['github.organisation'],

Hello.java

@@ -1 +1 @@
-2.4.0-alpha-2
+2.4.0-alpha-3

VERSION

@@ -0,0 +1,32 @@
+#
+# Copyright (C) 2021 Vaticle
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+
+load("@vaticle_bazel_distribution//common:rules.bzl", "assemble_targz")
+
+exports_files(["typedb-studio"])
+
+assemble_targz(
+    name = "assemble-bash-targz",
+    additional_files = {
+        "//binary:typedb-studio": 'typedb-studio',
+    },
+    permissions = {
+        "typedb-studio": "0755",
+    },
+    visibility = ["//visibility:public"]
+)

binary/BUILD

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+#
+# Copyright (C) 2021 Vaticle
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+# TypeDB Studio global variables
+JAVA_BIN=java
+if [[ ! -z "$JAVA_HOME" ]]; then
+    JAVA_BIN="$JAVA_HOME/bin/java"
+fi
+[[ $(readlink $0) ]] && path=$(readlink $0) || path=$0
+STUDIO_HOME=$(cd "$(dirname "${path}")" && pwd -P)
+
+# ================================================
+# common helper functions
+# ================================================
+exit_if_java_not_found() {
+    which "${JAVA_BIN}" > /dev/null
+    exit_code=$?
+
+    if [[ $exit_code -ne 0 ]]; then
+        echo "Java is not installed on this machine. TypeDB Studio needs Java 11+ in order to run."
+        exit 1
+    fi
+}
+
+# =============================================
+# main routine
+# =============================================
+
+exit_if_java_not_found
+
+LIB_DIR="${STUDIO_HOME}/lib"
+CLASSPATH="${LIB_DIR}/*"
+MAIN_CLASS=com.vaticle.typedb.studio.MainKt
+
+# exec replaces current shell process with java so no commands after this one will ever get executed
+exec $JAVA_BIN ${JAVAOPTS} -cp "${CLASSPATH}" ${MAIN_CLASS} "${@:1}"

binary/typedb-studio

@@ -15,15 +15,16 @@ import com.vaticle.typedb.client.api.connection.TypeDBTransaction
 import com.vaticle.typedb.client.api.connection.TypeDBTransaction.Type.READ
 import com.vaticle.typedb.client.api.logic.Explanation
 import com.vaticle.typedb.client.common.exception.TypeDBClientException
-import com.vaticle.typedb.studio.data.VertexEncoding.*
 import com.vaticle.typedb.studio.data.EdgeDirection.*
+import com.vaticle.typedb.studio.data.EdgeEncoding.*
+import com.vaticle.typedb.studio.data.VertexEncoding.*
 import com.vaticle.typeql.lang.TypeQL
 import com.vaticle.typeql.lang.TypeQL.match
-import java.lang.IllegalArgumentException
-import java.lang.IllegalStateException
+import com.vaticle.typeql.lang.query.TypeQLQuery
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.ConcurrentHashMap
 import java.util.concurrent.atomic.AtomicInteger
+import java.util.stream.Collectors
 import java.util.stream.Stream
 
 class DB(val client: DBClient, private val dbName: String) {
@@ -50,14 +51,14 @@ class DB(val client: DBClient, private val dbName: String) {
         CompletableFuture.allOf(*tasks.toTypedArray()).join()
     }
 
+    // TODO: The complexity of this function is too high - we should create some kind of ConceptMapLoader class
     private fun loadConceptMapAsync(conceptMap: ConceptMap, explanationID: Int? = null): CompletableFuture<Void> {
         val tasks: MutableList<CompletableFuture<Unit>> = mutableListOf()
         conceptMap.map().entries.parallelStream().forEach { (varName: String, concept: Concept) ->
             if (concept.isThing) {
                 val thing = concept.asThing()
                 val vertexID: Int = vertexGenerator.things.computeIfAbsent(thing.iid) {
                     val thingVertex: VertexData = vertexGenerator.generateVertex(thing)
-//                                    println("Added a thing! $thingVertex")
                     responseStream.putVertex(thingVertex)
                     try {
                         if (thing.isInferred) {
@@ -75,15 +76,27 @@ class DB(val client: DBClient, private val dbName: String) {
                         println(e.message)
                     }
 
+                    thing.type.let { type ->
+                        val typeNodeID = vertexGenerator.types[type.label.name()]
+                        if (typeNodeID != null) {
+                            responseStream.putEdge(EdgeData(id = vertexGenerator.nextID(), source = thingVertex.id,
+                                target = typeNodeID, encoding = ISA, label = "isa"))
+                        } else {
+                            incompleteTypeEdges.getOrPut(type.label.name()) { mutableListOf() }
+                                .add(IncompleteEdgeData(id = vertexGenerator.nextID(), vertexID = thingVertex.id,
+                                    direction = OUTGOING, encoding = ISA, label = "isa"))
+                        }
+                    }
+
                     tasks += LoadOwnedAttributesTask(thing, tx!!, thingVertex, vertexGenerator, responseStream, incompleteThingEdges).supplyAsync()
                     if (thing.isRelation) {
                         tasks += LoadRoleplayersTask(thing.asRelation().asRemote(tx), thingVertex, vertexGenerator, responseStream).supplyAsync()
                     }
 
                     incompleteThingEdges.remove(thing.iid)?.forEach {
                         val edgeData = when (it.direction) {
-                            INCOMING -> EdgeData(it.id, source = thingVertex.id, target = it.vertexID, it.label, it.inferred)
-                            OUTGOING -> EdgeData(it.id, source = it.vertexID, target = thingVertex.id, it.label, it.inferred)
+                            INCOMING -> EdgeData(it.id, source = thingVertex.id, target = it.vertexID, it.encoding, it.label, it.inferred)
+                            OUTGOING -> EdgeData(it.id, source = it.vertexID, target = thingVertex.id, it.encoding, it.label, it.inferred)
                         }
                         responseStream.putEdge(edgeData)
                     }
@@ -106,8 +119,8 @@ class DB(val client: DBClient, private val dbName: String) {
 
                     incompleteTypeEdges.remove(thingType.label.scopedName())?.forEach {
                         val edgeData = when (it.direction) {
-                            INCOMING -> EdgeData(it.id, source = typeVertex.id, target = it.vertexID, it.label, it.inferred)
-                            OUTGOING -> EdgeData(it.id, source = it.vertexID, target = typeVertex.id, it.label, it.inferred)
+                            INCOMING -> EdgeData(it.id, source = typeVertex.id, target = it.vertexID, it.encoding, it.label, it.inferred)
+                            OUTGOING -> EdgeData(it.id, source = it.vertexID, target = typeVertex.id, it.encoding, it.label, it.inferred)
                         }
                         responseStream.putEdge(edgeData)
                     }
@@ -136,6 +149,7 @@ class DB(val client: DBClient, private val dbName: String) {
             vertexGenerator = VertexGenerator()
             CompletableFuture.supplyAsync {
                 try {
+//                    TypeQL.parseQueries<TypeQLQuery>(query).collect(Collectors.toList())
                     loadAnswerStream(tx!!.query().match(query))
                     println("Completed query: $query")
                     responseStream.completed = true
@@ -186,10 +200,6 @@ class DB(val client: DBClient, private val dbName: String) {
         }
         return responseStream
     }
-
-    fun close() {
-        client.close()
-    }
 }
 
 class VertexGenerator(val things: ConcurrentHashMap<String, Int> = ConcurrentHashMap(),
@@ -267,7 +277,7 @@ private class LoadRoleplayersTask(private val relation: Relation.Remote, vertex:
                     return@computeIfAbsent vertex.id
                 }
                 responseStream.putEdge(EdgeData(id = vertexGenerator.nextID(), source = vertex.id, target = rolePlayerNodeID,
-                    label = rolePlayers.key.label.name(), inferred = relation.isInferred))
+                    encoding = ROLEPLAYER, label = rolePlayers.key.label.name(), inferred = relation.isInferred))
             }
         }
     }
@@ -287,11 +297,11 @@ private class LoadOwnedAttributesTask(private val thing: Thing, private val tx:
             val attributeNodeID = vertexGenerator.things[attribute.iid]
             if (attributeNodeID != null) {
                 responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = vertex.id, target = attributeNodeID,
-                    label = "has", inferred = isEdgeInferred))
+                    encoding = HAS, label = "has", inferred = isEdgeInferred))
             } else {
                 incompleteEdges.getOrPut(attribute.iid) { mutableListOf() }
                     .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = OUTGOING,
-                        label = "has", inferred = isEdgeInferred))
+                        encoding = HAS, label = "has", inferred = isEdgeInferred))
             }
         }
     }
@@ -306,10 +316,12 @@ private class LoadPlayableRolesTask(private val thingType: ThingType.Remote, ver
         thingType.plays.parallel().forEach { roleType ->
             val relationTypeNodeID = vertexGenerator.types[roleType.label.scope().get()]
             if (relationTypeNodeID != null) {
-                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = relationTypeNodeID, target = vertex.id, label = roleType.label.name()))
+                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = relationTypeNodeID,
+                    target = vertex.id, encoding = PLAYS, label = roleType.label.name()))
             } else {
                 incompleteEdges.getOrPut(roleType.label.scope().get()) { mutableListOf() }
-                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = INCOMING, label = roleType.label.name()))
+                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = INCOMING,
+                        encoding = PLAYS, label = roleType.label.name()))
             }
         }
     }
@@ -324,10 +336,12 @@ private class LoadOwnedAttributeTypesTask(private val thingType: ThingType.Remot
         thingType.owns.parallel().forEach { attributeType ->
             val attributeTypeNodeID = vertexGenerator.types[attributeType.label.name()]
             if (attributeTypeNodeID != null) {
-                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = vertex.id, target = attributeTypeNodeID, label = "owns"))
+                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = vertex.id,
+                    target = attributeTypeNodeID, encoding = OWNS, label = "owns"))
             } else {
                 incompleteEdges.getOrPut(attributeType.label.name()) { mutableListOf() }
-                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = OUTGOING, label = "owns"))
+                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = OUTGOING,
+                        encoding = OWNS, label = "owns"))
             }
         }
     }
@@ -342,10 +356,12 @@ private class LoadSupertypeTask(private val thingType: ThingType.Remote, vertex:
         thingType.supertype?.let { supertype ->
             val supertypeNodeID = vertexGenerator.types[supertype.label.name()]
             if (supertypeNodeID != null) {
-                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = vertex.id, target = supertypeNodeID, label = "sub"))
+                responseStream.putEdge(EdgeData(vertexGenerator.nextID(), source = vertex.id, target = supertypeNodeID,
+                    encoding = SUB, label = "sub"))
             } else {
                 incompleteEdges.getOrPut(supertype.label.name()) { mutableListOf() }
-                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = OUTGOING, label = "sub"))
+                    .add(IncompleteEdgeData(vertexGenerator.nextID(), vertexID = vertex.id, direction = OUTGOING,
+                        encoding = SUB, label = "sub"))
             }
         }
     }