DIRACGrid/diracx

Make the client send its version when calling the server

chaen opened this issue · 5 comments

chaen commented

The server should given an error if the client version is too old

The minimum version should be configured in the pyproject as a metadata such that the extension can overwrite it (diracx.min_client_version)

chrisburr commented
  • diracx-client/src/diracx/client/_patch.py
X-DIRACX-CLIENT-VERSION: 1.2.4

[project.entry-points."diracx.min_client_version"]
diracx = "1.2.3"
lhcbdirac = "5.6.7"
chaen commented

Side note: I don't think we will have millions of them, but do we want the diracx headers to be easily distinguishable from others ? That is, do we want e.g. DiracX-Client-Version more than client-version ?
It's nice when it's easy to spot so I would be tempted to add an extra prefix. The X- standard is deprecated though (https://www.rfc-editor.org/rfc/rfc6648#page-4)

Also, this raises the question: what do we do in case there isn't a version ? (swagger, diracx-web)

natthan-pigoux commented

Yes, I already changed the name with X-Diracx-Client-Version. I will remove the X- then.
I also added a TODO with the question on what to do in that cas.
Thanks again for your help @chaen :)

aldbr commented

what do we do in case there isn't a version ? (swagger, diracx-web)

I guess the server should check the DiracX-Client-Version only if it is provided by the client, shouldn't it?

natthan-pigoux commented

Another point is that the entrypoints in the toml for the "min_client_version" cannot be a static string but:
[project.entry-points."diracx.min_client_version"]
diracx = "diracx.routers:DIRACX_MIN_CLIENT_VERSION"

I hard coded it there for now: d0ff92f#diff-424d2a991980de5065c3b1e58f5066bf78641a4804b34bb5977be2ad95289ae7R483