Add protocol versioning transmitted during connection open (#185)

flyingsilverfin · web-flow · commit 3c844deff72f · 2023-05-27T10:37:31.000+01:00
## What is the goal of this PR?

We add a new connection opening request, which allows transmitting the protocol version for the server to verify.

## What are the changes implemented in this PR?

* Add new service: `connection`, which takes `Connection.Req` and returns `Connection.Res`
* Add new protocol message: `connection.proto`, which contains `Open.Req|Res`
* Add new protocol message: `version.proto`, which holds an Enum encoding the protocol version number
diff --git a/cluster/cluster_service.proto b/cluster/cluster_service.proto
@@ -21,7 +21,6 @@ option java_package = "com.vaticle.typedb.protocol";
 option java_outer_classname = "ClusterServiceProto";
 option java_generic_services = true;
 
-
 import "cluster/cluster_server.proto";
 import "cluster/cluster_user.proto";
 import "cluster/cluster_database.proto";
diff --git a/common/BUILD b/common/BUILD
@@ -30,6 +30,14 @@ proto_library(
     srcs = ["concept.proto"],
 )
 
+proto_library(
+    name = "connection-proto",
+    srcs = ["connection.proto"],
+    deps = [
+        ":version-proto",
+    ],
+)
+
 proto_library(
     name = "logic-proto",
     srcs = ["logic.proto"],
@@ -69,6 +77,11 @@ proto_library(
     ]
 )
 
+proto_library(
+    name = "version-proto",
+    srcs = ["version.proto"],
+)
+
 # TODO: THIS SHOULD BE MADE TO STOP EXISTING
 # This exists to support the nodejs build- when it becomes a real rule, we should extract the .src_files
 # from the above proto_library rules, but for now this is required to get the source files.
@@ -77,11 +90,13 @@ filegroup(
     srcs = [
         "answer.proto",
         "concept.proto",
+        "connection.proto",
         "options.proto",
         "query.proto",
         "session.proto",
         "transaction.proto",
         "logic.proto",
+        "version.proto",
     ]
 )
 
diff --git a/common/connection.proto b/common/connection.proto
@@ -0,0 +1,37 @@
+//
+// Copyright (C) 2022 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/>.
+//
+
+syntax = "proto3";
+
+option java_package = "com.vaticle.typedb.protocol";
+option java_outer_classname = "ConnectionProto";
+option java_generic_services = true;
+
+import "common/version.proto";
+
+package typedb.protocol;
+
+message Connection {
+
+  message Open {
+    message Req {
+      Version version = 1;
+    }
+
+    message Res {}
+  }
+}
diff --git a/common/version.proto b/common/version.proto
@@ -0,0 +1,30 @@
+//
+// Copyright (C) 2022 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/>.
+//
+
+syntax = "proto3";
+
+option java_package = "com.vaticle.typedb.protocol";
+option java_outer_classname = "VersionProto";
+option java_generic_services = true;
+
+package typedb.protocol;
+
+enum Version {
+//  reserved; // add past version numbers into the reserved range
+  UNSPECIFIED = 0;
+  VERSION = 1;
+}
diff --git a/core/BUILD b/core/BUILD
@@ -29,6 +29,7 @@ proto_library(
     srcs = ["core_service.proto"],
     deps = [
         "//core:database-proto",
+        "//common:connection-proto",
         "//common:session-proto",
         "//common:transaction-proto",
     ],
diff --git a/core/core_service.proto b/core/core_service.proto
@@ -22,13 +22,17 @@ option java_outer_classname = "CoreServiceProto";
 option java_generic_services = true;
 
 import "core/core_database.proto";
+import "common/connection.proto";
 import "common/session.proto";
 import "common/transaction.proto";
 
 package typedb.protocol;
 
 service TypeDB {
 
+    // Connection API
+    rpc connection_open (Connection.Open.Req) returns (Connection.Open.Res);
+
     // Database Manager API
     rpc databases_contains (CoreDatabaseManager.Contains.Req) returns (CoreDatabaseManager.Contains.Res);
     rpc databases_create (CoreDatabaseManager.Create.Req) returns (CoreDatabaseManager.Create.Res);
diff --git a/grpc/java/BUILD b/grpc/java/BUILD
@@ -32,11 +32,13 @@ java_grpc_compile(
         "//cluster:database-proto",
         "//common:answer-proto",
         "//common:concept-proto",
+        "//common:connection-proto",
         "//common:logic-proto",
         "//common:options-proto",
         "//common:query-proto",
         "//common:session-proto",
         "//common:transaction-proto",
+        "//common:version-proto",
         "//core:database-proto",
         "//core:service-proto",
     ]
diff --git a/grpc/nodejs/BUILD b/grpc/nodejs/BUILD
@@ -47,11 +47,13 @@ ts_grpc_compile(
         "//cluster:service-proto", # TODO: do we need this?
         "//common:answer-proto",
         "//common:concept-proto",
+        "//common:connection-proto",
         "//common:logic-proto",
         "//common:options-proto",
         "//common:query-proto",
         "//common:session-proto",
         "//common:transaction-proto",
+        "//common:version-proto",
         "//core:database-proto",
         "//core:service-proto", # TODO: do we need this?
     ],
diff --git a/grpc/python/BUILD b/grpc/python/BUILD
@@ -31,11 +31,13 @@ python_grpc_compile(
         "//cluster:service-proto",
         "//common:answer-proto",
         "//common:concept-proto",
+        "//common:connection-proto",
         "//common:logic-proto",
         "//common:options-proto",
         "//common:query-proto",
         "//common:session-proto",
         "//common:transaction-proto",
+        "//common:version-proto",
         "//core:database-proto",
         "//core:service-proto",
     ],
diff --git a/grpc/rust/BUILD b/grpc/rust/BUILD
@@ -31,11 +31,13 @@ rust_tonic_compile(
         "//cluster:database-proto",
         "//common:answer-proto",
         "//common:concept-proto",
+        "//common:connection-proto",
         "//common:logic-proto",
         "//common:options-proto",
         "//common:query-proto",
         "//common:session-proto",
         "//common:transaction-proto",
+        "//common:version-proto",
         "//core:database-proto",
         "//core:service-proto",
     ]
