Merge branch 'master' into SNOW-1016469-Update-Javadocs-With-missing-…

…comments

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

@@ -18,6 +18,7 @@ public class SFLoginOutput {
   private int databaseMajorVersion;
   private int databaseMinorVersion;
   private Duration httpClientSocketTimeout;
+  private Duration httpClientConnectionTimeout;
   private String sessionDatabase;
   private String sessionSchema;
   private String sessionRole;
@@ -53,6 +54,7 @@ public class SFLoginOutput {
     this.databaseMajorVersion = databaseMajorVersion;
     this.databaseMinorVersion = databaseMinorVersion;
     this.httpClientSocketTimeout = Duration.ofMillis(httpClientSocketTimeout);
+    this.httpClientConnectionTimeout = Duration.ofMillis(httpClientConnectionTimeout);
     this.sessionDatabase = sessionDatabase;
     this.sessionSchema = sessionSchema;
     this.sessionRole = sessionRole;
@@ -113,7 +115,7 @@ Duration getHttpClientSocketTimeout() {
   }
 
   Duration getHttpClientConnectionTimeout() {
-    return httpClientSocketTimeout;
+    return httpClientConnectionTimeout;
   }
 
   Map<String, Object> getCommonParams() {

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

@@ -283,7 +283,14 @@ public static CloseableHttpResponse execute(
         // if an SSL issue occurs like an SSLHandshakeException then fail
         // immediately and stop retrying the requests
 
-        throw new SnowflakeSQLLoggedException(null, ErrorCode.NETWORK_ERROR, ex, ex.getMessage());
+        String formattedMsg =
+            ex.getMessage()
+                + "\n"
+                + "Verify that the hostnames and portnumbers in SYSTEM$ALLOWLIST are added to your firewall's allowed list.\n"
+                + "To troubleshoot your connection further, you can refer to this article:\n"
+                + "https://docs.snowflake.com/en/user-guide/client-connectivity-troubleshooting/overview";
+
+        throw new SnowflakeSQLLoggedException(null, ErrorCode.NETWORK_ERROR, ex, formattedMsg);
 
       } catch (Exception ex) {
 

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

@@ -1649,6 +1649,7 @@ private void uploadStream() throws SnowflakeSQLException {
   /** Download a file from remote, and return an input stream */
   @Override
   public InputStream downloadStream(String fileName) throws SnowflakeSQLException {
+    logger.debug("Downloading file as stream: {}", fileName);
     if (stageInfo.getStageType() == StageInfo.StageType.LOCAL_FS) {
       logger.error("downloadStream function doesn't support local file system", false);
 
@@ -1662,14 +1663,32 @@ public InputStream downloadStream(String fileName) throws SnowflakeSQLException
 
     remoteLocation remoteLocation = extractLocationAndPath(stageInfo.getLocation());
 
-    String stageFilePath = fileName;
+    // when downloading files as stream there should be only one file in source files
+    String sourceLocation =
+        sourceFiles.stream()
+            .findFirst()
+            .orElseThrow(
+                () ->
+                    new SnowflakeSQLException(
+                        queryID,
+                        SqlState.NO_DATA,
+                        ErrorCode.FILE_NOT_FOUND.getMessageCode(),
+                        session,
+                        "File not found: " + fileName));
+
+    if (!fileName.equals(sourceLocation)) {
+      // filename may be different from source location e.g. in git repositories
+      logger.debug("Changing file to download location from {} to {}", fileName, sourceLocation);
+    }
+    String stageFilePath = sourceLocation;
 
     if (!remoteLocation.path.isEmpty()) {
-      stageFilePath = SnowflakeUtil.concatFilePathNames(remoteLocation.path, fileName, "/");
+      stageFilePath = SnowflakeUtil.concatFilePathNames(remoteLocation.path, sourceLocation, "/");
     }
+    logger.debug("Stage file path for {} is {}", sourceLocation, stageFilePath);
 
-    RemoteStoreFileEncryptionMaterial encMat = srcFileToEncMat.get(fileName);
-    String presignedUrl = srcFileToPresignedUrl.get(fileName);
+    RemoteStoreFileEncryptionMaterial encMat = srcFileToEncMat.get(sourceLocation);
+    String presignedUrl = srcFileToPresignedUrl.get(sourceLocation);
 
     return storageFactory
         .createClient(stageInfo, parallel, encMat, session)

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

@@ -4,6 +4,7 @@
 
 package net.snowflake.client.jdbc;
 
+import static java.util.Arrays.stream;
 import static net.snowflake.client.jdbc.SnowflakeType.GEOGRAPHY;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -32,10 +33,12 @@
 import java.util.Optional;
 import java.util.Properties;
 import java.util.Random;
+import java.util.TreeMap;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 import net.snowflake.client.core.Constants;
 import net.snowflake.client.core.HttpClientSettingsKey;
 import net.snowflake.client.core.OCSPMode;
@@ -53,6 +56,7 @@
 import org.apache.commons.io.IOUtils;
 import org.apache.http.Header;
 import org.apache.http.HttpResponse;
+import org.apache.http.NameValuePair;
 
 /**
  * @author jhuang
@@ -835,4 +839,29 @@ public static String getJsonNodeStringValue(JsonNode node) throws SFException {
     }
     return node.isValueNode() ? node.asText() : node.toString();
   }
+
+  /**
+   * Method introduced to avoid inconsistencies in custom headers handling, since these are defined
+   * on drivers side e.g. some drivers might internally convert headers to canonical form.
+   */
+  @SnowflakeJdbcInternalApi
+  public static Map<String, String> createCaseInsensitiveMap(Map<String, String> input) {
+    Map<String, String> caseInsensitiveMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
+    if (input != null) {
+      caseInsensitiveMap.putAll(input);
+    }
+    return caseInsensitiveMap;
+  }
+
+  /** toCaseInsensitiveMap, but adjusted to Headers[] argument type */
+  @SnowflakeJdbcInternalApi
+  public static Map<String, String> createCaseInsensitiveMap(Header[] headers) {
+    if (headers != null) {
+      return createCaseInsensitiveMap(
+          stream(headers)
+              .collect(Collectors.toMap(NameValuePair::getName, NameValuePair::getValue)));
+    } else {
+      return new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
+    }
+  }
 }

src/main/java/net/snowflake/client/jdbc/cloud/storage/CommonObjectMetadata.java

@@ -3,8 +3,9 @@
  */
 package net.snowflake.client.jdbc.cloud.storage;
 
-import java.util.HashMap;
 import java.util.Map;
+import java.util.TreeMap;
+import net.snowflake.client.jdbc.SnowflakeUtil;
 
 /**
  * Implements platform-independent interface Azure BLOB and GCS object metadata
@@ -16,11 +17,11 @@
  */
 public class CommonObjectMetadata implements StorageObjectMetadata {
   private long contentLength;
-  private Map<String, String> userDefinedMetadata;
+  private final Map<String, String> userDefinedMetadata;
   private String contentEncoding;
 
   CommonObjectMetadata() {
-    userDefinedMetadata = new HashMap<>();
+    userDefinedMetadata = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
   }
 
   /*
@@ -31,7 +32,7 @@ public class CommonObjectMetadata implements StorageObjectMetadata {
       long contentLength, String contentEncoding, Map<String, String> userDefinedMetadata) {
     this.contentEncoding = contentEncoding;
     this.contentLength = contentLength;
-    this.userDefinedMetadata = userDefinedMetadata;
+    this.userDefinedMetadata = SnowflakeUtil.createCaseInsensitiveMap(userDefinedMetadata);
   }
 
   /**
@@ -41,7 +42,6 @@ public class CommonObjectMetadata implements StorageObjectMetadata {
   public Map<String, String> getUserMetadata() {
     return userDefinedMetadata;
   }
-  ;
 
   /**
    * @return returns the size of object in bytes

src/main/java/net/snowflake/client/jdbc/cloud/storage/S3ObjectMetadata.java

@@ -5,6 +5,7 @@
 
 import com.amazonaws.services.s3.model.ObjectMetadata;
 import java.util.Map;
+import net.snowflake.client.jdbc.SnowflakeUtil;
 
 /**
  * s3 implementation of platform independent StorageObjectMetadata interface, wraps an S3
@@ -28,7 +29,7 @@ public class S3ObjectMetadata implements StorageObjectMetadata {
 
   @Override
   public Map<String, String> getUserMetadata() {
-    return objectMetadata.getUserMetadata();
+    return SnowflakeUtil.createCaseInsensitiveMap(objectMetadata.getUserMetadata());
   }
 
   @Override

src/main/java/net/snowflake/client/jdbc/cloud/storage/S3StorageObjectMetadata.java

@@ -5,6 +5,7 @@
 
 import com.amazonaws.services.s3.model.ObjectMetadata;
 import java.util.Map;
+import net.snowflake.client.jdbc.SnowflakeUtil;
 
 /**
  * Implementation of StorageObjectMetadata for S3 for remote storage object metadata.
@@ -26,7 +27,7 @@ public S3StorageObjectMetadata(ObjectMetadata s3Metadata) {
    */
   @Override
   public Map<String, String> getUserMetadata() {
-    return this.s3Metadata.getUserMetadata();
+    return SnowflakeUtil.createCaseInsensitiveMap(this.s3Metadata.getUserMetadata());
   }
 
   /**

src/main/java/net/snowflake/client/jdbc/cloud/storage/SnowflakeAzureClient.java

@@ -4,6 +4,8 @@
 package net.snowflake.client.jdbc.cloud.storage;
 
 import static net.snowflake.client.core.Constants.CLOUD_STORAGE_CREDENTIALS_EXPIRED;
+import static net.snowflake.client.core.HttpUtil.setProxyForAzure;
+import static net.snowflake.client.core.HttpUtil.setSessionlessProxyForAzure;
 import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetProperty;
 
 import com.fasterxml.jackson.core.JsonFactory;
@@ -41,7 +43,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import net.snowflake.client.core.HttpUtil;
 import net.snowflake.client.core.ObjectMapperFactory;
 import net.snowflake.client.core.SFBaseSession;
 import net.snowflake.client.core.SFSession;
@@ -154,9 +155,9 @@ private void setupAzureClient(
       this.azStorageClient = new CloudBlobClient(storageEndpoint, azCreds);
       opContext = new OperationContext();
       if (session != null) {
-        HttpUtil.setProxyForAzure(session.getHttpClientKey(), opContext);
+        setProxyForAzure(session.getHttpClientKey(), opContext);
       } else {
-        HttpUtil.setSessionlessProxyForAzure(stage.getProxyProperties(), opContext);
+        setSessionlessProxyForAzure(stage.getProxyProperties(), opContext);
       }
     } catch (URISyntaxException ex) {
       throw new IllegalArgumentException("invalid_azure_credentials");
@@ -273,7 +274,8 @@ public StorageObjectMetadata getObjectMetadata(String remoteStorageLocation, Str
       blob.downloadAttributes(null, null, opContext);
 
       // Get the user-defined BLOB metadata
-      Map<String, String> userDefinedMetadata = blob.getMetadata();
+      Map<String, String> userDefinedMetadata =
+          SnowflakeUtil.createCaseInsensitiveMap(blob.getMetadata());
 
       // Get the BLOB system properties we care about
       BlobProperties properties = blob.getProperties();
@@ -348,7 +350,8 @@ public void download(
         blob.downloadAttributes(null, transferOptions, opContext);
 
         // Get the user-defined BLOB metadata
-        Map<String, String> userDefinedMetadata = blob.getMetadata();
+        Map<String, String> userDefinedMetadata =
+            SnowflakeUtil.createCaseInsensitiveMap(blob.getMetadata());
         AbstractMap.SimpleEntry<String, String> encryptionData =
             parseEncryptionData(userDefinedMetadata.get(AZ_ENCRYPTIONDATAPROP), queryId);
 
@@ -447,13 +450,11 @@ public InputStream downloadToStream(
         InputStream stream = blob.openInputStream(null, null, opContext);
         stopwatch.stop();
         long downloadMillis = stopwatch.elapsedMillis();
-        Map<String, String> userDefinedMetadata = blob.getMetadata();
-
+        Map<String, String> userDefinedMetadata =
+            SnowflakeUtil.createCaseInsensitiveMap(blob.getMetadata());
         AbstractMap.SimpleEntry<String, String> encryptionData =
             parseEncryptionData(userDefinedMetadata.get(AZ_ENCRYPTIONDATAPROP), queryId);
-
         String key = encryptionData.getKey();
-
         String iv = encryptionData.getValue();
 
         if (this.isEncrypting() && this.getEncryptionKeySize() <= 256) {
@@ -574,7 +575,7 @@ public void upload(
         CloudBlockBlob blob = container.getBlockBlobReference(destFileName);
 
         // Set the user-defined/Snowflake metadata and upload the BLOB
-        blob.setMetadata((HashMap<String, String>) meta.getUserMetadata());
+        blob.setMetadata(new HashMap<>(meta.getUserMetadata()));
 
         BlobRequestOptions transferOptions = new BlobRequestOptions();
         transferOptions.setConcurrentRequestCount(parallelism);