Update FUNCTION LOAD changes (from release 7.0 rc3) (#2973)

* Update FUNCTION LOAD changes (Release 7.0 rc3) * update FUNCTION LIST * remove function load params * fix failure * lgtm report fix
redis · Apr 10, 2022 · 3c18734 · 3c18734
1 parent a41c7c6
commit 3c18734
Show file tree

Hide file tree

Showing 13 changed files with 101 additions and 158 deletions.
diff --git a/src/main/java/redis/clients/jedis/CommandObjects.java b/src/main/java/redis/clients/jedis/CommandObjects.java
@@ -2821,14 +2821,12 @@ public final CommandObject<List<LibraryInfo>> functionListWithCode(String librar
         .add(libraryNamePattern).add(WITHCODE), BuilderFactory.LIBRARY_LIST);
   }
 
-  public final CommandObject<String> functionLoad(String engineName, String libraryName, String functionCode) {
-    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(engineName)
-        .add(libraryName).add(functionCode), BuilderFactory.STRING);
+  public final CommandObject<String> functionLoad(String functionCode) {
+    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(functionCode), BuilderFactory.STRING);
   }
 
-  public final CommandObject<String> functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode) {
-    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(engineName)
-        .add(libraryName).addParams(params).add(functionCode), BuilderFactory.STRING);
+  public final CommandObject<String> functionLoadReplace(String functionCode) {
+    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(REPLACE).add(functionCode), BuilderFactory.STRING);
   }
 
   public final CommandObject<FunctionStats> functionStats() {
@@ -2893,14 +2891,12 @@ public final CommandObject<List<Object>> functionListWithCode(byte[] libraryName
         add(libraryNamePattern).add(WITHCODE), BuilderFactory.RAW_OBJECT_LIST);
   }
 
-  public final CommandObject<String> functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode) {
-    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(engineName)
-        .add(libraryName).add(functionCode), BuilderFactory.STRING);
+  public final CommandObject<String> functionLoad(byte[] functionCode) {
+    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(functionCode), BuilderFactory.STRING);
   }
 
-  public final CommandObject<String> functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode) {
-    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(engineName)
-        .add(libraryName).addParams(params).add(functionCode), BuilderFactory.STRING);
+  public final CommandObject<String> functionLoadReplace(byte[] functionCode) {
+    return new CommandObject<>(commandArguments(FUNCTION).add(LOAD).add(REPLACE).add(functionCode), BuilderFactory.STRING);
   }
 
   public final CommandObject<String> functionRestore(byte[] serializedValue) {

diff --git a/src/main/java/redis/clients/jedis/Jedis.java b/src/main/java/redis/clients/jedis/Jedis.java
@@ -8843,15 +8843,15 @@ public String functionDelete(final String libraryName) {
   }
 
   @Override
-  public String functionLoad(final String engineName, final String libraryName, final String functionCode) {
+  public String functionLoad(final String functionCode) {
     checkIsInMultiOrPipeline();
-    return connection.executeCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+    return connection.executeCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public String functionLoad(final String engineName, final String libraryName, final FunctionLoadParams params, final String functionCode) {
+  public String functionLoadReplace(final String functionCode) {
     checkIsInMultiOrPipeline();
-    return connection.executeCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+    return connection.executeCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override
@@ -9447,15 +9447,15 @@ public List<Object> functionListWithCode(final byte[] libraryNamePattern) {
   }
 
   @Override
-  public String functionLoad(final byte[] engineName, final byte[] libraryName, final byte[] functionCode) {
+  public String functionLoad(final byte[] functionCode) {
     checkIsInMultiOrPipeline();
-    return connection.executeCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+    return connection.executeCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public String functionLoad(final byte[] engineName, final byte[] libraryName, final FunctionLoadParams params, final byte[] functionCode) {
+  public String functionLoadReplace(final byte[] functionCode) {
     checkIsInMultiOrPipeline();
-    return connection.executeCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+    return connection.executeCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override

diff --git a/src/main/java/redis/clients/jedis/MultiNodePipelineBase.java b/src/main/java/redis/clients/jedis/MultiNodePipelineBase.java
@@ -1734,23 +1734,23 @@ public Response<List<Object>> functionListWithCode(final byte[] libraryNamePatte
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(String functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(String functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override

diff --git a/src/main/java/redis/clients/jedis/Pipeline.java b/src/main/java/redis/clients/jedis/Pipeline.java
@@ -1736,23 +1736,23 @@ public Response<List<Object>> functionListWithCode(final byte[] libraryNamePatte
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(String functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(String functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override

diff --git a/src/main/java/redis/clients/jedis/TransactionBase.java b/src/main/java/redis/clients/jedis/TransactionBase.java
@@ -1803,23 +1803,23 @@ public Response<List<Object>> functionListWithCode(final byte[] libraryNamePatte
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public Response<String> functionLoad(String functionCode) {
+    return appendCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(byte[] functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override
-  public Response<String> functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode) {
-    return appendCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public Response<String> functionLoadReplace(String functionCode) {
+    return appendCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override

diff --git a/src/main/java/redis/clients/jedis/UnifiedJedis.java b/src/main/java/redis/clients/jedis/UnifiedJedis.java
@@ -3140,13 +3140,13 @@ public List<LibraryInfo> functionListWithCode(String libraryNamePattern) {
   }
 
   @Override
-  public String functionLoad(String engineName, String libraryName, String functionCode) {
-    return executeCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public String functionLoad(String functionCode) {
+    return executeCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public String functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode) {
-    return executeCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public String functionLoadReplace(String functionCode) {
+    return executeCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override
@@ -3195,13 +3195,13 @@ public List<Object> functionListWithCode(final byte[] libraryNamePattern) {
   }
 
   @Override
-  public String functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode) {
-    return executeCommand(commandObjects.functionLoad(engineName, libraryName, functionCode));
+  public String functionLoad(byte[] functionCode) {
+    return executeCommand(commandObjects.functionLoad(functionCode));
   }
 
   @Override
-  public String functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode) {
-    return executeCommand(commandObjects.functionLoad(engineName, libraryName, params, functionCode));
+  public String functionLoadReplace(byte[] functionCode) {
+    return executeCommand(commandObjects.functionLoadReplace(functionCode));
   }
 
   @Override

diff --git a/src/main/java/redis/clients/jedis/commands/FunctionBinaryCommands.java b/src/main/java/redis/clients/jedis/commands/FunctionBinaryCommands.java
@@ -2,7 +2,6 @@
 
 import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.FunctionRestorePolicy;
-import redis.clients.jedis.params.FunctionLoadParams;
 import redis.clients.jedis.resps.FunctionStats;
 import redis.clients.jedis.resps.LibraryInfo;
 
@@ -89,22 +88,21 @@ public interface FunctionBinaryCommands {
 
   /**
    * Load a library to Redis.
-   * @param engineName the name of the execution engine for the library
-   * @param libraryName the unique name of the library
-   * @param functionCode the source code
-   * @return OK
+   * @param functionCode the source code. The library payload must start
+   *                     with Shebang statement that provides a metadata
+   *                     about the library (like the engine to use and the library name).
+   *                     Shebang format: #!<engine name> name=<library name>.
+   *                     Currently engine name must be lua.
+   * @return The library name that was loaded
    */
-  String functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode);
+  String functionLoad(byte[] functionCode);
 
   /**
-   * Load a library to Redis.
-   * @param engineName the name of the execution engine for the library
-   * @param libraryName the unique name of the library
-   * @param params {@link FunctionLoadParams}
+   * Load a library to Redis. Will replace the current library if it already exists.
    * @param functionCode the source code
-   * @return OK
+   * @return The library name that was loaded
    */
-  String functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode);
+  String functionLoadReplace(byte[] functionCode);
 
   /**
    * Restore libraries from the serialized payload. Default policy is APPEND.

diff --git a/src/main/java/redis/clients/jedis/commands/FunctionCommands.java b/src/main/java/redis/clients/jedis/commands/FunctionCommands.java
@@ -2,7 +2,6 @@
 
 import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.FunctionRestorePolicy;
-import redis.clients.jedis.params.FunctionLoadParams;
 import redis.clients.jedis.resps.FunctionStats;
 import redis.clients.jedis.resps.LibraryInfo;
 
@@ -93,22 +92,21 @@ public interface FunctionCommands {
 
   /**
    * Load a library to Redis.
-   * @param engineName the name of the execution engine for the library
-   * @param libraryName the unique name of the library
-   * @param functionCode the source code
-   * @return OK
+   * @param functionCode the source code. The library payload must start
+   *                     with Shebang statement that provides a metadata
+   *                     about the library (like the engine to use and the library name).
+   *                     Shebang format: #!<engine name> name=<library name>.
+   *                     Currently engine name must be lua.
+   * @return The library name that was loaded
    */
-  String functionLoad(String engineName, String libraryName, String functionCode);
+  String functionLoad(String functionCode);
 
   /**
-   * Load a library to Redis.
-   * @param engineName the name of the execution engine for the library
-   * @param libraryName the unique name of the library
-   * @param params {@link FunctionLoadParams}
+   * Load a library to Redis. Will replace the current library if it already exists.
    * @param functionCode the source code
-   * @return OK
+   * @return The library name that was loaded
    */
-  String functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode);
+  String functionLoadReplace(String functionCode);
 
   /**
    * Restore libraries from the serialized payload. Default policy is APPEND.

diff --git a/src/main/java/redis/clients/jedis/commands/FunctionPipelineBinaryCommands.java b/src/main/java/redis/clients/jedis/commands/FunctionPipelineBinaryCommands.java
@@ -3,7 +3,6 @@
 import redis.clients.jedis.Response;
 import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.FunctionRestorePolicy;
-import redis.clients.jedis.params.FunctionLoadParams;
 
 import java.util.List;
 
@@ -31,9 +30,9 @@ public interface FunctionPipelineBinaryCommands {
 
   Response<List<Object>> functionListWithCode(byte[] libraryNamePattern);
 
-  Response<String> functionLoad(byte[] engineName, byte[] libraryName, byte[] functionCode);
+  Response<String> functionLoad(byte[] functionCode);
 
-  Response<String> functionLoad(byte[] engineName, byte[] libraryName, FunctionLoadParams params, byte[] functionCode);
+  Response<String> functionLoadReplace(byte[] functionCode);
 
   Response<String> functionRestore(byte[] serializedValue);
 

diff --git a/src/main/java/redis/clients/jedis/commands/FunctionPipelineCommands.java b/src/main/java/redis/clients/jedis/commands/FunctionPipelineCommands.java
@@ -3,7 +3,6 @@
 import redis.clients.jedis.Response;
 import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.FunctionRestorePolicy;
-import redis.clients.jedis.params.FunctionLoadParams;
 import redis.clients.jedis.resps.FunctionStats;
 import redis.clients.jedis.resps.LibraryInfo;
 
@@ -33,9 +32,9 @@ public interface FunctionPipelineCommands {
 
   Response<List<LibraryInfo>> functionListWithCode(String libraryNamePattern);
 
-  Response<String> functionLoad(String engineName, String libraryName, String functionCode);
+  Response<String> functionLoad(String functionCode);
 
-  Response<String> functionLoad(String engineName, String libraryName, FunctionLoadParams params, String functionCode);
+  Response<String> functionLoadReplace(String functionCode);
 
   Response<String> functionRestore(byte[] serializedValue);
 

diff --git a/src/main/java/redis/clients/jedis/params/FunctionLoadParams.java b/src/main/java/redis/clients/jedis/params/FunctionLoadParams.java