Skip to content

Fix sourceData and add ?user parameter to /api/booth/history #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goto-bus-stop merged 2 commits into from
Jan 12, 2026
Merged

Fix sourceData and add ?user parameter to /api/booth/history #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19f81e2
Add ?user parameter to `/api/booth/history`
goto-bus-stop Jan 12, 2026
9a5cfd2
Fix `sourceData` property in history results
goto-bus-stop Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/controllers/booth.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,8 +356,8 @@ async function favorite(req) {
}

/**
* @typedef {object} GetRoomHistoryQuery
* @prop {import('../types.js').PaginationQuery & { media?: MediaID }} [filter]
* @typedef {import('../types.js').PaginationQuery & { media?: MediaID, user?: UserID }}
* GetRoomHistoryQuery
*/
/**
* @type {import('../types.js').Controller<never, GetRoomHistoryQuery, never>}
Expand All @@ -370,13 +370,16 @@ async function getHistory(req) {
});
const { history } = req.uwave;

if (req.query.filter && req.query.filter.media) {
filter['media.media'] = req.query.filter.media;
// XXX: This is not actually supported by `history.getHistory()` yet
if (req.query.media) {
filter.media = req.query.media;
}

// TODO: Support filter?
if (req.query.user) {
filter.user = req.query.user;
}

const roomHistory = await history.getRoomHistory(pagination);
const roomHistory = await history.getHistory(pagination, filter);

return toPaginatedResponse(roomHistory, {
baseUrl: req.fullUrl,
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/history.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function historyEntryFromRow(row) {
_id: row['media.id'],
sourceType: row['media.sourceType'],
sourceID: row['media.sourceID'],
sourceData: row['media.sourceData'],
sourceData: fromJson(row['media.sourceData']),
artist: row['media.artist'],
title: row['media.title'],
thumbnail: row['media.thumbnail'],
Expand Down
12 changes: 7 additions & 5 deletions src/validations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,13 @@ export const getRoomHistory = /** @type {const} */ ({
{
type: 'object',
properties: {
filter: {
type: 'object',
properties: {
media: { $ref: 'https://ns.u-wave.net/schemas/definitions.json#/definitions/UUID' },
},
media: {
description: 'Only return plays of the given media ID.',
$ref: 'https://ns.u-wave.net/schemas/definitions.json#/definitions/UUID',
},
user: {
description: 'Only return history entries played by the given user.',
$ref: 'https://ns.u-wave.net/schemas/definitions.json#/definitions/UUID',
},
},
},
Expand Down