feat: multiple improvements to library functionality (#50)
Node.js CI / CI (push) Successful in 1m18s
Security Scan and Upload / Security & DefectDojo Upload (push) Successful in 1m17s

## Summary

This PR implements several improvements to the library application:

- Added start and finish date tracking for media items
- Added "Retired" category for abandoned media
- Implemented avatar-based user menu with dropdown navigation
- Added automatic background token refresh to prevent session expiry
- Created centralised logging system with frontend-to-API log forwarding
- Added toast notifications for error handling

## Changes

### Media Tracking (#41)
- Added `dateStarted` and `dateFinished` fields to Books, Games, Manga, Music, and Shows
- Updated TypeScript types, Prisma schema, and API services
- Added manual date input fields to frontend forms
- Properly converts HTML date strings to Date objects before API submission

### Retired Category (#43)
- Added `RETIRED` status to all media type enums
- Updated Prisma schema, frontend dropdowns, and filter buttons
- Added status label handling for retired items

### User Menu (#46)
- Replaced username text with avatar image in header
- Created dropdown menu with navigation items (Users, Audit, Suggestions)
- Added logout button to menu
- Implemented keyboard accessibility (tabindex, role, keyup handlers)

### Token Refresh (#44)
- Implemented automatic token refresh every 13 minutes in background
- Added proactive refresh to prevent token expiry during form filling
- Prevents users from losing form data due to expired sessions

### Centralised Logging (#1)
- Created `/log` endpoint on API to receive frontend logs
- Replaced API console.log calls with @nhcarrigan/logger
- Created ConsoleLoggerService to intercept all console methods on frontend
- Added global error handlers (window.error, unhandledrejection) on frontend
- Added process error handlers (uncaughtException, unhandledRejection, SIGTERM, SIGINT) on API
- All frontend console activity now forwarded to centralised logging

### Error Handling
- Created ToastService and ToastComponent for displaying errors
- Integrated with GlobalErrorHandler and HTTP interceptor
- Added accessibility features (keyboard navigation, ARIA attributes)
- Set toast opacity to 40% for optimal readability

### Testing & Build
- Fixed pre-existing test failure for GET / route (now returns version info)
- Added ESM module mocking (jsdom, marked, dompurify, @nhcarrigan/logger)
- Configured Jest with isolatedModules to handle TypeScript errors
- Excluded test-setup.ts from production build
- All tests passing (123 total)
- Build passing with no errors

## Test Plan

- [x] All tests pass (123 tests)
- [x] Build passes without errors
- [x] Lint passes (only pre-existing warnings)
- [x] Date fields work correctly on all media types
- [x] Retired status displays and filters properly
- [x] Avatar menu opens/closes correctly with keyboard and mouse
- [x] Token refresh prevents session expiry
- [x] Toast notifications appear for errors
- [x] Frontend logs forward to API successfully
- [x] Root route returns version information

Closes #41
Closes #43
Closes #44
Closes #46
Closes #1

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Hikari <hikari@nhcarrigan.com>
Reviewed-on: #50
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit was merged in pull request #50.
This commit is contained in:
2026-02-19 16:52:43 -08:00
committed by Naomi Carrigan
parent 9caf74945a
commit 7579f1ec97
93 changed files with 4297 additions and 645 deletions
+440
View File
@@ -0,0 +1,440 @@
/**
* @copyright NHCarrigan
* @license Naomi's Public License
* @author Naomi Carrigan
*/
import { GameStatus, BookStatus, MangaStatus, MusicStatus, MusicType, ShowStatus, ShowType } from "../src";
import { SuggestionEntity, SuggestionStatus } from "../src/lib/suggestion.types";
import type {
Suggestion,
SuggestionUser,
CreateSuggestionDto,
DeclineSuggestionDto,
CreateGameSuggestionDto,
CreateBookSuggestionDto,
CreateMusicSuggestionDto,
CreateArtSuggestionDto,
CreateShowSuggestionDto,
CreateMangaSuggestionDto,
AcceptWithEditsDto,
} from "../src/lib/suggestion.types";
describe("suggestion Types", () => {
describe("suggestionEntity enum", () => {
it("should have the correct values", () => {
expect(SuggestionEntity.game).toBe("GAME");
expect(SuggestionEntity.book).toBe("BOOK");
expect(SuggestionEntity.music).toBe("MUSIC");
expect(SuggestionEntity.art).toBe("ART");
expect(SuggestionEntity.show).toBe("SHOW");
expect(SuggestionEntity.manga).toBe("MANGA");
});
it("should have all expected enum values", () => {
const values = Object.values(SuggestionEntity);
expect(values).toHaveLength(6);
expect(values).toContain("GAME");
expect(values).toContain("BOOK");
expect(values).toContain("MUSIC");
expect(values).toContain("ART");
expect(values).toContain("SHOW");
expect(values).toContain("MANGA");
});
});
describe("suggestionStatus enum", () => {
it("should have the correct values", () => {
expect(SuggestionStatus.unreviewed).toBe("UNREVIEWED");
expect(SuggestionStatus.accepted).toBe("ACCEPTED");
expect(SuggestionStatus.declined).toBe("DECLINED");
});
it("should have all expected enum values", () => {
const values = Object.values(SuggestionStatus);
expect(values).toHaveLength(3);
expect(values).toContain("UNREVIEWED");
expect(values).toContain("ACCEPTED");
expect(values).toContain("DECLINED");
});
});
describe("suggestionUser interface", () => {
it("should accept valid user object", () => {
const user: SuggestionUser = {
avatar: "https://example.com/avatar.png",
id: "user123",
inDiscord: true,
isMod: false,
isStaff: false,
isVip: false,
username: "suggester",
};
expect(user.inDiscord).toBeTruthy();
expect(user.isVip).toBeFalsy();
});
it("should accept user without avatar", () => {
const user: SuggestionUser = {
id: "user456",
inDiscord: true,
isMod: false,
isStaff: true,
isVip: true,
username: "vipuser",
};
expect(user.avatar).toBeUndefined();
expect(user.isVip).toBeTruthy();
expect(user.isStaff).toBeTruthy();
});
});
describe("suggestion interface", () => {
it("should accept game suggestion", () => {
const gameSuggestion: Suggestion = {
createdAt: new Date("2024-01-15"),
entityType: SuggestionEntity.game,
gameData: {
coverImage: "https://example.com/hades.jpg",
notes: "Amazing roguelike",
platform: "Nintendo Switch",
status: GameStatus.backlog,
title: "Hades",
},
id: "sug123",
status: SuggestionStatus.unreviewed,
title: "Hades",
updatedAt: new Date("2024-01-15"),
user: {
id: "user123",
inDiscord: true,
isMod: false,
isStaff: false,
isVip: false,
username: "gamer",
},
userId: "user123",
};
expect(gameSuggestion.entityType).toBe(SuggestionEntity.game);
expect(gameSuggestion.gameData).toBeDefined();
expect(gameSuggestion.bookData).toBeUndefined();
});
it("should accept book suggestion", () => {
const bookSuggestion: Suggestion = {
bookData: {
author: "George Orwell",
isbn: "978-0-452-28423-4",
notes: "Dystopian classic",
status: BookStatus.toRead,
title: "1984",
},
createdAt: new Date("2024-01-20"),
entityType: SuggestionEntity.book,
id: "sug456",
status: SuggestionStatus.accepted,
title: "1984",
updatedAt: new Date("2024-01-21"),
user: {
id: "user456",
inDiscord: false,
isMod: false,
isStaff: false,
isVip: true,
username: "reader",
},
userId: "user456",
};
expect(bookSuggestion.entityType).toBe(SuggestionEntity.book);
expect(bookSuggestion.bookData).toBeDefined();
expect(bookSuggestion.gameData).toBeUndefined();
});
it("should accept declined suggestion with reason", () => {
const declinedSuggestion: Suggestion = {
createdAt: new Date("2024-02-01"),
declineReason: "Already in the library",
entityType: SuggestionEntity.music,
id: "sug789",
musicData: {
artist: "Pink Floyd",
status: MusicStatus.wantToListen,
title: "Dark Side of the Moon",
type: MusicType.album,
},
status: SuggestionStatus.declined,
title: "Dark Side of the Moon",
updatedAt: new Date("2024-02-02"),
user: {
id: "user789",
inDiscord: true,
isMod: false,
isStaff: false,
isVip: false,
username: "suggester",
},
userId: "user789",
};
expect(declinedSuggestion.status).toBe(SuggestionStatus.declined);
expect(declinedSuggestion.declineReason).toBe("Already in the library");
});
it("should accept art suggestion", () => {
const artSuggestion: Suggestion = {
artData: {
artist: "Jane Doe",
description: "A stunning sunset painting",
imageUrl: "https://example.com/sunset.jpg",
title: "Beautiful Sunset",
},
createdAt: new Date("2024-02-10"),
entityType: SuggestionEntity.art,
id: "sug999",
status: SuggestionStatus.unreviewed,
title: "Beautiful Sunset",
updatedAt: new Date("2024-02-10"),
user: {
id: "user999",
inDiscord: true,
isMod: true,
isStaff: false,
isVip: false,
username: "artlover",
},
userId: "user999",
};
expect(artSuggestion.entityType).toBe(SuggestionEntity.art);
expect(artSuggestion.artData).toBeDefined();
});
it("should accept show and manga suggestions", () => {
const showSuggestion: Suggestion = {
createdAt: new Date("2024-02-15"),
entityType: SuggestionEntity.show,
id: "sug111",
showData: {
status: ShowStatus.wantToWatch,
title: "Breaking Bad",
type: ShowType.tvSeries,
},
status: SuggestionStatus.unreviewed,
title: "Breaking Bad",
updatedAt: new Date("2024-02-15"),
user: {
id: "user111",
inDiscord: false,
isMod: false,
isStaff: true,
isVip: false,
username: "tvfan",
},
userId: "user111",
};
const mangaSuggestion: Suggestion = {
createdAt: new Date("2024-02-20"),
entityType: SuggestionEntity.manga,
id: "sug222",
mangaData: {
author: "Eiichiro Oda",
status: MangaStatus.reading,
title: "One Piece",
},
status: SuggestionStatus.accepted,
title: "One Piece",
updatedAt: new Date("2024-02-21"),
user: {
id: "user222",
inDiscord: true,
isMod: true,
isStaff: true,
isVip: true,
username: "mangareader",
},
userId: "user222",
};
expect(showSuggestion.entityType).toBe(SuggestionEntity.show);
expect(mangaSuggestion.entityType).toBe(SuggestionEntity.manga);
});
});
describe("createSuggestionDto types", () => {
it("should accept game suggestion DTO", () => {
const gameDto: CreateGameSuggestionDto = {
coverImage: "https://example.com/hollow.jpg",
entityType: SuggestionEntity.game,
notes: "Great metroidvania",
platform: "PC",
title: "Hollow Knight",
};
expect(gameDto.entityType).toBe(SuggestionEntity.game);
expect(gameDto.platform).toBe("PC");
});
it("should accept book suggestion DTO", () => {
const bookDto: CreateBookSuggestionDto = {
author: "J.R.R. Tolkien",
coverImage: "https://example.com/hobbit.jpg",
entityType: SuggestionEntity.book,
isbn: "978-0-547-92822-7",
notes: "Fantasy classic",
title: "The Hobbit",
};
expect(bookDto.entityType).toBe(SuggestionEntity.book);
expect(bookDto.author).toBe("J.R.R. Tolkien");
});
it("should accept music suggestion DTO", () => {
const musicDto: CreateMusicSuggestionDto = {
artist: "Pink Floyd",
coverArt: "https://example.com/wall.jpg",
entityType: SuggestionEntity.music,
notes: "Rock opera",
title: "The Wall",
type: "ALBUM",
};
expect(musicDto.entityType).toBe(SuggestionEntity.music);
expect(musicDto.type).toBe("ALBUM");
});
it("should accept art suggestion DTO", () => {
const artDto: CreateArtSuggestionDto = {
artist: "Vincent van Gogh",
description: "Famous painting",
entityType: SuggestionEntity.art,
imageUrl: "https://example.com/starry.jpg",
title: "Starry Night",
};
expect(artDto.entityType).toBe(SuggestionEntity.art);
expect(artDto.imageUrl).toBe("https://example.com/starry.jpg");
});
it("should accept show suggestion DTO", () => {
const showDto: CreateShowSuggestionDto = {
coverImage: "https://example.com/office.jpg",
entityType: SuggestionEntity.show,
notes: "Comedy series",
title: "The Office",
type: "TV_SERIES",
};
expect(showDto.entityType).toBe(SuggestionEntity.show);
expect(showDto.type).toBe("TV_SERIES");
});
it("should accept manga suggestion DTO", () => {
const mangaDto: CreateMangaSuggestionDto = {
author: "Tsugumi Ohba",
coverImage: "https://example.com/deathnote.jpg",
entityType: SuggestionEntity.manga,
notes: "Psychological thriller",
title: "Death Note",
};
expect(mangaDto.entityType).toBe(SuggestionEntity.manga);
expect(mangaDto.author).toBe("Tsugumi Ohba");
});
it("should work with union type", () => {
const suggestions: Array<CreateSuggestionDto> = [
{
entityType: SuggestionEntity.game,
title: "Game Title",
},
{
author: "Author Name",
entityType: SuggestionEntity.book,
title: "Book Title",
},
];
expect(suggestions).toHaveLength(2);
expect(suggestions[0].entityType).toBe(SuggestionEntity.game);
expect(suggestions[1].entityType).toBe(SuggestionEntity.book);
});
});
describe("declineSuggestionDto interface", () => {
it("should accept empty decline DTO", () => {
const declineDto: DeclineSuggestionDto = {};
expect(declineDto.reason).toBeUndefined();
});
it("should accept decline DTO with reason", () => {
const declineDto: DeclineSuggestionDto = {
reason: "Already exists in the library",
};
expect(declineDto.reason).toBe("Already exists in the library");
});
});
describe("acceptWithEditsDto interface", () => {
it("should accept empty edits DTO", () => {
const editsDto: AcceptWithEditsDto = {};
expect(editsDto).toEqual({});
});
it("should accept edits for book fields", () => {
const editsDto: AcceptWithEditsDto = {
author: "Corrected Author",
coverImage: "https://example.com/new-cover.jpg",
isbn: "978-0-123-45678-9",
links: [ { label: "Goodreads", url: "https://goodreads.com" } ],
notes: "Updated notes",
tags: [ "fiction", "classic" ],
title: "Corrected Title",
};
expect(editsDto.title).toBe("Corrected Title");
expect(editsDto.author).toBe("Corrected Author");
expect(editsDto.tags).toHaveLength(2);
});
it("should accept edits for music fields", () => {
const editsDto: AcceptWithEditsDto = {
artist: "Artist Name",
coverArt: "https://example.com/album.jpg",
title: "Album Title",
type: "ALBUM",
};
expect(editsDto.artist).toBe("Artist Name");
expect(editsDto.type).toBe("ALBUM");
expect(editsDto.coverArt).toBe("https://example.com/album.jpg");
});
it("should accept edits for game fields", () => {
const editsDto: AcceptWithEditsDto = {
coverImage: "https://example.com/game.jpg",
notes: "Action RPG",
platform: "PlayStation 5",
title: "Game Title",
};
expect(editsDto.platform).toBe("PlayStation 5");
});
it("should accept edits for art fields", () => {
const editsDto: AcceptWithEditsDto = {
artist: "Artist Name",
description: "Beautiful artwork",
imageUrl: "https://example.com/art.jpg",
title: "Art Title",
};
expect(editsDto.description).toBe("Beautiful artwork");
expect(editsDto.imageUrl).toBe("https://example.com/art.jpg");
});
});
});