mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-21 19:40:34 +00:00
013aa3954d
The first time an admin opens the settings on an installation that can share, a dialog asks for the whole installation, with every field switched on and a plain list of what never goes along. Nothing is sent before Agree; Not now asks again in 14 days, No keeps the question away until the terms change, and closing it decides nothing. Inside the TREK Places API card, Share place details then holds the switch for the installation and one per field, the figures of the last 30 days, the transmission log and the way to withdraw everything sent. The place form reports for each field whether the user typed it or a provider filled it.
364 lines
16 KiB
TypeScript
364 lines
16 KiB
TypeScript
// FE-PLANNER-PLFORM-001 to FE-PLANNER-PLFORM-019: the place form state behind the desktop
|
|
// dialog and the phone sheet, its waiting picture, and the inline new category of both
|
|
// ('dialog' and 'sheet').
|
|
import { act, renderHook } from '@testing-library/react';
|
|
import type React from 'react';
|
|
import { afterEach, beforeEach, describe, expect, it, vi, type MockInstance } from 'vitest';
|
|
|
|
import { buildTripFile } from '../../../tests/helpers/factories';
|
|
import type { Category, Place } from '../../types';
|
|
import { DEFAULT_FORM } from './PlaceFormModal.helpers';
|
|
import { useNewCategory, usePlaceForm, type NewCategoryOptions } from './usePlaceForm';
|
|
|
|
const t = (key: string, params?: Record<string, string | number>) =>
|
|
params ? `${key}:${JSON.stringify(params)}` : key;
|
|
|
|
const makeToast = () => ({ success: vi.fn(), error: vi.fn(), warning: vi.fn(), info: vi.fn() });
|
|
|
|
let toast: ReturnType<typeof makeToast>;
|
|
|
|
beforeEach(() => {
|
|
toast = makeToast();
|
|
});
|
|
|
|
function setup(canUploadFiles = true) {
|
|
return renderHook(() => usePlaceForm({ t, toast, canUploadFiles }));
|
|
}
|
|
|
|
const PLACE = {
|
|
id: 5,
|
|
name: 'Louvre',
|
|
lat: 48.86,
|
|
lng: 2.33,
|
|
google_place_id: 'g-louvre',
|
|
amap_poi_id: null,
|
|
osm_id: null,
|
|
} as unknown as Place;
|
|
|
|
function file(name: string, type: string) {
|
|
return new File(['x'], name, { type });
|
|
}
|
|
|
|
function pasteEvent(items: { type: string; file: File | null }[]) {
|
|
const preventDefault = vi.fn();
|
|
const event = {
|
|
preventDefault,
|
|
clipboardData: { items: items.map((item) => ({ type: item.type, getAsFile: () => item.file })) },
|
|
} as unknown as React.ClipboardEvent;
|
|
return { event, preventDefault };
|
|
}
|
|
|
|
describe('usePlaceForm', () => {
|
|
it('FE-PLANNER-PLFORM-001: starts on the blank form with nothing attached, warned or described', () => {
|
|
const { result } = setup();
|
|
expect(result.current.form).toEqual(DEFAULT_FORM);
|
|
expect(result.current.pendingFiles).toEqual([]);
|
|
expect(result.current.duplicateWarning).toBeNull();
|
|
expect(result.current.detailsSelection).toBeNull();
|
|
expect(result.current.isSaving).toBe(false);
|
|
expect(result.current.autoFilledRef.current.size).toBe(0);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-002: opening on a place being edited owns no field and describes that place', () => {
|
|
const { result } = setup();
|
|
const next = { ...DEFAULT_FORM, name: 'Louvre' };
|
|
act(() => result.current.openForm(next, PLACE, null));
|
|
expect(result.current.form).toBe(next);
|
|
expect(result.current.autoFilledRef.current.size).toBe(0);
|
|
expect(result.current.detailsSelection).toEqual({ placeId: 'g-louvre', lat: 48.86, lng: 2.33, name: 'Louvre' });
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-003: opening on a map POI owns the fields it filled and describes the POI', () => {
|
|
const { result } = setup();
|
|
const prefill = { lat: 1, lng: 2, name: 'Cafe', website: 'https://cafe.example', osm_id: 'N9' };
|
|
act(() => result.current.openForm(DEFAULT_FORM, null, prefill));
|
|
expect([...result.current.autoFilledRef.current].sort()).toEqual(['lat', 'lng', 'name', 'osm_id', 'website']);
|
|
expect(result.current.detailsSelection).toEqual({ placeId: 'N9', lat: 1, lng: 2, name: 'Cafe' });
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-004: a fresh opening drops the files and the warning the last one left', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.addFiles([file('a.pdf', 'application/pdf')]));
|
|
act(() => result.current.handleChange('name', 'Louvre'));
|
|
act(() => {
|
|
result.current.warnIfDuplicate([{ name: 'louvre' }]);
|
|
});
|
|
expect(result.current.duplicateWarning).toBe('louvre');
|
|
act(() => result.current.openForm(DEFAULT_FORM, null, null));
|
|
expect(result.current.pendingFiles).toEqual([]);
|
|
expect(result.current.duplicateWarning).toBeNull();
|
|
expect(result.current.detailsSelection).toBeNull();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-005: a field typed by hand is no longer the last pick to clear', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.openForm(DEFAULT_FORM, null, { lat: 1, lng: 2, name: 'Cafe' }));
|
|
act(() => result.current.handleChange('name', 'My cafe'));
|
|
expect(result.current.form.name).toBe('My cafe');
|
|
expect(result.current.autoFilledRef.current.has('name')).toBe(false);
|
|
expect(result.current.autoFilledRef.current.has('lat')).toBe(true);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-006: files are added from the input, which is cleared, and removed by index', () => {
|
|
const { result } = setup();
|
|
const a = file('a.pdf', 'application/pdf');
|
|
const b = file('b.png', 'image/png');
|
|
const target = { files: [a, b], value: 'C:\\fakepath\\a.pdf' };
|
|
act(() => result.current.addFilesFromInput({ target } as unknown as React.ChangeEvent<HTMLInputElement>));
|
|
expect(result.current.pendingFiles).toEqual([a, b]);
|
|
expect(target.value).toBe('');
|
|
act(() => result.current.removeFile(0));
|
|
expect(result.current.pendingFiles).toEqual([b]);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-007: a pasted picture or PDF becomes an attachment, the first one only', () => {
|
|
const { result } = setup();
|
|
const img = file('shot.png', 'image/png');
|
|
const { event, preventDefault } = pasteEvent([
|
|
{ type: 'text/plain', file: null },
|
|
{ type: 'image/png', file: img },
|
|
{ type: 'application/pdf', file: file('x.pdf', 'application/pdf') },
|
|
]);
|
|
act(() => result.current.handlePaste(event));
|
|
expect(preventDefault).toHaveBeenCalledTimes(1);
|
|
expect(result.current.pendingFiles).toEqual([img]);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-008: a member who may not upload pastes text as text', () => {
|
|
const { result } = setup(false);
|
|
const { event, preventDefault } = pasteEvent([{ type: 'image/png', file: file('shot.png', 'image/png') }]);
|
|
act(() => result.current.handlePaste(event));
|
|
expect(preventDefault).not.toHaveBeenCalled();
|
|
expect(result.current.pendingFiles).toEqual([]);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-009: the details column picks the image and hands over its description', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.pickImage('https://img.example/1.jpg'));
|
|
expect(result.current.form.image_url).toBe('https://img.example/1.jpg');
|
|
act(() => result.current.pickImage(null));
|
|
expect(result.current.form.image_url).toBeUndefined();
|
|
act(() => result.current.adoptDescription('A museum'));
|
|
expect(result.current.form.description).toBe('A museum');
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-010: a likely duplicate warns once by name; none lets the save go on', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.handleChange('name', 'Louvre'));
|
|
let warned = true;
|
|
act(() => {
|
|
warned = result.current.warnIfDuplicate([{ name: 'Orsay' }]);
|
|
});
|
|
expect(warned).toBe(false);
|
|
expect(toast.warning).not.toHaveBeenCalled();
|
|
|
|
act(() => {
|
|
warned = result.current.warnIfDuplicate([{ name: 'Louvre Museum' }, { name: ' louvre ' }]);
|
|
});
|
|
expect(warned).toBe(true);
|
|
expect(result.current.duplicateWarning).toBe(' louvre ');
|
|
expect(toast.warning).toHaveBeenCalledWith('places.duplicateExists:{"name":" louvre "}');
|
|
});
|
|
});
|
|
|
|
function category(id: number): Category {
|
|
return { id, name: 'Food', color: '#6366f1', icon: 'MapPin' } as unknown as Category;
|
|
}
|
|
|
|
describe('usePlaceForm, the waiting picture', () => {
|
|
let previews: number;
|
|
let createObjectURL: MockInstance<typeof URL.createObjectURL>;
|
|
let revokeObjectURL: MockInstance<typeof URL.revokeObjectURL>;
|
|
|
|
beforeEach(() => {
|
|
previews = 0;
|
|
createObjectURL = vi.spyOn(URL, 'createObjectURL').mockImplementation(() => `blob:preview-${++previews}`);
|
|
revokeObjectURL = vi.spyOn(URL, 'revokeObjectURL').mockImplementation(() => undefined);
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-015: nothing waits on a fresh form', () => {
|
|
const { result } = setup();
|
|
expect(result.current.pendingImage).toBeNull();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-016: a picture from the device waits with its preview and keeps the field untouched', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.pickImage('https://img.example/1.jpg'));
|
|
const picture = file('front.png', 'image/png');
|
|
act(() => result.current.stageUpload(picture));
|
|
expect(createObjectURL).toHaveBeenCalledWith(picture);
|
|
expect(result.current.pendingImage).toEqual({ kind: 'upload', file: picture, preview: 'blob:preview-1' });
|
|
// A source's photo picked before gives way to it.
|
|
expect(result.current.form.image_url).toBeUndefined();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-017: replacing the waiting upload frees its preview, whatever replaces it', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.stageUpload(file('a.png', 'image/png')));
|
|
act(() => result.current.stageUpload(file('b.png', 'image/png')));
|
|
expect(revokeObjectURL).toHaveBeenCalledWith('blob:preview-1');
|
|
expect(result.current.pendingImage).toMatchObject({ kind: 'upload', preview: 'blob:preview-2' });
|
|
|
|
const attached = buildTripFile({ id: 8, mime_type: 'image/png' });
|
|
act(() => result.current.stageAttached(attached));
|
|
expect(revokeObjectURL).toHaveBeenCalledWith('blob:preview-2');
|
|
expect(result.current.pendingImage).toEqual({ kind: 'attached', file: attached });
|
|
expect(result.current.form.image_url).toBeUndefined();
|
|
|
|
// An attached image has no preview of ours to free.
|
|
revokeObjectURL.mockClear();
|
|
act(() => result.current.pickImage('https://img.example/2.jpg'));
|
|
expect(revokeObjectURL).not.toHaveBeenCalled();
|
|
expect(result.current.pendingImage).toBeNull();
|
|
expect(result.current.form.image_url).toBe('https://img.example/2.jpg');
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-018: removing the picture drops what waits and empties the field for the save', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.stageUpload(file('a.png', 'image/png')));
|
|
act(() => result.current.removeImage());
|
|
expect(revokeObjectURL).toHaveBeenCalledWith('blob:preview-1');
|
|
expect(result.current.pendingImage).toBeNull();
|
|
expect(result.current.form.image_url).toBeNull();
|
|
|
|
// A fresh opening starts without a waiting picture as well.
|
|
act(() => result.current.stageUpload(file('b.png', 'image/png')));
|
|
act(() => result.current.openForm(DEFAULT_FORM, null, null));
|
|
expect(revokeObjectURL).toHaveBeenCalledWith('blob:preview-2');
|
|
expect(result.current.pendingImage).toBeNull();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-019: closing the form frees the preview still waiting, and only that one', () => {
|
|
const { result, unmount } = setup();
|
|
act(() => result.current.stageUpload(file('a.png', 'image/png')));
|
|
revokeObjectURL.mockClear();
|
|
unmount();
|
|
expect(revokeObjectURL).toHaveBeenCalledTimes(1);
|
|
expect(revokeObjectURL).toHaveBeenCalledWith('blob:preview-1');
|
|
|
|
const empty = setup();
|
|
revokeObjectURL.mockClear();
|
|
empty.unmount();
|
|
expect(revokeObjectURL).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('useNewCategory', () => {
|
|
function setupCategory(options: Pick<NewCategoryOptions, 'variant' | 'create'>) {
|
|
const onCreated = vi.fn();
|
|
const hook = renderHook(() => useNewCategory({ ...options, onCreated, t, toast } as NewCategoryOptions));
|
|
return { ...hook, onCreated };
|
|
}
|
|
|
|
it('FE-PLANNER-PLFORM-011: a blank name creates nothing', async () => {
|
|
const create = vi.fn(async () => category(1));
|
|
const { result } = setupCategory({ variant: 'sheet', create });
|
|
act(() => result.current.setName(' '));
|
|
await act(async () => {
|
|
await result.current.submit();
|
|
});
|
|
expect(create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-012: the desktop sends the name as typed, picks the new category and closes', async () => {
|
|
const create = vi.fn(async () => category(7));
|
|
const { result, onCreated } = setupCategory({ variant: 'dialog', create });
|
|
act(() => {
|
|
result.current.setOpen(true);
|
|
result.current.setName(' Food ');
|
|
});
|
|
await act(async () => {
|
|
await result.current.submit();
|
|
});
|
|
expect(create).toHaveBeenCalledWith({ name: ' Food ', color: '#6366f1', icon: 'MapPin' });
|
|
expect(onCreated).toHaveBeenCalledWith('7');
|
|
expect(result.current.name).toBe('');
|
|
expect(result.current.open).toBe(false);
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-013: a desktop create that hands nothing back picks nothing but still closes', async () => {
|
|
const create = vi.fn(() => undefined);
|
|
const { result, onCreated } = setupCategory({ variant: 'dialog', create });
|
|
act(() => {
|
|
result.current.setOpen(true);
|
|
result.current.setName('Food');
|
|
});
|
|
await act(async () => {
|
|
await result.current.submit();
|
|
});
|
|
expect(onCreated).not.toHaveBeenCalled();
|
|
expect(result.current.open).toBe(false);
|
|
expect(toast.error).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-014: the phone trims the name, ignores a second tap while saving and toasts a failure', async () => {
|
|
let finish: (c: Category) => void = () => {};
|
|
const create = vi.fn(() => new Promise<Category>((resolve) => (finish = resolve)));
|
|
const { result, onCreated } = setupCategory({ variant: 'sheet', create });
|
|
act(() => result.current.setName(' Food '));
|
|
let first: Promise<void> = Promise.resolve();
|
|
act(() => {
|
|
first = result.current.submit();
|
|
});
|
|
expect(result.current.saving).toBe(true);
|
|
await act(async () => {
|
|
await result.current.submit();
|
|
});
|
|
expect(create).toHaveBeenCalledTimes(1);
|
|
expect(create).toHaveBeenCalledWith({ name: 'Food', color: '#6366f1', icon: 'MapPin' });
|
|
await act(async () => {
|
|
finish(category(3));
|
|
await first;
|
|
});
|
|
expect(onCreated).toHaveBeenCalledWith('3');
|
|
expect(result.current.saving).toBe(false);
|
|
|
|
create.mockImplementation(() => Promise.reject(new Error('nope')));
|
|
act(() => result.current.setName('Bar'));
|
|
await act(async () => {
|
|
await result.current.submit();
|
|
});
|
|
expect(toast.error).toHaveBeenCalledWith('places.categoryCreateError');
|
|
expect(result.current.name).toBe('Bar');
|
|
});
|
|
});
|
|
|
|
// FE-PLANNER-PLFORM-030 to FE-PLANNER-PLFORM-033: which fields the user typed and which a
|
|
// pick, a map POI or the details column filled, for the save's fieldOrigins.
|
|
describe('usePlaceForm field origins', () => {
|
|
it('FE-PLANNER-PLFORM-030: a typed shareable field is the user own; other fields report nothing', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.handleChange('website', 'https://mine.example'));
|
|
act(() => result.current.handleChange('name', 'Mine'));
|
|
expect(result.current.form.fieldOrigins).toEqual({ website: 'user' });
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-031: a map POI owns what it prefilled, until the user types over it', () => {
|
|
const { result } = setup();
|
|
const prefill = { lat: 1, lng: 2, name: 'Cafe', website: 'https://cafe.example', phone: '+49 1', osm_id: 'node:9' };
|
|
act(() => result.current.openForm(DEFAULT_FORM, null, prefill));
|
|
expect(result.current.form.fieldOrigins).toEqual({ website: 'osm', phone: 'osm' });
|
|
act(() => result.current.handleChange('phone', '+49 2'));
|
|
expect(result.current.form.fieldOrigins).toEqual({ website: 'osm', phone: 'user' });
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-032: an adopted description and a picked photo are the details column own', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.adoptDescription('A museum by the river.'));
|
|
act(() => result.current.pickImage('/api/maps/place-photo/x/bytes'));
|
|
expect(result.current.form.fieldOrigins).toEqual({ description: 'enrichment', image: 'enrichment' });
|
|
act(() => result.current.removeImage());
|
|
expect(result.current.form.fieldOrigins).toEqual({ description: 'enrichment' });
|
|
});
|
|
|
|
it('FE-PLANNER-PLFORM-033: hours taken over from the lookup say so', () => {
|
|
const { result } = setup();
|
|
act(() => result.current.handleChange('opening_hours', '[]', 'enrichment'));
|
|
expect(result.current.form.fieldOrigins).toEqual({ opening_hours: 'enrichment' });
|
|
});
|
|
});
|