mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-18 21:16:47 +00:00
test(collections): unit-test the nest controller (branch coverage) (#1081)
The collections nest module had no controller test, dragging src/nest/** branch coverage below the 80% gate. Cover the controller's branches: reorder/deleteMany payload validation, owner-gated invite/cancel/remove/available-users, invite + accept error surfacing, the cover demo-mode + no-file guards, and the x-socket-id forwarding on the mutating endpoints.
This commit is contained in:
Maurice
@@ -0,0 +1,194 @@
|
||||
import { describe, it, expect, vi, afterEach } from 'vitest';
|
||||
import { HttpException } from '@nestjs/common';
|
||||
import { CollectionsController } from '../../../src/nest/collections/collections.controller';
|
||||
import type { CollectionsService } from '../../../src/nest/collections/collections.service';
|
||||
import type { User } from '../../../src/types';
|
||||
|
||||
const user = { id: 1, username: 'owner', role: 'user', email: 'u@example.test' } as User;
|
||||
|
||||
/** Service mock — access granted + owner by default; each method a spy. */
|
||||
function makeService(overrides: Partial<Record<keyof CollectionsService, unknown>> = {}): CollectionsService {
|
||||
return {
|
||||
listCollections: vi.fn().mockReturnValue({ collections: [], incomingInvites: [] }),
|
||||
getCollection: vi.fn().mockReturnValue({ collection: { id: 3 }, places: [] }),
|
||||
createCollection: vi.fn().mockReturnValue({ id: 7 }),
|
||||
updateCollection: vi.fn().mockReturnValue({ id: 3 }),
|
||||
setCollectionCover: vi.fn().mockReturnValue({ id: 3 }),
|
||||
deleteCollection: vi.fn(),
|
||||
reorderCollections: vi.fn(),
|
||||
savePlace: vi.fn().mockReturnValue({ place: { id: 9 } }),
|
||||
saveFromTripPlace: vi.fn().mockReturnValue({ place: { id: 9 } }),
|
||||
updatePlace: vi.fn().mockReturnValue({ id: 9 }),
|
||||
setStatus: vi.fn().mockReturnValue({ id: 9 }),
|
||||
deletePlace: vi.fn(),
|
||||
deletePlacesMany: vi.fn().mockReturnValue([1, 2]),
|
||||
copyToTrip: vi.fn().mockReturnValue({ copied: 1, skipped: [] }),
|
||||
findMembership: vi.fn().mockReturnValue({ inLists: [] }),
|
||||
assertAccess: vi.fn(),
|
||||
isOwner: vi.fn().mockReturnValue(true),
|
||||
sendInvite: vi.fn().mockReturnValue({ success: true }),
|
||||
acceptInvite: vi.fn().mockReturnValue({ success: true }),
|
||||
declineInvite: vi.fn(),
|
||||
cancelInvite: vi.fn(),
|
||||
leaveCollection: vi.fn(),
|
||||
removeMember: vi.fn(),
|
||||
availableUsers: vi.fn().mockReturnValue([{ id: 2 }]),
|
||||
...overrides,
|
||||
} as unknown as CollectionsService;
|
||||
}
|
||||
|
||||
function thrown(fn: () => unknown): { status: number; body: unknown } {
|
||||
try {
|
||||
fn();
|
||||
} catch (err) {
|
||||
expect(err).toBeInstanceOf(HttpException);
|
||||
const e = err as HttpException;
|
||||
return { status: e.getStatus(), body: e.getResponse() };
|
||||
}
|
||||
throw new Error('expected the handler to throw');
|
||||
}
|
||||
|
||||
describe('CollectionsController', () => {
|
||||
afterEach(() => { delete process.env.DEMO_MODE; });
|
||||
|
||||
it('lists / creates / reads / deletes lists (pass-throughs)', () => {
|
||||
const svc = makeService();
|
||||
const c = new CollectionsController(svc);
|
||||
expect(c.list(user)).toEqual({ collections: [], incomingInvites: [] });
|
||||
expect(c.create(user, { name: 'Italy' } as never)).toEqual({ id: 7 });
|
||||
expect(c.get(user, '3')).toEqual({ collection: { id: 3 }, places: [] });
|
||||
expect(c.update(user, '3', { name: 'x' } as never, 'sock')).toEqual({ id: 3 });
|
||||
expect(svc.updateCollection).toHaveBeenCalledWith(1, 3, { name: 'x' }, 'sock');
|
||||
expect(c.remove(user, '3')).toEqual({ success: true });
|
||||
expect(svc.deleteCollection).toHaveBeenCalledWith(1, 3);
|
||||
});
|
||||
|
||||
describe('reorder', () => {
|
||||
it('400 when orderedIds is not an array of numbers', () => {
|
||||
expect(thrown(() => new CollectionsController(makeService()).reorder(user, 'nope' as never)))
|
||||
.toEqual({ status: 400, body: { error: 'orderedIds must be an array of numbers' } });
|
||||
expect(thrown(() => new CollectionsController(makeService()).reorder(user, [1, 'x'] as never)))
|
||||
.toEqual({ status: 400, body: { error: 'orderedIds must be an array of numbers' } });
|
||||
});
|
||||
it('reorders a valid array', () => {
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).reorder(user, [3, 1, 2] as never)).toEqual({ success: true });
|
||||
expect(svc.reorderCollections).toHaveBeenCalledWith(1, [3, 1, 2]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('places', () => {
|
||||
it('savePlace / updatePlace / setStatus / deletePlace forward the socket id', () => {
|
||||
const svc = makeService();
|
||||
const c = new CollectionsController(svc);
|
||||
c.savePlace(user, { collection_id: 3, name: 'A' } as never, 'sid');
|
||||
expect(svc.savePlace).toHaveBeenCalledWith(1, { collection_id: 3, name: 'A' }, 'sid');
|
||||
c.updatePlace(user, '9', { name: 'B' } as never, 'sid');
|
||||
expect(svc.updatePlace).toHaveBeenCalledWith(1, 9, { name: 'B' }, 'sid');
|
||||
c.setStatus(user, '9', { status: 'want' } as never, 'sid');
|
||||
expect(svc.setStatus).toHaveBeenCalledWith(1, 9, 'want', 'sid');
|
||||
expect(c.deletePlace(user, '9', 'sid')).toEqual({ success: true });
|
||||
expect(svc.deletePlace).toHaveBeenCalledWith(1, 9, 'sid');
|
||||
c.saveFromTrip(user, { collection_id: 3, source_trip_id: 5, source_place_id: 8 } as never);
|
||||
expect(svc.saveFromTripPlace).toHaveBeenCalledWith(1, 3, 5, 8, undefined);
|
||||
expect(c.copyToTrip(user, { trip_id: 5, place_ids: [9] } as never)).toEqual({ copied: 1, skipped: [] });
|
||||
});
|
||||
|
||||
it('deleteMany 400 on a bad payload, deletes a valid one', () => {
|
||||
expect(thrown(() => new CollectionsController(makeService()).deleteMany(user, { nope: 1 } as never)))
|
||||
.toEqual({ status: 400, body: { error: 'ids must be an array of numbers' } });
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).deleteMany(user, [1, 2] as never, 'sid')).toEqual({ deleted: [1, 2] });
|
||||
expect(svc.deletePlacesMany).toHaveBeenCalledWith(1, [1, 2], 'sid');
|
||||
});
|
||||
});
|
||||
|
||||
describe('membership lookup', () => {
|
||||
it('parses lat/lng when present', () => {
|
||||
const svc = makeService();
|
||||
new CollectionsController(svc).membership(user, 'gpid', undefined, 'Rome', '41.9', '12.5');
|
||||
expect(svc.findMembership).toHaveBeenCalledWith(1, { google_place_id: 'gpid', google_ftid: undefined, name: 'Rome', lat: 41.9, lng: 12.5 });
|
||||
});
|
||||
it('leaves lat/lng undefined when absent', () => {
|
||||
const svc = makeService();
|
||||
new CollectionsController(svc).membership(user);
|
||||
expect(svc.findMembership).toHaveBeenCalledWith(1, { google_place_id: undefined, google_ftid: undefined, name: undefined, lat: undefined, lng: undefined });
|
||||
});
|
||||
});
|
||||
|
||||
describe('invites (owner-gated)', () => {
|
||||
it('403 when a non-owner invites', () => {
|
||||
const svc = makeService({ isOwner: vi.fn().mockReturnValue(false) });
|
||||
expect(thrown(() => new CollectionsController(svc).invite(user, { collection_id: 3, user_id: 2 } as never)))
|
||||
.toEqual({ status: 403, body: { error: 'Only the owner can invite' } });
|
||||
});
|
||||
it('surfaces a sendInvite error with its status', () => {
|
||||
const svc = makeService({ sendInvite: vi.fn().mockReturnValue({ error: 'Already a member', status: 409 }) });
|
||||
expect(thrown(() => new CollectionsController(svc).invite(user, { collection_id: 3, user_id: 2 } as never)))
|
||||
.toEqual({ status: 409, body: { error: 'Already a member' } });
|
||||
});
|
||||
it('invites successfully as owner', () => {
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).invite(user, { collection_id: 3, user_id: 2 } as never)).toEqual({ success: true });
|
||||
});
|
||||
it('accept surfaces an error, else succeeds', () => {
|
||||
const bad = makeService({ acceptInvite: vi.fn().mockReturnValue({ error: 'Gone', status: 404 }) });
|
||||
expect(thrown(() => new CollectionsController(bad).acceptInvite(user, { collection_id: 3 } as never, 'sid')))
|
||||
.toEqual({ status: 404, body: { error: 'Gone' } });
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).acceptInvite(user, { collection_id: 3 } as never, 'sid')).toEqual({ success: true });
|
||||
expect(svc.acceptInvite).toHaveBeenCalledWith(1, 3, 'sid');
|
||||
});
|
||||
it('decline + leave forward the socket id', () => {
|
||||
const svc = makeService();
|
||||
const c = new CollectionsController(svc);
|
||||
expect(c.declineInvite(user, { collection_id: 3 } as never, 'sid')).toEqual({ success: true });
|
||||
expect(svc.declineInvite).toHaveBeenCalledWith(1, 3, 'sid');
|
||||
expect(c.leave(user, { collection_id: 3 } as never, 'sid')).toEqual({ success: true });
|
||||
expect(svc.leaveCollection).toHaveBeenCalledWith(1, 3, 'sid');
|
||||
});
|
||||
it('cancel is owner-gated', () => {
|
||||
const notOwner = makeService({ isOwner: vi.fn().mockReturnValue(false) });
|
||||
expect(thrown(() => new CollectionsController(notOwner).cancelInvite(user, { collection_id: 3, user_id: 2 } as never)))
|
||||
.toEqual({ status: 403, body: { error: 'Only the owner can cancel invites' } });
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).cancelInvite(user, { collection_id: 3, user_id: 2 } as never)).toEqual({ success: true });
|
||||
});
|
||||
});
|
||||
|
||||
describe('members', () => {
|
||||
it('removeMember is owner-gated', () => {
|
||||
const notOwner = makeService({ isOwner: vi.fn().mockReturnValue(false) });
|
||||
expect(thrown(() => new CollectionsController(notOwner).removeMember(user, { collection_id: 3, user_id: 2 } as never)))
|
||||
.toEqual({ status: 403, body: { error: 'Only the owner can remove members' } });
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).removeMember(user, { collection_id: 3, user_id: 2 } as never)).toEqual({ success: true });
|
||||
expect(svc.removeMember).toHaveBeenCalledWith(1, 3, 2);
|
||||
});
|
||||
it('availableUsers is owner-gated', () => {
|
||||
const notOwner = makeService({ isOwner: vi.fn().mockReturnValue(false) });
|
||||
expect(thrown(() => new CollectionsController(notOwner).availableUsers(user, '3')))
|
||||
.toEqual({ status: 403, body: { error: 'Only the owner can manage members' } });
|
||||
expect(new CollectionsController(makeService()).availableUsers(user, '3')).toEqual({ users: [{ id: 2 }] });
|
||||
});
|
||||
});
|
||||
|
||||
describe('uploadCover', () => {
|
||||
const file = { filename: 'x.jpg' } as Express.Multer.File;
|
||||
it('403 in demo mode for a demo user', () => {
|
||||
process.env.DEMO_MODE = 'true';
|
||||
const demo = { ...user, email: 'demo@trek.app' } as User;
|
||||
expect(thrown(() => new CollectionsController(makeService()).uploadCover(demo, '3', file)))
|
||||
.toEqual({ status: 403, body: { error: 'Uploads are disabled in demo mode. Self-host TREK for full functionality.' } });
|
||||
});
|
||||
it('400 when no file was uploaded', () => {
|
||||
expect(thrown(() => new CollectionsController(makeService()).uploadCover(user, '3', undefined)))
|
||||
.toEqual({ status: 400, body: { error: 'No image uploaded' } });
|
||||
});
|
||||
it('stores the cover and forwards the socket id', () => {
|
||||
const svc = makeService();
|
||||
expect(new CollectionsController(svc).uploadCover(user, '3', file, 'sid')).toEqual({ id: 3 });
|
||||
expect(svc.setCollectionCover).toHaveBeenCalledWith(1, 3, '/uploads/covers/x.jpg', 'sid');
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user