Fixed bugs in member endpoints; Added merge-into member endpoint

korridor · korridor · commit ab263e725fc4 · 2025-03-06T14:44:11.000-05:00
diff --git a/app/Console/Commands/Correction/CorrectionPlaceholderMembersCommand.php b/app/Console/Commands/Correction/CorrectionPlaceholderMembersCommand.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands\Correction;
+
+use App\Enums\Role;
+use App\Models\Member;
+use App\Models\User;
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Builder;
+
+class CorrectionPlaceholderMembersCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'correction:placeholder-members '.
+        ' { --dry-run : Do not actually save anything to the database, just output what would happen }';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Sets all members who belong to a placeholder user to role placeholder';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->comment('Sets all members who belong to a placeholder user to role placeholder...');
+        $dryRun = (bool) $this->option('dry-run');
+        if ($dryRun) {
+            $this->comment('Running in dry-run mode. Nothing will be saved to the database.');
+        }
+
+        $members = Member::query()
+            ->where('role', '!=', Role::Placeholder->value)
+            ->whereHas('user', function (Builder $builder): void {
+                /** @var Builder<User> $builder */
+                $builder->where('is_placeholder', '=', true);
+            })
+            ->get();
+        foreach ($members as $member) {
+            /** @var Member $member */
+            $member->role = Role::Placeholder->value;
+            if (! $dryRun) {
+                $member->save();
+            }
+            $this->line('Set role of member (id='.$member->getKey().') to placeholder');
+        }
+
+        return self::SUCCESS;
+    }
+}
diff --git a/app/Exceptions/Api/ChangingRoleOfPlaceholderIsNotAllowed.php b/app/Exceptions/Api/ChangingRoleOfPlaceholderIsNotAllowed.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions\Api;
+
+class ChangingRoleOfPlaceholderIsNotAllowed extends ApiException
+{
+    public const string KEY = 'changing_role_of_placeholder_is_not_allowed';
+}
diff --git a/app/Exceptions/Api/OnlyPlaceholdersCanBeMergedIntoAnotherMember.php b/app/Exceptions/Api/OnlyPlaceholdersCanBeMergedIntoAnotherMember.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions\Api;
+
+class OnlyPlaceholdersCanBeMergedIntoAnotherMember extends ApiException
+{
+    public const string KEY = 'only_placeholders_can_be_merged_into_another_member';
+}
diff --git a/app/Exceptions/Api/ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException.php b/app/Exceptions/Api/ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions\Api;
+
+class ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException extends ApiException
+{
+    public const string KEY = 'this_placeholder_can_not_be_invited_use_the_merge_tool_instead_api_exception';
+}
diff --git a/app/Http/Controllers/Api/V1/MemberController.php b/app/Http/Controllers/Api/V1/MemberController.php
@@ -7,12 +7,17 @@
 use App\Enums\Role;
 use App\Events\MemberMadeToPlaceholder;
 use App\Exceptions\Api\CanNotRemoveOwnerFromOrganization;
+use App\Exceptions\Api\ChangingRoleOfPlaceholderIsNotAllowed;
 use App\Exceptions\Api\ChangingRoleToPlaceholderIsNotAllowed;
 use App\Exceptions\Api\EntityStillInUseApiException;
 use App\Exceptions\Api\OnlyOwnerCanChangeOwnership;
+use App\Exceptions\Api\OnlyPlaceholdersCanBeMergedIntoAnotherMember;
 use App\Exceptions\Api\OrganizationNeedsAtLeastOneOwner;
+use App\Exceptions\Api\ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException;
+use App\Exceptions\Api\UserIsAlreadyMemberOfOrganizationApiException;
 use App\Exceptions\Api\UserNotPlaceholderApiException;
 use App\Http\Requests\V1\Member\MemberIndexRequest;
+use App\Http\Requests\V1\Member\MemberMergeIntoRequest;
 use App\Http\Requests\V1\Member\MemberUpdateRequest;
 use App\Http\Resources\V1\Member\MemberCollection;
 use App\Http\Resources\V1\Member\MemberResource;
@@ -21,9 +26,12 @@
 use App\Service\BillableRateService;
 use App\Service\InvitationService;
 use App\Service\MemberService;
+use App\Service\UserService;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Str;
 
 class MemberController extends Controller
 {
@@ -63,6 +71,7 @@ public function index(Organization $organization, MemberIndexRequest $request):
      * @throws OrganizationNeedsAtLeastOneOwner
      * @throws OnlyOwnerCanChangeOwnership
      * @throws ChangingRoleToPlaceholderIsNotAllowed
+     * @throws ChangingRoleOfPlaceholderIsNotAllowed
      *
      * @operationId updateMember
      */
@@ -105,7 +114,7 @@ public function destroy(Organization $organization, Member $member, MemberServic
     /**
      * Make a member a placeholder member
      *
-     * @throws AuthorizationException|CanNotRemoveOwnerFromOrganization
+     * @throws AuthorizationException|CanNotRemoveOwnerFromOrganization|ChangingRoleOfPlaceholderIsNotAllowed
      */
     public function makePlaceholder(Organization $organization, Member $member, MemberService $memberService): JsonResponse
     {
@@ -114,6 +123,9 @@ public function makePlaceholder(Organization $organization, Member $member, Memb
         if ($member->role === Role::Owner->value) {
             throw new CanNotRemoveOwnerFromOrganization;
         }
+        if ($member->role === Role::Placeholder->value) {
+            throw new ChangingRoleOfPlaceholderIsNotAllowed;
+        }
 
         $memberService->makeMemberToPlaceholder($member);
 
@@ -122,10 +134,37 @@ public function makePlaceholder(Organization $organization, Member $member, Memb
         return response()->json(null, 204);
     }
 
+    /**
+     * @throws AuthorizationException
+     * @throws OnlyPlaceholdersCanBeMergedIntoAnotherMember
+     * @throws \Throwable
+     */
+    public function mergeInto(Organization $organization, Member $member, MemberMergeIntoRequest $request): JsonResponse
+    {
+        $this->checkPermission($organization, 'members:merge-into', $member);
+
+        $user = $member->user;
+        if ($member->role !== Role::Placeholder->value || ! $user->is_placeholder) {
+            throw new OnlyPlaceholdersCanBeMergedIntoAnotherMember;
+        }
+        $memberTo = Member::findOrFail($request->getMemberId());
+
+        DB::transaction(function () use ($organization, $member, $user, $memberTo): void {
+            app(UserService::class)->assignOrganizationEntitiesToDifferentMember($organization, $user, $memberTo->user, $memberTo);
+            $member->delete();
+            $user->delete();
+        });
+
+        return response()->json(null, 204);
+    }
+
     /**
      * Invite a placeholder member to become a real member of the organization
      *
-     * @throws AuthorizationException|UserNotPlaceholderApiException
+     * @throws AuthorizationException
+     * @throws UserNotPlaceholderApiException
+     * @throws UserIsAlreadyMemberOfOrganizationApiException
+     * @throws ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException
      *
      * @operationId invitePlaceholder
      */
@@ -138,6 +177,10 @@ public function invitePlaceholder(Organization $organization, Member $member, In
             throw new UserNotPlaceholderApiException;
         }
 
+        if (Str::endsWith($user->email, '@solidtime-import.test')) {
+            throw new ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException;
+        }
+
         $invitationService->inviteUser($organization, $user->email, Role::Employee);
 
         return response()->json(null, 204);
diff --git a/app/Http/Requests/V1/Member/MemberMergeIntoRequest.php b/app/Http/Requests/V1/Member/MemberMergeIntoRequest.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests\V1\Member;
+
+use App\Models\Member;
+use App\Models\Organization;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Foundation\Http\FormRequest;
+use Korridor\LaravelModelValidationRules\Rules\ExistsEloquent;
+
+/**
+ * @property Organization $organization
+ */
+class MemberMergeIntoRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, array<string|ValidationRule|\Illuminate\Contracts\Validation\Rule>>
+     */
+    public function rules(): array
+    {
+        return [
+            // ID of the member to which the data should be transferred (destination)
+            'member_id' => [
+                'string',
+                ExistsEloquent::make(Member::class, null, function (Builder $builder): Builder {
+                    /** @var Builder<Member> $builder */
+                    return $builder->whereBelongsTo($this->organization, 'organization');
+                })->uuid(),
+            ],
+        ];
+    }
+
+    public function getMemberId(): string
+    {
+        return (string) $this->input('member_id');
+    }
+}
diff --git a/app/Models/Member.php b/app/Models/Member.php
@@ -7,6 +7,7 @@
 use App\Models\Concerns\CustomAuditable;
 use App\Models\Concerns\HasUuids;
 use Database\Factories\MemberFactory;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -24,6 +25,8 @@
  * @property Carbon|null $updated_at
  * @property-read Organization $organization
  * @property-read User $user
+ * @property-read Collection<ProjectMember> $projectMembers
+ * @property-read Collection<TimeEntry> $timeEntries
  *
  * @method static MemberFactory factory()
  */
@@ -59,6 +62,14 @@ public function organization(): BelongsTo
         return $this->belongsTo(Organization::class, 'organization_id');
     }
 
+    /**
+     * @return HasMany<TimeEntry>
+     */
+    public function timeEntries(): HasMany
+    {
+        return $this->hasMany(TimeEntry::class, 'member_id');
+    }
+
     /**
      * @return HasMany<ProjectMember>
      */
diff --git a/app/Service/MemberService.php b/app/Service/MemberService.php
@@ -7,6 +7,7 @@
 use App\Enums\Role;
 use App\Events\MemberRemoved;
 use App\Exceptions\Api\CanNotRemoveOwnerFromOrganization;
+use App\Exceptions\Api\ChangingRoleOfPlaceholderIsNotAllowed;
 use App\Exceptions\Api\ChangingRoleToPlaceholderIsNotAllowed;
 use App\Exceptions\Api\EntityStillInUseApiException;
 use App\Exceptions\Api\OnlyOwnerCanChangeOwnership;
@@ -75,13 +76,17 @@ public function removeMember(Member $member, Organization $organization): void
      * @throws ChangingRoleToPlaceholderIsNotAllowed
      * @throws OnlyOwnerCanChangeOwnership
      * @throws OrganizationNeedsAtLeastOneOwner
+     * @throws ChangingRoleOfPlaceholderIsNotAllowed
      */
     public function changeRole(Member $member, Organization $organization, Role $newRole, bool $allowOwnerChange): void
     {
         $oldRole = Role::from($member->role);
         if ($oldRole === Role::Owner) {
             throw new OrganizationNeedsAtLeastOneOwner;
         }
+        if ($oldRole === Role::Placeholder) {
+            throw new ChangingRoleOfPlaceholderIsNotAllowed;
+        }
         if ($newRole === Role::Placeholder) {
             throw new ChangingRoleToPlaceholderIsNotAllowed;
         }
diff --git a/lang/en/exceptions.php b/lang/en/exceptions.php
@@ -4,15 +4,18 @@
 
 use App\Exceptions\Api\CanNotDeleteUserWhoIsOwnerOfOrganizationWithMultipleMembers;
 use App\Exceptions\Api\CanNotRemoveOwnerFromOrganization;
+use App\Exceptions\Api\ChangingRoleOfPlaceholderIsNotAllowed;
 use App\Exceptions\Api\ChangingRoleToPlaceholderIsNotAllowed;
 use App\Exceptions\Api\EntityStillInUseApiException;
 use App\Exceptions\Api\FeatureIsNotAvailableInFreePlanApiException;
 use App\Exceptions\Api\InactiveUserCanNotBeUsedApiException;
 use App\Exceptions\Api\OnlyOwnerCanChangeOwnership;
+use App\Exceptions\Api\OnlyPlaceholdersCanBeMergedIntoAnotherMember;
 use App\Exceptions\Api\OrganizationHasNoSubscriptionButMultipleMembersException;
 use App\Exceptions\Api\OrganizationNeedsAtLeastOneOwner;
 use App\Exceptions\Api\PdfRendererIsNotConfiguredException;
 use App\Exceptions\Api\PersonalAccessClientIsNotConfiguredException;
+use App\Exceptions\Api\ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException;
 use App\Exceptions\Api\TimeEntryCanNotBeRestartedApiException;
 use App\Exceptions\Api\TimeEntryStillRunningApiException;
 use App\Exceptions\Api\UserIsAlreadyMemberOfOrganizationApiException;
@@ -39,6 +42,9 @@
         PdfRendererIsNotConfiguredException::KEY => 'PDF renderer is not configured',
         FeatureIsNotAvailableInFreePlanApiException::KEY => 'Feature is not available in free plan',
         PersonalAccessClientIsNotConfiguredException::KEY => 'Personal access client is not configured',
+        ChangingRoleOfPlaceholderIsNotAllowed::KEY => 'Changing role of placeholder is not allowed',
+        OnlyPlaceholdersCanBeMergedIntoAnotherMember::KEY => 'Only placeholders can be merged into another member',
+        ThisPlaceholderCanNotBeInvitedUseTheMergeToolInsteadException::KEY => 'This placeholder can not be invited use the merge tool instead',
     ],
     'unknown_error_in_admin_panel' => 'An unknown error occurred. Please check the logs.',
 ];
diff --git a/lang/en/importer.php b/lang/en/importer.php
@@ -13,7 +13,7 @@
             '<br> 4. Now click Export -> Save as CSV. The Export dropdown is in the header of the export table left of the printer symbol. '.
             '<br><br>Before you import make sure that the Timezone settings in Clockify are the same as in solidtime.',
     ],
-    'generic_project' => [
+    'generic_projects' => [
         'name' => 'Generic Projects',
         'description' => 'If you want to import many projects yourself this importer the right choice. Please see our docs for <a href="https://docs.solidtime.io/user-guide/import">more information about the CSV structure</a>',
     ],
diff --git a/routes/api.php b/routes/api.php
@@ -51,6 +51,7 @@
             Route::delete('/members/{member}', [MemberController::class, 'destroy'])->name('destroy');
             Route::post('/members/{member}/invite-placeholder', [MemberController::class, 'invitePlaceholder'])->name('invite-placeholder');
             Route::post('/members/{member}/make-placeholder', [MemberController::class, 'makePlaceholder'])->name('make-placeholder');
+            Route::post('member/{member}/merge-into', [MemberController::class, 'mergeInto'])->name('merge-into');
         });
 
         // User routes
diff --git a/tests/Unit/Console/Commands/Correction/CorrectionPlaceholderMembersCommandTest.php b/tests/Unit/Console/Commands/Correction/CorrectionPlaceholderMembersCommandTest.php
diff --git a/tests/Unit/Endpoint/Api/V1/MemberEndpointTest.php b/tests/Unit/Endpoint/Api/V1/MemberEndpointTest.php
