iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move shifts event handler to right location

This commit is contained in:
Igor Scheller 2024-04-13 18:02:40 +02:00 committed by xuwhite
parent f397d809de
commit 8f6bd547d3
4 changed files with 273 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
config/app.php
View File

@ -81,10 +81,10 @@ return [
'oauth2.login' => \Engelsystem\Events\Listener\OAuth2::class . '@login',
'shift.deleting' => [
\Engelsystem\Events\Listener\Shift::class . '@shiftDeletingCreateWorklogs',
\Engelsystem\Events\Listener\Shift::class . '@shiftDeletingSendEmails',
\Engelsystem\Events\Listener\Shifts::class . '@deletingCreateWorklogs',
\Engelsystem\Events\Listener\Shifts::class . '@deletingSendEmails',
],
'shift.updating' => \Engelsystem\Events\Listener\Shift::class . '@updatedShiftSendEmail',
'shift.updating' => \Engelsystem\Events\Listener\Shifts::class . '@updatedSendEmail',
],
];

1
includes/includes.php
View File

@ -46,7 +46,6 @@ $includeFiles = [
__DIR__ . '/../includes/helper/legacy_helper.php',
__DIR__ . '/../includes/helper/message_helper.php',
__DIR__ . '/../includes/helper/email_helper.php',
__DIR__ . '/../includes/helper/shift_helper.php',
__DIR__ . '/../includes/mailer/shifts_mailer.php',
__DIR__ . '/../includes/mailer/users_mailer.php',

21
includes/helper/shift_helper.php → src/Events/Listener/Shifts.php
View File

@ -1,16 +1,18 @@
<?php
declare(strict_types=1);
namespace Engelsystem\Events\Listener;
use Carbon\Carbon;
use Engelsystem\Mail\EngelsystemMailer;
use Engelsystem\Models\Shifts\Shift as ShiftModel;
use Engelsystem\Models\Shifts\Shift;
use Engelsystem\Models\Shifts\ShiftEntry;
use Engelsystem\Models\Worklog;
use Illuminate\Database\Eloquent\Collection;
use Psr\Log\LoggerInterface;
class Shift
class Shifts
{
public function __construct(
protected LoggerInterface $log,
@ -18,7 +20,7 @@ class Shift
) {
}
public function shiftDeletingCreateWorklogs(ShiftModel $shift): void
public function deletingCreateWorklogs(Shift $shift): void
{
foreach ($shift->shiftEntries as $entry) {
if ($entry->freeloaded || $shift->start > Carbon::now()) {
@ -50,7 +52,7 @@ class Shift
}
}
public function shiftDeletingSendEmails(ShiftModel $shift): void
public function deletingSendEmails(Shift $shift): void
{
foreach ($shift->shiftEntries as $entry) {
if (!$entry->user->settings->email_shiftinfo) {
@ -70,10 +72,8 @@ class Shift
}
}
public function updatedShiftSendEmail(
ShiftModel $shift,
ShiftModel $oldShift
): void {
public function updatedSendEmail(Shift $shift, Shift $oldShift): void
{
// Only send e-mail on relevant changes
if (
$oldShift->shift_type_id == $shift->shift_type_id
@ -96,7 +96,10 @@ class Shift
$user = $shiftEntry->user;
$angelType = $shiftEntry->angelType;
if (!$user->settings->email_shiftinfo || $shift->end < Carbon::now()) {
if (
!$user->settings->email_shiftinfo
|| $shift->end < Carbon::now() && $oldShift->end < Carbon::now()
) {
continue;
}

258
tests/Unit/Events/Listener/ShiftsTest.php Normal file
View File

@ -0,0 +1,258 @@
<?php
declare(strict_types=1);
namespace Engelsystem\Test\Unit\Events\Listener;
use Engelsystem\Config\Config;
use Engelsystem\Events\Listener\Shifts;
use Engelsystem\Helpers\Authenticator;
use Engelsystem\Helpers\Carbon;
use Engelsystem\Helpers\Translation\Translator;
use Engelsystem\Mail\EngelsystemMailer;
use Engelsystem\Models\Shifts\Shift;
use Engelsystem\Models\Shifts\ShiftEntry;
use Engelsystem\Models\User\Settings;
use Engelsystem\Models\User\User;
use Engelsystem\Test\Unit\HasDatabase;
use Engelsystem\Test\Unit\TestCase;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Psr\Log\Test\TestLogger;
class ShiftsTest extends TestCase
{
use HasDatabase;
protected Authenticator | MockObject $auth;
protected TestLogger $log;
protected EngelsystemMailer | MockObject $mailer;
protected Shift $shift;
protected ShiftEntry $entry;
protected Translator | MockObject $translator;
protected User $user;
/**
* @covers \Engelsystem\Events\Listener\Shifts::deletingCreateWorklogs
* @covers \Engelsystem\Events\Listener\Shifts::__construct
*/
public function testDeletingCreateWorklogs(): void
{
$this->setExpects($this->auth, 'user', null, $this->user);
$this->setExpects($this->translator, 'translate', null, 'Text', $this->atLeastOnce());
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->deletingCreateWorklogs($this->shift);
$this->assertCount(1, $this->user->worklogs);
$this->assertEquals($this->shift->isNightShift() ? 4 : 2, $this->user->worklogs[0]->hours);
$this->assertEquals('Text', $this->user->worklogs[0]->comment);
$this->assertTrue($this->log->hasInfoThatContains('Created worklog entry'));
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::deletingCreateWorklogs
*/
public function testDeletingCreateWorklogsIgnoreFreeload(): void
{
$this->entry->freeloaded = true;
$this->entry->save();
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->deletingCreateWorklogs($this->shift);
$this->assertCount(0, $this->user->worklogs);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::deletingCreateWorklogs
*/
public function testDeletingCreateWorklogsIgnoreNotStarted(): void
{
$this->shift->start = Carbon::now()->addMinutes(42);
$this->shift->save();
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->deletingCreateWorklogs($this->shift);
$this->assertCount(0, $this->user->worklogs);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::deletingSendEmails
*/
public function testDeletingSendEmailsNoNotification(): void
{
$this->setExpects($this->mailer, 'sendViewTranslated', null, null, $this->never());
$this->user->settings->email_shiftinfo = false;
$this->user->settings->save();
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->deletingSendEmails($this->shift);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::deletingSendEmails
*/
public function testDeletingSendEmails(): void
{
$this->mailer->expects($this->once())
->method('sendViewTranslated')
->willReturnCallback(function (User $user, string $subject, string $template, array $data): bool {
$this->assertEquals($this->user->id, $user->id);
$this->assertEquals('notification.shift.deleted', $subject);
$this->assertEquals('emails/worklog-from-shift', $template);
$this->assertArrayHasKey('shift', $data);
$this->assertEquals($this->shift, $data['shift']);
$this->assertArrayHasKey('entry', $data);
$this->assertEquals($this->entry->id, $data['entry']->id);
return true;
});
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->deletingSendEmails($this->shift);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::updatedSendEmail
*/
public function testUpdatedSendEmailNoRelevantChange(): void
{
$this->setExpects($this->mailer, 'sendViewTranslated', null, null, $this->never());
$oldShift = Shift::find($this->shift->id);
$this->shift->description = 'Foo';
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->updatedSendEmail($this->shift, $oldShift);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::updatedSendEmail
*/
public function testUpdatedSendEmailNoNotification(): void
{
$this->setExpects($this->mailer, 'sendViewTranslated', null, null, $this->never());
$oldShift = Shift::find($this->shift->id);
$this->shift->title = 'Bar';
$this->user->settings->email_shiftinfo = false;
$this->user->settings->save();
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->updatedSendEmail($this->shift, $oldShift);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::updatedSendEmail
*/
public function testUpdatedSendEmailAlreadyEnded(): void
{
$this->setExpects($this->mailer, 'sendViewTranslated', null, null, $this->never());
$oldShift = Shift::find($this->shift->id);
$oldShift->end = Carbon::now()->subMinutes(42);
$this->shift->end = Carbon::now()->subMinutes(42);
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->updatedSendEmail($this->shift, $oldShift);
}
/**
* @covers \Engelsystem\Events\Listener\Shifts::updatedSendEmail
*/
public function testUpdatedSendEmail(): void
{
$oldShift = Shift::find($this->shift->id);
$this->shift->title = 'Bar';
$this->mailer->expects($this->once())
->method('sendViewTranslated')
->willReturnCallback(function (
User $user,
string $subject,
string $template,
array $data
) use ($oldShift): bool {
$this->assertEquals($this->user->id, $user->id);
$this->assertEquals('notification.shift.updated', $subject);
$this->assertEquals('emails/updated-shift', $template);
$this->assertArrayHasKey('shift', $data);
$this->assertEquals($this->shift, $data['shift']);
$this->assertArrayHasKey('oldShift', $data);
$this->assertEquals($oldShift, $data['oldShift']);
return true;
});
/** @var Shifts $listener */
$listener = $this->app->make(Shifts::class);
$listener->updatedSendEmail($this->shift, $oldShift);
}
protected function setUp(): void
{
parent::setUp();
$this->initDatabase();
$this->log = new TestLogger();
$this->app->instance(LoggerInterface::class, $this->log);
$this->mailer = $this->createMock(EngelsystemMailer::class);
$this->app->instance(EngelsystemMailer::class, $this->mailer);
$config = new Config([
'night_shifts' => [
'enabled' => true,
'start' => 2,
'end' => 8,
'multiplier' => 2,
],
]);
$this->app->instance('config', $config);
$this->translator = $this->createMock(Translator::class);
$this->app->instance('translator', $this->translator);
$this->user = User::factory()
->has(Settings::factory([
'language' => '',
'theme' => 1,
'email_shiftinfo' => true,
]))
->create();
$start = Carbon::now()->subHour();
$this->shift = Shift::factory([
'title' => 'Foo',
'start' => $start,
'end' => $start->copy()->addHours(2),
])->create();
$this->entry = ShiftEntry::factory([
'shift_id' => $this->shift->id,
'user_id' => $this->user->id,
'freeloaded' => false,
])->create();
$this->auth = $this->createMock(Authenticator::class);
$this->app->instance('authenticator', $this->auth);
}
}