[GitHub] [geode] sabbey37 commented on a change in pull request #5749: GEODE-8711: Enable SLOWLOG Redis command

[GitBox <gi...@apache.org>]

sabbey37 commented on a change in pull request #5749:
URL: https://github.com/apache/geode/pull/5749#discussion_r524387822



##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/RedisCommandType.java
##########
@@ -265,6 +267,9 @@
   FLUSHDB(new FlushAllExecutor(), UNSUPPORTED, new MaximumParameterRequirements(2, ERROR_SYNTAX)),
   INFO(new InfoExecutor(), UNSUPPORTED, new MaximumParameterRequirements(2, ERROR_SYNTAX)),
   SHUTDOWN(new ShutDownExecutor(), UNSUPPORTED, new MaximumParameterRequirements(2, ERROR_SYNTAX)),
+  SLOWLOG(new SlowlogExecutor(), UNSUPPORTED, new MinimumParameterRequirements(2)
+      .and(new MaximumParameterRequirements(3, ERROR_SYNTAX))
+      .and(new SlowlogParameterRequirements())),

Review comment:
       I don't think you need the `new MaximumParameterRequirements(3, ERROR_SYNTAX)` here.  In Redis, when more than 3 parameters are provided, the following error is returned: `ERR Unknown subcommand or wrong number of arguments for '[WHATEVER OPTION YOU TYPED]'. Try SLOWLOG HELP.` (not syntax error).

##########
File path: geode-redis/src/integrationTest/java/org/apache/geode/redis/internal/executor/server/AbstractSlowlogIntegrationTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License. You may obtain a
+ * copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.apache.geode.redis.internal.executor.server;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import java.util.List;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.Protocol;
+import redis.clients.jedis.util.Slowlog;
+
+import org.apache.geode.test.awaitility.GeodeAwaitility;
+import org.apache.geode.test.dunit.rules.RedisPortSupplier;
+
+public abstract class AbstractSlowlogIntegrationTest implements RedisPortSupplier {
+
+  private Jedis jedis;
+  private static final int REDIS_CLIENT_TIMEOUT =
+      Math.toIntExact(GeodeAwaitility.getTimeout().toMillis());
+
+  @Before
+  public void setUp() {
+    jedis = new Jedis("localhost", getPort(), REDIS_CLIENT_TIMEOUT);
+  }
+
+  @After
+  public void tearDown() {
+    jedis.close();
+  }
+
+  abstract int getExposedPort();
+
+  @Test
+  public void shouldReturnEmptyArray_whenGetSubcommandSpecified() {
+    List<Slowlog> actualResult = jedis.slowlogGet();
+
+    assertThat(actualResult.size()).isEqualTo(0);
+  }
+
+  @Test
+  public void shouldReturnEmptyArray_whenGetSubcommandSpecified_withLengthParameter() {
+    List<Slowlog> actualResult = jedis.slowlogGet(200);
+
+    assertThat(actualResult.size()).isEqualTo(0);
+  }
+
+  @Test
+  public void shouldReturnEmptyArray_whenGetSubcommandSpecified_withNegativeLengthParameter() {
+    List<Slowlog> actualResult = jedis.slowlogGet(-200);
+
+    assertThat(actualResult.size()).isEqualTo(0);
+  }
+
+  @Test
+  public void shouldReturnZero_whenLenSubcommandSpecified() {
+    Long length = jedis.slowlogLen();
+
+    assertThat(length).isEqualTo(0L);
+  }
+
+  @Test
+  public void shouldReturnOK_whenResetSubcommandSpecified() {
+    String response = jedis.slowlogReset();
+
+    assertThat(response).isEqualTo("OK");
+  }
+
+  @Test
+  public void shouldThrowException_IfResetGivenAParameter() {
+    assertThatThrownBy(
+        () -> jedis.sendCommand(
+            Protocol.Command.SLOWLOG, "RESET", "Superfluous"))
+                .hasMessageContaining("ERR Unknown subcommand or wrong number of arguments for");

Review comment:
       It would be nice to put the full error message here and verify that it matches exactly (so `hasMessage()` vs. `hasMessageContaining()` (if we end up returning the same messages as Redis).

##########
File path: geode-redis/src/integrationTest/java/org/apache/geode/redis/internal/executor/server/AbstractSlowlogIntegrationTest.java
##########
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License. You may obtain a
+ * copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.apache.geode.redis.internal.executor.server;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import java.util.List;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.Protocol;
+import redis.clients.jedis.util.Slowlog;
+
+import org.apache.geode.test.awaitility.GeodeAwaitility;
+import org.apache.geode.test.dunit.rules.RedisPortSupplier;
+
+public abstract class AbstractSlowlogIntegrationTest implements RedisPortSupplier {

Review comment:
       We should add tests for the error messages that get returned if less than 2 arguments are provided (so just `SLOWLOG`) and if more than 3 arguments are provided (like `SLOWLOG get 2 extraArg`) 

##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/executor/server/SlowlogExecutor.java
##########
@@ -30,7 +27,21 @@
   @Override
   public RedisResponse executeCommand(Command command,
       ExecutionHandlerContext context) {
-    List<ByteArrayWrapper> values = new ArrayList<ByteArrayWrapper>();
-    return RedisResponse.array(values);
+    String subCommand = command.getStringKey();
+    if (subCommand.toLowerCase().equals("get")) {
+      return RedisResponse.emptyArray();
+    } else if (subCommand.toLowerCase().equals("len")) {
+      return RedisResponse.integer(0);
+    } else if (subCommand.toLowerCase().equals("reset")) {
+      return RedisResponse.ok();
+    }
+    throw new RedisParametersMismatchException(wrongNumberOfArgumentsErrorMessage());
+  }
+
+  public String wrongNumberOfArgumentsErrorMessage() {
+    String result;
+    result = String
+        .format("Unknown subcommand or wrong number of arguments for 'len'. Try SLOWLOG HELP.");
+    return result;

Review comment:
       It seems kind of weird that we have this hard coded to `len`... right now if I type in `slowlog sjls`, I get `ERR Unknown subcommand or wrong number of arguments for 'len'. Try SLOWLOG HELP.` instead of `ERR Unknown subcommand or wrong number of arguments for 'jsls'. Try SLOWLOG HELP.` It also might be good to add this Error to the `RedisConstants` class.

##########
File path: geode-redis/src/main/java/org/apache/geode/redis/internal/ParameterRequirements/SlowlogParameterRequirements.java
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License. You may obtain a
+ * copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.apache.geode.redis.internal.ParameterRequirements;
+
+import static org.apache.geode.redis.internal.RedisConstants.ERROR_NOT_INTEGER;
+
+import org.apache.geode.redis.internal.netty.Command;
+import org.apache.geode.redis.internal.netty.ExecutionHandlerContext;
+
+public class SlowlogParameterRequirements implements ParameterRequirements {
+  @Override
+  public void checkParameters(Command command, ExecutionHandlerContext context) {
+    if (command.getProcessedCommand().size() == 3) {
+      if (!command.getStringKey().toLowerCase().equals("get")) {
+        throw new RedisParametersMismatchException(
+            unknownSubcommandOrWrongNumberOfArgumentsErrorMessage(command.getCommandType()
+                .name()));
+      }
+      try {
+        Integer.parseInt(new String(command.getProcessedCommand().get(2)));
+      } catch (NumberFormatException nex) {
+        throw new RedisParametersMismatchException(ERROR_NOT_INTEGER);
+      }
+    }
+  }
+
+  public String unknownSubcommandOrWrongNumberOfArgumentsErrorMessage(String command) {
+    String result;
+    result =
+        String.format("Unknown subcommand or wrong number of arguments for '%s'. Try SLOWLOG HELP.",
+            command);

Review comment:
       I think we'd want to put the `command.getStringKey()` here instead of the command (if we want to match what Redis does, not sure if this was discussed and we decided to do something different).




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org