SNOW-1732907: Change custom cloud storage header metadata handling to be case-insensitive

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) {

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

@@ -4,6 +4,10 @@
 package net.snowflake.client.jdbc.cloud.storage;
 
 import static net.snowflake.client.core.Constants.CLOUD_STORAGE_CREDENTIALS_EXPIRED;
+import static net.snowflake.client.jdbc.SnowflakeUtil.convertSystemPropertyToBooleanValue;
+import static net.snowflake.client.jdbc.SnowflakeUtil.createCaseInsensitiveMap;
+import static net.snowflake.client.jdbc.SnowflakeUtil.getRootCause;
+import static net.snowflake.client.jdbc.SnowflakeUtil.isBlank;
 import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetProperty;
 
 import com.fasterxml.jackson.core.JsonFactory;
@@ -62,7 +66,6 @@
 import net.snowflake.common.core.RemoteStoreFileEncryptionMaterial;
 import net.snowflake.common.core.SqlState;
 import org.apache.commons.io.IOUtils;
-import org.apache.http.Header;
 import org.apache.http.HttpResponse;
 import org.apache.http.client.HttpResponseException;
 import org.apache.http.client.methods.HttpGet;
@@ -310,18 +313,14 @@ public void download(
               outStream.close();
               bodyStream.close();
               if (isEncrypting()) {
-                for (Header header : response.getAllHeaders()) {
-                  if (header
-                      .getName()
-                      .equalsIgnoreCase(GCS_METADATA_PREFIX + GCS_ENCRYPTIONDATAPROP)) {
-                    AbstractMap.SimpleEntry<String, String> encryptionData =
-                        parseEncryptionData(header.getValue(), queryId);
-
-                    key = encryptionData.getKey();
-                    iv = encryptionData.getValue();
-                    break;
-                  }
-                }
+                Map<String, String> userDefinedHeaders =
+                    createCaseInsensitiveMap(response.getAllHeaders());
+                AbstractMap.SimpleEntry<String, String> encryptionData =
+                    parseEncryptionData(
+                        userDefinedHeaders.get(GCS_METADATA_PREFIX + GCS_ENCRYPTIONDATAPROP),
+                        queryId);
+                key = encryptionData.getKey();
+                iv = encryptionData.getValue();
               }
               stopwatch.stop();
               downloadMillis = stopwatch.elapsedMillis();
@@ -355,9 +354,10 @@ public void download(
           logger.debug("Download successful", false);
 
           // Get the user-defined BLOB metadata
-          Map<String, String> userDefinedMetadata = blob.getMetadata();
+          Map<String, String> userDefinedMetadata =
+              SnowflakeUtil.createCaseInsensitiveMap(blob.getMetadata());
           if (isEncrypting()) {
-            if (userDefinedMetadata != null) {
+            if (!userDefinedMetadata.isEmpty()) {
               AbstractMap.SimpleEntry<String, String> encryptionData =
                   parseEncryptionData(userDefinedMetadata.get(GCS_ENCRYPTIONDATAPROP), queryId);
 
@@ -499,18 +499,14 @@ public InputStream downloadToStream(
               inputStream = response.getEntity().getContent();
 
               if (isEncrypting()) {
-                for (Header header : response.getAllHeaders()) {
-                  if (header
-                      .getName()
-                      .equalsIgnoreCase(GCS_METADATA_PREFIX + GCS_ENCRYPTIONDATAPROP)) {
-                    AbstractMap.SimpleEntry<String, String> encryptionData =
-                        parseEncryptionData(header.getValue(), queryId);
-
-                    key = encryptionData.getKey();
-                    iv = encryptionData.getValue();
-                    break;
-                  }
-                }
+                Map<String, String> userDefinedHeaders =
+                    createCaseInsensitiveMap(response.getAllHeaders());
+                AbstractMap.SimpleEntry<String, String> encryptionData =
+                    parseEncryptionData(
+                        userDefinedHeaders.get(GCS_METADATA_PREFIX + GCS_ENCRYPTIONDATAPROP),
+                        queryId);
+                key = encryptionData.getKey();
+                iv = encryptionData.getValue();
               }
               stopwatch.stop();
               downloadMillis = stopwatch.elapsedMillis();
@@ -538,7 +534,8 @@ public InputStream downloadToStream(
           inputStream = Channels.newInputStream(blob.reader());
           if (isEncrypting()) {
             // 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(GCS_ENCRYPTIONDATAPROP), queryId);
 
@@ -1121,7 +1118,7 @@ public void handleStorageException(
 
     // If there is no space left in the download location, java.io.IOException is thrown.
     // Don't retry.
-    if (SnowflakeUtil.getRootCause(ex) instanceof IOException) {
+    if (getRootCause(ex) instanceof IOException) {
       SnowflakeFileTransferAgent.throwNoSpaceLeftError(session, operation, ex, queryId);
     }
 
@@ -1181,7 +1178,7 @@ public void handleStorageException(
         }
       }
     } else if (ex instanceof InterruptedException
-        || SnowflakeUtil.getRootCause(ex) instanceof SocketTimeoutException) {
+        || getRootCause(ex) instanceof SocketTimeoutException) {
       if (retryCount > getMaxRetries()) {
         throw new SnowflakeSQLLoggedException(
             queryId,
@@ -1278,7 +1275,7 @@ private AbstractMap.SimpleEntry<String, String> parseEncryptionData(
   /** Adds digest metadata to the StorageObjectMetadata object */
   @Override
   public void addDigestMetadata(StorageObjectMetadata meta, String digest) {
-    if (!SnowflakeUtil.isBlank(digest)) {
+    if (!isBlank(digest)) {
       meta.addUserMetadata("sfc-digest", digest);
     }
   }
@@ -1355,7 +1352,7 @@ private void setupGCSClient(
 
   private static boolean areDisabledGcsDefaultCredentials(SFSession session) {
     return session != null && session.getDisableGcsDefaultCredentials()
-        || SnowflakeUtil.convertSystemPropertyToBooleanValue(
+        || convertSystemPropertyToBooleanValue(
             DISABLE_GCS_DEFAULT_CREDENTIALS_PROPERTY_NAME, false);
   }
 

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

@@ -5,6 +5,8 @@
 package net.snowflake.client.jdbc.cloud.storage;
 
 import static net.snowflake.client.core.Constants.CLOUD_STORAGE_CREDENTIALS_EXPIRED;
+import static net.snowflake.client.jdbc.SnowflakeUtil.createDefaultExecutorService;
+import static net.snowflake.client.jdbc.SnowflakeUtil.getRootCause;
 import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetProperty;
 
 import com.amazonaws.AmazonClientException;
@@ -368,7 +370,7 @@ public void download(
                     new ExecutorFactory() {
                       @Override
                       public ExecutorService newExecutor() {
-                        return SnowflakeUtil.createDefaultExecutorService(
+                        return createDefaultExecutorService(
                             "s3-transfer-manager-downloader-", parallelism);
                       }
                     })
@@ -379,7 +381,8 @@ public ExecutorService newExecutor() {
         // Pull object metadata from S3
         ObjectMetadata meta = amazonClient.getObjectMetadata(remoteStorageLocation, stageFilePath);
 
-        Map<String, String> metaMap = meta.getUserMetadata();
+        Map<String, String> metaMap =
+            SnowflakeUtil.createCaseInsensitiveMap(meta.getUserMetadata());
         String key = metaMap.get(AMZ_KEY);
         String iv = metaMap.get(AMZ_IV);
 
@@ -481,7 +484,8 @@ public InputStream downloadToStream(
         InputStream stream = file.getObjectContent();
         stopwatch.stop();
         long downloadMillis = stopwatch.elapsedMillis();
-        Map<String, String> metaMap = meta.getUserMetadata();
+        Map<String, String> metaMap =
+            SnowflakeUtil.createCaseInsensitiveMap(meta.getUserMetadata());
 
         String key = metaMap.get(AMZ_KEY);
         String iv = metaMap.get(AMZ_IV);
@@ -611,7 +615,7 @@ public void upload(
                     new ExecutorFactory() {
                       @Override
                       public ExecutorService newExecutor() {
-                        return SnowflakeUtil.createDefaultExecutorService(
+                        return createDefaultExecutorService(
                             "s3-transfer-manager-uploader-", parallelism);
                       }
                     })
@@ -821,7 +825,7 @@ private static void handleS3Exception(
 
     // If there is no space left in the download location, java.io.IOException is thrown.
     // Don't retry.
-    if (SnowflakeUtil.getRootCause(ex) instanceof IOException) {
+    if (getRootCause(ex) instanceof IOException) {
       SnowflakeFileTransferAgent.throwNoSpaceLeftError(session, operation, ex, queryId);
     }
 
@@ -912,7 +916,7 @@ private static void handleS3Exception(
       }
     } else {
       if (ex instanceof InterruptedException
-          || SnowflakeUtil.getRootCause(ex) instanceof SocketTimeoutException) {
+          || getRootCause(ex) instanceof SocketTimeoutException) {
         if (retryCount > s3Client.getMaxRetries()) {
           throw new SnowflakeSQLLoggedException(
               queryId,