SammyVimes commented on code in PR #10042: URL: https://github.com/apache/ignite/pull/10042#discussion_r908449223
########## modules/control-utility/src/main/java/org/apache/ignite/internal/commandline/cache/CacheScheduleIndexesRebuild.java: ########## @@ -0,0 +1,320 @@ +/* + * 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.ignite.internal.commandline.cache; + +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.logging.Logger; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.apache.ignite.internal.client.GridClient; +import org.apache.ignite.internal.client.GridClientConfiguration; +import org.apache.ignite.internal.commandline.AbstractCommand; +import org.apache.ignite.internal.commandline.Command; +import org.apache.ignite.internal.commandline.CommandArgIterator; +import org.apache.ignite.internal.commandline.TaskExecutor; +import org.apache.ignite.internal.commandline.argument.CommandArgUtils; +import org.apache.ignite.internal.commandline.cache.argument.IndexRebuildCommandArg; +import org.apache.ignite.internal.util.typedef.F; +import org.apache.ignite.internal.util.typedef.internal.S; +import org.apache.ignite.internal.visor.cache.index.ScheduleIndexRebuildTaskArg; +import org.apache.ignite.internal.visor.cache.index.ScheduleIndexRebuildTaskRes; + +import static java.util.stream.Collectors.toSet; +import static org.apache.ignite.internal.commandline.CommandLogger.INDENT; +import static org.apache.ignite.internal.commandline.cache.argument.IndexRebuildCommandArg.CACHE_GROUPS_TARGET; +import static org.apache.ignite.internal.commandline.cache.argument.IndexRebuildCommandArg.CACHE_NAMES_TARGET; +import static org.apache.ignite.internal.commandline.cache.argument.IndexRebuildCommandArg.NODE_ID; + +/** + * Cache subcommand that schedules indexes rebuild via the maintenance mode. + */ +public class CacheScheduleIndexesRebuild extends AbstractCommand<CacheScheduleIndexesRebuild.Arguments> { + /** --cache-names parameter format. */ + private static final String CACHE_NAMES_FORMAT = "cacheName[index1,...indexN],cacheName2,cacheName3[index1]"; + + /** --group-names parameter format. */ + private static final String CACHE_GROUPS_FORMAT = "groupName1,groupName2,...groupNameN"; + + /** Command's parsed arguments. */ + private Arguments args; + + /** {@inheritDoc} */ + @Override public void printUsage(Logger logger) { + String desc = "Schedules rebuild of the indexes for specified caches via the Maintenance Mode."; + + Map<String, String> map = new LinkedHashMap<>(2); + + map.put(NODE_ID.argName(), "(Optional) Specify node for indexes rebuild."); + + map.put( + CACHE_NAMES_TARGET.argName(), + "Comma-separated list of cache names with optionally specified indexes. If indexes are not specified then all indexes " + + "of the cache will be scheduled for the rebuild operation." + ); + + map.put(CACHE_GROUPS_TARGET.argName(), "Comma-separated list of cache group names for which indexes should be scheduled for the " + + "rebuild."); + + usageCache( + logger, + CacheSubcommands.INDEX_REBUILD, + desc, + map, + NODE_ID.argName() + " nodeId", + CACHE_NAMES_TARGET + " " + CACHE_NAMES_FORMAT, + CACHE_GROUPS_TARGET + " " + CACHE_GROUPS_FORMAT + ); + } + + /** {@inheritDoc} */ + @Override public Object execute(GridClientConfiguration clientCfg, Logger logger) throws Exception { + ScheduleIndexRebuildTaskRes taskRes; + + try (GridClient client = Command.startClient(clientCfg)) { + UUID nodeId = args.nodeId; + + if (nodeId == null) + nodeId = TaskExecutor.BROADCAST_UUID; + + taskRes = TaskExecutor.executeTaskByNameOnNode( + client, + "org.apache.ignite.internal.visor.cache.index.ScheduleIndexRebuildTask", + new ScheduleIndexRebuildTaskArg(args.cacheToIndexes, args.cacheGroups), + nodeId, + clientCfg + ); + } + + printResult(taskRes, logger); + + return taskRes; + } + + /** + * @param taskRes Rebuild task result. + * @param logger Logger to print to. + */ + private void printResult(ScheduleIndexRebuildTaskRes taskRes, Logger logger) { + taskRes.results().forEach((nodeId, res) -> { + printMissed(logger, "WARNING: These caches were not found:", res.notFoundCacheNames()); + printMissed(logger, "WARNING: These cache groups were not found:", res.notFoundGroupNames()); + + if (!F.isEmpty(res.notFoundIndexes()) && hasAtLeastOneIndex(res.notFoundIndexes())) { + String warning = "WARNING: These indexes were not found:"; + + logger.info(warning); + + printCachesAndIndexes(res.notFoundIndexes(), logger); + } + + if (!F.isEmpty(res.cacheToIndexes()) && hasAtLeastOneIndex(res.cacheToIndexes())) { + logger.info("Indexes rebuild was scheduled for these caches:"); + + printCachesAndIndexes(res.cacheToIndexes(), logger); + } + else + logger.info("WARNING: Indexes rebuild was not scheduled for any cache. Check command input."); + + logger.info(""); + }); + } + + /** + * Prints missed caches' or cache groups' names. + * + * @param logger Logger. + * @param warning Warning message. + * @param missed Missed caches or cache groups' names. + */ + private void printMissed(Logger logger, String warning, Set<String> missed) { + if (!F.isEmpty(missed)) { + logger.info(warning); + + missed.stream() + .sorted() + .forEach(name -> logger.info(INDENT + name)); + + logger.info(""); + } + } + + /** + * Prints caches and their indexes. + * + * @param cachesToIndexes Cache -> indexes map. + * @param logger Logger. + */ + private static void printCachesAndIndexes(Map<String, Set<String>> cachesToIndexes, Logger logger) { + cachesToIndexes.forEach((cacheName, indexes) -> { + logger.info(INDENT + cacheName + ":"); + indexes.forEach(index -> logger.info(INDENT + INDENT + index)); + }); + } + + /** + * @param cacheToIndexes Cache name -> indexes map. + * @return {@code true} if has at least one index in the map, {@code false} otherwise. + */ + private static boolean hasAtLeastOneIndex(Map<String, Set<String>> cacheToIndexes) { + return cacheToIndexes.values().stream() + .anyMatch(indexes -> !indexes.isEmpty()); + } + + /** {@inheritDoc} */ + @Override public Arguments arg() { + return args; + } + + /** {@inheritDoc} */ + @Override public String name() { + return CacheSubcommands.INDEX_REBUILD.text().toUpperCase(); + } + + /** + * Container for command arguments. + */ + public static class Arguments { + /** Node id. */ + private final UUID nodeId; + + /** Cache name -> indexes. */ + private final Map<String, Set<String>> cacheToIndexes; + + /** Cache groups' names. */ + private final Set<String> cacheGroups; + + /** */ + private Arguments(UUID nodeId, Map<String, Set<String>> cacheToIndexes, Set<String> cacheGroups) { + this.nodeId = nodeId; + this.cacheToIndexes = cacheToIndexes; + this.cacheGroups = cacheGroups; + } + + /** + * @return Cache -> indexes map. + */ + public Map<String, Set<String>> cacheToIndexes() { + return cacheToIndexes; + } + + /** + * @return Cache groups. + */ + public Set<String> cacheGroups() { + return cacheGroups; + } + + /** {@inheritDoc} */ + @Override public String toString() { + return S.toString(Arguments.class, this); + } + } + + /** {@inheritDoc} */ + @Override public void parseArguments(CommandArgIterator argIterator) { + UUID nodeId = null; + Map<String, Set<String>> cacheToIndexes = null; + Set<String> cacheGroups = null; + + while (argIterator.hasNextSubArg()) { + String nextArg = argIterator.nextArg(""); + + IndexRebuildCommandArg arg = CommandArgUtils.of(nextArg, IndexRebuildCommandArg.class); + + if (arg == null) + throw new IllegalArgumentException("Unknown argument: " + nextArg); + + switch (arg) { + case NODE_ID: + if (nodeId != null) + throw new IllegalArgumentException(arg.argName() + " arg specified twice."); + + nodeId = UUID.fromString(argIterator.nextArg("Failed to read node id.")); + + break; + + case CACHE_NAMES_TARGET: + if (cacheToIndexes != null) + throw new IllegalArgumentException(arg.argName() + " arg specified twice."); + + cacheToIndexes = new HashMap<>(); + + String cacheNamesArg = argIterator.nextArg("Expected a comma-separated cache names (and optionally a" + + " comma-separated list of index names in square brackets)."); + + Pattern cacheNamesPattern = Pattern.compile("([^,\\[\\]]+)(\\[(.*?)])?"); + Matcher matcher = cacheNamesPattern.matcher(cacheNamesArg); + + boolean found = false; + + while (matcher.find()) { + found = true; + + String cacheName = matcher.group(1); + String commaSeparatedIndexes = matcher.group(3); + + if (F.isEmpty(commaSeparatedIndexes)) { + cacheToIndexes.put(cacheName, Collections.emptySet()); + + continue; + } + + Set<String> indexes = Arrays.stream(commaSeparatedIndexes.split(",")).collect(toSet()); + cacheToIndexes.put(cacheName, indexes); + } + + if (!found) + throw new IllegalArgumentException("Wrong format for --cache-names, should be: " + CACHE_NAMES_FORMAT); + + break; + + case CACHE_GROUPS_TARGET: + if (cacheGroups != null) + throw new IllegalArgumentException(arg.argName() + " arg specified twice."); + + String cacheGroupsArg = argIterator.nextArg("Expected comma-separated cache group names"); + + cacheGroups = Arrays.stream(cacheGroupsArg.split(",")).collect(toSet()); + + break; + + default: + throw new IllegalArgumentException("Unknown argument: " + arg.argName()); + } + } + + args = new Arguments(nodeId, cacheToIndexes, cacheGroups); + + validateArguments(); + } + + /** */ + private void validateArguments() { + Set<String> cacheGroups = args.cacheGroups; + Map<String, Set<String>> cacheToIndexes = args.cacheToIndexes; + + if (cacheGroups == null && cacheToIndexes == null && cacheGroups.isEmpty() && cacheToIndexes.isEmpty()) Review Comment: Ouch, you're right -- 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. To unsubscribe, e-mail: notifications-unsubscr...@ignite.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
