SNOW-1868467: Add custom headers

[bpackter]

Overview

SNOW-1868467

Pre-review self checklist

• PR branch is updated with all the changes from master branch
• The code is correctly formatted (run mvn -P check-style validate)
• New public API is not unnecessary exposed (run mvn verify and inspect target/japicmp/japicmp.html)
• The pull request name is prefixed with SNOW-XXXX:
• Code is in compliance with internal logging requirements

External contributors - please answer these questions before submitting a pull request. Thanks!

1. What GitHub issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

   Issue: #2015

2. Fill out the following pre-review checklist:

   • I am adding a new automated test(s) to verify correctness of my new code
   • I am adding new logging messages
   • I am modifying authorization mechanisms
   • I am adding new credentials
   • I am modifying OCSP code
   • I am adding a new dependency or upgrading an existing one
   • I am adding new public/protected component not marked with @SnowflakeJdbcInternalApi (note that public/protected methods/fields in classes marked with this annotation are already internal)

3. Please describe how your code solves the related issue.

There is no options to add custom headers on each snowflake request (login, query, telemetry, heartbeat etc..)
This is needed in our case because we are calling snowflake from proxy and proxy enforce us to add jwt in some custom header.

This change
add an option to add map of custom headers in session coonig.
make sure headers are added on each request

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[sfc-gh-dprzybysz]

Hi, I left some comments.
Could you also provide some tests for the provided features?

[sfc-gh-dprzybysz]

there should not be so many changes in pom.xml files - probably it's an unwanted change

[bpackter]

only whitespace, I'll reformat

[sfc-gh-dprzybysz]

we should follow the enum naming convention

[brachi-wernick]

fixed

[sfc-gh-dprzybysz]

what if the value contains ':' or ';' internally? than the simple split could be not sufficient

[bpackter]

yes, we need to agree on some separator, since this is map of string string.
what do you suggest?

[sfc-gh-dprzybysz]

the ';' and ':' may be easy to read but e.g. ';' is used in some headers as a separator inside the fields

maybe we can think about url encoded parameters with '&' and = as separators - then we could expect that all property values are encoded separately and also the whole property value is encoded e.g.

static Map<String, String> getHttpHeaders(String headers) {
        if (headers != null && !headers.isEmpty()) {
            Map<String, String> headersMap = new HashMap<>();
            for (String headerKeyPair : java.net.URLDecoder.decode(headers).split("&")) {
                String[] split = headerKeyPair.split("=");
                if (split.length >= 2) {
                    headersMap.put(split[0], java.net.URLDecoder.decode(split[1]));
                }
            }
            return headersMap;
        }
        return null;
    }

    public static void main(String[] args){
        String headers = java.net.URLEncoder.encode("x="+java.net.URLEncoder.encode("test=&123")+"&y="+java.net.URLEncoder.encode("t&12=3"));

        System.out.println(getHttpHeaders(headers));
  }

[sfc-gh-dprzybysz]

Please note that signing the CLA is also necessary for your PR to be merged

[bpackter]

I have read the CLA Document and I hereby sign the CLA

[sfc-gh-dprzybysz]

if newly added methods need to be public please mark them with @SnowflakeJdbcInternalApi

[brachi-wernick]

I have read the CLA Document and I hereby sign the CLA