Pablo/dev 95 headers on sdk

glassflow / glassflow-python-sdk

GlassFlow Python SDK to publish and consume data to your pipelines at Glassflow.dev

https://docs.glassflow.dev

MIT License

9 stars 0 forks source link

Pablo/dev 95 headers on sdk #13

Closed PabloPardoGarcia closed 4 months ago

PabloPardoGarcia commented 5 months ago

This PR changes:

Gets sdk version from importlib so we don't have to manually write it in two places at the same time
Add headers:
- Gf-Python-Version = <major>.<minor>.<micro>
- Gf-Client = python-sdk/<sdk version>
And updates User-Agent header to be glassflow-python-sdk/<sdk version>
Move headers logic to a separated private method in the PipelineClient

PabloPardoGarcia commented 5 months ago

After a conversation with @vkd and @alexandertrefz, they suggested to change the headers to:

Gf-Client = <client-name> / <version>
User-Agent = <client-name> / <version>

Reason to duplicate it: Front-end can't overwrite the user-agent

We should keep the header names consistent, which means we should also change the header: X-PIPELINE-ACCESS-TOKEN to Gf-Pipeline-Access-Token (sync changes with @vkd )

vkd commented 4 months ago

For the record, In general, header keys are case-insensitive. But there is a convention to write it like Content-Type, which turns our headers into Gf-Client and Gf-Pipeline-Access-Token. Some HTTP clients go even further and send headers with that format regardless of how they were defined.

alexandertrefz commented 4 months ago

From the Browser side, no matter how I define the Header, the Browser DevTools show the Header as being sent as Gf-Client as well.