Паттерн Интерактор (Interactor, Operation)02.02.2019 22:04

Есть только два метода, которые должен содержать этот класс: __construct для настройки данных и call для реализации сценария.

Эти методы, особенно call, должны вызывать приватные методы, которые вы напишите.

По умолчанию результат считается успешным, так как мы явно не указали, что операция не удалось.

Давайте запустим тест:

$ phpunit

Все тесты должны пройти!

Теперь давайте сделаем так, чтобы наш интерактор AddBook действительно что-то выполнял!

Создание книги

Изменим tests/bookshelf/interactors/AddBookTest.php:

   public function testCreateBook()
   {
       $result = $this->subjectCall();
       $this->assertEquals("The Fire Next Time", $result->book->title);
       $this->assertEquals("James Baldwin", $result->book->author);
   }

Если вы запустите тесты phpunit, то увидите ошибку:

Exception: Undefined property Lib\Interactor\InteractorResult::$book

Давайте заполним наш интерактор, затем объясним, что мы сделали:

book = new Book($bookAttributes);
   }
}

Здесь следует отметить две важные вещи:

Строка protected static $expose = ["book"]; добавляет свойство book в объект результата который будет возвращён при вызове интерактора.

Метод call присваивает модель Book свойству book, которое будет доступно в результате.

Теперь тесты должны пройти.

Мы инициализировали модель Book, но она не сохраняется в базе данных.

Сохранение книги

У нас есть новая книга, полученная из заголовка и автора, но ее еще нет в базе данных.

Нам нужно использовать наш BookRepository, чтобы сохранить её.

// tests/bookshelf/interactors/AddBookTest.php

public function testPersistsBook()
{
   $result = $this->subjectCall();
   $this->assertNotNull($result->book->id);
}

Если вы запустите тесты, то увидите новую ошибку с сообщением Failed asserting that null is not null.

Это потому, что книга, которую мы создали, не имеет идентификатора, поскольку она получит его только тогда, когда будет сохранена.

Чтобы тест проходил, нам нужно создать сохранённую книгу. Другой, не менее правильный путь — сохранить ту книгу, которая у нас уже есть.

Отредактируйте метод call в файле интерактора lib/bookshelf/interactors/AddBook.php:

protected function call($bookAttributes)
{
   $this->book = Book::create($bookAttributes);
}

Вместо вызова new Book, мы делаем Book::create с атрибутами книги.

Метод по прежнему возвращает книгу, а также сохраняет эту запись в базе данных.

Если вы запустите тесты сейчас, вы увидите, что все тесты проходят.

Внедрение зависимостей (Dependency Injection)

Давайте проведём рефакторинг, чтобы использовать внедрение зависимостей.

Тесты до сих пор работают, но они зависят от особенностей сохранения в базу (свойство id определяется после успешного сохранения). Это деталь реализации того, как работает сохранение. Например, если вы хотите создать UUID до его сохранения и указать, что сохранение прошло успешно каким-либо иным способом, чем заполнение столбца id, вам придется изменить этот тест.

Мы можем изменить наш тест и интерактор, чтобы сделать его более надежным: он будет менее подвержен поломкам из-за изменений вне его файла.

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

// lib/bookshelf/interactors/AddBook.php

public function __construct(Book $repository)
{
   $this->repository = $repository;
}

protected function call($bookAttributes)
{
   $this->book = $this->repository->create($bookAttributes);
}

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

Прямо сейчас тест проверяет поведение метода create, на то, что его идентификатор заполнен $this->assertNotNull($result->book->id).

Это деталь реализации.

Вместо этого мы можем изменить тест, чтобы просто убедиться, что у репозитория был вызван метод create, и довериться тому, что репозиторий сохранит объект (так как это его ответственность).

Давайте изменим тест testPersistsBook:

// tests/bookshelf/interactors/AddBookTest.php

public function testPersistsBook()
{
   $repository = Mockery::mock(Book::class);
   $this->app->instance(Book::class, $repository);
   $attributes = [
       "author" => "James Baldwin",
       'title' => "The Fire Next Time",
   ];

   $repository->expects()->create($attributes);
   $this->subjectCall($attributes);
}

Теперь наш тест не нарушает границы своей зоны.

Всё, что мы сделали, это добавили зависимость интерактора от репозитория.

Уведомление на электронную почту

Давайте добавим уведомление на электронную почту!

Так же вы можете сделать здесь что угодно, например, отправить SMS, отправить сообщение в чат или активировать веб-хук.

Мы оставим тело письма пустым, но в поле тема укажем «Book added!».

Создайте тест на уведомление tests/bookshelf/mail/BookAddedNotificationTest.php:

mail = new BookAddedNotification();
   }

   public function testCorrectAttributes()
   {
       $this->mail->build();
       $this->assertEquals('no-reply@example.com', $this->mail->from[0]['address']);
       $this->assertEquals('admin@example.com', $this->mail->to[0]['address']);
       $this->assertEquals('Book added!', $this->mail->subject);
   }
}

Добавим класс уведомления lib/Bookshelf/Mail/BookAddedNotification.php:

from('no-reply@example.com')
           ->to('admin@example.com')
           ->subject('Book added!');

       return $this->view('emails.book_added_notification');
   }
}

Теперь все наши тесты проходят!

Но уведомление ещё не отправляется. Нам нужно вызвать отправку из нашего интерактора AddBook.

Отредактируем тест AddBook, чтобы убедиться, что почтовик будет вызван:

public function testSendMail()
{
   Mail::fake();
   $this->subjectCall();
   Mail::assertSent(BookAddedNotification::class, 1);
}

Если запустить тесты, мы получим ошибку: The expected [Lib\Bookshelf\Mail\BookAddedNotification] mailable was sent 0 times instead of 1 times..

Теперь интегрируем отправку уведомления в интерактор.

public function __construct(Book $repository, BookAddedNotification $mail)
{
   $this->repository = $repository;
   $this->mail = $mail;
}

protected function call($bookAttributes)
{
   $this->book = $this->repository->create($bookAttributes);
   Mail::send($this->mail);
}

В результате интерактор отправит уведомление о добавлении книги на электронную почту.

Интеграция с контроллером

Наконец, нам нужно вызвать интерактор из экшена.

Отредактируем экшен файл app/Http/Controllers/BooksCreateController.php:

addBook = $addBook;
   }

   public function call(Request $request)
   {
       $input = $request->all();
       ($this->addBook)($input);
       return (new Response(null, 201));
   }
}

Наши тесты проходят, но есть небольшая проблема.

Мы дважды тестируем код создания книги.

Как правило, это плохая практика, и мы можем исправить это, проиллюстрировав еще одно преимущество интеракторов.

Мы собираемся удалить упоминание на BookRepository в тестах и использовать мок для нашего интерактора AddBook:

 '1984', 'author' => 'George Orwell'];       

       $addBook = Mockery::mock(AddBook::class);
       $this->app->instance(AddBook::class, $addBook);
       $addBook->expects()->__invoke($attributes);

       $response = $this->call('POST', '/books', $attributes);
   }
}

Теперь наши тесты проходят и они намного надежнее!

Экшен принимает входные данные (из параметров http запроса) и вызывает интерактор, чтобы выполнить свою работу. Единственная ответственность экшена — работа с сетью. А интерактор работает с нашей реальной бизнес-логикой.

Это значительно упрощает экшены и их тесты.

Экшены практически освобождены от бизнес-логики.

Когда мы модифицируем интерактор, нам уже не нужно изменять экшен или его тест.

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

Репозиторий с кодом

© Habrahabr.ru