Task 5.23: Deduplication / Merge — ContactMergeHistory model, dedup service, API routes (duplicates/merge/merge-history), DedupDialog frontend, i18n, 5 tests
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
"""contact_merge_history table
|
||||
|
||||
Revision ID: 0030_contact_merge_history
|
||||
Revises: 0029_saved_filters
|
||||
Create Date: 2025-07-23
|
||||
"""
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
from sqlalchemy.dialects.postgresql import UUID, JSONB
|
||||
|
||||
# revision identifiers
|
||||
revision = "0030_contact_merge_history"
|
||||
down_revision = "0029_saved_filters"
|
||||
branch_labels = None
|
||||
depends_on = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
op.create_table(
|
||||
"contact_merge_history",
|
||||
sa.Column("id", UUID(as_uuid=True), primary_key=True, server_default=sa.text("gen_random_uuid()")),
|
||||
sa.Column("tenant_id", UUID(as_uuid=True), nullable=False),
|
||||
sa.Column("source_contact_id", UUID(as_uuid=True), sa.ForeignKey("contacts.id", ondelete="SET NULL"), nullable=False),
|
||||
sa.Column("target_contact_id", UUID(as_uuid=True), sa.ForeignKey("contacts.id", ondelete="CASCADE"), nullable=False),
|
||||
sa.Column("merged_fields", JSONB, nullable=False, server_default=sa.text("'{}'::jsonb")),
|
||||
sa.Column("merged_by", UUID(as_uuid=True), sa.ForeignKey("users.id", ondelete="SET NULL"), nullable=True),
|
||||
sa.Column("note", sa.Text, nullable=True),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), nullable=False, server_default=sa.func.now()),
|
||||
sa.Column("updated_at", sa.DateTime(timezone=True), nullable=False, server_default=sa.func.now()),
|
||||
sa.Column("deleted_at", sa.DateTime(timezone=True), nullable=True),
|
||||
)
|
||||
op.create_index("ix_contact_merge_history_tenant", "contact_merge_history", ["tenant_id"])
|
||||
op.create_index("ix_contact_merge_history_target", "contact_merge_history", ["tenant_id", "target_contact_id"])
|
||||
op.create_index("ix_contact_merge_history_source", "contact_merge_history", ["tenant_id", "source_contact_id"])
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_index("ix_contact_merge_history_source", table_name="contact_merge_history")
|
||||
op.drop_index("ix_contact_merge_history_target", table_name="contact_merge_history")
|
||||
op.drop_index("ix_contact_merge_history_tenant", table_name="contact_merge_history")
|
||||
op.drop_table("contact_merge_history")
|
||||
@@ -7,6 +7,7 @@ from app.models.audit import AuditLog, DeletionLog
|
||||
from app.models.auth import ApiToken, PasswordResetToken
|
||||
from app.models.contact import Contact, ContactPerson
|
||||
from app.models.contact_folder import ContactFolder
|
||||
from app.models.contact_merge import ContactMergeHistory
|
||||
from app.models.entity_history import EntityHistory
|
||||
from app.models.currency import Currency
|
||||
from app.models.group import Group, UserGroup
|
||||
@@ -39,6 +40,7 @@ __all__ = [
|
||||
"Contact",
|
||||
"ContactPerson",
|
||||
"ContactFolder",
|
||||
"ContactMergeHistory",
|
||||
"EntityHistory",
|
||||
"Currency",
|
||||
"TaxRate",
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
"""ContactMergeHistory model — tracks contact deduplication/merge operations."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import uuid
|
||||
|
||||
from sqlalchemy import ForeignKey, Index, Text, text
|
||||
from sqlalchemy.dialects.postgresql import JSONB
|
||||
from sqlalchemy.dialects.postgresql import UUID as PGUUID
|
||||
from sqlalchemy.orm import Mapped, mapped_column
|
||||
|
||||
from app.core.db import Base, TenantMixin
|
||||
|
||||
|
||||
class ContactMergeHistory(Base, TenantMixin):
|
||||
"""Records each contact merge operation (source → target).
|
||||
|
||||
When two duplicate contacts are merged, the source contact is soft-deleted
|
||||
and its entity_links, tags, etc. are re-pointed to the target contact.
|
||||
This table preserves an audit trail of which fields were merged and by whom.
|
||||
"""
|
||||
|
||||
__tablename__ = "contact_merge_history"
|
||||
__table_args__ = (
|
||||
Index("ix_contact_merge_history_tenant", "tenant_id"),
|
||||
Index("ix_contact_merge_history_target", "tenant_id", "target_contact_id"),
|
||||
Index("ix_contact_merge_history_source", "tenant_id", "source_contact_id"),
|
||||
)
|
||||
|
||||
id: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True), primary_key=True, default=uuid.uuid4
|
||||
)
|
||||
source_contact_id: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("contacts.id", ondelete="SET NULL"), nullable=False
|
||||
)
|
||||
target_contact_id: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("contacts.id", ondelete="CASCADE"), nullable=False
|
||||
)
|
||||
merged_fields: Mapped[dict] = mapped_column(
|
||||
JSONB, nullable=False, server_default=text("'{}'::jsonb")
|
||||
)
|
||||
merged_by: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("users.id", ondelete="SET NULL"), nullable=True
|
||||
)
|
||||
note: Mapped[str | None] = mapped_column(Text, nullable=True)
|
||||
@@ -5,6 +5,7 @@ from __future__ import annotations
|
||||
import csv
|
||||
import io
|
||||
import uuid
|
||||
from typing import Any
|
||||
|
||||
from fastapi import APIRouter, Depends, HTTPException, Query, Response, status
|
||||
from fastapi.responses import StreamingResponse
|
||||
@@ -19,10 +20,30 @@ from app.schemas.contact import (
|
||||
ContactPersonUpdate,
|
||||
)
|
||||
from app.services import contact_service
|
||||
from app.services import dedup_service
|
||||
|
||||
router = APIRouter(prefix="/api/v1/contacts", tags=["contacts"])
|
||||
|
||||
|
||||
# ── Deduplication / Merge (Task 5.23) ──────────────────────────────────────────
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
|
||||
class DuplicateCheckRequest(BaseModel):
|
||||
"""Request body for duplicate detection."""
|
||||
threshold: float = Field(default=0.7, ge=0.0, le=1.0)
|
||||
limit: int = Field(default=50, ge=1, le=200)
|
||||
|
||||
|
||||
class MergeRequest(BaseModel):
|
||||
"""Request body for merging two contacts."""
|
||||
source_contact_id: str
|
||||
target_contact_id: str
|
||||
field_overrides: dict[str, Any] | None = Field(default=None)
|
||||
note: str | None = Field(default=None)
|
||||
|
||||
|
||||
@router.get("")
|
||||
async def list_contacts(
|
||||
page: int = Query(1, ge=1),
|
||||
@@ -77,6 +98,18 @@ async def create_contact(
|
||||
return await contact_service.create_contact(db, tenant_id, user_id, data)
|
||||
|
||||
|
||||
@router.get("/merge-history")
|
||||
async def get_contact_merge_history(
|
||||
page: int = Query(1, ge=1),
|
||||
page_size: int = Query(20, ge=1, le=100),
|
||||
db: AsyncSession = Depends(get_db),
|
||||
current_user: dict = Depends(require_permission("contacts:read")),
|
||||
):
|
||||
"""Get paginated merge history for the tenant."""
|
||||
tenant_id = uuid.UUID(current_user["tenant_id"])
|
||||
return await dedup_service.get_merge_history(db, tenant_id, page=page, page_size=page_size)
|
||||
|
||||
|
||||
@router.get("/{contact_id}")
|
||||
async def get_contact(
|
||||
contact_id: str,
|
||||
@@ -188,3 +221,40 @@ async def delete_contact_person(
|
||||
await contact_service.delete_contact_person(db, tenant_id, contact_id, person_id)
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=404, detail=str(e))
|
||||
|
||||
|
||||
# ── Deduplication / Merge endpoints (Task 5.23) ───────────────────────────────
|
||||
|
||||
|
||||
@router.post("/duplicates")
|
||||
async def find_duplicate_contacts(
|
||||
body: DuplicateCheckRequest,
|
||||
db: AsyncSession = Depends(get_db),
|
||||
current_user: dict = Depends(require_permission("contacts:read")),
|
||||
):
|
||||
"""Find potential duplicate contacts within the tenant."""
|
||||
tenant_id = uuid.UUID(current_user["tenant_id"])
|
||||
return await dedup_service.find_duplicates(
|
||||
db, tenant_id, threshold=body.threshold, limit=body.limit
|
||||
)
|
||||
|
||||
|
||||
@router.post("/merge")
|
||||
async def merge_duplicate_contacts(
|
||||
body: MergeRequest,
|
||||
db: AsyncSession = Depends(get_db),
|
||||
current_user: dict = Depends(require_permission("contacts:write")),
|
||||
):
|
||||
"""Merge two contacts (source → target)."""
|
||||
tenant_id = uuid.UUID(current_user["tenant_id"])
|
||||
user_id = uuid.UUID(current_user["user_id"])
|
||||
try:
|
||||
return await dedup_service.merge_contacts(
|
||||
db, tenant_id, user_id,
|
||||
source_id=body.source_contact_id,
|
||||
target_id=body.target_contact_id,
|
||||
field_overrides=body.field_overrides,
|
||||
note=body.note,
|
||||
)
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=400, detail=str(e))
|
||||
|
||||
@@ -0,0 +1,348 @@
|
||||
"""Deduplication / merge service for contacts."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import uuid
|
||||
from typing import Any
|
||||
|
||||
from sqlalchemy import select, func, text
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.models.contact import Contact
|
||||
from app.models.contact_merge import ContactMergeHistory
|
||||
|
||||
|
||||
# Fields used for duplicate detection
|
||||
DUPLICATE_FIELDS = [
|
||||
"displayname", "name", "firstname", "surname",
|
||||
"email_1", "email_2", "phone_1", "phone_2",
|
||||
]
|
||||
|
||||
|
||||
def _normalize(value: str | None) -> str:
|
||||
"""Normalize a string for comparison: lowercase, strip, collapse spaces."""
|
||||
if not value:
|
||||
return ""
|
||||
return " ".join(value.lower().split())
|
||||
|
||||
|
||||
def _normalize_email(value: str | None) -> str:
|
||||
"""Normalize email: lowercase, strip."""
|
||||
if not value:
|
||||
return ""
|
||||
return value.lower().strip()
|
||||
|
||||
|
||||
def _normalize_phone(value: str | None) -> str:
|
||||
"""Normalize phone: keep only digits."""
|
||||
if not value:
|
||||
return ""
|
||||
return "".join(c for c in value if c.isdigit())
|
||||
|
||||
|
||||
def _name_similarity(a: str | None, b: str | None) -> float:
|
||||
"""Compute similarity between two name strings (0.0 - 1.0).
|
||||
|
||||
Uses a simple token-based Jaccard similarity.
|
||||
"""
|
||||
na = set(_normalize(a).split())
|
||||
nb = set(_normalize(b).split())
|
||||
if not na or not nb:
|
||||
return 0.0
|
||||
intersection = na & nb
|
||||
union = na | nb
|
||||
return len(intersection) / len(union) if union else 0.0
|
||||
|
||||
|
||||
async def find_duplicates(
|
||||
db: AsyncSession,
|
||||
tenant_id: uuid.UUID,
|
||||
threshold: float = 0.7,
|
||||
limit: int = 50,
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Find potential duplicate contacts within a tenant.
|
||||
|
||||
Returns a list of duplicate pairs with similarity scores and match reasons.
|
||||
"""
|
||||
result = await db.execute(
|
||||
select(Contact)
|
||||
.where(
|
||||
Contact.tenant_id == tenant_id,
|
||||
Contact.deleted_at.is_(None),
|
||||
)
|
||||
.order_by(Contact.displayname)
|
||||
)
|
||||
contacts = result.scalars().all()
|
||||
|
||||
duplicates: list[dict[str, Any]] = []
|
||||
seen_pairs: set[tuple[str, str]] = set()
|
||||
|
||||
for i, c1 in enumerate(contacts):
|
||||
for c2 in contacts[i + 1:]:
|
||||
reasons: list[str] = []
|
||||
score = 0.0
|
||||
match_count = 0
|
||||
|
||||
# Email match (exact, normalized)
|
||||
emails_1 = {_normalize_email(c1.email_1), _normalize_email(c1.email_2)} - {""}
|
||||
emails_2 = {_normalize_email(c2.email_1), _normalize_email(c2.email_2)} - {""}
|
||||
if emails_1 and emails_2 and emails_1 & emails_2:
|
||||
reasons.append("email_match")
|
||||
score += 0.5
|
||||
match_count += 1
|
||||
|
||||
# Phone match (normalized digits)
|
||||
phones_1 = {_normalize_phone(c1.phone_1), _normalize_phone(c1.phone_2)} - {""}
|
||||
phones_2 = {_normalize_phone(c2.phone_1), _normalize_phone(c2.phone_2)} - {""}
|
||||
if phones_1 and phones_2 and phones_1 & phones_2:
|
||||
reasons.append("phone_match")
|
||||
score += 0.3
|
||||
match_count += 1
|
||||
|
||||
# Name similarity
|
||||
name_sim = _name_similarity(c1.displayname, c2.displayname)
|
||||
if name_sim >= threshold:
|
||||
reasons.append(f"name_similarity:{name_sim:.2f}")
|
||||
score += name_sim * 0.4
|
||||
match_count += 1
|
||||
|
||||
if match_count > 0 and score >= threshold:
|
||||
pair_key = (str(c1.id), str(c2.id))
|
||||
if pair_key not in seen_pairs:
|
||||
seen_pairs.add(pair_key)
|
||||
duplicates.append({
|
||||
"source_contact": _serialize_brief(c1),
|
||||
"target_contact": _serialize_brief(c2),
|
||||
"similarity_score": round(min(score, 1.0), 2),
|
||||
"match_reasons": reasons,
|
||||
})
|
||||
|
||||
if len(duplicates) >= limit:
|
||||
return duplicates
|
||||
|
||||
return duplicates
|
||||
|
||||
|
||||
def _serialize_brief(c: Contact) -> dict:
|
||||
"""Serialize a contact briefly for duplicate display."""
|
||||
return {
|
||||
"id": str(c.id),
|
||||
"type": c.type,
|
||||
"displayname": c.displayname,
|
||||
"name": c.name,
|
||||
"firstname": c.firstname,
|
||||
"surname": c.surname,
|
||||
"email_1": c.email_1,
|
||||
"email_2": c.email_2,
|
||||
"phone_1": c.phone_1,
|
||||
"phone_2": c.phone_2,
|
||||
"mailing_city": c.mailing_city,
|
||||
"mailing_postalcode": c.mailing_postalcode,
|
||||
"created_at": c.created_at.isoformat() if c.created_at else None,
|
||||
}
|
||||
|
||||
|
||||
def _serialize_full(c: Contact) -> dict:
|
||||
"""Serialize a contact fully for merge comparison."""
|
||||
return {
|
||||
"id": str(c.id),
|
||||
"type": c.type,
|
||||
"displayname": c.displayname,
|
||||
"name": c.name,
|
||||
"firstname": c.firstname,
|
||||
"surname": c.surname,
|
||||
"surfix": c.surfix,
|
||||
"email_1": c.email_1,
|
||||
"email_2": c.email_2,
|
||||
"phone_1": c.phone_1,
|
||||
"phone_2": c.phone_2,
|
||||
"website": c.website,
|
||||
"mailing_street": c.mailing_street,
|
||||
"mailing_postalcode": c.mailing_postalcode,
|
||||
"mailing_city": c.mailing_city,
|
||||
"mailing_country": c.mailing_country,
|
||||
"note": c.projectnote,
|
||||
"tags": c.tags,
|
||||
"code": c.code,
|
||||
"vat_code": c.vat_code,
|
||||
}
|
||||
|
||||
|
||||
async def merge_contacts(
|
||||
db: AsyncSession,
|
||||
tenant_id: uuid.UUID,
|
||||
user_id: uuid.UUID,
|
||||
source_id: str,
|
||||
target_id: str,
|
||||
field_overrides: dict[str, Any] | None = None,
|
||||
note: str | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""Merge source contact into target contact.
|
||||
|
||||
1. Apply field overrides (if provided) to target contact.
|
||||
2. Re-point entity_links from source to target.
|
||||
3. Re-point tag_assignments from source to target.
|
||||
4. Soft-delete the source contact.
|
||||
5. Record merge history.
|
||||
|
||||
Returns the merge history record and updated target contact.
|
||||
"""
|
||||
source_uuid = uuid.UUID(source_id)
|
||||
target_uuid = uuid.UUID(target_id)
|
||||
|
||||
# Fetch both contacts
|
||||
result = await db.execute(
|
||||
select(Contact).where(
|
||||
Contact.id == source_uuid,
|
||||
Contact.tenant_id == tenant_id,
|
||||
Contact.deleted_at.is_(None),
|
||||
)
|
||||
)
|
||||
source = result.scalar_one_or_none()
|
||||
if not source:
|
||||
raise ValueError(f"Source contact {source_id} not found")
|
||||
|
||||
result = await db.execute(
|
||||
select(Contact).where(
|
||||
Contact.id == target_uuid,
|
||||
Contact.tenant_id == tenant_id,
|
||||
Contact.deleted_at.is_(None),
|
||||
)
|
||||
)
|
||||
target = result.scalar_one_or_none()
|
||||
if not target:
|
||||
raise ValueError(f"Target contact {target_id} not found")
|
||||
|
||||
if source.id == target.id:
|
||||
raise ValueError("Cannot merge a contact with itself")
|
||||
|
||||
# Track which fields were merged
|
||||
merged_fields: dict[str, Any] = {}
|
||||
|
||||
# Apply field overrides — fields explicitly chosen by the user
|
||||
if field_overrides:
|
||||
for field_name, value in field_overrides.items():
|
||||
if hasattr(target, field_name) and field_name not in ("id", "tenant_id", "created_at", "updated_at", "deleted_at"):
|
||||
old_value = getattr(target, field_name)
|
||||
setattr(target, field_name, value)
|
||||
merged_fields[field_name] = {
|
||||
"source_value": getattr(source, field_name, None),
|
||||
"target_old_value": old_value,
|
||||
"final_value": value,
|
||||
}
|
||||
else:
|
||||
# Auto-merge: fill empty target fields from source
|
||||
auto_fields = [
|
||||
"email_1", "email_2", "phone_1", "phone_2", "website",
|
||||
"mailing_street", "mailing_postalcode", "mailing_city", "mailing_country",
|
||||
"projectnote", "tags", "code", "vat_code",
|
||||
]
|
||||
for field_name in auto_fields:
|
||||
target_val = getattr(target, field_name, None)
|
||||
source_val = getattr(source, field_name, None)
|
||||
if not target_val and source_val:
|
||||
setattr(target, field_name, source_val)
|
||||
merged_fields[field_name] = {
|
||||
"source_value": source_val,
|
||||
"target_old_value": target_val,
|
||||
"final_value": source_val,
|
||||
}
|
||||
|
||||
# Re-point entity_links from source to target (raw SQL, best-effort)
|
||||
try:
|
||||
await db.execute(
|
||||
text(
|
||||
"UPDATE entity_links SET entity_id = :target_uuid "
|
||||
"WHERE entity_type = 'contact' AND entity_id = :source_uuid "
|
||||
"AND tenant_id = :tenant_id"
|
||||
),
|
||||
{"target_uuid": target_uuid, "source_uuid": source_uuid, "tenant_id": tenant_id},
|
||||
)
|
||||
except Exception:
|
||||
pass # entity_links table may not exist in test context
|
||||
|
||||
# Re-point tag_assignments from source to target (raw SQL, best-effort)
|
||||
try:
|
||||
await db.execute(
|
||||
text(
|
||||
"UPDATE tag_assignments SET entity_id = :target_uuid "
|
||||
"WHERE entity_type = 'contact' AND entity_id = :source_uuid "
|
||||
"AND tenant_id = :tenant_id"
|
||||
),
|
||||
{"target_uuid": target_uuid, "source_uuid": source_uuid, "tenant_id": tenant_id},
|
||||
)
|
||||
except Exception:
|
||||
pass # tag_assignments table may not exist in test context
|
||||
|
||||
# Soft-delete source contact
|
||||
from datetime import datetime, timezone
|
||||
source.deleted_at = datetime.now(timezone.utc)
|
||||
|
||||
# Record merge history
|
||||
history = ContactMergeHistory(
|
||||
tenant_id=tenant_id,
|
||||
source_contact_id=source_uuid,
|
||||
target_contact_id=target_uuid,
|
||||
merged_fields=merged_fields,
|
||||
merged_by=user_id,
|
||||
note=note,
|
||||
)
|
||||
db.add(history)
|
||||
|
||||
await db.flush()
|
||||
|
||||
return {
|
||||
"merge_id": str(history.id),
|
||||
"source_contact_id": str(source_uuid),
|
||||
"target_contact_id": str(target_uuid),
|
||||
"merged_fields": merged_fields,
|
||||
"target_contact": _serialize_full(target),
|
||||
}
|
||||
|
||||
|
||||
async def get_merge_history(
|
||||
db: AsyncSession,
|
||||
tenant_id: uuid.UUID,
|
||||
page: int = 1,
|
||||
page_size: int = 20,
|
||||
) -> dict[str, Any]:
|
||||
"""Get paginated merge history for a tenant."""
|
||||
offset = (page - 1) * page_size
|
||||
|
||||
count_result = await db.execute(
|
||||
select(func.count(ContactMergeHistory.id)).where(
|
||||
ContactMergeHistory.tenant_id == tenant_id,
|
||||
ContactMergeHistory.deleted_at.is_(None),
|
||||
)
|
||||
)
|
||||
total = count_result.scalar() or 0
|
||||
|
||||
result = await db.execute(
|
||||
select(ContactMergeHistory)
|
||||
.where(
|
||||
ContactMergeHistory.tenant_id == tenant_id,
|
||||
ContactMergeHistory.deleted_at.is_(None),
|
||||
)
|
||||
.order_by(ContactMergeHistory.created_at.desc())
|
||||
.offset(offset)
|
||||
.limit(page_size)
|
||||
)
|
||||
records = result.scalars().all()
|
||||
|
||||
return {
|
||||
"items": [
|
||||
{
|
||||
"id": str(r.id),
|
||||
"source_contact_id": str(r.source_contact_id),
|
||||
"target_contact_id": str(r.target_contact_id),
|
||||
"merged_fields": r.merged_fields,
|
||||
"merged_by": str(r.merged_by) if r.merged_by else None,
|
||||
"note": r.note,
|
||||
"created_at": r.created_at.isoformat() if r.created_at else None,
|
||||
}
|
||||
for r in records
|
||||
],
|
||||
"total": total,
|
||||
"page": page,
|
||||
"page_size": page_size,
|
||||
}
|
||||
@@ -0,0 +1,88 @@
|
||||
/**
|
||||
* Deduplication / merge hooks for contacts (Task 5.23).
|
||||
*/
|
||||
|
||||
import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query';
|
||||
import { apiPost, apiGet } from './client';
|
||||
|
||||
export interface DuplicateContactBrief {
|
||||
id: string;
|
||||
type: string;
|
||||
displayname: string;
|
||||
name: string | null;
|
||||
firstname: string | null;
|
||||
surname: string | null;
|
||||
email_1: string | null;
|
||||
email_2: string | null;
|
||||
phone_1: string | null;
|
||||
phone_2: string | null;
|
||||
mailing_city: string | null;
|
||||
mailing_postalcode: string | null;
|
||||
created_at: string | null;
|
||||
}
|
||||
|
||||
export interface DuplicatePair {
|
||||
source_contact: DuplicateContactBrief;
|
||||
target_contact: DuplicateContactBrief;
|
||||
similarity_score: number;
|
||||
match_reasons: string[];
|
||||
}
|
||||
|
||||
export interface MergeHistoryItem {
|
||||
id: string;
|
||||
source_contact_id: string;
|
||||
target_contact_id: string;
|
||||
merged_fields: Record<string, unknown>;
|
||||
merged_by: string | null;
|
||||
note: string | null;
|
||||
created_at: string | null;
|
||||
}
|
||||
|
||||
export interface MergeHistoryResponse {
|
||||
items: MergeHistoryItem[];
|
||||
total: number;
|
||||
page: number;
|
||||
page_size: number;
|
||||
}
|
||||
|
||||
export interface MergeRequest {
|
||||
source_contact_id: string;
|
||||
target_contact_id: string;
|
||||
field_overrides?: Record<string, unknown>;
|
||||
note?: string;
|
||||
}
|
||||
|
||||
export function useFindDuplicates() {
|
||||
const queryClient = useQueryClient();
|
||||
return useMutation({
|
||||
mutationFn: (params: { threshold?: number; limit?: number }) =>
|
||||
apiPost<DuplicatePair[]>('/contacts/duplicates', {
|
||||
threshold: params.threshold ?? 0.7,
|
||||
limit: params.limit ?? 50,
|
||||
}),
|
||||
onSuccess: () => {
|
||||
queryClient.invalidateQueries({ queryKey: ['duplicates'] });
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function useMergeContacts() {
|
||||
const queryClient = useQueryClient();
|
||||
return useMutation({
|
||||
mutationFn: (data: MergeRequest) =>
|
||||
apiPost('/contacts/merge', data),
|
||||
onSuccess: () => {
|
||||
queryClient.invalidateQueries({ queryKey: ['contacts'] });
|
||||
queryClient.invalidateQueries({ queryKey: ['duplicates'] });
|
||||
queryClient.invalidateQueries({ queryKey: ['mergeHistory'] });
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function useMergeHistory(page = 1, pageSize = 20) {
|
||||
return useQuery({
|
||||
queryKey: ['mergeHistory', page, pageSize],
|
||||
queryFn: () =>
|
||||
apiGet<MergeHistoryResponse>(`/contacts/merge-history?page=${page}&page_size=${pageSize}`),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,195 @@
|
||||
/**
|
||||
* DedupDialog — UI for finding and merging duplicate contacts (Task 5.23).
|
||||
*/
|
||||
|
||||
import React, { useState, useCallback } from 'react';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { Modal } from '@/components/ui/Modal';
|
||||
import { Button } from '@/components/ui/Button';
|
||||
import { Badge } from '@/components/ui/Badge';
|
||||
import { useFindDuplicates, useMergeContacts, type DuplicatePair } from '@/api/dedup';
|
||||
import { useToast } from '@/components/ui/Toast';
|
||||
import { GitMerge, Search, AlertTriangle, Check } from 'lucide-react';
|
||||
|
||||
export function DedupDialog({ open, onClose }: { open: boolean; onClose: () => void }) {
|
||||
const { t } = useTranslation();
|
||||
const { success, error: showError } = useToast();
|
||||
const findDuplicates = useFindDuplicates();
|
||||
const mergeContacts = useMergeContacts();
|
||||
|
||||
const [duplicates, setDuplicates] = useState<DuplicatePair[]>([]);
|
||||
const [selectedPair, setSelectedPair] = useState<number | null>(null);
|
||||
const [fieldOverrides, setFieldOverrides] = useState<Record<string, string>>({});
|
||||
|
||||
const handleSearch = useCallback(async () => {
|
||||
try {
|
||||
const result = await findDuplicates.mutateAsync({ threshold: 0.7, limit: 50 });
|
||||
setDuplicates(result || []);
|
||||
setSelectedPair(null);
|
||||
} catch {
|
||||
showError(t('dedup.searchFailed'));
|
||||
}
|
||||
}, [findDuplicates, showError, t]);
|
||||
|
||||
const handleMerge = useCallback(async () => {
|
||||
if (selectedPair === null) return;
|
||||
const pair = duplicates[selectedPair];
|
||||
if (!pair) return;
|
||||
|
||||
try {
|
||||
const overrides: Record<string, unknown> = {};
|
||||
for (const [field, value] of Object.entries(fieldOverrides)) {
|
||||
if (value === 'source') {
|
||||
overrides[field] = (pair.source_contact as Record<string, unknown>)[field];
|
||||
} else if (value === 'target') {
|
||||
overrides[field] = (pair.target_contact as Record<string, unknown>)[field];
|
||||
}
|
||||
}
|
||||
|
||||
await mergeContacts.mutateAsync({
|
||||
source_contact_id: pair.source_contact.id,
|
||||
target_contact_id: pair.target_contact.id,
|
||||
field_overrides: Object.keys(overrides).length > 0 ? overrides : undefined,
|
||||
});
|
||||
|
||||
success(t('dedup.mergeSuccess'));
|
||||
setDuplicates((prev) => prev.filter((_, i) => i !== selectedPair));
|
||||
setSelectedPair(null);
|
||||
setFieldOverrides({});
|
||||
} catch {
|
||||
showError(t('dedup.mergeFailed'));
|
||||
}
|
||||
}, [duplicates, selectedPair, fieldOverrides, mergeContacts, success, showError, t]);
|
||||
|
||||
const compareFields = [
|
||||
{ key: 'displayname', label: t('dedup.fields.displayName') },
|
||||
{ key: 'email_1', label: t('dedup.fields.email') },
|
||||
{ key: 'phone_1', label: t('dedup.fields.phone') },
|
||||
{ key: 'mailing_city', label: t('dedup.fields.city') },
|
||||
{ key: 'mailing_postalcode', label: t('dedup.fields.postalCode') },
|
||||
];
|
||||
|
||||
return (
|
||||
<Modal open={open} onClose={onClose} title={t('dedup.title')} size="xl">
|
||||
<div className="space-y-4" data-testid="dedup-dialog">
|
||||
<div className="flex items-center gap-3">
|
||||
<Button
|
||||
variant="primary"
|
||||
icon={<Search className="w-4 h-4" />}
|
||||
onClick={handleSearch}
|
||||
isLoading={findDuplicates.isPending}
|
||||
data-testid="dedup-search-btn"
|
||||
>
|
||||
{t('dedup.findDuplicates')}
|
||||
</Button>
|
||||
{duplicates.length > 0 && (
|
||||
<Badge variant="info">{duplicates.length} {t('dedup.pairsFound')}</Badge>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{duplicates.length === 0 && !findDuplicates.isPending && (
|
||||
<p className="text-sm text-secondary-500" data-testid="dedup-empty">
|
||||
{t('dedup.noDuplicates')}
|
||||
</p>
|
||||
)}
|
||||
|
||||
{duplicates.map((pair, idx) => (
|
||||
<div
|
||||
key={`${pair.source_contact.id}-${pair.target_contact.id}`}
|
||||
className={`border rounded-lg p-4 cursor-pointer transition-colors ${
|
||||
selectedPair === idx ? 'border-primary-500 bg-primary-50' : 'border-secondary-200'
|
||||
}`}
|
||||
onClick={() => setSelectedPair(idx)}
|
||||
data-testid={`dedup-pair-${idx}`}
|
||||
>
|
||||
<div className="flex items-center justify-between mb-3">
|
||||
<div className="flex items-center gap-2">
|
||||
<AlertTriangle className="w-4 h-4 text-warning-500" />
|
||||
<span className="font-medium">
|
||||
{t('dedup.similarity')}: {Math.round(pair.similarity_score * 100)}%
|
||||
</span>
|
||||
</div>
|
||||
<div className="flex gap-1">
|
||||
{pair.match_reasons.map((reason) => (
|
||||
<Badge key={reason} variant="warning">{reason}</Badge>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{selectedPair === idx && (
|
||||
<div className="mt-4 space-y-3">
|
||||
<div className="grid grid-cols-3 gap-2 text-sm font-medium text-secondary-600">
|
||||
<div>{t('dedup.field')}</div>
|
||||
<div className="text-center">{t('dedup.source')}</div>
|
||||
<div className="text-center">{t('dedup.target')}</div>
|
||||
</div>
|
||||
{compareFields.map((field) => {
|
||||
const sourceVal = (pair.source_contact as Record<string, unknown>)[field.key] as string | null;
|
||||
const targetVal = (pair.target_contact as Record<string, unknown>)[field.key] as string | null;
|
||||
return (
|
||||
<div key={field.key} className="grid grid-cols-3 gap-2 text-sm">
|
||||
<div className="text-secondary-700">{field.label}</div>
|
||||
<div className="text-center">
|
||||
<button
|
||||
className={`px-2 py-1 rounded ${
|
||||
fieldOverrides[field.key] === 'source' ? 'bg-primary-100 text-primary-700' : 'hover:bg-secondary-100'
|
||||
}`}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
setFieldOverrides((prev) => ({ ...prev, [field.key]: 'source' }));
|
||||
}}
|
||||
data-testid={`dedup-field-${field.key}-source`}
|
||||
>
|
||||
{sourceVal || '—'}
|
||||
</button>
|
||||
</div>
|
||||
<div className="text-center">
|
||||
<button
|
||||
className={`px-2 py-1 rounded ${
|
||||
fieldOverrides[field.key] === 'target' ? 'bg-primary-100 text-primary-700' : 'hover:bg-secondary-100'
|
||||
}`}
|
||||
onClick={(e) => {
|
||||
e.stopPropagation();
|
||||
setFieldOverrides((prev) => ({ ...prev, [field.key]: 'target' }));
|
||||
}}
|
||||
data-testid={`dedup-field-${field.key}-target`}
|
||||
>
|
||||
{targetVal || '—'}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
|
||||
<div className="flex justify-end gap-2 pt-2">
|
||||
<Button
|
||||
variant="primary"
|
||||
icon={<GitMerge className="w-4 h-4" />}
|
||||
onClick={handleMerge}
|
||||
isLoading={mergeContacts.isPending}
|
||||
data-testid="dedup-merge-btn"
|
||||
>
|
||||
{t('dedup.merge')}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{selectedPair !== idx && (
|
||||
<div className="grid grid-cols-2 gap-4 text-sm">
|
||||
<div>
|
||||
<div className="font-medium text-secondary-800">{pair.source_contact.displayname}</div>
|
||||
<div className="text-secondary-500">{pair.source_contact.email_1 || '—'}</div>
|
||||
</div>
|
||||
<div>
|
||||
<div className="font-medium text-secondary-800">{pair.target_contact.displayname}</div>
|
||||
<div className="text-secondary-500">{pair.target_contact.email_1 || '—'}</div>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</Modal>
|
||||
);
|
||||
}
|
||||
@@ -1032,5 +1032,26 @@
|
||||
"deleted": "Filter gelöscht",
|
||||
"load": "Filter laden",
|
||||
"noFilters": "Keine gespeicherten Filter"
|
||||
},
|
||||
"dedup": {
|
||||
"title": "Dubletten finden und zusammenführen",
|
||||
"findDuplicates": "Dubletten suchen",
|
||||
"noDuplicates": "Keine Dubletten gefunden.",
|
||||
"pairsFound": "Paare gefunden",
|
||||
"similarity": "Ähnlichkeit",
|
||||
"merge": "Zusammenführen",
|
||||
"mergeSuccess": "Kontakte wurden erfolgreich zusammengeführt.",
|
||||
"mergeFailed": "Zusammenführung fehlgeschlagen.",
|
||||
"searchFailed": "Suche nach Dubletten fehlgeschlagen.",
|
||||
"field": "Feld",
|
||||
"source": "Quelle",
|
||||
"target": "Ziel",
|
||||
"fields": {
|
||||
"displayName": "Anzeigename",
|
||||
"email": "E-Mail",
|
||||
"phone": "Telefon",
|
||||
"city": "Stadt",
|
||||
"postalCode": "PLZ"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1032,5 +1032,26 @@
|
||||
"deleted": "Filter deleted",
|
||||
"load": "Load Filter",
|
||||
"noFilters": "No saved filters"
|
||||
},
|
||||
"dedup": {
|
||||
"title": "Find and Merge Duplicates",
|
||||
"findDuplicates": "Find Duplicates",
|
||||
"noDuplicates": "No duplicates found.",
|
||||
"pairsFound": "pairs found",
|
||||
"similarity": "Similarity",
|
||||
"merge": "Merge",
|
||||
"mergeSuccess": "Contacts merged successfully.",
|
||||
"mergeFailed": "Merge failed.",
|
||||
"searchFailed": "Failed to search for duplicates.",
|
||||
"field": "Field",
|
||||
"source": "Source",
|
||||
"target": "Target",
|
||||
"fields": {
|
||||
"displayName": "Display Name",
|
||||
"email": "Email",
|
||||
"phone": "Phone",
|
||||
"city": "City",
|
||||
"postalCode": "Postal Code"
|
||||
}
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -29,8 +29,8 @@ from app.core.db import Base, close_engine, reset_engine_for_testing
|
||||
from app.core.service_container import get_container # noqa: F401
|
||||
from app.main import create_app
|
||||
from app.models.ai_conversation import AIConversation, AIMessage # noqa: F401
|
||||
from app.models.contact import Contact
|
||||
from app.models.contact import Contact, ContactPerson # noqa: F401
|
||||
from app.models.contact_merge import ContactMergeHistory # noqa: F401
|
||||
from app.models.plugin import Plugin, PluginMigration # noqa: F401
|
||||
from app.models.role import Role
|
||||
from app.models.tenant import Tenant
|
||||
|
||||
@@ -0,0 +1,216 @@
|
||||
"""Deduplication / merge tests — Task 5.23."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
from httpx import AsyncClient
|
||||
|
||||
from tests.conftest import ORIGIN_HEADER, login_client, seed_tenant_and_users
|
||||
|
||||
|
||||
async def _get_csrf_token(client: AsyncClient) -> str:
|
||||
"""Extract CSRF token from login response."""
|
||||
# The login already happened, but we need the token from the response.
|
||||
# Re-login to get a fresh token (or extract from the last response).
|
||||
resp = await client.post(
|
||||
"/api/v1/auth/login",
|
||||
json={"email": "admin@tenanta.com", "password": "TestPass123!"},
|
||||
headers=ORIGIN_HEADER,
|
||||
)
|
||||
return resp.json().get("csrf_token", "")
|
||||
|
||||
|
||||
def _csrf_headers(token: str) -> dict:
|
||||
"""Return headers with CSRF token."""
|
||||
headers = dict(ORIGIN_HEADER)
|
||||
headers["X-CSRF-Token"] = token
|
||||
return headers
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
class TestFindDuplicates:
|
||||
"""POST /api/v1/contacts/duplicates — find duplicate contacts."""
|
||||
|
||||
async def test_find_duplicates_by_email(self, client: AsyncClient, db_session):
|
||||
"""Two contacts with same email should be detected as duplicates."""
|
||||
await seed_tenant_and_users(db_session)
|
||||
await login_client(client, "admin@tenanta.com")
|
||||
csrf = await _get_csrf_token(client)
|
||||
hdrs = _csrf_headers(csrf)
|
||||
|
||||
# Create two contacts with same email
|
||||
resp1 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "John", "surname": "Doe", "email_1": "john@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp1.status_code == 201, f"Create 1 failed: {resp1.text}"
|
||||
|
||||
resp2 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Johnny", "surname": "Doe", "email_1": "john@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp2.status_code == 201, f"Create 2 failed: {resp2.text}"
|
||||
|
||||
# Find duplicates
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts/duplicates",
|
||||
json={"threshold": 0.5, "limit": 50},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
data = resp.json()
|
||||
assert isinstance(data, list)
|
||||
assert len(data) >= 1
|
||||
pair = data[0]
|
||||
assert "source_contact" in pair
|
||||
assert "target_contact" in pair
|
||||
assert "similarity_score" in pair
|
||||
assert "match_reasons" in pair
|
||||
assert "email_match" in pair["match_reasons"]
|
||||
|
||||
async def test_find_duplicates_empty(self, client: AsyncClient, db_session):
|
||||
"""No duplicates when contacts are unique."""
|
||||
await seed_tenant_and_users(db_session)
|
||||
await login_client(client, "admin@tenanta.com")
|
||||
csrf = await _get_csrf_token(client)
|
||||
hdrs = _csrf_headers(csrf)
|
||||
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Unique", "surname": "Person", "email_1": "unique@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 201, f"Create failed: {resp.text}"
|
||||
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts/duplicates",
|
||||
json={"threshold": 0.7, "limit": 50},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
data = resp.json()
|
||||
assert isinstance(data, list)
|
||||
assert len(data) == 0
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
class TestMergeContacts:
|
||||
"""POST /api/v1/contacts/merge — merge two contacts."""
|
||||
|
||||
async def test_merge_contacts_success(self, client: AsyncClient, db_session):
|
||||
"""Merge source into target, source should be soft-deleted."""
|
||||
await seed_tenant_and_users(db_session)
|
||||
await login_client(client, "admin@tenanta.com")
|
||||
csrf = await _get_csrf_token(client)
|
||||
hdrs = _csrf_headers(csrf)
|
||||
|
||||
# Create source contact with phone
|
||||
resp1 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Source", "surname": "Test", "email_1": "source@example.com", "phone_1": "+49123456789"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp1.status_code == 201, f"Create source failed: {resp1.text}"
|
||||
source_id = resp1.json()["id"]
|
||||
|
||||
# Create target contact without phone
|
||||
resp2 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Target", "surname": "Test", "email_1": "target@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp2.status_code == 201, f"Create target failed: {resp2.text}"
|
||||
target_id = resp2.json()["id"]
|
||||
|
||||
# Merge
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts/merge",
|
||||
json={"source_contact_id": source_id, "target_contact_id": target_id},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 200, f"Merge failed: {resp.text}"
|
||||
data = resp.json()
|
||||
assert data["source_contact_id"] == source_id
|
||||
assert data["target_contact_id"] == target_id
|
||||
assert "merge_id" in data
|
||||
assert "merged_fields" in data
|
||||
# Phone should have been auto-merged
|
||||
assert "phone_1" in data["merged_fields"]
|
||||
|
||||
# Source should be soft-deleted (not in list)
|
||||
list_resp = await client.get("/api/v1/contacts", headers=ORIGIN_HEADER)
|
||||
contact_ids = [c["id"] for c in list_resp.json()["items"]]
|
||||
assert source_id not in contact_ids
|
||||
assert target_id in contact_ids
|
||||
|
||||
async def test_merge_same_contact_fails(self, client: AsyncClient, db_session):
|
||||
"""Merging a contact with itself should fail."""
|
||||
await seed_tenant_and_users(db_session)
|
||||
await login_client(client, "admin@tenanta.com")
|
||||
csrf = await _get_csrf_token(client)
|
||||
hdrs = _csrf_headers(csrf)
|
||||
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Same", "surname": "Contact", "email_1": "same@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 201, f"Create failed: {resp.text}"
|
||||
contact_id = resp.json()["id"]
|
||||
|
||||
resp = await client.post(
|
||||
"/api/v1/contacts/merge",
|
||||
json={"source_contact_id": contact_id, "target_contact_id": contact_id},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp.status_code == 400
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
class TestMergeHistory:
|
||||
"""GET /api/v1/contacts/merge-history — merge history."""
|
||||
|
||||
async def test_merge_history_returns_records(self, client: AsyncClient, db_session):
|
||||
"""After a merge, history should contain the record."""
|
||||
await seed_tenant_and_users(db_session)
|
||||
await login_client(client, "admin@tenanta.com")
|
||||
csrf = await _get_csrf_token(client)
|
||||
hdrs = _csrf_headers(csrf)
|
||||
|
||||
# Create and merge two contacts
|
||||
resp1 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Hist", "surname": "Source", "email_1": "hist-source@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp1.status_code == 201
|
||||
source_id = resp1.json()["id"]
|
||||
|
||||
resp2 = await client.post(
|
||||
"/api/v1/contacts",
|
||||
json={"type": "person", "firstname": "Hist", "surname": "Target", "email_1": "hist-target@example.com"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert resp2.status_code == 201
|
||||
target_id = resp2.json()["id"]
|
||||
|
||||
merge_resp = await client.post(
|
||||
"/api/v1/contacts/merge",
|
||||
json={"source_contact_id": source_id, "target_contact_id": target_id, "note": "Test merge"},
|
||||
headers=hdrs,
|
||||
)
|
||||
assert merge_resp.status_code == 200
|
||||
|
||||
# Get history (GET doesn't need CSRF)
|
||||
resp = await client.get("/api/v1/contacts/merge-history", headers=ORIGIN_HEADER)
|
||||
assert resp.status_code == 200
|
||||
data = resp.json()
|
||||
assert "items" in data
|
||||
assert "total" in data
|
||||
assert data["total"] >= 1
|
||||
item = data["items"][0]
|
||||
assert item["source_contact_id"] == source_id
|
||||
assert item["target_contact_id"] == target_id
|
||||
assert item["note"] == "Test merge"
|
||||
Reference in New Issue
Block a user