Implement Fetch query (#796)

## What is the goal of this PR?

We update to the newest version of TypeDB Driver which supports Fetch
queries. As Fetch queries return a stream of JSONs, they are only
available in text output view, not as a graph.

For more details, see typedb/typeql#300

## What are the changes implemented in this PR?

Closes typedb/typedb#6921

Author: dmitrii-ubskii

WORKSPACE

@@ -103,6 +103,17 @@ unuseddeps_deps()
 load("@vaticle_dependencies//tool/common:deps.bzl", "vaticle_dependencies_ci_pip",
     vaticle_dependencies_tool_maven_artifacts = "maven_artifacts")
 
+# Load //tool/docs
+load("@vaticle_dependencies//tool/docs:python_deps.bzl", docs_deps = "deps")
+docs_deps()
+load("@vaticle_dependencies_tool_docs//:requirements.bzl", install_doc_deps = "install_deps")
+install_doc_deps()
+
+load("@vaticle_dependencies//tool/docs:java_deps.bzl", java_doc_deps = "deps")
+java_doc_deps()
+load("@google_bazel_common//:workspace_defs.bzl", "google_common_workspace_rules")
+google_common_workspace_rules()
+
 #####################################################################
 # Load @vaticle_bazel_distribution from (@vaticle_dependencies) #
 #####################################################################

dependencies/maven/artifacts.snapshot

@@ -137,6 +137,7 @@
 @maven//:org_jetbrains_skiko_skiko_awt_runtime_macos_arm64_0_7_34
 @maven//:org_jetbrains_skiko_skiko_awt_runtime_macos_x64_0_7_34
 @maven//:org_jetbrains_skiko_skiko_awt_runtime_windows_x64_0_7_34
+@maven//:org_jsoup_jsoup_1_16_1
 @maven//:org_mockito_mockito_core_2_6_4
 @maven//:org_objenesis_objenesis_2_5
 @maven//:org_slf4j_jcl_over_slf4j_2_0_0

dependencies/vaticle/artifacts.bzl

@@ -25,5 +25,5 @@ def vaticle_typedb_artifact():
         artifact_name = "typedb-server-{platform}-{version}.{ext}",
         tag_source = deployment["artifact.release"],
         commit_source = deployment["artifact.snapshot"],
-        commit = "f73907a60494228973cf3372b3eecb91770c90dd",
+        commit = "525ac0f5e072242c1d2f360379e9622397497ef2",
     )

dependencies/vaticle/repositories.bzl

@@ -28,7 +28,7 @@ def vaticle_dependencies():
     git_repository(
         name = "vaticle_dependencies",
         remote = "https://github.com/vaticle/dependencies",
-        commit = "fcc9a56b65e6ab69bbf0f1680affe38e12617ed6", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
+        commit = "adda846178ed799aca001cc9dfd7934cd4f805a8", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
     )
 
 def vaticle_force_graph():
@@ -48,6 +48,6 @@ def vaticle_typedb_common():
 def vaticle_typedb_driver():
     git_repository(
         name = "vaticle_typedb_driver",
-        remote = "https://github.com/vaticle/typedb-driver",
-        tag = "2.24.15",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_client_java
+        remote = "https://github.com/dmitrii-ubskii/typedb-driver",
+        tag = "2.25.0",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_client_java
     )

framework/graph/GraphBuilder.kt

@@ -171,7 +171,7 @@ class GraphBuilder(
     private fun renderEdges(type: Type, rendered: MutableMap<Vertex, Set<Pair<String, Vertex.Type>>>): Set<Pair<String, Vertex.Type>> {
         if (type.isRoot) return emptySet()
 
-        val superType = type.getSupertype(transactionState.transaction)!!
+        val superType = type.getSupertype(transactionState.transaction).resolve()!!
         if (!allTypeVertices.containsKey(type.label.name())) return renderEdges(superType, rendered)
 
         val typeVertex = allTypeVertices[type.label.name()]!!

framework/output/LogOutput.kt

@@ -28,8 +28,8 @@ import androidx.compose.ui.text.SpanStyle
 import androidx.compose.ui.unit.dp
 import com.vaticle.typedb.driver.api.answer.ConceptMap
 import com.vaticle.typedb.driver.api.answer.ConceptMapGroup
-import com.vaticle.typedb.driver.api.answer.Numeric
-import com.vaticle.typedb.driver.api.answer.NumericGroup
+import com.vaticle.typedb.driver.api.answer.JSON
+import com.vaticle.typedb.driver.api.answer.ValueGroup
 import com.vaticle.typedb.driver.api.concept.Concept
 import com.vaticle.typedb.driver.api.concept.thing.Attribute
 import com.vaticle.typedb.driver.api.concept.thing.Relation
@@ -144,7 +144,7 @@ internal class LogOutput constructor(
 
     internal fun outputFn(message: Response.Message): () -> Unit = { output(message.type, message.text) }
 
-    internal fun outputFn(numeric: Numeric): () -> Unit = { output(TYPEQL, numeric.toString()) }
+    internal fun outputFn(value: Value?): () -> Unit = { output(TYPEQL, printValue(value)) }
 
     internal fun outputFn(conceptMap: ConceptMap): () -> Unit {
         val output = loadToString(conceptMap)
@@ -156,8 +156,13 @@ internal class LogOutput constructor(
         return { output(TYPEQL, output) }
     }
 
-    internal fun outputFn(numericGroup: NumericGroup): () -> Unit {
-        val output = loadToString(numericGroup)
+    internal fun outputFn(valueGroup: ValueGroup): () -> Unit {
+        val output = loadToString(valueGroup)
+        return { output(TYPEQL, output) }
+    }
+
+    internal fun outputFn(json: JSON): () -> Unit {
+        val output = loadToString(json)
         return { output(TYPEQL, output) }
     }
 
@@ -185,10 +190,12 @@ internal class LogOutput constructor(
         return builder.toAnnotatedString()
     }
 
-    private fun loadToString(group: NumericGroup): String {
-        return loadToString(group.owner()) + " => " + group.numeric().asNumber()
+    private fun loadToString(group: ValueGroup): String {
+        return loadToString(group.owner()) + " => " + group.value().toString()
     }
 
+    private fun loadToString(json: JSON): String = json.toString()
+
     private fun loadToString(group: ConceptMapGroup): String {
         val str = StringBuilder(loadToString(group.owner()) + " => {\n")
         group.conceptMaps().forEach { str.append(Strings.indent(loadToString(it))) }
@@ -230,7 +237,7 @@ internal class LogOutput constructor(
     private fun printType(type: Type): String {
         var str = TypeQLToken.Constraint.TYPE.toString() + " " + type.label
         transactionState.transaction?.let {
-            type.getSupertype(it)?.let {
+            type.getSupertype(it).resolve()?.let {
                 str += " " + TypeQLToken.Constraint.SUB + " " + it.label.scopedName()
             }
         }
@@ -258,7 +265,7 @@ internal class LogOutput constructor(
         return "($rolePlayers)"
     }
 
-    private fun printValue(value: Value) = Strings.valueToString(value)
+    private fun printValue(value: Value?) = value?.let { Strings.valueToString(value) } ?: "NaN"
 
     @OptIn(ExperimentalComposeUiApi::class)
     @Composable

framework/output/RunOutputGroup.kt

@@ -32,7 +32,7 @@ import com.vaticle.typedb.studio.service.common.StatusService.Key.OUTPUT_RESPONS
 import com.vaticle.typedb.studio.service.common.StatusService.Key.QUERY_RESPONSE_TIME
 import com.vaticle.typedb.studio.service.connection.QueryRunner
 import com.vaticle.typedb.studio.service.connection.QueryRunner.Response
-import com.vaticle.typedb.studio.service.connection.QueryRunner.Response.Stream.ConceptMaps.Source.MATCH
+import com.vaticle.typedb.studio.service.connection.QueryRunner.Response.Stream.ConceptMaps.Source.GET
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.LinkedBlockingQueue
@@ -164,20 +164,21 @@ internal class RunOutputGroup constructor(
 
     private suspend fun consumeResponse(response: Response) = when (response) {
         is Response.Message -> consumeMessageResponse(response)
-        is Response.Numeric -> consumeNumericResponse(response)
+        is Response.Value -> consumeValueResponse(response)
         is Response.Stream<*> -> when (response) {
-            is Response.Stream.NumericGroups -> consumeNumericGroupStreamResponse(response)
+            is Response.Stream.ValueGroups -> consumeValueGroupStreamResponse(response)
             is Response.Stream.ConceptMapGroups -> consumeConceptMapGroupStreamResponse(response)
             is Response.Stream.ConceptMaps -> consumeConceptMapStreamResponse(response)
+            is Response.Stream.JSONs -> consumeJSONStreamResponse(response)
         }
         is Response.Done -> {}
     }
 
     private fun consumeMessageResponse(response: Response.Message) = collectSerial(logOutput.outputFn(response))
 
-    private fun consumeNumericResponse(response: Response.Numeric) = collectSerial(logOutput.outputFn(response.value))
+    private fun consumeValueResponse(response: Response.Value) = collectSerial(logOutput.outputFn(response.value))
 
-    private suspend fun consumeNumericGroupStreamResponse(response: Response.Stream.NumericGroups) {
+    private suspend fun consumeValueGroupStreamResponse(response: Response.Stream.ValueGroups) {
         consumeStreamResponse(response) {
             collectSerial(
                 launchCompletableFuture(
@@ -196,11 +197,11 @@ internal class RunOutputGroup constructor(
     private suspend fun consumeConceptMapStreamResponse(response: Response.Stream.ConceptMaps) {
         val notificationSrv = Service.notification
         // TODO: enable configuration of displaying GraphOutput for INSERT and UPDATE
-        val table = if (response.source != MATCH) null else TableOutput(
+        val table = if (response.source != GET) null else TableOutput(
             transaction = runner.transactionState, number = tableCount.incrementAndGet()
         ) // TODO: .also { outputs.add(it) }
         val graph =
-            if (response.source != MATCH || !Service.preference.graphOutputEnabled) null else GraphOutput(
+            if (response.source != GET || !Service.preference.graphOutputEnabled) null else GraphOutput(
                 transactionState = runner.transactionState, number = graphCount.incrementAndGet()
             ).also { outputs.add(it); activate(it) }
 
@@ -211,6 +212,10 @@ internal class RunOutputGroup constructor(
         }
     }
 
+    private suspend fun consumeJSONStreamResponse(response: Response.Stream.JSONs) = consumeStreamResponse(response) {
+        collectSerial(launchCompletableFuture(Service.notification, LOGGER) { logOutput.outputFn(it) })
+    }
+
     private suspend fun <T> consumeStreamResponse(
         stream: Response.Stream<T>,
         consumer: (T) -> Unit

module/preference/PreferenceDialog.kt

@@ -429,8 +429,8 @@ object PreferenceDialog {
                 private const val TRANSACTION_TIMEOUT_MINS_PLACEHOLDER = "5"
             }
 
-            private var matchQueryLimit = PreferenceField.TextInputValidated(
-                initValue = preferenceSrv.matchQueryLimit.toString(),
+            private var getQueryLimit = PreferenceField.TextInputValidated(
+                initValue = preferenceSrv.getQueryLimit.toString(),
                 label = SET_QUERY_LIMIT, placeholder = QUERY_LIMIT_PLACEHOLDER,
                 invalidWarning = Label.PREFERENCE_INTEGER_WARNING, caption = PREFERENCES_MATCH_QUERY_LIMIT_CAPTION
             ) {/* validator = */ it.toLongOrNull() != null && it.toLongOrNull()!! >= 0 }
@@ -445,19 +445,19 @@ object PreferenceDialog {
                 transactionTimeoutMins in 1..10000
             }
 
-            override val preferences: List<PreferenceField> = listOf(matchQueryLimit, transactionTimeoutMins)
+            override val preferences: List<PreferenceField> = listOf(getQueryLimit, transactionTimeoutMins)
 
             override fun submit() {
-                preferenceSrv.matchQueryLimit = matchQueryLimit.value.toLong()
+                preferenceSrv.getQueryLimit = getQueryLimit.value.toLong()
                 preferenceSrv.transactionTimeoutMins = transactionTimeoutMins.value.toLong()
-                matchQueryLimit.modified = false
+                getQueryLimit.modified = false
                 transactionTimeoutMins.modified = false
             }
 
             override fun reset() {
-                matchQueryLimit.value = preferenceSrv.matchQueryLimit.toString()
+                getQueryLimit.value = preferenceSrv.getQueryLimit.toString()
                 transactionTimeoutMins.value = preferenceSrv.transactionTimeoutMins.toString()
-                matchQueryLimit.modified = false
+                getQueryLimit.modified = false
                 transactionTimeoutMins.modified = false
             }
         }
@@ -566,4 +566,4 @@ object PreferenceDialog {
         Separator.Horizontal()
         ColumnSpacer()
     }
-}
+}

service/common/DataService.kt

@@ -113,7 +113,7 @@ class DataService {
             get() = properties?.getProperty(IGNORED_PATHS)?.split(',')?.map { it.trim() }
             set(value) = setProperty(IGNORED_PATHS, value!!.joinToString(","))
 
-        var matchQueryLimit: Long?
+        var getQueryLimit: Long?
             get() = properties?.getProperty(MATCH_QUERY_LIMIT)?.toLong()
             set(value) = setProperty(MATCH_QUERY_LIMIT, value!!.toString())
 

service/common/PreferenceService.kt

@@ -35,9 +35,9 @@ class PreferenceService(dataSrv: DataService) {
         get() = preferences.graphOutputEnabled ?: field
         set(value) = run { preferences.graphOutputEnabled = value }
 
-    var matchQueryLimit: Long = Defaults.matchQueryLimit
-        get() = preferences.matchQueryLimit ?: field
-        set(value) = run { preferences.matchQueryLimit = value }
+    var getQueryLimit: Long = Defaults.getQueryLimit
+        get() = preferences.getQueryLimit ?: field
+        set(value) = run { preferences.getQueryLimit = value }
 
     var transactionTimeoutMins: Long = Defaults.transactionTimeoutMins
         get() = preferences.transactionTimeoutMins ?: field
@@ -60,8 +60,8 @@ class PreferenceService(dataSrv: DataService) {
     private object Defaults {
         val autoSave = true
         val graphOutputEnabled = true
-        val matchQueryLimit = 1000L
+        val getQueryLimit = 1000L
         val ignoredPaths = listOf(".git")
         val transactionTimeoutMins = 60L
     }
-}
+}