Files
gerbeur/api/services/comment-like-service.ts
khannurien d62e4a9883
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 47s
Build and deploy docs / build-and-push (push) Successful in 26s
v3: the backend is documented for deno doc, one way in every file, and the docs build and publish themselves — comments were in three shapes: file headers as // lines, as an untagged /** */ (which deno doc drops, only an @module block counts) or missing; 43 exports described by a // deno doc can't see, two JSDoc blocks sitting on the wrong declaration and one duplicated; endpoints commented in 5 of 18 route files, three ways, on router.get() calls no doc tool reads. The rule, applied to every non-test module of api/, migrations included: each opens with a /** … @module */ block; every export has JSDoc, and so does every field of an exported interface; a comment describing a declaration is /** */, // only notes code; functions open with a verb, everything else with a noun phrase; parameters are named in the prose, {@link} only for symbols in scope; whatever throws to its caller says so with @throws (for an APIException, the statuses and when); a router's JSDoc lists its endpoints, method and path, who may call it, what it does. deno doc --lint goes from 528 errors to none in api/ (shared/ keeps its 385; it is next). The lint also wanted explicit types on config.ts's settings and a few return types, JsonLdResult exported, and the routers typed Router. deno task doc builds the HTML reference into docs/ from every module of api/ and shared/ but the tests, deno task doc:lint lints it; the index page is the module doc of a root mod.ts (deno.json's exports), which introduces the backend, shared/ and the frontend to come and links every module, and mod.test.ts fails when one is missing. The docs workflow builds it on every push to main that touches them and publishes it to the gh-pages branch, like publish-assistant's. Two defects found along the way are fixed: a private playlist's cover was served to anyone who had its id or slug, and now needs its owner's media token, as private dump files do (playlistImageUrl adds it for private playlists only, so public cover URLs stay the same for everyone); og.ts and static.ts each filled index.html's placeholders, and now share lib/index-html.ts, so the OG middleware picks up a rebuilt index.html instead of keeping the first it read. The README states the documentation rule. 205 backend and 628 frontend tests pass.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 21:07:40 +00:00

158 lines
5.0 KiB
TypeScript

/**
* Likes on comments.
*
* @module
*/
import { APIErrorCode } from "../../shared/api.ts";
import { APIException } from "../lib/api-exception.ts";
import { isUserRow, type User, userRowToApi } from "../model/user.ts";
import { db } from "../db/connection.ts";
import { type Page, pageOf } from "../lib/pagination.ts";
import { notifyCommentOwnerLike } from "./notification-service.ts";
/** A comment's likes after a like was cast or removed. */
export interface LikeResult {
/** The comment's like count now. */
likeCount: number;
/** Whether the comment's dump is private: its likes go to the dump's owner only. */
isPrivate: boolean;
}
/**
* Returns whether the comment's dump is private, or throws a 404 when the user
* can't see it.
*/
function commentVisibility(commentId: string, userId: string): boolean {
const row = db.prepare(
`SELECT d.is_private, d.user_id FROM comments c JOIN dumps d ON d.id = c.dump_id
WHERE c.id = ?;`,
).get(commentId) as { is_private: number; user_id: string } | undefined;
if (!row || (row.is_private && row.user_id !== userId)) {
throw new APIException(APIErrorCode.NOT_FOUND, 404, "Comment not found");
}
return Boolean(row.is_private);
}
/**
* Records `userId`'s like on a comment and notifies its author.
*
* @throws {APIException} 404 when the comment doesn't exist or sits on someone
* else's private dump, 409 when the user already likes it.
*/
export function castCommentLike(
commentId: string,
userId: string,
): LikeResult {
const isPrivate = commentVisibility(commentId, userId);
let likeCount: number;
try {
db.exec("BEGIN;");
db.prepare(
`INSERT INTO comment_likes (comment_id, user_id, created_at) VALUES (?, ?, ?);`,
).run(commentId, userId, new Date().toISOString());
db.prepare(
`UPDATE comments SET like_count = like_count + 1 WHERE id = ?;`,
).run(commentId);
const row = db.prepare(
`SELECT like_count FROM comments WHERE id = ?;`,
).get(commentId) as { like_count: number } | undefined;
db.exec("COMMIT;");
likeCount = row?.like_count ?? 0;
} catch (err) {
try {
db.exec("ROLLBACK;");
} catch { /* ignore if no active transaction */ }
if (err instanceof Error && err.message.includes("UNIQUE constraint")) {
throw new APIException(
APIErrorCode.VALIDATION_ERROR,
409,
"Already liked",
);
}
throw err;
}
// Notification is best-effort — must not prevent like_ack from being sent
try {
notifyCommentOwnerLike(userId, commentId);
} catch { /* ignore */ }
return { likeCount, isPrivate };
}
/**
* Takes back `userId`'s like on a comment. No visibility check: taking back a
* like is harmless, and it's the user's own row.
*
* @throws {APIException} 404 when the user doesn't like the comment.
*/
export function removeCommentLike(
commentId: string,
userId: string,
): LikeResult {
const dumpRow = db.prepare(
`SELECT d.is_private FROM comments c JOIN dumps d ON d.id = c.dump_id
WHERE c.id = ?;`,
).get(commentId) as { is_private: number } | undefined;
const isPrivate = Boolean(dumpRow?.is_private);
try {
db.exec("BEGIN;");
const result = db.prepare(
`DELETE FROM comment_likes WHERE comment_id = ? AND user_id = ?;`,
).run(commentId, userId);
if (result.changes === 0) {
db.exec("ROLLBACK;");
throw new APIException(APIErrorCode.NOT_FOUND, 404, "Like not found");
}
db.prepare(
`UPDATE comments SET like_count = like_count - 1 WHERE id = ?;`,
).run(commentId);
const row = db.prepare(
`SELECT like_count FROM comments WHERE id = ?;`,
).get(commentId) as { like_count: number } | undefined;
db.exec("COMMIT;");
return { likeCount: row?.like_count ?? 0, isPrivate };
} catch (err) {
if (err instanceof APIException) throw err;
db.exec("ROLLBACK;");
throw err;
}
}
/** Returns the ids of every comment `userId` likes. */
export function getUserCommentLikes(userId: string): string[] {
const rows = db.prepare(
`SELECT comment_id FROM comment_likes WHERE user_id = ?;`,
).all(userId) as { comment_id: string }[];
return rows.map((r) => r.comment_id);
}
/** Returns a page of the users who like a comment, latest first. */
export function getCommentLikers(
commentId: string,
page: number,
limit: number,
): Page<User> {
const offset = (page - 1) * limit;
const rawRows = db.prepare(
`SELECT u.id, u.username, u.password_hash, u.role, u.created_at, u.updated_at,
u.avatar_mime, u.description, u.invited_by, u.email,
i.username as invited_by_username
FROM users u
LEFT JOIN users i ON i.id = u.invited_by
INNER JOIN comment_likes cl ON cl.comment_id = ? AND cl.user_id = u.id
ORDER BY cl.created_at DESC
LIMIT ? OFFSET ?;`,
).all(commentId, limit + 1, offset);
if (!rawRows.every(isUserRow)) {
throw new APIException(
APIErrorCode.SERVER_ERROR,
500,
"Malformed user data",
);
}
return pageOf(rawRows.map(userRowToApi), limit);
}