proxmox-mirrors/pve-common
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-common synced 2025-04-29 10:50:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REST handler: make API return validation opt-in

Browse Source 
It has not shown any real value in the last decade+ it was enabled,
and it can actually add quite some performance overhead. E.g., if an
API endpoint returns a few 100k of relatively simple entries we can
easily require several seconds, even tens of seconds, to run the
return validation - making it easier to run into timeouts along the
transmit path to the client.

The CLI handler has it still enabled, normally there's no timeout
there as no HTTP transmit path is involved, and d.csapak had a slight
preference for that in an off-list discussion.

The actual implementations in PMG or PVE could enable it too if
running under debug mode.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2021-04-04 17:05:56 +02:00
parent 4a6f8872a4
commit 1b44e6fe0f
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/PVE/RESTHandler.pm
View File

@ -426,7 +426,7 @@ sub find_handler {
}
sub handle {
my ($self, $info, $param) = @_;
my ($self, $info, $param, $result_verification) = @_;
my $func = $info->{code};
@ -449,13 +449,13 @@ sub handle {
$param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra;
}
my $result = &$func($param);
my $result = $func->($param); # the actual API code execution call
# todo: this is only to be safe - disable?
if (my $schema = $info->{returns}) {
if ($result_verification && (my $schema = $info->{returns})) {
# return validation is rather lose-lose, as it can require quite a bit of time and lead to
# false-positive errors, any HTTP API handler should avoid enabling it by default.
PVE::JSONSchema::validate($result, $schema, "Result verification failed\n");
}
return $result;
}
@ -861,7 +861,7 @@ sub cli_handler {
$replace_file_names_with_contents->($param, $param_map);
}
$res = $self->handle($info, $param);
$res = $self->handle($info, $param, 1);
};
if (my $err = $@) {
my $ec = ref($err);