Как в Yii2 работать с исключениями в контроллере?

Question

[Михаил]

Знаю что вопрос уже много раз поднимался. Но найти решения пока не удалось.

Возьмем стандартный контроллер из примера:

public function actionContact()
{
    $model = new ContactForm();
    if ($model->load(Yii::$app->request->post()) && $model->validate()) {
        if ($model->sendEmail(Yii::$app->params['adminEmail'])) {
            Yii::$app->session->setFlash('success', 'Thank you for contacting us. We will respond to you as soon as possible.');
        } else {
            Yii::$app->session->setFlash('error', 'There was an error sending your message.');
        }
        return $this->refresh();
    } else {
        return $this->render('contact', [
            'model' => $model,
        ]);
    }
}

С первого взгляда все хорошо. Внезапно ContactForm теперь может выбросить исключение. По умолчанию оно обрабатывается в отдельном контроллере если сайт на проде и на отдельной отладочной странице если на деве.

Внезапно понадобилось отображать сообщение прямо на странице ошибки. В данном случае /contact/.
В голову приходит такой код:

public function actionContact()
{
    $model = new ContactForm();

    try {
        if ($model->load(Yii::$app->request->post()) && $model->validate()) {
            if ($model->sendEmail(Yii::$app->params['adminEmail'])) {
                Yii::$app->session->setFlash('success', 'Thank you for contacting us. We will respond to you as soon as possible.');
            } else {
                Yii::$app->session->setFlash('error', 'There was an error sending your message.');
            }
        }
    } catch (UserException $e) {
        Yii::$app->session->setFlash('error', $e->getMessage());
    } catch (\Exeption $e) {
        Yii::$app->session->setFlash('error', 'Something went wrong.');
    }

    return $this->render('contact', [
        'model' => $model,
    ]);
}

Код не проверял, но идея думаю понятна. С этим кодом есть проблема: я думаю что он не правильный. Да, можно вынести обработку исключений в базовый контроллер, но хочется узнать, как это сделать правильно с точки зрения yii.
Долгая работа с magento 2 заставила разобраться с исключениями. В ней они делаются вот так.

Answer 1

[Boris Köln]

В конфиге указывается страница показа ошибки при exception

'components' => [
            'errorHandler' => [
                'errorAction' => 'site/error',
            ],
]

Но это только для тех случаев, когда дальнейшая работа приложения невозможна.

Form не должна бросать исключение. В случае неправильных входных данных надо возвращаться false в validate()

sendEmail() тоже не должна бросать исключений. Только return true/false

Comments

[Михаил]

С формой легко. Она, по видимому, действительно не должна бросать исключения.

Легким движением руки форма превращается в работу с API :) Где исключение - обычное дело.

[Boris Köln]

При обращении к стороннему сервису можно кидать исключения. Но только внутри. И там же внутри надо их ловить и return false. Чтобы вызывающий никогда не получил исключения.

[Михаил]

Boris Korobkov: В API может произойти 2 ошибки: не получилось добавить X (общая ошибка) и не получилось добавить X потому что (например, дубликат). Предлагаете просто возвращать false и говорить "ошибка"?

[Boris Köln]

"Потому что дубликат" или "потому что неправильный foreign key" - это не исключение, а return false на валидации. Надо правильно писать rules:

[['user_id'], 'exist', 'skipOnError' => true, 'targetClass' => User::className(), 'targetAttribute' => 'id'],

Если же БД упала, то дальнейшее выполнение приложения бесполезно - кидайте исключение (вернее, оно само будет).

[Михаил]

Boris Korobkov: Я могу, конечно, сделать отдельно поиск перед добавлением. Получится как раз сделать валидацию и возврат false. Но в реальной жизни нужно пробовать добавить итем и уже по ответу понять дубликат или вставка прошла успешно. Напоминаю, я не про бд, а про API. В итоге добавление и валидация, грубо говоря, в 1 действии.

[Boris Köln]

Еще раз: в контроллере исключений быть не должно. Либо вообще не доводить до них (правильно валидировать данные), либо внутри обработчика кидать, там же внутри ловить и return false;

[Михаил]

Boris Korobkov: Я вас понял. Наверное, существуют разные точки зрения по этому поводу. В стандартном yii2 даже есть такой action:

public function actionResetPassword($token)
{
    try {
        $model = new ResetPasswordForm($token);
    } catch (InvalidParamException $e) {
        throw new BadRequestHttpException($e->getMessage());
    }
    if ($model->load(Yii::$app->request->post()) && $model->validate() && $model->resetPassword()) {
        Yii::$app->session->setFlash('success', 'New password saved.');
        return $this->goHome();
    }
    return $this->render('resetPassword', [
        'model' => $model,
    ]);
}

Answer 2

[Андрей К]

Или Вы как-то неоднозначно задаёте вопрос, или не совсем понимаете исключения.

Comments

[Михаил]

Если коротко, то как показывать ошибки исключительных ситуаций на странице где они возникли.

[Андрей К]

Михаил:
Смотрите, когда мы передаём код ошибки HTTP - это значит, что все совсем плохо! Поэтому должна быть отдельная простая страница, чтобы показать пользователю хоть что-то.
В случае, если мы можем спокойно сами обработать ситуацию, то не должно быть исключения, в данном случае с формой, можно просто вывести сообщение через flash.
Конечно вопрос ещё понимания, что именно может пойти не так.

Если зацепиться за конкретный пример с формой. Может быть ситуация, что почта не отправилось, мы можем просто сохранить почту в файл или бд и обработать потом, если мы понимаем, что от ввода тех же данных ничего не изменится. Про валидацию ввода говорит не серьезно, так как это не исключительная ситуация. Если нам не критично, можем просто сказать, что попробуйте позже.

А API не должен никуда перекидывать, он на том же адресе просто должен дать ответ, но это другое.

[Михаил]

Андрей К: Да, для критических ошибок должна быть отдельная страница.

Предположим, нужно заполнить форму которая на сервере отправит API-запрос. По результату запроса становится понятно что возникла ошибка. Выбрасывается исключение из библиотеки. Его можно поймать в условном сервисе или уже в самом контроллере. А результат одни - flash message.

[Андрей К]

Михаил: Правильно, но приложение работает нормально, оно не должно кидать ошибку, просто должно уведомить пользователя.
В идеале, понимать, что именно там за ошибка, чтобы предложить пользователю конкретные действия.

Пример, у нас в оплате онлайн для экскурсий то, что мест уже нет - это критическая ситуация, но мы предлагаем попробовать через 15 минут, так как через 15 минут снимется бронь у тех, кто не оплатил и можно будет заказать другому клиенту.
То есть, для сервиса - это исключение, для контроллера - это "да" или "нет".