refactor: person merge suggestion modal (#18287)

This commit is contained in:
Daniel Dietzler 2025-05-15 02:30:24 +02:00 committed by GitHub
parent 117b263887
commit cd03d0c0f2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 214 additions and 238 deletions

View File

@ -1,126 +0,0 @@
<script lang="ts">
import Icon from '$lib/components/elements/icon.svelte';
import FullScreenModal from '$lib/components/shared-components/full-screen-modal.svelte';
import { getPeopleThumbnailUrl } from '$lib/utils';
import { type PersonResponseDto } from '@immich/sdk';
import { Button } from '@immich/ui';
import { mdiArrowLeft, mdiMerge } from '@mdi/js';
import { onMount, tick } from 'svelte';
import { t } from 'svelte-i18n';
import ImageThumbnail from '../assets/thumbnail/image-thumbnail.svelte';
import CircleIconButton from '../elements/buttons/circle-icon-button.svelte';
interface Props {
personMerge1: PersonResponseDto;
personMerge2: PersonResponseDto;
potentialMergePeople: PersonResponseDto[];
onReject: () => void;
onConfirm: ([personMerge1, personMerge2]: [PersonResponseDto, PersonResponseDto]) => void;
onClose: () => void;
}
let {
personMerge1 = $bindable(),
personMerge2 = $bindable(),
potentialMergePeople = $bindable(),
onReject,
onConfirm,
onClose,
}: Props = $props();
let choosePersonToMerge = $state(false);
const title = personMerge2.name;
const changePersonToMerge = (newPerson: PersonResponseDto) => {
const index = potentialMergePeople.indexOf(newPerson);
[potentialMergePeople[index], personMerge2] = [personMerge2, potentialMergePeople[index]];
choosePersonToMerge = false;
};
onMount(async () => {
await tick();
document.querySelector<HTMLElement>('#merge-confirm-button')?.focus();
});
</script>
<FullScreenModal title="{$t('merge_people')} - {title}" {onClose}>
<div class="flex items-center justify-center py-4 md:h-36 md:py-4">
{#if !choosePersonToMerge}
<div class="flex h-20 w-20 items-center px-1 md:h-24 md:w-24 md:px-2">
<ImageThumbnail
circle
shadow
url={getPeopleThumbnailUrl(personMerge1)}
altText={personMerge1.name}
widthStyle="100%"
/>
</div>
<div class="mx-0.5 flex md:mx-2">
<CircleIconButton
title={$t('swap_merge_direction')}
icon={mdiMerge}
onclick={() => ([personMerge1, personMerge2] = [personMerge2, personMerge1])}
/>
</div>
<button
type="button"
disabled={potentialMergePeople.length === 0}
class="flex h-28 w-28 items-center rounded-full border-2 border-immich-primary px-1 dark:border-immich-dark-primary md:h-32 md:w-32 md:px-2"
onclick={() => {
if (potentialMergePeople.length > 0) {
choosePersonToMerge = !choosePersonToMerge;
}
}}
>
<ImageThumbnail
border={potentialMergePeople.length > 0}
circle
shadow
url={getPeopleThumbnailUrl(personMerge2)}
altText={personMerge2.name}
widthStyle="100%"
/>
</button>
{:else}
<div class="grid w-full grid-cols-1 gap-2">
<div class="px-2">
<button type="button" onclick={() => (choosePersonToMerge = false)}> <Icon path={mdiArrowLeft} /></button>
</div>
<div class="flex items-center justify-center">
<div class="flex flex-wrap justify-center md:grid md:grid-cols-{potentialMergePeople.length}">
{#each potentialMergePeople as person (person.id)}
<div class="h-24 w-24 md:h-28 md:w-28">
<button type="button" class="p-2 w-full" onclick={() => changePersonToMerge(person)}>
<ImageThumbnail
border={true}
circle
shadow
url={getPeopleThumbnailUrl(person)}
altText={person.name}
widthStyle="100%"
/>
</button>
</div>
{/each}
</div>
</div>
</div>
{/if}
</div>
<div class="flex px-4 md:pt-4">
<h1 class="text-xl text-gray-500 dark:text-gray-300">{$t('are_these_the_same_person')}</h1>
</div>
<div class="flex px-4 pt-2">
<p class="text-sm text-gray-500 dark:text-gray-300">{$t('they_will_be_merged_together')}</p>
</div>
{#snippet stickyBottom()}
<Button fullWidth shape="round" color="secondary" onclick={onReject}>{$t('no')}</Button>
<Button id="merge-confirm-button" fullWidth shape="round" onclick={() => onConfirm([personMerge1, personMerge2])}>
{$t('yes')}
</Button>
{/snippet}
</FullScreenModal>

View File

@ -383,7 +383,6 @@ export enum PersonPageViewMode {
VIEW_ASSETS = 'view-assets',
SELECT_PERSON = 'select-person',
MERGE_PEOPLE = 'merge-people',
SUGGEST_MERGE = 'suggest-merge',
UNASSIGN_ASSETS = 'unassign-faces',
}

View File

@ -0,0 +1,147 @@
<script lang="ts">
import Icon from '$lib/components/elements/icon.svelte';
import {
notificationController,
NotificationType,
} from '$lib/components/shared-components/notification/notification';
import { getPeopleThumbnailUrl } from '$lib/utils';
import { handleError } from '$lib/utils/handle-error';
import { mergePerson, type PersonResponseDto } from '@immich/sdk';
import { Button, Modal, ModalBody, ModalFooter } from '@immich/ui';
import { mdiArrowLeft, mdiMerge } from '@mdi/js';
import { onMount, tick } from 'svelte';
import { t } from 'svelte-i18n';
import ImageThumbnail from '../components/assets/thumbnail/image-thumbnail.svelte';
import CircleIconButton from '../components/elements/buttons/circle-icon-button.svelte';
interface Props {
personToMerge: PersonResponseDto;
personToBeMergedInto: PersonResponseDto;
potentialMergePeople: PersonResponseDto[];
onClose: (people?: [PersonResponseDto, PersonResponseDto]) => void;
}
let {
personToMerge = $bindable(),
personToBeMergedInto = $bindable(),
potentialMergePeople = $bindable(),
onClose,
}: Props = $props();
let choosePersonToMerge = $state(false);
const title = personToBeMergedInto.name;
const changePersonToMerge = (newPerson: PersonResponseDto) => {
const index = potentialMergePeople.indexOf(newPerson);
[potentialMergePeople[index], personToBeMergedInto] = [personToBeMergedInto, potentialMergePeople[index]];
choosePersonToMerge = false;
};
const handleMergePerson = async () => {
try {
await mergePerson({
id: personToBeMergedInto.id,
mergePersonDto: { ids: [personToMerge.id] },
});
notificationController.show({
message: $t('merge_people_successfully'),
type: NotificationType.Info,
});
onClose([personToMerge, personToBeMergedInto]);
} catch (error) {
handleError(error, $t('errors.unable_to_save_name'));
}
};
onMount(async () => {
await tick();
document.querySelector<HTMLElement>('#merge-confirm-button')?.focus();
});
</script>
<Modal title="{$t('merge_people')} - {title}" {onClose}>
<ModalBody>
<div class="flex items-center justify-center py-4 md:h-36 md:py-4">
{#if !choosePersonToMerge}
<div class="flex h-20 w-20 items-center px-1 md:h-24 md:w-24 md:px-2">
<ImageThumbnail
circle
shadow
url={getPeopleThumbnailUrl(personToMerge)}
altText={personToMerge.name}
widthStyle="100%"
/>
</div>
<div class="mx-0.5 flex md:mx-2">
<CircleIconButton
title={$t('swap_merge_direction')}
icon={mdiMerge}
onclick={() => ([personToMerge, personToBeMergedInto] = [personToBeMergedInto, personToMerge])}
/>
</div>
<button
type="button"
disabled={potentialMergePeople.length === 0}
class="flex h-28 w-28 items-center rounded-full border-2 border-immich-primary px-1 dark:border-immich-dark-primary md:h-32 md:w-32 md:px-2"
onclick={() => {
if (potentialMergePeople.length > 0) {
choosePersonToMerge = !choosePersonToMerge;
}
}}
>
<ImageThumbnail
border={potentialMergePeople.length > 0}
circle
shadow
url={getPeopleThumbnailUrl(personToBeMergedInto)}
altText={personToBeMergedInto.name}
widthStyle="100%"
/>
</button>
{:else}
<div class="grid w-full grid-cols-1 gap-2">
<div class="px-2">
<button type="button" onclick={() => (choosePersonToMerge = false)}> <Icon path={mdiArrowLeft} /></button>
</div>
<div class="flex items-center justify-center">
<div class="flex flex-wrap justify-center md:grid md:grid-cols-{potentialMergePeople.length}">
{#each potentialMergePeople as person (person.id)}
<div class="h-24 w-24 md:h-28 md:w-28">
<button type="button" class="p-2 w-full" onclick={() => changePersonToMerge(person)}>
<ImageThumbnail
border={true}
circle
shadow
url={getPeopleThumbnailUrl(person)}
altText={person.name}
widthStyle="100%"
/>
</button>
</div>
{/each}
</div>
</div>
</div>
{/if}
</div>
<div class="flex px-4 md:pt-4">
<h1 class="text-xl text-gray-500 dark:text-gray-300">{$t('are_these_the_same_person')}</h1>
</div>
<div class="flex px-4 pt-2">
<p class="text-sm text-gray-500 dark:text-gray-300">{$t('they_will_be_merged_together')}</p>
</div>
</ModalBody>
<ModalFooter>
<div class="flex gap-3 w-full">
<Button fullWidth shape="round" color="secondary" onclick={() => onClose()}>{$t('no')}</Button>
<Button id="merge-confirm-button" fullWidth shape="round" onclick={handleMergePerson}>
{$t('yes')}
</Button>
</div>
</ModalFooter>
</Modal>

View File

@ -3,9 +3,9 @@
import { page } from '$app/stores';
import { focusTrap } from '$lib/actions/focus-trap';
import { scrollMemory } from '$lib/actions/scroll-memory';
import { shortcut } from '$lib/actions/shortcut';
import Icon from '$lib/components/elements/icon.svelte';
import ManagePeopleVisibility from '$lib/components/faces-page/manage-people-visibility.svelte';
import MergeSuggestionModal from '$lib/components/faces-page/merge-suggestion-modal.svelte';
import PeopleCard from '$lib/components/faces-page/people-card.svelte';
import PeopleInfiniteScroll from '$lib/components/faces-page/people-infinite-scroll.svelte';
import SearchPeople from '$lib/components/faces-page/people-search.svelte';
@ -17,19 +17,13 @@
import { ActionQueryParameterValue, AppRoute, QueryParameter, SessionStorageKey } from '$lib/constants';
import { modalManager } from '$lib/managers/modal-manager.svelte';
import PersonEditBirthDateModal from '$lib/modals/PersonEditBirthDateModal.svelte';
import PersonMergeSuggestionModal from '$lib/modals/PersonMergeSuggestionModal.svelte';
import { locale } from '$lib/stores/preferences.store';
import { websocketEvents } from '$lib/stores/websocket';
import { handlePromiseError } from '$lib/utils';
import { handleError } from '$lib/utils/handle-error';
import { clearQueryParam } from '$lib/utils/navigation';
import {
getAllPeople,
getPerson,
mergePerson,
searchPerson,
updatePerson,
type PersonResponseDto,
} from '@immich/sdk';
import { getAllPeople, getPerson, searchPerson, updatePerson, type PersonResponseDto } from '@immich/sdk';
import { Button } from '@immich/ui';
import { mdiAccountOff, mdiEyeOutline } from '@mdi/js';
import { onMount } from 'svelte';
@ -46,7 +40,6 @@
let selectHidden = $state(false);
let searchName = $state('');
let showMergeModal = $state(false);
let newName = $state('');
let currentPage = $state(1);
let nextPage = $state(data.people.hasNextPage ? 2 : null);
@ -131,42 +124,41 @@
}
};
const handleMergeSamePerson = async (response: [PersonResponseDto, PersonResponseDto]) => {
const [personToMerge, personToBeMergedIn] = response;
showMergeModal = false;
if (!editingPerson) {
const handleMerge = async () => {
if (!editingPerson || !personMerge1 || !personMerge2) {
return;
}
try {
await mergePerson({
id: personToBeMergedIn.id,
mergePersonDto: { ids: [personToMerge.id] },
});
const mergedPerson = await getPerson({ id: personToBeMergedIn.id });
const response = await modalManager.show(PersonMergeSuggestionModal, {
personToMerge: personMerge1,
personToBeMergedInto: personMerge2,
potentialMergePeople,
});
people = people.filter((person: PersonResponseDto) => person.id !== personToMerge.id);
people = people.map((person: PersonResponseDto) => (person.id === personToBeMergedIn.id ? mergedPerson : person));
notificationController.show({
message: $t('merge_people_successfully'),
type: NotificationType.Info,
});
} catch (error) {
handleError(error, $t('errors.unable_to_save_name'));
if (!response) {
await updateName(personMerge1.id, newName);
return;
}
if (personToBeMergedIn.name !== newName && editingPerson.id === personToBeMergedIn.id) {
const [personToMerge, personToBeMergedInto] = response;
const mergedPerson = await getPerson({ id: personToBeMergedInto.id });
people = people.filter((person: PersonResponseDto) => person.id !== personToMerge.id);
people = people.map((person: PersonResponseDto) => (person.id === personToBeMergedInto.id ? mergedPerson : person));
if (personToBeMergedInto.name !== newName && editingPerson.id === personToBeMergedInto.id) {
/*
*
* If the user merges one of the suggested people into the person he's editing it, it's merging the suggested person AND renames
* If the user merges one of the suggested people into the person he's editing, it's merging the suggested person AND renames
* the person he's editing
*
*/
try {
await updatePerson({ id: personToBeMergedIn.id, personUpdateDto: { name: newName } });
await updatePerson({ id: personToBeMergedInto.id, personUpdateDto: { name: newName } });
for (const person of people) {
if (person.id === personToBeMergedIn.id) {
if (person.id === personToBeMergedInto.id) {
person.name = newName;
break;
}
@ -263,7 +255,7 @@
const onNameChangeSubmit = async (name: string, targetPerson: PersonResponseDto) => {
try {
if (name == targetPerson.name || showMergeModal) {
if (name == targetPerson.name) {
return;
}
@ -285,7 +277,7 @@
!person.isHidden,
)
.slice(0, 3);
showMergeModal = true;
await handleMerge();
return;
}
await updateName(targetPerson.id, name);
@ -315,32 +307,10 @@
(person) => person.name.toLowerCase() === name.toLowerCase() && person.id !== personId && person.name,
);
};
const handleMergeCancel = async () => {
if (!personMerge1) {
return;
}
await updateName(personMerge1.id, newName);
showMergeModal = false;
};
</script>
<svelte:window bind:innerHeight />
{#if showMergeModal && personMerge1 && personMerge2}
<MergeSuggestionModal
{personMerge1}
{personMerge2}
{potentialMergePeople}
onClose={() => {
showMergeModal = false;
}}
onReject={() => handleMergeCancel()}
onConfirm={handleMergeSamePerson}
/>
{/if}
<UserPageLayout
title={$t('people')}
description={countVisiblePeople === 0 && !searchName ? undefined : `(${countVisiblePeople.toLocaleString($locale)})`}
@ -403,17 +373,16 @@
onToggleFavorite={() => handleToggleFavorite(person)}
/>
<form onsubmit={() => onNameChangeSubmit(newName, person)}>
<input
type="text"
class=" bg-white dark:bg-immich-dark-gray border-gray-100 placeholder-gray-400 text-center dark:border-gray-900 w-full rounded-2xl mt-2 py-2 text-sm text-immich-primary dark:text-immich-dark-primary"
value={person.name}
placeholder={$t('add_a_name')}
onfocusin={() => onNameChangeInputFocus(person)}
onfocusout={() => onNameChangeSubmit(newName, person)}
oninput={(event) => onNameChangeInputUpdate(event)}
/>
</form>
<input
type="text"
class=" bg-white dark:bg-immich-dark-gray border-gray-100 placeholder-gray-400 text-center dark:border-gray-900 w-full rounded-2xl mt-2 py-2 text-sm text-immich-primary dark:text-immich-dark-primary"
value={person.name}
placeholder={$t('add_a_name')}
use:shortcut={{ shortcut: { key: 'Enter' }, onShortcut: (e) => e.currentTarget.blur() }}
onfocusin={() => onNameChangeInputFocus(person)}
onfocusout={() => onNameChangeSubmit(newName, person)}
oninput={(event) => onNameChangeInputUpdate(event)}
/>
</div>
{/snippet}
</PeopleInfiniteScroll>

View File

@ -7,7 +7,6 @@
import ImageThumbnail from '$lib/components/assets/thumbnail/image-thumbnail.svelte';
import EditNameInput from '$lib/components/faces-page/edit-name-input.svelte';
import MergeFaceSelector from '$lib/components/faces-page/merge-face-selector.svelte';
import MergeSuggestionModal from '$lib/components/faces-page/merge-suggestion-modal.svelte';
import UnMergeFaceSelector from '$lib/components/faces-page/unmerge-face-selector.svelte';
import AddToAlbum from '$lib/components/photos-page/actions/add-to-album.svelte';
import ArchiveAction from '$lib/components/photos-page/actions/archive-action.svelte';
@ -32,6 +31,7 @@
import { AppRoute, PersonPageViewMode, QueryParameter, SessionStorageKey } from '$lib/constants';
import { modalManager } from '$lib/managers/modal-manager.svelte';
import PersonEditBirthDateModal from '$lib/modals/PersonEditBirthDateModal.svelte';
import PersonMergeSuggestionModal from '$lib/modals/PersonMergeSuggestionModal.svelte';
import { AssetInteraction } from '$lib/stores/asset-interaction.svelte';
import { assetViewingStore } from '$lib/stores/asset-viewing.store';
import { AssetStore } from '$lib/stores/assets-store.svelte';
@ -44,7 +44,6 @@
import {
AssetVisibility,
getPersonStatistics,
mergePerson,
searchPerson,
updatePerson,
type AssetResponseDto,
@ -122,7 +121,7 @@
});
const handleEscape = async () => {
if ($showAssetViewer || viewMode === PersonPageViewMode.SUGGEST_MERGE) {
if ($showAssetViewer) {
return;
}
if (assetInteraction.selectionActive) {
@ -220,31 +219,32 @@
viewMode = PersonPageViewMode.VIEW_ASSETS;
};
const handleMergeSamePerson = async (response: [PersonResponseDto, PersonResponseDto]) => {
const [personToMerge, personToBeMergedIn] = response;
viewMode = PersonPageViewMode.VIEW_ASSETS;
isEditingName = false;
try {
await mergePerson({
id: personToBeMergedIn.id,
mergePersonDto: { ids: [personToMerge.id] },
});
notificationController.show({
message: $t('merge_people_successfully'),
type: NotificationType.Info,
});
people = people.filter((person: PersonResponseDto) => person.id !== personToMerge.id);
if (personToBeMergedIn.name != personName && person.id === personToBeMergedIn.id) {
await updateAssetCount();
return;
}
await goto(`${AppRoute.PEOPLE}/${personToBeMergedIn.id}`, { replaceState: true });
} catch (error) {
handleError(error, $t('errors.unable_to_save_name'));
const handleMergeSuggestion = async () => {
if (!personMerge1 || !personMerge2) {
return;
}
const result = await modalManager.show(PersonMergeSuggestionModal, {
personToMerge: personMerge1,
personToBeMergedInto: personMerge2,
potentialMergePeople,
});
if (!result) {
return;
}
const [personToMerge, personToBeMergedInto] = result;
people = people.filter((person: PersonResponseDto) => person.id !== personToMerge.id);
if (personToBeMergedInto.name != personName && person.id === personToBeMergedInto.id) {
await updateAssetCount();
return;
}
await goto(`${AppRoute.PEOPLE}/${personToBeMergedInto.id}`, { replaceState: true });
};
const handleSuggestPeople = (person2: PersonResponseDto) => {
const handleSuggestPeople = async (person2: PersonResponseDto) => {
isEditingName = false;
if (person.id !== person2.id) {
potentialMergePeople = [];
@ -252,7 +252,8 @@
personMerge1 = person;
personMerge2 = person2;
isSuggestionSelectedByUser = true;
viewMode = PersonPageViewMode.SUGGEST_MERGE;
await handleMergeSuggestion();
}
};
@ -280,9 +281,6 @@
};
const handleCancelEditName = () => {
if (viewMode === PersonPageViewMode.SUGGEST_MERGE) {
return;
}
isSearchingPeople = false;
isEditingName = false;
};
@ -317,7 +315,7 @@
!person.isHidden,
)
.slice(0, 3);
viewMode = PersonPageViewMode.SUGGEST_MERGE;
await handleMergeSuggestion();
return;
}
await changeName();
@ -382,7 +380,7 @@
onSelect={handleSelectFeaturePhoto}
onEscape={handleEscape}
>
{#if viewMode === PersonPageViewMode.VIEW_ASSETS || viewMode === PersonPageViewMode.SUGGEST_MERGE}
{#if viewMode === PersonPageViewMode.VIEW_ASSETS}
<!-- Person information block -->
<div
class="relative w-fit p-4 sm:px-6"
@ -497,17 +495,6 @@
/>
{/if}
{#if viewMode === PersonPageViewMode.SUGGEST_MERGE && personMerge1 && personMerge2}
<MergeSuggestionModal
{personMerge1}
{personMerge2}
{potentialMergePeople}
onClose={() => (viewMode = PersonPageViewMode.VIEW_ASSETS)}
onReject={changeName}
onConfirm={handleMergeSamePerson}
/>
{/if}
{#if viewMode === PersonPageViewMode.MERGE_PEOPLE}
<MergeFaceSelector {person} onBack={handleGoBack} onMerge={handleMerge} />
{/if}
@ -553,7 +540,7 @@
</ButtonContextMenu>
</AssetSelectControlBar>
{:else}
{#if viewMode === PersonPageViewMode.VIEW_ASSETS || viewMode === PersonPageViewMode.SUGGEST_MERGE}
{#if viewMode === PersonPageViewMode.VIEW_ASSETS}
<ControlAppBar showBackButton backIcon={mdiArrowLeft} onClose={() => goto(previousRoute)}>
{#snippet trailing()}
<ButtonContextMenu icon={mdiDotsVertical} title={$t('menu')}>