Implement and test transaction timeouts (#244)

## What is the goal of this PR?

We implement options for transaction timeout configuration (typedb/typedb#6487). We also add BDD implementation for new steps required to test transaction timeout and configuring transaction options.

## What are the changes implemented in this PR?

* Add option for transaction timeout (default: 5 mins)
* drain and throw exceptions when the transaction is closed with un-received errors
* add missing BDD steps for session and transaction option configuration

Author: flyingsilverfin

.grabl/automation.yml

@@ -64,20 +64,20 @@ build:
         export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
         bazel run @vaticle_dependencies//distribution/artifact:create-netrc
         .grabl/test-core.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
-    test-behaviour-connection-cluster:
-      image: vaticle-ubuntu-21.04
-      type: foreground
-      command: |
-        pyenv global 3.6.10
-        pip3 install -U pip
-        pip install -r requirements_dev.txt
-        sudo unlink /usr/bin/python3
-        sudo ln -s $(which python3) /usr/bin/python3
-        sudo ln -s /usr/share/pyshared/lsb_release.py /opt/pyenv/versions/3.6.10/lib/python3.6/site-packages/lsb_release.py
-        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
-        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
-        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-        .grabl/test-cluster.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
+#    test-behaviour-connection-cluster:
+#      image: vaticle-ubuntu-21.04
+#      type: foreground
+#      command: |
+#        pyenv global 3.6.10
+#        pip3 install -U pip
+#        pip install -r requirements_dev.txt
+#        sudo unlink /usr/bin/python3
+#        sudo ln -s $(which python3) /usr/bin/python3
+#        sudo ln -s /usr/share/pyshared/lsb_release.py /opt/pyenv/versions/3.6.10/lib/python3.6/site-packages/lsb_release.py
+#        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
+#        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
+#        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
+#        .grabl/test-cluster.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
     test-behaviour-concept-core:
       image: vaticle-ubuntu-21.04
       type: foreground
@@ -121,21 +121,21 @@ build:
         bazel run @vaticle_dependencies//distribution/artifact:create-netrc
         .grabl/test-core.sh //tests/behaviour/typeql/language/match/... --test_output=errors
         .grabl/test-core.sh //tests/behaviour/typeql/language/get/... --test_output=errors
-    test-behaviour-match-cluster:
-      image: vaticle-ubuntu-21.04
-      type: foreground
-      command: |
-        pyenv global 3.6.10
-        pip3 install -U pip
-        pip install -r requirements_dev.txt
-        sudo unlink /usr/bin/python3
-        sudo ln -s $(which python3) /usr/bin/python3
-        sudo ln -s /usr/share/pyshared/lsb_release.py /opt/pyenv/versions/3.6.10/lib/python3.6/site-packages/lsb_release.py
-        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
-        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
-        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-        .grabl/test-cluster.sh //tests/behaviour/typeql/language/match/... --test_output=errors
-        .grabl/test-cluster.sh //tests/behaviour/typeql/language/get/... --test_output=errors
+#    test-behaviour-match-cluster:
+#      image: vaticle-ubuntu-21.04
+#      type: foreground
+#      command: |
+#        pyenv global 3.6.10
+#        pip3 install -U pip
+#        pip install -r requirements_dev.txt
+#        sudo unlink /usr/bin/python3
+#        sudo ln -s $(which python3) /usr/bin/python3
+#        sudo ln -s /usr/share/pyshared/lsb_release.py /opt/pyenv/versions/3.6.10/lib/python3.6/site-packages/lsb_release.py
+#        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
+#        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
+#        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
+#        .grabl/test-cluster.sh //tests/behaviour/typeql/language/match/... --test_output=errors
+#        .grabl/test-cluster.sh //tests/behaviour/typeql/language/get/... --test_output=errors
     test-behaviour-writable-core:
       image: vaticle-ubuntu-21.04
       type: foreground
@@ -217,9 +217,9 @@ build:
       image: vaticle-ubuntu-21.04
       dependencies: [
         build,
-        test-behaviour-connection-core, test-behaviour-connection-cluster,
+        test-behaviour-connection-core, #test-behaviour-connection-cluster,
         test-behaviour-concept-core, test-behaviour-concept-cluster,
-        test-behaviour-match-core, test-behaviour-match-cluster,
+        test-behaviour-match-core, #test-behaviour-match-cluster,
         test-behaviour-writable-core, test-behaviour-writable-cluster,
         test-behaviour-definable-core, test-behaviour-definable-cluster,
         test-failover-cluster

dependencies/vaticle/artifacts.bzl

@@ -29,7 +29,7 @@ def vaticle_typedb_artifacts():
         artifact_name = "typedb-server-{platform}-{version}.{ext}",
         tag_source = deployment["artifact.release"],
         commit_source = deployment["artifact.snapshot"],
-        commit = "6ed020e52fe379d1100f64511805ed344c7a68db",
+        commit = "2367157bdd898e474198726d0ef5446372a73314",
     )
 
 def vaticle_typedb_cluster_artifacts():

dependencies/vaticle/repositories.bzl

@@ -25,19 +25,19 @@ def vaticle_dependencies():
     git_repository(
         name = "vaticle_dependencies",
         remote = "https://github.com/vaticle/dependencies",
-        commit = "e1e21118201b71855927062fb67f267b54f71017",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
+        commit = "4d6ca1b6d7fe93e4c11b18aeba5d5889b928aadd",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
     )
 
 def vaticle_typedb_common():
     git_repository(
         name = "vaticle_typedb_common",
         remote = "https://github.com/vaticle/typedb-common",
-        tag = "2.5.0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
+        tag = "2.6.0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
     )
 
 def vaticle_typedb_behaviour():
     git_repository(
         name = "vaticle_typedb_behaviour",
         remote = "https://github.com/vaticle/typedb-behaviour",
-        commit = "042cbf2a6c3b8b9d7a8c3b8d74e796da968523fd" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
+        commit = "d92d840dd40cc8393936d6f6042820ebcd3a9cef" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
     )

requirements.txt

@@ -24,13 +24,14 @@
 
 ## Configuration options
 
+
 # Allow importing of snapshots
 --extra-index-url https://repo.vaticle.com/repository/pypi-snapshot/simple
 
 
 ## Dependencies
 
 # IMPORTANT: Any changes to these dependencies should be copied to requirements_dev.txt.
-typedb-protocol==2.5.0
-grpcio==1.38.0
+typedb-protocol==2.6.0
+grpcio==1.43.0
 protobuf==3.15.5

requirements_dev.txt

@@ -30,8 +30,8 @@
 
 ## Dependencies
 
-typedb-protocol==2.5.0
-grpcio==1.38.0
+typedb-protocol==2.6.0
+grpcio==1.43.0
 protobuf==3.15.5
 
 

tests/behaviour/background/cluster/environment.py

@@ -42,6 +42,9 @@ def before_scenario(context: Context, scenario):
             scenario.skip("tagged with @" + tag)
             return
     environment_base.before_scenario(context, scenario)
+    context.session_options = TypeDBOptions.cluster().set_infer(True)
+    context.transaction_options = TypeDBOptions.cluster().set_infer(True)
+
 
 
 def after_scenario(context: Context, scenario):

tests/behaviour/background/core/environment.py

@@ -38,7 +38,8 @@ def before_scenario(context: Context, scenario):
             scenario.skip("tagged with @" + tag)
             return
     environment_base.before_scenario(context, scenario)
-
+    context.session_options = TypeDBOptions.core().set_infer(True)
+    context.transaction_options = TypeDBOptions.core().set_infer(True)
 
 def after_scenario(context: Context, scenario):
     environment_base.after_scenario(context, scenario)

tests/behaviour/background/environment_base.py

@@ -46,6 +46,10 @@ def before_scenario(context: Context, scenario):
     context.put = lambda var, thing: _put_impl(context, var, thing)
     context.get_thing_type = lambda root_label, type_label: _get_thing_type_impl(context, root_label, type_label)
     context.clear_answers = lambda: _clear_answers_impl(context)
+    context.option_setters = {
+        "session-idle-timeout-millis": lambda option, value: option.set_session_idle_timeout_millis(int(value)),
+        "transaction-timeout-millis": lambda option, value: option.set_transaction_timeout_millis(int(value)),
+    }
 
 
 def _put_impl(context: Context, variable: str, thing: Thing):

tests/behaviour/connection/connection_steps.py

@@ -18,6 +18,7 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+from time import sleep
 
 from behave import *
 
@@ -32,3 +33,8 @@ def step_impl(context: Context):
 @step("connection does not have any database")
 def step_impl(context: Context):
     assert len(context.client.databases().all()) == 0
+
+
+@step("wait {seconds} seconds")
+def step_impl(context: Context, seconds: str):
+    sleep(float(seconds))

tests/behaviour/connection/session/session_steps.py

@@ -35,9 +35,9 @@
 DATA = SessionType.DATA
 
 
-def open_sessions_for_databases(context: Context, names: list, session_type=DATA):
+def open_sessions_for_databases(context: Context, names: list, session_type):
     for name in names:
-        context.sessions.append(context.client.session(name, session_type))
+        context.sessions.append(context.client.session(name, session_type, context.session_options))
 
 
 @step("connection open schema session for database: {database_name}")
@@ -147,3 +147,14 @@ def step_impl(context: Context):
     future_session_iter = iter(context.sessions_parallel)
     for name in database_names:
         assert_that(next(future_session_iter).result().database().name(), is_(name))
+
+######################################
+# session configuration              #
+######################################
+
+@step("set session option {option} to: {value}")
+def step_impl(context: Context, option: str, value: str):
+    if option not in context.option_setters:
+        raise Exception("Unrecognised option: " + option)
+    context.option_setters[option](context.session_options, value)
+

tests/behaviour/connection/transaction/transaction_steps.py

@@ -35,9 +35,7 @@ def for_each_session_open_transaction_of_type(context: Context, transaction_type
     for session in context.sessions:
         transactions = []
         for transaction_type in transaction_types:
-            opts = TypeDBOptions.core()
-            opts.infer = True
-            transaction = session.transaction(transaction_type, opts)
+            transaction = session.transaction(transaction_type, context.transaction_options)
             transactions.append(transaction)
         context.sessions_to_transactions[session] = transactions
 
@@ -254,6 +252,17 @@ def step_impl(context: Context, is_open):
     for_each_session_in_parallel_transactions_in_parallel_are(context, lambda tx: assert_transaction_open(tx, is_open))
 
 
+######################################
+# transaction configuration          #
+######################################
+
+@step("set transaction option {option} to: {value}")
+def step_impl(context: Context, option: str, value: str):
+    if option not in context.option_setters:
+        raise Exception("Unrecognised option: " + option)
+    context.option_setters[option](context.transaction_options, value)
+
+
 ######################################
 # transaction behaviour with queries #
 ######################################

tests/behaviour/context.py

@@ -51,12 +51,15 @@ def __init__(self):
         self.sessions_to_transactions: Dict[TypeDBSession, List[TypeDBTransaction]] = {}
         self.sessions_parallel: List[Future[TypeDBSession]] = []
         self.sessions_parallel_to_transactions_parallel: Dict[Future[TypeDBSession], List[TypeDBTransaction]] = {}
+        self.session_options: Optional[TypeDBOptions] = None
+        self.transaction_options: Optional[TypeDBOptions] = None
         self.things: Dict[str, Thing] = {}
         self.answers: Optional[List[ConceptMap]] = None
         self.numeric_answer: Optional[Numeric] = None
         self.answer_groups: Optional[List[ConceptMapGroup]] = None
         self.numeric_answer_groups: Optional[List[NumericGroup]] = None
         self.config = Config()
+        self.option_setters = {}
 
     def tx(self) -> TypeDBTransaction:
         return self.sessions_to_transactions[self.sessions[0]][0]

tools/behave_rule.bzl

@@ -81,7 +81,7 @@ def _rule_implementation(ctx):
            echo Starting TypeDB $PRODUCT Server.
            mkdir ./typedb_distribution/"$DIRECTORY"/typedb_test
            if [[ $PRODUCT == "Core" ]]; then
-             ./typedb_distribution/"$DIRECTORY"/typedb server --port $PORT --data typedb_test &
+             ./typedb_distribution/"$DIRECTORY"/typedb server --server.address 0.0.0.0:$PORT --storage.data typedb_test &
            else
              ./typedb_distribution/"$DIRECTORY"/typedb cluster --address "127.0.0.1:$PORT:$(($PORT+1)):$(($PORT+2))" --data typedb_test --encryption-enabled=true &
 

typedb/api/connection/options.py

@@ -33,6 +33,7 @@ def __init__(self):
         self.prefetch_size: Optional[int] = None
         self.prefetch: Optional[bool] = None
         self.session_idle_timeout_millis: Optional[int] = None
+        self.transaction_timeout_millis: Optional[int] = None
         self.schema_lock_acquire_timeout_millis: Optional[int] = None
 
     @staticmethod
@@ -46,6 +47,69 @@ def cluster() -> "TypeDBClusterOptions":
     def is_cluster(self) -> bool:
         return False
 
+    def get_infer(self) -> Optional[bool]:
+        return self.infer
+
+    def set_infer(self, infer: bool):
+        self.infer = infer
+        return self
+
+    def get_trace_inference(self) -> Optional[bool]:
+        return self.trace_inference
+
+    def set_trace_inference(self, trace_inference: bool):
+        self.trace_inference = trace_inference
+        return self
+
+    def get_explain(self) -> Optional[bool]:
+        return self.explain
+
+    def set_explain(self, explain: bool):
+        self.explain = explain
+        return self
+
+    def get_parallel(self) -> Optional[bool]:
+        return self.parallel
+
+    def set_parallel(self, parallel: bool):
+        self.parallel = parallel
+        return self
+
+    def get_prefetch_size(self) -> Optional[int]:
+        return self.prefetch_size
+
+    def set_prefetch_size(self, prefetch_size: int):
+        self.prefetch_size = prefetch_size
+        return self
+
+    def get_prefetch(self) -> Optional[bool]:
+        return self.prefetch
+
+    def set_prefetch(self, prefetch: bool):
+        self.prefetch = prefetch
+        return self
+
+    def get_session_idle_timeout_millis(self) -> Optional[int]:
+        return self.session_idle_timeout_millis
+
+    def set_session_idle_timeout_millis(self, session_idle_timeout_millis: int):
+        self.session_idle_timeout_millis = session_idle_timeout_millis
+        return self
+
+    def get_transaction_timeout_millis(self) -> Optional[int]:
+        return self.transaction_timeout_millis
+
+    def set_transaction_timeout_millis(self, transaction_timeout_millis: int):
+        self.transaction_timeout_millis = transaction_timeout_millis
+        return self
+
+    def get_schema_lock_acquire_timeout_millis(self) -> Optional[int]:
+        return self.schema_lock_acquire_timeout_millis
+
+    def set_schema_lock_acquire_timeout_millis(self, schema_lock_acquire_timeout_millis: int):
+        self.schema_lock_acquire_timeout_millis = schema_lock_acquire_timeout_millis
+        return self
+
     def proto(self) -> options_proto.Options:
         proto_options = options_proto.Options()
 
@@ -63,6 +127,8 @@ def proto(self) -> options_proto.Options:
             proto_options.prefetch = self.prefetch
         if self.session_idle_timeout_millis is not None:
             proto_options.session_idle_timeout_millis = self.session_idle_timeout_millis
+        if self.transaction_timeout_millis is not None:
+            proto_options.transaction_timeout_millis = self.transaction_timeout_millis
         if self.schema_lock_acquire_timeout_millis is not None:
             proto_options.schema_lock_acquire_timeout_millis = self.schema_lock_acquire_timeout_millis
 
@@ -78,6 +144,13 @@ def __init__(self):
     def is_cluster(self) -> bool:
         return True
 
+    def get_read_any_replica(self) -> Optional[bool]:
+        return self.read_any_replica
+
+    def set_read_any_replica(self, read_any_replica: bool):
+        self.read_any_replica = read_any_replica
+        return self
+
     def proto(self) -> options_proto.Options:
         proto_options = super(TypeDBClusterOptions, self).proto()