albertogpz commented on a change in pull request #6601: URL: https://github.com/apache/geode/pull/6601#discussion_r655665242
########## File path: geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/functions/WanCopyRegionFunction.java ########## @@ -0,0 +1,480 @@ +/* + * 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.management.internal.cli.functions; + +import java.io.IOException; +import java.io.PrintWriter; +import java.io.Serializable; +import java.io.StringWriter; +import java.io.Writer; +import java.time.Clock; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.Set; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import org.apache.logging.log4j.Logger; + +import org.apache.geode.annotations.VisibleForTesting; +import org.apache.geode.cache.Declarable; +import org.apache.geode.cache.EntryDestroyedException; +import org.apache.geode.cache.Operation; +import org.apache.geode.cache.Region; +import org.apache.geode.cache.client.AllConnectionsInUseException; +import org.apache.geode.cache.client.NoAvailableServersException; +import org.apache.geode.cache.client.ServerConnectivityException; +import org.apache.geode.cache.client.internal.Connection; +import org.apache.geode.cache.client.internal.PoolImpl; +import org.apache.geode.cache.client.internal.pooling.ConnectionDestroyedException; +import org.apache.geode.cache.client.internal.pooling.PooledConnection; +import org.apache.geode.cache.execute.FunctionContext; +import org.apache.geode.cache.wan.GatewayQueueEvent; +import org.apache.geode.cache.wan.GatewaySender; +import org.apache.geode.internal.cache.BucketRegion; +import org.apache.geode.internal.cache.DefaultEntryEventFactory; +import org.apache.geode.internal.cache.EntryEventImpl; +import org.apache.geode.internal.cache.EntrySnapshot; +import org.apache.geode.internal.cache.EnumListenerEvent; +import org.apache.geode.internal.cache.InternalCache; +import org.apache.geode.internal.cache.InternalRegion; +import org.apache.geode.internal.cache.NonTXEntry; +import org.apache.geode.internal.cache.PartitionedRegion; +import org.apache.geode.internal.cache.wan.AbstractGatewaySender; +import org.apache.geode.internal.cache.wan.BatchException70; +import org.apache.geode.internal.cache.wan.GatewaySenderEventDispatcher; +import org.apache.geode.internal.cache.wan.GatewaySenderEventImpl; +import org.apache.geode.internal.cache.wan.InternalGatewaySender; +import org.apache.geode.internal.serialization.KnownVersion; +import org.apache.geode.logging.internal.executors.LoggingExecutors; +import org.apache.geode.logging.internal.log4j.api.LogService; +import org.apache.geode.management.cli.CliFunction; +import org.apache.geode.management.internal.functions.CliFunctionResult; +import org.apache.geode.management.internal.i18n.CliStrings; + +/** + * Class for copying via WAN the contents of a region + * It must be executed in all members of the Geode cluster that host the region + * to be copied. (called with onServers() or withMembers() passing the list + * of all members hosting the region). + * It also offers the possibility to cancel an ongoing execution of this function. + * The copying itself is executed in a new thread with a known name + * (parameterized with the regionName and senderId) in order to allow + * to cancel ongoing invocations by interrupting that thread. + * + * It accepts the following arguments in an array of objects + * 0: regionName (String) + * 1: senderId (String) + * 2: isCancel (Boolean): If true, it indicates that an ongoing execution of this + * function for the given region and senderId must be stopped. Otherwise, + * it indicates that the region must be copied. + * 3: maxRate (Long) maximum copy rate in entries per second. In the case of + * parallel gateway senders, the maxRate is per server hosting the region. + * 4: batchSize (Integer): the size of the batches. Region entries are copied in batches of the + * passed size. After each batch is sent, the function checks if the command + * must be canceled and also sleeps for some time if necessary to adjust the + * copy rate to the one passed as argument. + */ +public class WanCopyRegionFunction extends CliFunction<Object[]> implements Declarable { + private static final Logger logger = LogService.getLogger(); + private static final long serialVersionUID = 1L; + + public static final String ID = WanCopyRegionFunction.class.getName(); + + private static final int MAX_BATCH_SEND_RETRIES = 1; + + private Clock clock = Clock.systemDefaultZone(); + private ThreadSleeper threadSleeper = new ThreadSleeper(); + + static class ThreadSleeper implements Serializable { + void millis(long millis) throws InterruptedException { + Thread.sleep(millis); + } + } + + @VisibleForTesting + public void setClock(Clock clock) { + this.clock = clock; + } + + @VisibleForTesting + public void setThreadSleeper(ThreadSleeper ts) { + this.threadSleeper = ts; + } + + @Override + public String getId() { + return ID; + } + + @Override + public boolean hasResult() { + return true; + } + + @Override + public boolean isHA() { + return false; + } + + @Override + public CliFunctionResult executeFunction(FunctionContext<Object[]> context) { + final Object[] args = context.getArguments(); + if (args.length < 5) { + throw new IllegalStateException( + "Arguments length does not match required length."); + } + final String regionName = (String) args[0]; + final String senderId = (String) args[1]; + final boolean isCancel = (Boolean) args[2]; + long maxRate = (Long) args[3]; + int batchSize = (Integer) args[4]; + + final InternalCache cache = (InternalCache) context.getCache(); + + if (isCancel) { + return cancelWanCopyRegion(context, regionName, senderId); + } + + final Region region = cache.getRegion(regionName); + if (region == null) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__REGION__NOT__FOUND, regionName)); + } + + GatewaySender sender = cache.getGatewaySender(senderId); + if (sender == null) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__SENDER__NOT__FOUND, senderId)); + } + + if (!region.getAttributes().getGatewaySenderIds().contains(sender.getId())) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__REGION__NOT__USING_SENDER, regionName, + senderId)); + } + + if (!sender.isRunning()) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__SENDER__NOT__RUNNING, senderId)); + } + + if (!sender.isParallel() && !((InternalGatewaySender) sender).isPrimary()) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.OK, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__SENDER__SERIAL__AND__NOT__PRIMARY, + senderId)); + } + + try { + return executeWanCopyRegionFunctionInNewThread(context, region, regionName, sender, maxRate, + batchSize); + } catch (InterruptedException e) { + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.WAN_COPY_REGION__MSG__EXECUTION__CANCELED); + } catch (ExecutionException e) { + Writer buffer = new StringWriter(); + PrintWriter pw = new PrintWriter(buffer); + e.printStackTrace(pw); + logger.error("Exception when running wan-copy region command: {}", buffer.toString()); + return new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR, + CliStrings.format(CliStrings.WAN_COPY_REGION__MSG__EXECUTION__FAILED, e.getMessage())); + } + } + + private CliFunctionResult executeWanCopyRegionFunctionInNewThread( + FunctionContext<Object[]> context, + Region region, String regionName, GatewaySender sender, long maxRate, int batchSize) + throws InterruptedException, ExecutionException { + ExecutorService executor = LoggingExecutors + .newSingleThreadExecutor(getFunctionThreadName(regionName, + sender.getId()), true); Review comment: @kirklund Thanks for the advice. The problem here is that you could have several instances of this function running and you may want to stop one of them. How could you access the specific instance from a command in order to call the shutdown() method of the `ExecutorService`? In order to use a more usual way to cancel the threads, I have added static fields to the function class with the `ExecutorService` to be used by any instance of this function and the current executions (`Futures`) so that, if one of them is required to be canceled, you can identify the execution by the senderId and region, get the Future and then invoke cancel on it. You could also cancel all executions by invoking shutdownNow() on the executor as you suggested. Nevertheless, if you do that, you would not be able to create new executions. I do not like using static variables but I have not found any better way. -- 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: [email protected]
