You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by co...@apache.org on 2024/10/15 16:55:46 UTC

(tinkerpop) branch TINKERPOP-2700 updated: rename useCompression to enableCompression

This is an automated email from the ASF dual-hosted git repository.

colegreer pushed a commit to branch TINKERPOP-2700
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git


The following commit(s) were added to refs/heads/TINKERPOP-2700 by this push:
     new de6e9ac7c2 rename useCompression to enableCompression
de6e9ac7c2 is described below

commit de6e9ac7c22cdc5a6f0a8519fc5e716ceb358b1d
Author: Cole-Greer <Co...@improving.com>
AuthorDate: Tue Oct 15 09:55:38 2024 -0700

    rename useCompression to enableCompression
---
 .../apache/tinkerpop/gremlin/driver/Channelizer.java |  2 +-
 .../org/apache/tinkerpop/gremlin/driver/Cluster.java | 20 ++++++++++----------
 .../apache/tinkerpop/gremlin/driver/Settings.java    |  6 +++---
 .../tinkerpop/gremlin/driver/SettingsTest.java       |  4 ++--
 .../gremlin-javascript/lib/driver/client.js          |  2 +-
 .../gremlin-javascript/lib/driver/connection.js      |  4 ++--
 .../lib/driver/driver-remote-connection.js           |  2 +-
 .../src/main/python/gremlin_python/driver/client.py  |  6 +++---
 .../driver/driver_remote_connection.py               |  6 +++---
 .../tests/driver/test_driver_remote_connection.py    |  6 +++---
 10 files changed, 29 insertions(+), 29 deletions(-)

diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
index 7b9cb27a60..6bafcd7b0a 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
@@ -210,7 +210,7 @@ public interface Channelizer extends ChannelHandler {
 
             pipeline.addLast("http-codec", new HttpClientCodec());
             pipeline.addLast("aggregator", new HttpObjectAggregator(maxContentLength));
-            if (connection.getCluster().useCompression()) {
+            if (connection.getCluster().enableCompression()) {
                 // Add compression extension for WebSocket defined in https://tools.ietf.org/html/rfc7692
                 pipeline.addLast(WebSocketClientCompressionHandler.INSTANCE);
             }
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
index 5c65556a4a..b8ef9cbc66 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
@@ -208,7 +208,7 @@ public final class Cluster {
                 .minConnectionPoolSize(settings.connectionPool.minSize)
                 .connectionSetupTimeoutMillis(settings.connectionPool.connectionSetupTimeoutMillis)
                 .enableUserAgentOnConnect(settings.enableUserAgentOnConnect)
-                .useCompression(settings.useCompression)
+                .enableCompression(settings.enableCompression)
                 .validationRequest(settings.connectionPool.validationRequest);
 
         if (settings.username != null && settings.password != null)
@@ -580,8 +580,8 @@ public final class Cluster {
     /**
      * Checks if cluster is configured to use per-message deflate compression
      */
-    public boolean useCompression() {
-        return manager.useCompression();
+    public boolean enableCompression() {
+        return manager.enableCompression();
     }
 
     public final static class Builder {
@@ -621,7 +621,7 @@ public final class Cluster {
         private AuthProperties authProps = new AuthProperties();
         private long connectionSetupTimeoutMillis = Connection.CONNECTION_SETUP_TIMEOUT_MILLIS;
         private boolean enableUserAgentOnConnect = true;
-        private boolean useCompression = true;
+        private boolean enableCompression = true;
 
         private Builder() {
             // empty to prevent direct instantiation
@@ -1041,8 +1041,8 @@ public final class Cluster {
         /**
          * Configures use of per-message deflate compression. Defaults to true.
          */
-        public Builder useCompression(final boolean useCompression) {
-            this.useCompression = useCompression;
+        public Builder enableCompression(final boolean enableCompression) {
+            this.enableCompression = enableCompression;
             return this;
         }
 
@@ -1115,7 +1115,7 @@ public final class Cluster {
         private final int port;
         private final String path;
         private final boolean enableUserAgentOnConnect;
-        private final boolean useCompression;
+        private final boolean enableCompression;
 
         private final AtomicReference<CompletableFuture<Void>> closeFuture = new AtomicReference<>();
 
@@ -1129,7 +1129,7 @@ public final class Cluster {
             this.contactPoints = builder.getContactPoints();
             this.interceptor = builder.interceptor;
             this.enableUserAgentOnConnect = builder.enableUserAgentOnConnect;
-            this.useCompression = builder.useCompression;
+            this.enableCompression = builder.enableCompression;
 
             connectionPoolSettings = new Settings.ConnectionPoolSettings();
             connectionPoolSettings.maxInProcessPerConnection = builder.maxInProcessPerConnection;
@@ -1328,8 +1328,8 @@ public final class Cluster {
         /**
          * Checks if cluster is configured to use per-message deflate compression
          */
-        public boolean useCompression() {
-            return useCompression;
+        public boolean enableCompression() {
+            return enableCompression;
         }
     }
 }
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
index f9dbbd0372..b84798e999 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
@@ -107,7 +107,7 @@ final class Settings {
     /**
      * Configures use of per-message deflate compression. Defaults to true.
      */
-    public boolean useCompression = true;
+    public boolean enableCompression = true;
 
     /**
      * Read configuration from a file into a new {@link Settings} object.
@@ -158,8 +158,8 @@ final class Settings {
         if (conf.containsKey("enableUserAgentOnConnect"))
             settings.enableUserAgentOnConnect = conf.getBoolean("enableUserAgentOnConnect");
 
-        if (conf.containsKey("useCompression"))
-            settings.useCompression = conf.getBoolean("useCompression");
+        if (conf.containsKey("enableCompression"))
+            settings.enableCompression = conf.getBoolean("enableCompression");
 
         if (conf.containsKey("hosts"))
             settings.hosts = conf.getList("hosts").stream().map(Object::toString).collect(Collectors.toList());
diff --git a/gremlin-driver/src/test/java/org/apache/tinkerpop/gremlin/driver/SettingsTest.java b/gremlin-driver/src/test/java/org/apache/tinkerpop/gremlin/driver/SettingsTest.java
index 6a7b2a004a..26eb8a9f7f 100644
--- a/gremlin-driver/src/test/java/org/apache/tinkerpop/gremlin/driver/SettingsTest.java
+++ b/gremlin-driver/src/test/java/org/apache/tinkerpop/gremlin/driver/SettingsTest.java
@@ -47,7 +47,7 @@ public class SettingsTest {
         conf.setProperty("serializer.className", "my.serializers.MySerializer");
         conf.setProperty("serializer.config.any", "thing");
         conf.setProperty("enableUserAgentOnConnect", false);
-        conf.setProperty("useCompression", false);
+        conf.setProperty("enableCompression", false);
         conf.setProperty("connectionPool.enableSsl", true);
         conf.setProperty("connectionPool.keyStore", "server.jks");
         conf.setProperty("connectionPool.keyStorePassword", "password2");
@@ -85,7 +85,7 @@ public class SettingsTest {
         assertEquals("my.serializers.MySerializer", settings.serializer.className);
         assertEquals("thing", settings.serializer.config.get("any"));
         assertEquals(false, settings.enableUserAgentOnConnect);
-        assertEquals(false, settings.useCompression);
+        assertEquals(false, settings.enableCompression);
         assertThat(settings.connectionPool.enableSsl, is(true));
         assertEquals("server.jks", settings.connectionPool.keyStore);
         assertEquals("password2", settings.connectionPool.keyStorePassword);
diff --git a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/client.js b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/client.js
index 6d00fa64e4..7095057809 100644
--- a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/client.js
+++ b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/client.js
@@ -46,7 +46,7 @@ class Client {
    * @param {Boolean} [options.pingEnabled] Setup ping interval. Defaults to: true.
    * @param {Number} [options.pingInterval] Ping request interval in ms if ping enabled. Defaults to: 60000.
    * @param {Number} [options.pongTimeout] Timeout of pong response in ms after sending a ping. Defaults to: 30000.
-   * @param {Boolean} [options.useCompression] Enable per-message deflate compression. Defaults to: false.
+   * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
    * @constructor
    */
   constructor(url, options = {}) {
diff --git a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js
index ce780862d1..d1645ab49f 100644
--- a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js
+++ b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js
@@ -70,7 +70,7 @@ class Connection extends EventEmitter {
    * @param {Boolean} [options.pingEnabled] Setup ping interval. Defaults to: true.
    * @param {Number} [options.pingInterval] Ping request interval in ms if ping enabled. Defaults to: 60000.
    * @param {Number} [options.pongTimeout] Timeout of pong response in ms after sending a ping. Defaults to: 30000.
-   * @param {Boolean} [options.useCompression] Enable per-message deflate compression. Defaults to: false.
+   * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
    * @param {Boolean} [options.connectOnStartup] Deprecated and non-functional. Open websocket on startup.
    * @constructor
    */
@@ -142,7 +142,7 @@ class Connection extends EventEmitter {
       cert: this.options.cert,
       pfx: this.options.pfx,
       rejectUnauthorized: this.options.rejectUnauthorized,
-      perMessageDeflate: this.options.useCompression,
+      perMessageDeflate: this.options.enableCompression,
     });
 
     this._ws.on('message', (data) => this._handleMessage(data));
diff --git a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/driver-remote-connection.js b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/driver-remote-connection.js
index 8911766ce2..2e2711eda1 100644
--- a/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/driver-remote-connection.js
+++ b/gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/driver-remote-connection.js
@@ -52,7 +52,7 @@ class DriverRemoteConnection extends RemoteConnection {
    * @param {Boolean} [options.pingEnabled] Setup ping interval. Defaults to: true.
    * @param {Number} [options.pingInterval] Ping request interval in ms if ping enabled. Defaults to: 60000.
    * @param {Number} [options.pongTimeout] Timeout of pong response in ms after sending a ping. Defaults to: 30000.
-   * @param {Boolean} [options.useCompression] Enable per-message deflate compression. Defaults to: false.
+   * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
    * @constructor
    */
   constructor(url, options = {}) {
diff --git a/gremlin-python/src/main/python/gremlin_python/driver/client.py b/gremlin-python/src/main/python/gremlin_python/driver/client.py
index a88d893075..d1d13064f9 100644
--- a/gremlin-python/src/main/python/gremlin_python/driver/client.py
+++ b/gremlin-python/src/main/python/gremlin_python/driver/client.py
@@ -44,7 +44,7 @@ class Client:
                  transport_factory=None, pool_size=None, max_workers=None,
                  message_serializer=None, username="", password="",
                  kerberized_service="", headers=None, session=None,
-                 enable_user_agent_on_connect=True, use_compression=False,
+                 enable_user_agent_on_connect=True, enable_compression=False,
                  **transport_kwargs):
         log.info("Creating Client with url '%s'", url)
 
@@ -56,10 +56,10 @@ class Client:
         self._headers = headers
         self._enable_user_agent_on_connect = enable_user_agent_on_connect
         self._traversal_source = traversal_source
-        self._use_compression = use_compression
+        self._enable_compression = enable_compression
         if not self._use_http and "max_content_length" not in transport_kwargs:
             transport_kwargs["max_content_length"] = 10 * 1024 * 1024
-        if self._use_compression and "compress" not in transport_kwargs:
+        if self._enable_compression and "compress" not in transport_kwargs:
             transport_kwargs["compress"] = 15  # enable per-message deflate compression with max 32k sliding window size
         if message_serializer is None:
             message_serializer = serializer.GraphBinarySerializersV1()
diff --git a/gremlin-python/src/main/python/gremlin_python/driver/driver_remote_connection.py b/gremlin-python/src/main/python/gremlin_python/driver/driver_remote_connection.py
index fffdb7fd77..6fba9711d1 100644
--- a/gremlin-python/src/main/python/gremlin_python/driver/driver_remote_connection.py
+++ b/gremlin-python/src/main/python/gremlin_python/driver/driver_remote_connection.py
@@ -39,7 +39,7 @@ class DriverRemoteConnection(RemoteConnection):
                  username="", password="", kerberized_service='',
                  message_serializer=None, graphson_reader=None,
                  graphson_writer=None, headers=None, session=None,
-                 enable_user_agent_on_connect=True, use_compression=False, **transport_kwargs):
+                 enable_user_agent_on_connect=True, enable_compression=False, **transport_kwargs):
         log.info("Creating DriverRemoteConnection with url '%s'", str(url))
         self.__url = url
         self.__traversal_source = traversal_source
@@ -56,7 +56,7 @@ class DriverRemoteConnection(RemoteConnection):
         self.__headers = headers
         self.__session = session
         self.__enable_user_agent_on_connect = enable_user_agent_on_connect
-        self.__use_compression = use_compression
+        self.__enable_compression = enable_compression
         self.__transport_kwargs = transport_kwargs
 
         # keeps a list of sessions that have been spawned from this DriverRemoteConnection
@@ -79,7 +79,7 @@ class DriverRemoteConnection(RemoteConnection):
                                      headers=headers,
                                      session=session,
                                      enable_user_agent_on_connect=enable_user_agent_on_connect,
-                                     use_compression=use_compression,
+                                     enable_compression=enable_compression,
                                      **transport_kwargs)
         self._url = self._client._url
         self._traversal_source = self._client._traversal_source
diff --git a/gremlin-python/src/main/python/tests/driver/test_driver_remote_connection.py b/gremlin-python/src/main/python/tests/driver/test_driver_remote_connection.py
index e8a0e35a31..df379ebc40 100644
--- a/gremlin-python/src/main/python/tests/driver/test_driver_remote_connection.py
+++ b/gremlin-python/src/main/python/tests/driver/test_driver_remote_connection.py
@@ -275,15 +275,15 @@ class TestDriverRemoteConnection(object):
 
         assert long(6) == g.V().count().toList()[0]
 
-    def test_should_propagate_use_compression(self):
+    def test_should_propagate_enable_compression(self):
         # Use Compression
-        drc = DriverRemoteConnection(anonymous_url, use_compression=True)
+        drc = DriverRemoteConnection(anonymous_url, enable_compression=True)
 
         aiohttp_kwargs = drc._client._transport_factory()._aiohttp_kwargs
         assert aiohttp_kwargs.get("compress") != 0
 
         # Disable Compression
-        drc = DriverRemoteConnection(anonymous_url, use_compression=False)
+        drc = DriverRemoteConnection(anonymous_url, enable_compression=False)
 
         aiohttp_kwargs = drc._client._transport_factory()._aiohttp_kwargs
         assert aiohttp_kwargs.get("compress") is None or aiohttp_kwargs.get("compress") == 0