From e591c95aa682d6567dc5885176c8b524355ca7df Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Tue, 31 Mar 2020 18:43:02 -0300 Subject: [PATCH] Bug 25032: Generic unhandled exception handling on API [WIP] This patch adds Koha::Logger as the default logger for the API, and introduces a new helper plugin that takes care of handling the unhandled exceptions. Basically, with this we would write something like this in our controller methods: try { ... } catch { if ( know_exception ) { handle_known_exception($_); } $c->unhandled_exception($_); } Without this, we end up adding more and more handling 'just in case'. This is WIP, to test: 1. Edit the Koha/REST/V1/Cities.pm 'list' method adding die("Nada"); before the render step. 2. Restart plack and try the endpoint => FAIL: A generic error is displayed, and no traces of the original problem are found on the logs. 3. Apply this patches, make sure your instance's log4perl has the introduced lines for API with the right path. 4. Repeat 2 => SUCCESS: The message is still generic, but you see something is logged in /var/log/koha/kohadev/api-error.log 5. Discuss the approach on the bug, with special attention on: - Can Koha::Logger be used in Mojo like that? It seems so - How the heck can we write tests for the change in V1.pm? - Do you really like what I put in the log? Should we change that? That was just the first thing that crossed my mind so ideas are welcome. --- Koha/REST/Plugin/Exceptions.pm | 75 ++++++++++++++++++++++++++++++++++ Koha/REST/V1.pm | 3 ++ 2 files changed, 78 insertions(+) create mode 100644 Koha/REST/Plugin/Exceptions.pm diff --git a/Koha/REST/Plugin/Exceptions.pm b/Koha/REST/Plugin/Exceptions.pm new file mode 100644 index 0000000000..a2bdfb374e --- /dev/null +++ b/Koha/REST/Plugin/Exceptions.pm @@ -0,0 +1,75 @@ +package Koha::REST::Plugin::Exceptions; + +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# Koha is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Koha; if not, see . + +use Modern::Perl; + +use Koha::Logger; + +use Mojo::Base 'Mojolicious::Plugin'; + +=head1 NAME + +Koha::REST::Plugin::Exceptions + +=head1 API + +=head2 Helper methods + +=head3 unhandled_exception + + try { + ... + } + catch { + if ( know_exception ) { + handle_known_exception($_); + } + + $c->unhandled_exception($_); + } + +Provides a generic and reusable way to throw unhandled exceptions. This way we +can centralize the behaviour control (e.g. production vs. development environmet) + +=cut + +sub register { + my ( $self, $app ) = @_; + + $app->helper( + 'unhandled_exception' => sub { + my ( $c, $exception ) = @_; + + my $req = $c->req; + my $method = $req->method; + my $path = $req->url->to_abs->path; + + $c->app->log->error("$method $path: unhandled exception ($exception)"); + + $c->render( + status => 500, + openapi => { + error => + "Something went wrong, check Koha logs for details." + } + ); + } + + ); +} + +1; diff --git a/Koha/REST/V1.pm b/Koha/REST/V1.pm index 0b14b97b95..4afeae3381 100644 --- a/Koha/REST/V1.pm +++ b/Koha/REST/V1.pm @@ -40,6 +40,8 @@ Overloaded Mojolicious->startup method. It is called at application startup. sub startup { my $self = shift; + $self->log( Koha::Logger->get({ interface => 'api' }) ); + $self->hook( before_dispatch => sub { my $c = shift; @@ -132,6 +134,7 @@ sub startup { $self->plugin( 'Koha::REST::Plugin::Pagination' ); $self->plugin( 'Koha::REST::Plugin::Query' ); $self->plugin( 'Koha::REST::Plugin::Objects' ); + $self->plugin( 'Koha::REST::Plugin::Exceptions' ); } 1; -- 2.26.0