Compression Headers

[TuSKan]

Hi Kyle, how are you?

Thank you very much for develop this package.
This package is a great contribution. I was using a very old package, with no maintenance. My wish was granted!
I'm more than happy to contribute.

Compression Headers reduces the bandwidth required for a request and could benefits the overall performance.

How do you think is the better way to incorporate this feature in your package?

As the package was develop, doRequest return a http.Response. The reader of the response body needs to be decompressed.

This could be easy done using a NewReader like this one NewReader

And requestPayload in addition to content (Content-Type), need to have a additional parameter encoding (Accept-Encoding) to include on request header.

I'll be glad to know your opinion on that.

Docs:
Compression Headers

Use Compression for Bulk API 2.0 Query Responses

Use Compression for Bulk API 2.0 Ingest Responses

[k-capehart]

Very good idea. I'll start looking into this.

[k-capehart]

@TuSKan It took me a bit but I started exploring this. Do you mind taking a look at #86?

I think this makes sense, but the missing piece is how to actually indicate to that the response should be compressed. I think it might be a bit messy to add it as a parameter for each and every method? Maybe we could only do bulk API methods?

Or maybe we could do something like:

sf.Config.ToggleCompressionHeaders()

And then it would be enabled for everything, until toggled back off. Let me know your thoughts.

[k-capehart]

@TuSKan This is now available in v2.4.0

go get github.com/k-capehart/go-salesforce/v2@v2.4.0

Example:

sf.Config.SetCompressionHeaders(true)