Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Verify command methods using Redis COMMAND metadata
- Loading branch information
Showing
9 changed files
with
419 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
src/main/java/com/lambdaworks/redis/dynamic/CommandMethodSyntaxException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| package com.lambdaworks.redis.dynamic; | ||
|
|
||
| /** | ||
| * @author Mark Paluch | ||
| */ | ||
| public class CommandMethodSyntaxException extends CommandCreationException { | ||
|
|
||
| public CommandMethodSyntaxException(CommandMethod commandMethod, String msg) { | ||
| super(commandMethod, msg); | ||
| } | ||
| } |
191 changes: 191 additions & 0 deletions
191
src/main/java/com/lambdaworks/redis/dynamic/CommandMethodVerifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| package com.lambdaworks.redis.dynamic; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import com.lambdaworks.redis.LettuceStrings; | ||
| import com.lambdaworks.redis.dynamic.parameter.Parameter; | ||
| import com.lambdaworks.redis.dynamic.segment.CommandSegments; | ||
| import com.lambdaworks.redis.internal.LettuceAssert; | ||
| import com.lambdaworks.redis.internal.LettuceLists; | ||
| import com.lambdaworks.redis.models.command.CommandDetail; | ||
|
|
||
| /** | ||
| * Verifies {@link CommandMethod} declarations by checking available Redis commands. | ||
| * | ||
| * @author Mark Paluch | ||
| */ | ||
| class CommandMethodVerifier { | ||
|
|
||
| /** | ||
| * Default maximum property distance: 2 | ||
| */ | ||
| public static final int DEFAULT_MAX_DISTANCE = 2; | ||
|
|
||
| private List<CommandDetail> commandDetails; | ||
|
|
||
| /** | ||
| * Create a new {@link CommandMethodVerifier} given a {@link List} of {@link CommandDetail} | ||
| * | ||
| * @param commandDetails must not be {@literal null}. | ||
| */ | ||
| public CommandMethodVerifier(List<CommandDetail> commandDetails) { | ||
|
|
||
| LettuceAssert.notNull(commandDetails, "Command details must not be null"); | ||
|
|
||
| this.commandDetails = LettuceLists.newList(commandDetails); | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * Verify a {@link CommandMethod} with its {@link CommandSegments}. This method verifies that the command exists and that | ||
| * the required number of arguments is declared. | ||
| * | ||
| * @param commandSegments | ||
| * @param commandMethod | ||
| */ | ||
| public void validate(CommandSegments commandSegments, CommandMethod commandMethod) throws CommandMethodSyntaxException { | ||
|
|
||
| LettuceAssert.notEmpty(commandSegments.getCommandType().name(), "Command name must not be empty"); | ||
|
|
||
| CommandDetail commandDetail = findCommandDetail(commandSegments.getCommandType().name()) | ||
| .orElseThrow(() -> syntaxException(commandSegments.getCommandType().name(), commandMethod)); | ||
|
|
||
| validateParameters(commandDetail, commandSegments, commandMethod); | ||
| } | ||
|
|
||
| private void validateParameters(CommandDetail commandDetail, CommandSegments commandSegments, CommandMethod commandMethod) { | ||
|
|
||
| List<? extends Parameter> bindableParameters = commandMethod.getParameters().getBindableParameters(); | ||
|
|
||
| int availableParameterCount = bindableParameters.size() + commandSegments.size(); | ||
|
|
||
| // exact parameter count | ||
| if (commandDetail.getArity() - 1 == availableParameterCount) { | ||
| return; | ||
| } | ||
|
|
||
| // more or same parameter cound for dynamic arg count commands | ||
| if (0 > commandDetail.getArity() && availableParameterCount >= -(commandDetail.getArity() + 1)) { | ||
| return; | ||
| } | ||
|
|
||
| for (Parameter bindableParameter : bindableParameters) { | ||
|
|
||
| // Can't verify collection-like arguments as they may contain multiple elements. | ||
| if (bindableParameter.getTypeInformation().isCollectionLike()) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| String message; | ||
| if (commandDetail.getArity() == 1) { | ||
| message = String.format("Command %s accepts no parameters.", commandDetail.getName().toUpperCase()); | ||
| } else if (commandDetail.getArity() < -1) { | ||
| message = String.format("Command %s requires at least %d parameters but method declares %d parameter(s).", | ||
| commandDetail.getName().toUpperCase(), Math.abs(commandDetail.getArity()) - 1, availableParameterCount); | ||
| } else { | ||
| message = String.format("Command %s accepts %d parameters but method declares %d parameter(s).", | ||
| commandDetail.getName().toUpperCase(), commandDetail.getArity() - 1, availableParameterCount); | ||
| } | ||
|
|
||
| throw new CommandMethodSyntaxException(commandMethod, message); | ||
| } | ||
|
|
||
| private CommandMethodSyntaxException syntaxException(String commandName, CommandMethod commandMethod) { | ||
|
|
||
| CommandMatches commandMatches = CommandMatches.forCommand(commandName, commandDetails); | ||
|
|
||
| if (commandMatches.hasMatches()) { | ||
| return new CommandMethodSyntaxException(commandMethod, | ||
| String.format("Command %s does not exist. Did you mean: %s?", commandName, commandMatches)); | ||
| } | ||
|
|
||
| return new CommandMethodSyntaxException(commandMethod, String.format("Command %s does not exist", commandName)); | ||
|
|
||
| } | ||
|
|
||
| private Optional<CommandDetail> findCommandDetail(String commandName) { | ||
| return commandDetails.stream().filter(commandDetail -> commandDetail.getName().equalsIgnoreCase(commandName)) | ||
| .findFirst(); | ||
| } | ||
|
|
||
| static class CommandMatches { | ||
|
|
||
| private final List<String> matches = new ArrayList<>(); | ||
|
|
||
| private CommandMatches(List<String> matches) { | ||
| this.matches.addAll(matches); | ||
| } | ||
|
|
||
| public static CommandMatches forCommand(String command, List<CommandDetail> commandDetails) { | ||
| return new CommandMatches(calculateMatches(command, commandDetails)); | ||
| } | ||
|
|
||
| private static List<String> calculateMatches(String command, List<CommandDetail> commandDetails) { | ||
|
|
||
| return commandDetails.stream() // | ||
| .filter(commandDetail -> calculateStringDistance(commandDetail.getName().toLowerCase(), | ||
| command.toLowerCase()) <= DEFAULT_MAX_DISTANCE) | ||
| .map(CommandDetail::getName) // | ||
| .map(String::toUpperCase) // | ||
| .sorted((o1, o2) -> calculateStringDistance(o1, o2)).collect(Collectors.toList()); | ||
| } | ||
|
|
||
| public boolean hasMatches() { | ||
| return !matches.isEmpty(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return LettuceStrings.collectionToDelimitedString(matches, ", ", "", ""); | ||
| } | ||
|
|
||
| /** | ||
| * Calculate the distance between the given two Strings according to the Levenshtein algorithm. | ||
| * | ||
| * @param s1 the first String | ||
| * @param s2 the second String | ||
| * @return the distance value | ||
| */ | ||
| private static int calculateStringDistance(String s1, String s2) { | ||
|
|
||
| if (s1.length() == 0) { | ||
| return s2.length(); | ||
| } | ||
|
|
||
| if (s2.length() == 0) { | ||
| return s1.length(); | ||
| } | ||
|
|
||
| int d[][] = new int[s1.length() + 1][s2.length() + 1]; | ||
|
|
||
| for (int i = 0; i <= s1.length(); i++) { | ||
| d[i][0] = i; | ||
| } | ||
|
|
||
| for (int j = 0; j <= s2.length(); j++) { | ||
| d[0][j] = j; | ||
| } | ||
|
|
||
| for (int i = 1; i <= s1.length(); i++) { | ||
| char s_i = s1.charAt(i - 1); | ||
| for (int j = 1; j <= s2.length(); j++) { | ||
| int cost; | ||
| char t_j = s2.charAt(j - 1); | ||
| if (s_i == t_j) { | ||
| cost = 0; | ||
| } else { | ||
| cost = 1; | ||
| } | ||
| d[i][j] = Math.min(Math.min(d[i - 1][j] + 1, d[i][j - 1] + 1), d[i - 1][j - 1] + cost); | ||
| } | ||
| } | ||
|
|
||
| return d[s1.length()][s2.length()]; | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.