PHOENIX-6185 : Propagate info available in SQLExceptionInfo to SQLTim…

…eoutException (#919)

 PHOENIX-6185 : Propagate info available in SQLExceptionInfo to OPERATION_TIMED_OUT

phoenix-core/src/it/java/org/apache/phoenix/end2end/OperationTimeoutWithReasonIT.java

@@ -0,0 +1,98 @@
+/*
+ * 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.phoenix.end2end;
+
+import org.apache.phoenix.util.EnvironmentEdge;
+import org.apache.phoenix.util.EnvironmentEdgeManager;
+import org.junit.Test;
+
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+
+import static org.apache.phoenix.exception.SQLExceptionCode.OPERATION_TIMED_OUT;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+public class OperationTimeoutWithReasonIT extends ParallelStatsDisabledIT {
+
+    private static final class MyClock extends EnvironmentEdge {
+        private long time;
+        private final long delay;
+
+        public MyClock (long time, long delay) {
+            this.time = time;
+            this.delay = delay;
+        }
+
+        @Override
+        public long currentTime() {
+            long currentTime = this.time;
+            this.time += this.delay;
+            return currentTime;
+        }
+    }
+
+    @Test
+    public void testOperationTimeout() throws SQLException {
+        final String tableName = generateUniqueName();
+        final String ddl = "CREATE TABLE " + tableName
+            + " (COL1 VARCHAR NOT NULL PRIMARY KEY, COL2 VARCHAR)";
+        try (Connection conn = DriverManager.getConnection(getUrl());
+                 Statement stmt = conn.createStatement()) {
+            stmt.execute(ddl);
+            final String dml = String.format("UPSERT INTO %s VALUES (?, ?)",
+                tableName);
+            try(PreparedStatement prepStmt = conn.prepareStatement(dml)) {
+                for (int i = 1; i <= 100; i++) {
+                    prepStmt.setString(1, "key" + i);
+                    prepStmt.setString(2, "value" + i);
+                    prepStmt.executeUpdate();
+                }
+            }
+            conn.commit();
+        }
+
+        try (Connection conn = DriverManager.getConnection(getUrl());
+             Statement stmt = conn.createStatement()) {
+            stmt.setQueryTimeout(5); // 5 sec
+            ResultSet rs = stmt.executeQuery(String.format("SELECT * FROM %s",
+                tableName));
+            // Use custom EnvironmentEdge to timeout query with a longer delay in ms
+            MyClock clock = new MyClock(10, 10000);
+            EnvironmentEdgeManager.injectEdge(clock);
+            try {
+                rs.next();
+                fail();
+            } catch (SQLException e) {
+                assertEquals(OPERATION_TIMED_OUT.getErrorCode(),
+                    e.getErrorCode());
+                assertTrue(e.getMessage().contains("Query couldn't be " +
+                    "completed in the allotted time: 5000 ms"));
+            }
+        } finally {
+            EnvironmentEdgeManager.reset();
+        }
+    }
+
+}

phoenix-core/src/main/java/org/apache/phoenix/exception/SQLExceptionCode.java

@@ -453,8 +453,12 @@ public SQLException newException(SQLExceptionInfo info) {
     OPERATION_TIMED_OUT(6000, "TIM01", "Operation timed out.", new Factory() {
         @Override
         public SQLException newException(SQLExceptionInfo info) {
-            return new SQLTimeoutException(OPERATION_TIMED_OUT.getMessage(),
-                    OPERATION_TIMED_OUT.getSQLState(), OPERATION_TIMED_OUT.getErrorCode());
+            final String reason = info.getMessage() != null
+                ? info.getMessage() : OPERATION_TIMED_OUT.getMessage();
+            return new SQLTimeoutException(reason,
+                OPERATION_TIMED_OUT.getSQLState(),
+                OPERATION_TIMED_OUT.getErrorCode(),
+                info.getRootCause());
         }
     }),
     FUNCTION_UNDEFINED(6001, "42F01", "Function undefined.", new Factory() {

phoenix-core/src/test/java/org/apache/phoenix/util/SQLExceptionCodeTest.java

@@ -0,0 +1,58 @@
+/*
+ *  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.phoenix.util;
+
+import org.apache.phoenix.exception.SQLExceptionCode;
+import org.apache.phoenix.exception.SQLExceptionInfo;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.sql.SQLException;
+
+public class SQLExceptionCodeTest {
+
+    @Test
+    public void testOperationTimedOutTest() {
+        SQLException sqlException = new SQLExceptionInfo
+            .Builder(SQLExceptionCode.OPERATION_TIMED_OUT)
+            .setMessage("Test Operation Timedout")
+            .setRootCause(new IllegalArgumentException("TestOpsTimeout1"))
+            .build().buildException();
+        Assert.assertEquals("Test Operation Timedout",
+            sqlException.getMessage());
+        Assert.assertEquals("TestOpsTimeout1",
+            sqlException.getCause().getMessage());
+        Assert.assertTrue(sqlException.getCause() instanceof
+            IllegalArgumentException);
+        Assert.assertEquals(sqlException.getErrorCode(),
+            SQLExceptionCode.OPERATION_TIMED_OUT.getErrorCode());
+        Assert.assertEquals(sqlException.getSQLState(),
+            SQLExceptionCode.OPERATION_TIMED_OUT.getSQLState());
+        sqlException = new SQLExceptionInfo
+            .Builder(SQLExceptionCode.OPERATION_TIMED_OUT)
+            .build().buildException();
+        Assert.assertEquals(SQLExceptionCode.OPERATION_TIMED_OUT.getMessage(),
+            sqlException.getMessage());
+        Assert.assertNull(sqlException.getCause());
+        Assert.assertEquals(sqlException.getErrorCode(),
+            SQLExceptionCode.OPERATION_TIMED_OUT.getErrorCode());
+        Assert.assertEquals(sqlException.getSQLState(),
+            SQLExceptionCode.OPERATION_TIMED_OUT.getSQLState());
+    }
+
+}