argo_tunnel: make V4 API response compatible #572
Conversation
While diagnosing some issues implementing the `cloudflare_argo_tunnel` resource in Terraform, I noticed that the API response was lacking the outer response structure that the other V4 endpoints have. The early implementation of Argo Tunnel endpoints didn't conform to the V4 API standard response structure. This has been remedied going forward however to support older clients this isn't yet the default. An explicit `Accept` header is used to get the V4 compatible version. Along with this change, is removing the use of the `context` package in favour of existing request helpers. I opted not to reinvent a specific case for this right now because: - It's highly unlikely these requests will need to be cancelled; and - This is currently a snowflake scenario and I didn't want to build a new interface after only needing it once. I'd prefer to wait for more use cases before expanding it. As this change is internal, it won't impact clients and we can revert this once the default response is the V4 compatible version without interruption.
jacobbednarz
force-pushed
the
make-argo-tunnel-endpoints-use-v4-compat-version
branch
from
ba44eae
to
338cc14
Compare
|
I'd prefer we kept context in these functions (the idea is to refactor all remaining functions in #324 by 0.14 release). Because we don't have |
|
Sure thing. I didn't really want to copy paste as is due to the confusion around which method you should be using for what purposes. Alongside that, the method signatures are quite long which makes determining parameters a little more confusing again. I'll add a new method that follows the same patterns and we can always rejig it once we get a bit more usage under our belt. |
Implements `makeRequestContextWithHeaders` which is similar to `makeRequestWithHeaders` however it accepts a context as a parameter.
|
f90d975 has the changes I've mentioned above. |
|
No worries, they are internal to the library (lowercased name), we will likely clean them up during refactor by allowing optional arguments. |
jacobbednarz
deleted the
make-argo-tunnel-endpoints-use-v4-compat-version
branch
While diagnosing some issues implementing the
cloudflare_argo_tunnelresource in Terraform, I noticed that the API response was lacking the
outer response structure that the other V4 endpoints have.
The early implementation of Argo Tunnel endpoints didn't conform to the
V4 API standard response structure. This has been remedied going forward
however to support older clients this isn't yet the default. An explicit
Acceptheader is used to get the V4 compatible version.Along with this change, is removing the use of the
contextpackage infavour of existing request helpers. I opted not to reinvent a specific
case for this right now because:
new interface after only needing it once. I'd prefer to wait for more
use cases before expanding it.
As this change is internal, it won't impact clients and we can revert
this once the default response is the V4 compatible version without
interruption.