[pve-devel] applied: [PATCH manager v2] pvesh: decode streamed responses

[Thomas Lamprecht <t.lamprecht@proxmox.com>]

Am 07/06/2023 um 16:15 schrieb Christoph Heiss:
> This allows to use `pvesh` on endpoints like /nodes/{node}/journal,
> which return streamed (and possibly gzip'd) responses.
> 
> Currently, e.g. `pvesh get /nodes/localhost/journal --lastentries 10`
> fails with:
> 
>   gzip: stdout: Broken pipe
>   got hash object, but result schema specified array!
> 
> Using e.g. `--output-format yaml` resulted in:
> 
>   ---
>   download:
>     content-encoding: gzip
>     content-type: application/json
>     fh: &1 !!perl/ref
>       =: *1
>     stream: 1
> 
>   gzip: stdout: Broken pipe
>   Failed to write
> 
> This is due the API call returning a "download" object (as seen above),
> which contains (among some other things) a file handle to read the
> response from.
> 
> With this patch, the response from such endpoints is now correctly read
> and displayed. Only handles combinations of `Content-Encoding` == 'gzip'
> and either 'text/plain' or 'application/json' for `Content-Type`.
> 
> This tries to mimic the behavior of the API server implementation when
> encountering `download` objects.
> 
> Tested this with all four output formats 'text', 'json', 'json-pretty'
> and 'yaml', as well as "cross-node" in a local test cluster.
> 
> Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
> ---
> Changes v1 -> v2:
>   * Fix some style nits
>   * Move content-{encoding,type} checks before actual decoding
> 
> As far as I could see (aka. grep for it), the only two endpoints which
> implement this are /nodes/{node}/journal and
> /nodes/{node}/tasks/{upid}/log, latter one only with `--download 1`
> set.
> 
>  PVE/CLI/pvesh.pm | 39 +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 39 insertions(+)
> 
>

applied, thanks!