Skip to content

When creating a user, do not persist the user on invitation sending failure #3179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ssddanbrown merged 1 commit into from
Jan 24, 2022
Merged

When creating a user, do not persist the user on invitation sending failure #3179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions app/Http/Controllers/UserController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use BookStack\Uploads\ImageRepo;
use Exception;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;
use Illuminate\Validation\Rules\Password;
use Illuminate\Validation\ValidationException;
Expand Down Expand Up @@ -99,20 +100,23 @@ public function store(Request $request)
}

$user->refreshSlug();
$user->save();

if ($sendInvite) {
$this->inviteService->sendInvitation($user);
}

if ($request->filled('roles')) {
$roles = $request->get('roles');
$this->userRepo->setUserRoles($user, $roles);
}
DB::transaction(function () use ($user, $sendInvite, $request) {
$user->save();

$this->userRepo->downloadAndAssignUserAvatar($user);
if ($sendInvite) {
$this->inviteService->sendInvitation($user);
}

$this->logActivity(ActivityType::USER_CREATE, $user);
if ($request->filled('roles')) {
$roles = $request->get('roles');
$this->userRepo->setUserRoles($user, $roles);
}

$this->userRepo->downloadAndAssignUserAvatar($user);

$this->logActivity(ActivityType::USER_CREATE, $user);
});

return redirect('/settings/users');
}
Expand Down
45 changes: 45 additions & 0 deletions tests/User/UserManagementTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
namespace Tests\User;

use BookStack\Actions\ActivityType;
use BookStack\Auth\Access\UserInviteService;
use BookStack\Auth\Role;
use BookStack\Auth\User;
use BookStack\Entities\Models\Page;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
use Mockery\MockInterface;
use RuntimeException;
use Tests\TestCase;

class UserManagementTest extends TestCase
Expand Down Expand Up @@ -179,4 +182,46 @@ public function test_guest_profile_cannot_be_deleted()
$resp = $this->followRedirects($resp);
$resp->assertSee('cannot delete the guest user');
}

public function test_user_creation_is_not_performed_if_the_invitation_sending_fails()
{
/** @var User $user */
$user = User::factory()->make();
$adminRole = Role::getRole('admin');

// Simulate an invitation sending failure
$this->mock(UserInviteService::class, function (MockInterface $mock) {
$mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
});

$this->asAdmin()->post('/settings/users/create', [
'name' => $user->name,
'email' => $user->email,
'send_invite' => 'true',
'roles[' . $adminRole->id . ']' => 'true',
]);

// Since the invitation failed, the user should not exist in the database
$this->assertDatabaseMissing('users', $user->only('name', 'email'));
}

public function test_user_create_activity_is_not_persisted_if_the_invitation_sending_fails()
{
/** @var User $user */
$user = User::factory()->make();
$adminRole = Role::getRole('admin');

$this->mock(UserInviteService::class, function (MockInterface $mock) {
$mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
});

$this->asAdmin()->post('/settings/users/create', [
'name' => $user->name,
'email' => $user->email,
'send_invite' => 'true',
'roles[' . $adminRole->id . ']' => 'true',
]);

$this->assertDatabaseMissing('activities', ['type' => 'USER_CREATE']);
}
}