SNOW-1016468-Set-QueryID-For-all-exceptions

src/main/java/net/snowflake/client/core/SFArrowResultSet.java

@@ -221,6 +221,7 @@ public SFArrowResultSet(
         // we don't support sort result when there are offline chunks
         if (resultSetSerializable.getChunkFileCount() > 0) {
           throw new SnowflakeSQLLoggedException(
+              queryId,
               session,
               ErrorCode.CLIENT_SIDE_SORTING_NOT_SUPPORTED.getMessageCode(),
               SqlState.FEATURE_NOT_SUPPORTED);
@@ -267,6 +268,7 @@ private boolean fetchNextRowUnsorted() throws SnowflakeSQLException {
 
           if (nextChunk == null) {
             throw new SnowflakeSQLLoggedException(
+                queryId,
                 session,
                 ErrorCode.INTERNAL_ERROR.getMessageCode(),
                 SqlState.INTERNAL_ERROR,
@@ -287,7 +289,7 @@ private boolean fetchNextRowUnsorted() throws SnowflakeSQLException {
           }
         } catch (InterruptedException ex) {
           throw new SnowflakeSQLLoggedException(
-              session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+              queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
         }
       } else {
         // always free current chunk
@@ -300,7 +302,7 @@ private boolean fetchNextRowUnsorted() throws SnowflakeSQLException {
           }
         } catch (InterruptedException e) {
           throw new SnowflakeSQLLoggedException(
-              session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+              queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
         }
       }
 
@@ -324,6 +326,7 @@ private ArrowResultChunk buildFirstChunk(byte[] firstChunk) throws SQLException
       resultChunk.readArrowStream(inputStream);
     } catch (IOException e) {
       throw new SnowflakeSQLLoggedException(
+          queryId,
           session,
           ErrorCode.INTERNAL_ERROR,
           "Failed to " + "load data in first chunk into arrow vector ex: " + e.getMessage());
@@ -445,7 +448,7 @@ public boolean next() throws SFException, SnowflakeSQLException {
           || Boolean.TRUE
               .toString()
               .equalsIgnoreCase(systemGetProperty("snowflake.enable_incident_test2"))) {
-        throw new SFException(ErrorCode.MAX_RESULT_LIMIT_EXCEEDED);
+        throw new SFException(queryId, ErrorCode.MAX_RESULT_LIMIT_EXCEEDED);
       }
 
       // mark end of result
@@ -589,7 +592,7 @@ private Object createJsonSqlInput(int columnIndex, Object obj) throws SFExceptio
           resultSetMetaData.getColumnFields(columnIndex),
           sessionTimeZone);
     } catch (JsonProcessingException e) {
-      throw new SFException(e, ErrorCode.INVALID_STRUCT_DATA);
+      throw new SFException(queryId, e, ErrorCode.INVALID_STRUCT_DATA);
     }
   }
 
@@ -615,7 +618,7 @@ public Array getArray(int columnIndex) throws SFException {
     } else if (converter instanceof VectorTypeConverter) {
       return getArrowArray((List<Object>) obj, columnIndex);
     } else {
-      throw new SFException(ErrorCode.INVALID_STRUCT_DATA);
+      throw new SFException(queryId, ErrorCode.INVALID_STRUCT_DATA);
     }
   }
 
@@ -624,6 +627,7 @@ private SfSqlArray getArrowArray(List<Object> elements, int columnIndex) throws
       List<FieldMetadata> fieldMetadataList = resultSetMetaData.getColumnFields(columnIndex);
       if (fieldMetadataList.size() != 1) {
         throw new SFException(
+            queryId,
             ErrorCode.INVALID_STRUCT_DATA,
             "Wrong size of fields for array type " + fieldMetadataList.size());
       }
@@ -711,11 +715,12 @@ private SfSqlArray getArrowArray(List<Object> elements, int columnIndex) throws
                   .toArray(Map[][]::new));
         default:
           throw new SFException(
+              queryId,
               ErrorCode.FEATURE_UNSUPPORTED,
               "Can't construct array for data type: " + columnSubType);
       }
     } catch (RuntimeException e) {
-      throw new SFException(e, ErrorCode.INVALID_STRUCT_DATA);
+      throw new SFException(queryId, e, ErrorCode.INVALID_STRUCT_DATA);
     }
   }
 
@@ -774,7 +779,7 @@ public void close() throws SnowflakeSQLException {
       }
     } catch (InterruptedException ex) {
       throw new SnowflakeSQLLoggedException(
-          session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+          queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
     }
   }
 

src/main/java/net/snowflake/client/core/SFException.java

@@ -36,6 +36,18 @@ public SFException(ErrorCode errorCode, Object... params) {
     this.params = params;
   }
 
+  public SFException(String queryID, ErrorCode errorCode, Object... params) {
+    super(
+        errorResourceBundleManager.getLocalizedMessage(
+            String.valueOf(errorCode.getMessageCode()), params));
+
+    this.cause = null;
+    this.queryId = queryID;
+    this.sqlState = errorCode.getSqlState();
+    this.vendorCode = errorCode.getMessageCode();
+    this.params = params;
+  }
+
   public SFException(Throwable cause, ErrorCode errorCode, Object... params) {
     super(
         errorResourceBundleManager.getLocalizedMessage(
@@ -49,6 +61,19 @@ public SFException(Throwable cause, ErrorCode errorCode, Object... params) {
     this.params = params;
   }
 
+  public SFException(String queryId, Throwable cause, ErrorCode errorCode, Object... params) {
+    super(
+        errorResourceBundleManager.getLocalizedMessage(
+            String.valueOf(errorCode.getMessageCode()), params),
+        cause);
+
+    this.cause = null;
+    this.queryId = queryId;
+    this.sqlState = errorCode.getSqlState();
+    this.vendorCode = errorCode.getMessageCode();
+    this.params = params;
+  }
+
   public Throwable getCause() {
     return cause;
   }

src/main/java/net/snowflake/client/core/SFFixedViewResultSet.java

@@ -67,6 +67,7 @@ public SFFixedViewResultSet(SnowflakeFixedView fixedView, CommandType commandTyp
 
     } catch (Exception ex) {
       throw new SnowflakeSQLLoggedException(
+          queryID,
           session,
           SqlState.INTERNAL_ERROR,
           ErrorCode.INTERNAL_ERROR.getMessageCode(),
@@ -91,6 +92,7 @@ public boolean next() throws SFException {
       nextRowList = fixedView.getNextRow();
     } catch (Exception ex) {
       throw new SFException(
+          queryID,
           ErrorCode.INTERNAL_ERROR,
           IncidentUtil.oneLiner("Error getting next row from " + "fixed view:", ex));
     }
@@ -115,11 +117,11 @@ protected Object getObjectInternal(int columnIndex) throws SFException {
     logger.debug("public Object getObjectInternal(int columnIndex)", false);
 
     if (nextRow == null) {
-      throw new SFException(ErrorCode.ROW_DOES_NOT_EXIST);
+      throw new SFException(queryID, ErrorCode.ROW_DOES_NOT_EXIST);
     }
 
     if (columnIndex <= 0 || columnIndex > nextRow.length) {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
+      throw new SFException(queryID, ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
     }
 
     wasNull = nextRow[columnIndex - 1] == null;

src/main/java/net/snowflake/client/core/SFResultSet.java

@@ -191,6 +191,7 @@ public SFResultSet(
       // we don't support sort result when there are offline chunks
       if (chunkCount > 0) {
         throw new SnowflakeSQLLoggedException(
+            queryId,
             session,
             ErrorCode.CLIENT_SIDE_SORTING_NOT_SUPPORTED.getMessageCode(),
             SqlState.FEATURE_NOT_SUPPORTED);
@@ -242,6 +243,7 @@ private boolean fetchNextRowUnsorted() throws SFException, SnowflakeSQLException
 
         if (nextChunk == null) {
           throw new SnowflakeSQLLoggedException(
+              queryId,
               session,
               ErrorCode.INTERNAL_ERROR.getMessageCode(),
               SqlState.INTERNAL_ERROR,
@@ -260,7 +262,7 @@ private boolean fetchNextRowUnsorted() throws SFException, SnowflakeSQLException
         return true;
       } catch (InterruptedException ex) {
         throw new SnowflakeSQLLoggedException(
-            session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+            queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
       }
     } else if (chunkCount > 0) {
       try {
@@ -269,7 +271,7 @@ private boolean fetchNextRowUnsorted() throws SFException, SnowflakeSQLException
         logChunkDownloaderMetrics(metrics);
       } catch (InterruptedException ex) {
         throw new SnowflakeSQLLoggedException(
-            session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+            queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
       }
     }
 
@@ -319,7 +321,7 @@ public boolean next() throws SFException, SnowflakeSQLException {
           || Boolean.TRUE
               .toString()
               .equalsIgnoreCase(systemGetProperty("snowflake.enable_incident_test2"))) {
-        throw new SFException(ErrorCode.MAX_RESULT_LIMIT_EXCEEDED);
+        throw new SFException(queryId, ErrorCode.MAX_RESULT_LIMIT_EXCEEDED);
       }
 
       // mark end of result
@@ -330,7 +332,7 @@ public boolean next() throws SFException, SnowflakeSQLException {
   @Override
   protected Object getObjectInternal(int columnIndex) throws SFException {
     if (columnIndex <= 0 || columnIndex > resultSetMetaData.getColumnCount()) {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
+      throw new SFException(queryId, ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
     }
 
     final int internalColumnIndex = columnIndex - 1;
@@ -343,7 +345,7 @@ protected Object getObjectInternal(int columnIndex) throws SFException {
     } else if (currentChunk != null) {
       retValue = currentChunk.getCell(currentChunkRowIndex, internalColumnIndex);
     } else {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
+      throw new SFException(queryId, ErrorCode.COLUMN_DOES_NOT_EXIST, columnIndex);
     }
     wasNull = retValue == null;
     return retValue;
@@ -422,7 +424,7 @@ public void close() throws SnowflakeSQLException {
       }
     } catch (InterruptedException ex) {
       throw new SnowflakeSQLLoggedException(
-          session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
+          queryId, session, ErrorCode.INTERRUPTED.getMessageCode(), SqlState.QUERY_CANCELED);
     }
   }
 

src/main/java/net/snowflake/client/core/SFResultSetMetaData.java

@@ -363,23 +363,25 @@ public int getColumnType(int column) throws SFException {
   public int getInternalColumnType(int column) throws SFException {
     int columnIdx = column - 1;
     if (column < 1 || column > columnTypes.size()) {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, column);
+      throw new SFException(queryId, ErrorCode.COLUMN_DOES_NOT_EXIST, column);
     }
 
     if (columnTypes.get(columnIdx) == null) {
-      throw new SFException(ErrorCode.INTERNAL_ERROR, "Missing column type for column " + column);
+      throw new SFException(
+          queryId, ErrorCode.INTERNAL_ERROR, "Missing column type for column " + column);
     }
 
     return columnTypes.get(columnIdx);
   }
 
   public String getColumnTypeName(int column) throws SFException {
     if (column < 1 || column > columnTypeNames.size()) {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, column);
+      throw new SFException(queryId, ErrorCode.COLUMN_DOES_NOT_EXIST, column);
     }
 
     if (columnTypeNames.get(column - 1) == null) {
-      throw new SFException(ErrorCode.INTERNAL_ERROR, "Missing column type for column " + column);
+      throw new SFException(
+          queryId, ErrorCode.INTERNAL_ERROR, "Missing column type for column " + column);
     }
 
     return columnTypeNames.get(column - 1);
@@ -477,11 +479,12 @@ public List<Boolean> getIsAutoIncrementList() {
   @SnowflakeJdbcInternalApi
   public List<FieldMetadata> getColumnFields(int column) throws SFException {
     if (column < 1 || column > columnMetadata.size()) {
-      throw new SFException(ErrorCode.COLUMN_DOES_NOT_EXIST, column);
+      throw new SFException(queryId, ErrorCode.COLUMN_DOES_NOT_EXIST, column);
     }
 
     if (columnMetadata.get(column - 1) == null) {
-      throw new SFException(ErrorCode.INTERNAL_ERROR, "Missing column fields for column " + column);
+      throw new SFException(
+          queryId, ErrorCode.INTERNAL_ERROR, "Missing column fields for column " + column);
     }
 
     return columnMetadata.get(column - 1).getFields();

src/main/java/net/snowflake/client/core/SFSession.java

@@ -218,7 +218,10 @@ private JsonNode getQueryMetadata(String queryID) throws SQLException {
         jsonNode = OBJECT_MAPPER.readTree(response);
       } catch (Exception e) {
         throw new SnowflakeSQLLoggedException(
-            this, e.getMessage(), "No response or invalid response from GET request. Error: {}");
+            queryID,
+            this,
+            e.getMessage(),
+            "No response or invalid response from GET request. Error: {}");
       }
 
       // Get response as JSON and parse it to get the query status
@@ -252,7 +255,7 @@ else if (ex instanceof SnowflakeReauthenticationRequest) {
             else if (ex instanceof SFException) {
               throw new SnowflakeSQLException((SFException) ex);
             }
-            throw new SnowflakeSQLException(ex.getMessage());
+            throw new SnowflakeSQLException(queryID, ex.getMessage());
           }
           sessionRenewed = true;
           // If the error code was not due to session renewal issues, throw an exception

src/main/java/net/snowflake/client/jdbc/SnowflakeResultSetSerializableV1.java

@@ -953,6 +953,7 @@ private void setupTransientFields() throws SQLException {
             (this.firstChunkStringData != null) ? mapper.readTree(this.firstChunkStringData) : null;
       } catch (IOException ex) {
         throw new SnowflakeSQLLoggedException(
+            queryId,
             possibleSession.orElse(/* session = */ null),
             "The JSON data is invalid. The error is: " + ex.getMessage());
       }
@@ -994,6 +995,7 @@ public List<SnowflakeResultSetSerializable> splitBySize(long maxSizeInBytes) thr
 
     if (this.chunkFileMetadatas.isEmpty() && this.firstChunkStringData == null) {
       throw new SnowflakeSQLLoggedException(
+          queryId,
           this.possibleSession.orElse(/* session = */ null),
           "The Result Set serializable is invalid.");
     }
@@ -1052,6 +1054,7 @@ public ResultSet getResultSet(ResultSetRetrieveConfig resultSetRetrieveConfig)
       SessionUtil.resetOCSPUrlIfNecessary(resultSetRetrieveConfig.getSfFullURL());
     } catch (IOException e) {
       throw new SnowflakeSQLLoggedException(
+          queryId,
           /*session = */ null, // There is no connection
           ErrorCode.INTERNAL_ERROR,
           "Hit exception when adjusting OCSP cache server. The original message is: "
@@ -1124,6 +1127,7 @@ private ResultSet getResultSetInternal(Properties info) throws SQLException {
         }
       default:
         throw new SnowflakeSQLLoggedException(
+            queryId,
             this.possibleSession.orElse(/*session = */ null),
             ErrorCode.INTERNAL_ERROR,
             "Unsupported query result format: " + getQueryResultFormat().name());
@@ -1167,6 +1171,7 @@ else if (getQueryResultFormat().equals(QueryResultFormat.ARROW)) {
         logger.debug("Interrupted when loading Arrow first chunk row count.", cbie);
       } catch (Exception ex) {
         throw new SnowflakeSQLLoggedException(
+            queryId,
             possibleSession.orElse(/* session = */ null),
             ErrorCode.INTERNAL_ERROR,
             "Fail to retrieve row count for first arrow chunk: " + ex.getMessage());
@@ -1178,6 +1183,7 @@ else if (getQueryResultFormat().equals(QueryResultFormat.ARROW)) {
     } else {
       // This shouldn't happen
       throw new SnowflakeSQLLoggedException(
+          queryId,
           this.possibleSession.orElse(/*session = */ null),
           ErrorCode.INTERNAL_ERROR,
           "setFirstChunkRowCountForArrow() should only be called for Arrow.");

src/main/java/net/snowflake/client/jdbc/SnowflakeSQLException.java

@@ -57,6 +57,13 @@ public SnowflakeSQLException(String reason, String sqlState) {
     logger.debug("Snowflake exception: {}, sqlState:{}", reason, sqlState);
   }
 
+  public SnowflakeSQLException(String queryId, String reason, String sqlState) {
+    super(reason, sqlState);
+    this.queryId = queryId;
+    // log user error from GS at fine level
+    logger.debug("Snowflake exception: {}, sqlState:{}", reason, sqlState);
+  }
+
   /** use {@link SnowflakeSQLException#SnowflakeSQLException(String, String, int)} */
   @Deprecated
   public SnowflakeSQLException(String sqlState, int vendorCode) {