HBASE-22700 refactor isMetaClearingException (apache#578)

(cherry picked from commit b1d4878)

Change-Id: I0cee17d3d5bb80ddb880be07f0edab9ef7a8b890

hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncRegionLocatorHelper.java

@@ -19,6 +19,7 @@
 
 import static org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil.findException;
 import static org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil.isMetaClearingException;
+import static org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil.isRegionServerOverloadedException;
 
 import java.util.Arrays;
 import java.util.Optional;
@@ -67,7 +68,8 @@ static void updateCachedLocationOnError(HRegionLocation loc, Throwable exception
       LOG.debug("The actual exception when updating {} is {}", loc,
         cause != null ? cause.toString() : "none");
     }
-    if (cause == null || !isMetaClearingException(cause)) {
+    if (cause == null || !isMetaClearingException(cause)
+        || isRegionServerOverloadedException(cause)) {
       LOG.debug("Will not update {} because the exception is null or not the one we care about",
         loc);
       return;

hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncRequestFutureImpl.java

@@ -711,7 +711,8 @@ private void receiveGlobalFailure(
       // Do not use the exception for updating cache because it might be coming from
       // any of the regions in the MultiAction.
       updateCachedLocations(server, regionName, row,
-        ClientExceptionsUtil.isMetaClearingException(t) ? null : t);
+        ClientExceptionsUtil.isMetaClearingException(t) &&
+            !ClientExceptionsUtil.isRegionServerOverloadedException(t) ? null : t);
       for (Action action : e.getValue()) {
         Retry retry = manageError(
             action.getOriginalIndex(), action.getAction(), canRetry, t, server);
@@ -913,7 +914,8 @@ private void invokeCallBack(byte[] regionName, byte[] row, CResult result) {
   }
 
   private void cleanServerCache(ServerName server, Throwable regionException) {
-    if (ClientExceptionsUtil.isMetaClearingException(regionException)) {
+    if (ClientExceptionsUtil.isMetaClearingException(regionException)
+        && !ClientExceptionsUtil.isRegionServerOverloadedException(regionException)) {
       // We want to make sure to clear the cache in case there were location-related exceptions.
       // We don't to clear the cache for every possible exception that comes through, however.
       asyncProcess.connection.clearCaches(server);

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionImplementation.java

@@ -1911,7 +1911,8 @@ public void updateCachedLocations(final TableName tableName, byte[] regionName,
     RegionInfo regionInfo = oldLocation.getRegion();
     Throwable cause = ClientExceptionsUtil.findException(exception);
     if (cause != null) {
-      if (!ClientExceptionsUtil.isMetaClearingException(cause)) {
+      if (!ClientExceptionsUtil.isMetaClearingException(cause)
+          || ClientExceptionsUtil.isRegionServerOverloadedException(cause)) {
         // We know that the region is still on this region server
         return;
       }

hbase-client/src/main/java/org/apache/hadoop/hbase/exceptions/ClientExceptionsUtil.java

@@ -32,7 +32,6 @@
 import org.apache.hadoop.hbase.CallDroppedException;
 import org.apache.hadoop.hbase.CallQueueTooBigException;
 import org.apache.hadoop.hbase.DoNotRetryIOException;
-import org.apache.hadoop.hbase.MultiActionResultTooLarge;
 import org.apache.hadoop.hbase.NotServingRegionException;
 import org.apache.hadoop.hbase.RegionTooBusyException;
 import org.apache.hadoop.hbase.RetryImmediatelyException;
@@ -59,18 +58,28 @@ public static boolean isMetaClearingException(Throwable cur) {
     if (cur == null) {
       return true;
     }
-    return !isSpecialException(cur) || (cur instanceof RegionMovedException)
-        || cur instanceof NotServingRegionException;
+    return !isMetaCachePreservingException(cur);
   }
 
-  public static boolean isSpecialException(Throwable cur) {
-    return (cur instanceof RegionMovedException || cur instanceof RegionOpeningException
-        || cur instanceof RegionTooBusyException || cur instanceof RpcThrottlingException
-        || cur instanceof MultiActionResultTooLarge || cur instanceof RetryImmediatelyException
-        || cur instanceof CallQueueTooBigException || cur instanceof CallDroppedException
-        || cur instanceof NotServingRegionException || cur instanceof RequestTooBigException);
+  public static boolean isRegionServerOverloadedException(Throwable t) {
+    t = findException(t);
+    return isInstanceOfRegionServerOverloadedException(t);
+  }
+
+  private static boolean isInstanceOfRegionServerOverloadedException(Throwable t) {
+    return t instanceof CallQueueTooBigException || t instanceof CallDroppedException;
   }
 
+  private static boolean isMetaCachePreservingException(Throwable t) {
+    return t instanceof RegionOpeningException || t instanceof RegionTooBusyException
+        || t instanceof RpcThrottlingException || t instanceof RetryImmediatelyException
+        || t instanceof RequestTooBigException;
+  }
+
+  private static boolean isExceptionWeCare(Throwable t) {
+    return isMetaCachePreservingException(t) || isInstanceOfRegionServerOverloadedException(t)
+        || t instanceof NotServingRegionException;
+  }
 
   /**
    * Look for an exception we know in the remote exception:
@@ -87,15 +96,15 @@ public static Throwable findException(Object exception) {
     }
     Throwable cur = (Throwable) exception;
     while (cur != null) {
-      if (isSpecialException(cur)) {
+      if (isExceptionWeCare(cur)) {
         return cur;
       }
       if (cur instanceof RemoteException) {
         RemoteException re = (RemoteException) cur;
         cur = re.unwrapRemoteException();
 
         // unwrapRemoteException can return the exception given as a parameter when it cannot
-        //  unwrap it. In this case, there is no need to look further
+        // unwrap it. In this case, there is no need to look further
         // noinspection ObjectEquality
         if (cur == re) {
           return cur;

hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestMetaCache.java

@@ -27,6 +27,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.CallDroppedException;
 import org.apache.hadoop.hbase.CallQueueTooBigException;
 import org.apache.hadoop.hbase.HBaseClassTestRule;
 import org.apache.hadoop.hbase.HBaseTestingUtility;
@@ -40,6 +41,7 @@
 import org.apache.hadoop.hbase.TableName;
 import org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil;
 import org.apache.hadoop.hbase.exceptions.RegionOpeningException;
+import org.apache.hadoop.hbase.exceptions.RequestTooBigException;
 import org.apache.hadoop.hbase.quotas.RpcThrottlingException;
 import org.apache.hadoop.hbase.regionserver.HRegionServer;
 import org.apache.hadoop.hbase.regionserver.RSRpcServices;
@@ -143,12 +145,14 @@ public void testPreserveMetaCacheOnException() throws Exception {
           table.mutateRow(mutations);
         } catch (IOException ex) {
           // Only keep track of the last exception that updated the meta cache
-          if (ClientExceptionsUtil.isMetaClearingException(ex) || success) {
+          if ((ClientExceptionsUtil.isMetaClearingException(ex)
+              && !ClientExceptionsUtil.isRegionServerOverloadedException(ex)) || success) {
             exp = ex;
           }
         }
         // Do not test if we did not touch the meta cache in this iteration.
-        if (exp != null && ClientExceptionsUtil.isMetaClearingException(exp)) {
+        if (exp != null && ClientExceptionsUtil.isMetaClearingException(exp)
+            && !ClientExceptionsUtil.isRegionServerOverloadedException(exp)) {
           assertNull(conn.getCachedLocation(TABLE_NAME, row));
         } else if (success) {
           assertNotNull(conn.getCachedLocation(TABLE_NAME, row));
@@ -207,7 +211,9 @@ public static List<Throwable> metaCachePreservingExceptions() {
         add(new RpcThrottlingException(" "));
         add(new MultiActionResultTooLarge(" "));
         add(new RetryImmediatelyException(" "));
+        add(new RequestTooBigException());
         add(new CallQueueTooBigException());
+        add(new CallDroppedException());
     }};
   }