Enable .NET driver over HTTP for 4.0.0 (#3338)

Replace Bytecode with GremlinLang, update GraphBinary serializers to 4.0 format, implemented non-streaming HTTP while replacing all WebSocket reference and settings, added interceptors to .NET with new reference auth implementations, split request and response serializer to allow user customization, and moved MimeType into IMessageSerializer.

---------

Co-authored-by: Ken Hu <106191785+kenhuuu@users.noreply.github.com>

Author: xiazcy

.github/workflows/build-test.yml

@@ -339,40 +339,40 @@ jobs:
           EXCLUDE="${EXCLUDE_MODULES/,-:gremlin-python},$EXCLUDE_FOR_GLV"
           mvn clean install -pl $EXCLUDE -q -DskipTests -Dci
           mvn verify -pl gremlin-python
-#  dotnet:
-#    name: .NET
-#    timeout-minutes: 20
-#    needs: cache-gremlin-server-docker-image
-#    runs-on: ubuntu-latest
-#    steps:
-#      - uses: actions/checkout@v6
-#      - name: Set up JDK11
-#        uses: actions/setup-java@v5
-#        with:
-#          java-version: '11'
-#          distribution: 'temurin'
-#      - name: Set up .NET 8.0.x
-#        uses: actions/setup-dotnet@v4
-#        with:
-#          dotnet-version: '8.0.x'
-#      - name: Get Cached Server Base Image
-#        uses: actions/cache@v5
-#        id: gremlin-server-test-docker-image
-#        with:
-#          path: |
-#            ./gremlin-server/*
-#            ~/.m2/repository/org/apache/tinkerpop/*
-#          key: ${{ github.sha }}
-#      - name: Load Docker Image
-#        working-directory: ./gremlin-server
-#        run: docker load --input gremlin-server.tar
-#      - name: Build with Maven
-#        run: |
-#          touch gremlin-dotnet/src/.glv
-#          touch gremlin-dotnet/test/.glv
-#          EXCLUDE="${EXCLUDE_MODULES/-:gremlin-dotnet-source,-:gremlin-dotnet-tests,},$EXCLUDE_FOR_GLV"
-#          mvn clean install -pl $EXCLUDE -q -DskipTests -Dci
-#          mvn verify -pl :gremlin-dotnet,:gremlin-dotnet-tests -P gremlin-dotnet
+  dotnet:
+    name: .NET
+    timeout-minutes: 20
+    needs: cache-gremlin-server-docker-image
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up JDK11
+        uses: actions/setup-java@v5
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Set up .NET 8.0.x
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+      - name: Get Cached Server Base Image
+        uses: actions/cache@v5
+        id: gremlin-server-test-docker-image
+        with:
+          path: |
+            ./gremlin-server/*
+            ~/.m2/repository/org/apache/tinkerpop/*
+          key: ${{ github.sha }}
+      - name: Load Docker Image
+        working-directory: ./gremlin-server
+        run: docker load --input gremlin-server.tar
+      - name: Build with Maven
+        run: |
+          touch gremlin-dotnet/src/.glv
+          touch gremlin-dotnet/test/.glv
+          EXCLUDE="${EXCLUDE_MODULES/-:gremlin-dotnet-source,-:gremlin-dotnet-tests,},$EXCLUDE_FOR_GLV"
+          mvn clean install -pl $EXCLUDE -q -DskipTests -Dci
+          mvn verify -pl :gremlin-dotnet,:gremlin-dotnet-tests -P gremlin-dotnet
   neo4j-gremlin:
     name: neo4j-gremlin
     timeout-minutes: 20

CHANGELOG.asciidoc

@@ -37,6 +37,10 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
 * Added `RequestInterceptor` to `gremlin-go` with `auth` reference implementations to replace `authInfo`.
 * Refactored GraphBinary serializers to use `io.Writer` and `io.Reader` instead of `*bytes.Buffer` for streaming capacities.
 * Refactored `httpProtocol` and `httpTransport` in `gremlin-go` into single `connection.go` that handles HTTP request and response.
+* Replace `Bytecode` with `GremlinLang` in `gremlin-dotnet`.
+* Replace `WebSocket` with `HTTP` (non-streaming) in `gremlin-dotnet`.
+* Added `MimeType` to `IMessageSerializer` and split client option to allow separate request and response serialization in `gremlin-dotnet`.
+* Added `RequestInterceptor` to `gremlin-dotnet` with `auth` reference implementations.
 * Bumped ANTLR to 4.13.2
 * Bumped SLF4j to 2.0.16.
 * Bumped GMavenPlus to 4.1.1.

gremlin-dotnet/Examples/BasicGremlin/BasicGremlin.cs

@@ -20,6 +20,7 @@ under the License.
 using Gremlin.Net.Driver;
 using Gremlin.Net.Driver.Remote;
 using static Gremlin.Net.Process.Traversal.AnonymousTraversalSource;
+using static Gremlin.Net.Process.Traversal.__;
 
 public class BasicGremlinExample
 {
@@ -40,8 +41,8 @@ static async Task Main()
 
         // Be sure to use a terminating step like Next() or Iterate() so that the traversal "executes"
         // Iterate() does not return any data and is used to just generate side-effects (i.e. write data to the database)
-        g.V(v1).AddE("knows").To(v2).Property("weight", 0.75).Iterate();
-        g.V(v1).AddE("knows").To(v3).Property("weight", 0.75).Iterate();
+        g.V(v1).AddE("knows").To(Constant(v2)).Property("weight", 0.75).Iterate();
+        g.V(v1).AddE("knows").To(Constant(v3)).Property("weight", 0.75).Iterate();
 
         // Retrieve the data from the "marko" vertex
         var marko = await g.V().Has(VertexLabel, "name", "marko").Values<string>("name").Promise(t => t.Next());

gremlin-dotnet/Examples/Connections/Connections.cs

@@ -19,20 +19,20 @@ under the License.
 
 using Gremlin.Net.Driver;
 using Gremlin.Net.Driver.Remote;
-using Gremlin.Net.Structure.IO.GraphSON;
 using static Gremlin.Net.Process.Traversal.AnonymousTraversalSource;
 
 public class ConnectionExample
 {
     static readonly string ServerHost = Environment.GetEnvironmentVariable("GREMLIN_SERVER_HOST") ?? "localhost";
     static readonly int ServerPort = int.Parse(Environment.GetEnvironmentVariable("GREMLIN_SERVER_PORT") ?? "8182");
+    static readonly int SecureServerPort = int.Parse(Environment.GetEnvironmentVariable("GREMLIN_SECURE_SERVER_PORT") ?? "8183");
     static readonly string VertexLabel = Environment.GetEnvironmentVariable("VERTEX_LABEL") ?? "connection";
 
     static void Main()
     {
         WithRemoteConnection();
         WithConf();
-        WithSerializer();
+        WithBasicAuth();
     }
 
     // Connecting to the server
@@ -48,23 +48,30 @@ static void WithRemoteConnection()
         Console.WriteLine("Vertex count: " + count);
     }
 
-    // Connecting to the server with customized configurations
+    // Connecting to the server with customized connection settings
     static void WithConf()
     {
-        using var remoteConnection = new DriverRemoteConnection(new GremlinClient(
-        new GremlinServer(hostname: ServerHost, port: ServerPort, enableSsl: false, username: "", password: "")), "g");
+        var server = new GremlinServer(ServerHost, ServerPort);
+        var settings = new ConnectionSettings
+        {
+            ConnectionTimeout = TimeSpan.FromSeconds(30),
+        };
+        using var remoteConnection = new DriverRemoteConnection(
+            new GremlinClient(server, connectionSettings: settings), "g");
         var g = Traversal().With(remoteConnection);
 
         var v = g.AddV(VertexLabel).Iterate();
         var count = g.V().HasLabel(VertexLabel).Count().Next();
         Console.WriteLine("Vertex count: " + count);
     }
 
-    // Specifying a serializer
-    static void WithSerializer()
+    // Connecting with basic authentication using a request interceptor
+    static void WithBasicAuth()
     {
-        var server = new GremlinServer(ServerHost, ServerPort);
-        var client = new GremlinClient(server, new GraphSON3MessageSerializer());
+        var server = new GremlinServer(ServerHost, SecureServerPort, enableSsl: true);
+        var client = new GremlinClient(server,
+            connectionSettings: new ConnectionSettings { SkipCertificateValidation = true },
+            interceptors: new[] { Auth.BasicAuth("stephen", "password") });
         using var remoteConnection = new DriverRemoteConnection(client, "g");
         var g = Traversal().With(remoteConnection);
 

gremlin-dotnet/Examples/ModernTraversals/ModernTraversals.cs

@@ -47,8 +47,8 @@ This example requires the Modern toy graph to be preloaded upon launching the Gr
         var e2 = g.V(1).BothE().Where(OtherV().HasId(2)).ToList(); // (2)
         var v1 = g.V(1).Next();
         var v2 = g.V(2).Next();
-        var e3 = g.V(v1).BothE().Where(OtherV().Is(v2)).ToList(); // (3)
-        var e4 = g.V(v1).OutE().Where(InV().Is(v2)).ToList(); // (4)
+        var e3 = g.V(v1).BothE().Where(OtherV().Id().Is(v2)).ToList(); // (3)
+        var e4 = g.V(v1).OutE().Where(InV().Id().Is(v2)).ToList(); // (4)
         var e5 = g.V(1).OutE().Where(InV().Has(T.Id, Within(2, 3))).ToList(); // (5)
         var e6 = g.V(1).Out().Where(__.In().HasId(6)).ToList(); // (6)
 

gremlin-dotnet/build/generate.groovy

@@ -65,6 +65,7 @@ radishGremlinFile.withWriter('UTF-8') { Writer writer ->
                      'using Gremlin.Net.Process.Traversal;\n' +
                      'using Gremlin.Net.Process.Traversal.Strategy.Optimization;\n' +
                      'using Gremlin.Net.Process.Traversal.Strategy.Verification;\n' +
+                     'using Gremlin.Net.Process.Traversal.Strategy.Finalization;\n' +
                      'using Gremlin.Net.Process.Traversal.Strategy.Decoration;\n')
     writer.writeLine('namespace Gremlin.Net.IntegrationTest.Gherkin\n' +
             '{\n' +
@@ -138,9 +139,16 @@ radishGremlinFile.withWriter('UTF-8') { Writer writer ->
             '            Func<GraphTraversalSource, IDictionary<string, object>, ITraversal> f = list[0];\n' +
             '            list.RemoveAt(0);\n' +
             '            ITraversal traversal = f.Invoke(g, parameters);\n' +
-            '            foreach (var sideEffect in sideEffects)\n' +
+            '            // Side effects need to be prepended as source steps (before traversal steps).\n' +
+            '            // Build them in a temporary GremlinLang and prepend to the traversal\'s gremlin string.\n' +
+            '            if (sideEffects.Count > 0)\n' +
             '            {\n' +
-            '                traversal.Bytecode.AddSource("withSideEffect", sideEffect.Key, sideEffect.Value);\n' +
+            '                var sideEffectLang = new GremlinLang();\n' +
+            '                foreach (var sideEffect in sideEffects)\n' +
+            '                {\n' +
+            '                    sideEffectLang.AddSource("withSideEffect", sideEffect.Key, sideEffect.Value);\n' +
+            '                }\n' +
+            '                traversal.GremlinLang.Gremlin = sideEffectLang.Gremlin + traversal.GremlinLang.Gremlin;\n' +
             '            }\n' +
             '            return traversal;\n' +
             '        }\n' +

gremlin-dotnet/docker-compose.yml

@@ -35,26 +35,26 @@ services:
       - ${HOME}/.m2:/root/.m2
       - ${ABS_PROJECT_HOME}/gremlin-test/target:/opt/gremlin-test
     healthcheck:
-      test: [ "CMD-SHELL", "apk add curl && curl -f http://localhost:45940?gremlin=100-1" ]
+      test: [ "CMD-SHELL", "apk add curl && curl -X POST -d '{\"gremlin\":\"g.inject(1)\"}' http://localhost:45940" ]
       interval: 30s
       timeout: 10s
       retries: 30
       start_period: 30s
-    depends_on:
-      - gremlin-socket-server
 
   gremlin-dotnet-integration-tests:
     container_name: gremlin-dotnet-integration-tests
     image: mcr.microsoft.com/dotnet/sdk:8.0
     volumes:
       - .:/gremlin-dotnet
       - ../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features:/gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features
+      - ../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/structure/io:/gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/structure/io
       - ../docker/gremlin-test-server:/gremlin-dotnet/gremlin-test-server
       - ../gremlin-tools/gremlin-socket-server/conf:/gremlin-dotnet/gremlin-socket-server/conf/
     environment:
       - DOCKER_ENVIRONMENT=true
       - GREMLIN_SERVER_HOST=gremlin-server-test-dotnet
       - GREMLIN_SERVER_PORT=45940
+      - GREMLIN_SECURE_SERVER_PORT=45941
       - VERTEX_LABEL=dotnet-example
     working_dir: /gremlin-dotnet
     command: >
@@ -72,10 +72,3 @@ services:
     depends_on:
       gremlin-server-test-dotnet:
         condition: service_healthy
-
-  gremlin-socket-server:
-    container_name: gremlin-socket-server
-    image: tinkerpop/gremlin-socket-server:${GREMLIN_SERVER}
-    ports:
-      - "45943:45943"
-