feat(api): Make Reactions API correctly output whether a reaction is remote

This commit is contained in:
Jesse Wierzbinski 2025-05-28 17:07:24 +02:00
parent e0adaca2a2
commit fa1dd69e2d
No known key found for this signature in database
5 changed files with 139 additions and 3 deletions

View file

@ -106,6 +106,7 @@ describe("/api/v1/statuses/:id/reactions/:name", () => {
name: "❤️", name: "❤️",
count: 1, count: 1,
me: false, me: false,
remote: false,
}), }),
); );
expect(data.reactions).toContainEqual( expect(data.reactions).toContainEqual(
@ -113,6 +114,7 @@ describe("/api/v1/statuses/:id/reactions/:name", () => {
name: "😂", name: "😂",
count: 1, count: 1,
me: true, me: true,
remote: false,
}), }),
); );
}); });
@ -133,6 +135,7 @@ describe("/api/v1/statuses/:id/reactions/:name", () => {
name: "👍", name: "👍",
count: 1, count: 1,
me: true, me: true,
remote: false,
}); });
}); });

View file

@ -39,6 +39,7 @@ describe("/api/v1/statuses/:id/reactions", () => {
count: 1, count: 1,
me: true, me: true,
account_ids: [users[1].id], account_ids: [users[1].id],
remote: false,
}); });
// Check for ❤️ reaction // Check for ❤️ reaction
@ -48,6 +49,7 @@ describe("/api/v1/statuses/:id/reactions", () => {
count: 1, count: 1,
me: false, me: false,
account_ids: [users[2].id], account_ids: [users[2].id],
remote: false,
}); });
// Check for 😂 reaction // Check for 😂 reaction
@ -57,6 +59,7 @@ describe("/api/v1/statuses/:id/reactions", () => {
count: 1, count: 1,
me: true, me: true,
account_ids: [users[1].id], account_ids: [users[1].id],
remote: false,
}); });
}); });
@ -71,6 +74,7 @@ describe("/api/v1/statuses/:id/reactions", () => {
// All reactions should have me: false when not authenticated // All reactions should have me: false when not authenticated
for (const reaction of data) { for (const reaction of data) {
expect(reaction.me).toBe(false); expect(reaction.me).toBe(false);
expect(reaction.remote).toBe(false);
} }
}); });
}); });

View file

@ -6,7 +6,7 @@ import {
enableRealRequests, enableRealRequests,
mock, mock,
} from "bun-bagel"; } from "bun-bagel";
import { and, eq } from "drizzle-orm"; import { and, eq, isNull } from "drizzle-orm";
import { Instance } from "~/classes/database/instance"; import { Instance } from "~/classes/database/instance";
import { Note } from "~/classes/database/note"; import { Note } from "~/classes/database/note";
import { Reaction } from "~/classes/database/reaction"; import { Reaction } from "~/classes/database/reaction";
@ -15,13 +15,14 @@ import { config } from "~/config";
import { Notes, Reactions, Users } from "~/drizzle/schema"; import { Notes, Reactions, Users } from "~/drizzle/schema";
import { sign } from "~/packages/sdk/crypto"; import { sign } from "~/packages/sdk/crypto";
import * as VersiaEntities from "~/packages/sdk/entities"; import * as VersiaEntities from "~/packages/sdk/entities";
import { fakeRequest } from "~/tests/utils"; import { fakeRequest, generateClient, getTestUsers } from "~/tests/utils";
const instanceUrl = new URL("https://versia.example.com"); const instanceUrl = new URL("https://versia.example.com");
const noteId = randomUUIDv7(); const noteId = randomUUIDv7();
const userId = randomUUIDv7(); const userId = randomUUIDv7();
const shareId = randomUUIDv7(); const shareId = randomUUIDv7();
const reactionId = randomUUIDv7(); const reactionId = randomUUIDv7();
const reaction2Id = randomUUIDv7();
const userKeys = await User.generateKeys(); const userKeys = await User.generateKeys();
const privateKey = await crypto.subtle.importKey( const privateKey = await crypto.subtle.importKey(
"pkcs8", "pkcs8",
@ -32,6 +33,7 @@ const privateKey = await crypto.subtle.importKey(
); );
const instanceKeys = await User.generateKeys(); const instanceKeys = await User.generateKeys();
const inboxUrl = new URL("/inbox", config.http.base_url); const inboxUrl = new URL("/inbox", config.http.base_url);
const { users, deleteUsers } = await getTestUsers(1);
disableRealRequests(); disableRealRequests();
@ -101,6 +103,7 @@ afterAll(async () => {
} }
await instance.delete(); await instance.delete();
await deleteUsers();
clearMocks(); clearMocks();
enableRealRequests(); enableRealRequests();
}); });
@ -286,6 +289,122 @@ describe("Inbox Tests", () => {
); );
expect(reaction).not.toBeNull(); expect(reaction).not.toBeNull();
// Check if API returns the reaction correctly
await using client = await generateClient(users[1]);
const { data, ok } = await client.getStatusReactions(dbNote.id);
expect(ok).toBe(true);
expect(data).toContainEqual(
expect.objectContaining({
name: "👍",
count: 1,
me: false,
remote: false,
}),
);
});
test("should correctly process Reaction with custom emoji", async () => {
const exampleRequest = new VersiaEntities.Reaction({
id: reaction2Id,
created_at: "2025-04-18T10:32:01.427Z",
uri: new URL(`/reactions/${reaction2Id}`, instanceUrl).href,
type: "pub.versia:reactions/Reaction",
author: new URL(`/users/${userId}`, instanceUrl).href,
object: new URL(`/notes/${noteId}`, instanceUrl).href,
content: ":neocat:",
extensions: {
"pub.versia:custom_emojis": {
emojis: [
{
name: ":neocat:",
url: {
"image/webp": {
hash: {
sha256: "e06240155d2cb90e8dc05327d023585ab9d47216ff547ad72aaf75c485fe9649",
},
size: 4664,
width: 256,
height: 256,
remote: true,
content:
"https://cdn.cpluspatch.com/versia-cpp/e06240155d2cb90e8dc05327d023585ab9d47216ff547ad72aaf75c485fe9649/neocat.webp",
},
},
},
],
},
},
});
const signedRequest = await sign(
privateKey,
new URL(exampleRequest.data.author),
new Request(inboxUrl, {
method: "POST",
headers: {
"Content-Type": "application/json",
Accept: "application/json",
"User-Agent": "Versia/1.0.0",
},
body: JSON.stringify(exampleRequest.toJSON()),
}),
);
const response = await fakeRequest(inboxUrl, {
method: "POST",
headers: signedRequest.headers,
body: signedRequest.body,
});
expect(response.status).toBe(200);
await sleep(500);
const dbNote = await Note.fromSql(
eq(Notes.uri, new URL(`/notes/${noteId}`, instanceUrl).href),
);
if (!dbNote) {
throw new Error("DBNote not found");
}
// Find the remote user who reacted by URI
const remoteUser = await User.fromSql(
eq(Users.uri, new URL(`/users/${userId}`, instanceUrl).href),
);
if (!remoteUser) {
throw new Error("Remote user not found");
}
// Check if reaction was created in the database
const reaction = await Reaction.fromSql(
and(
eq(Reactions.noteId, dbNote.id),
eq(Reactions.authorId, remoteUser.id),
isNull(Reactions.emojiText), // Custom emoji reactions have emojiText as NULL
),
);
expect(reaction).not.toBeNull();
// Check if API returns the reaction correctly
await using client = await generateClient(users[1]);
const { data, ok } = await client.getStatusReactions(dbNote.id);
expect(ok).toBe(true);
expect(data).toContainEqual(
expect.objectContaining({
name: ":neocat@versia.example.com:",
count: 1,
me: false,
remote: true,
}),
);
}); });
test("should correctly process Delete", async () => { test("should correctly process Delete", async () => {

View file

@ -948,6 +948,7 @@ export class Note extends BaseInterface<typeof Notes, NoteTypeWithRelations> {
{ {
count: number; count: number;
me: boolean; me: boolean;
instance: typeof Instance.$type | null;
account_ids: string[]; account_ids: string[];
} }
>(); >();
@ -958,8 +959,10 @@ export class Note extends BaseInterface<typeof Notes, NoteTypeWithRelations> {
// Determine emoji name based on type // Determine emoji name based on type
if (reaction.emojiText) { if (reaction.emojiText) {
emojiName = reaction.emojiText; emojiName = reaction.emojiText;
} else if (reaction.emoji) { } else if (reaction.emoji?.instance === null) {
emojiName = `:${reaction.emoji.shortcode}:`; emojiName = `:${reaction.emoji.shortcode}:`;
} else if (reaction.emoji?.instance) {
emojiName = `:${reaction.emoji.shortcode}@${reaction.emoji.instance.baseUrl}:`;
} else { } else {
continue; // Skip invalid reactions continue; // Skip invalid reactions
} }
@ -970,6 +973,7 @@ export class Note extends BaseInterface<typeof Notes, NoteTypeWithRelations> {
count: 0, count: 0,
me: false, me: false,
account_ids: [], account_ids: [],
instance: reaction.emoji?.instance ?? null,
}); });
} }
@ -994,6 +998,7 @@ export class Note extends BaseInterface<typeof Notes, NoteTypeWithRelations> {
count: data.count, count: data.count,
me: data.me, me: data.me,
account_ids: data.account_ids, account_ids: data.account_ids,
remote: data.instance !== null,
})); }));
} }
} }

View file

@ -62,6 +62,11 @@ export const NoteReaction = z
description: "Number of users who reacted with this emoji.", description: "Number of users who reacted with this emoji.",
example: 5, example: 5,
}), }),
remote: z.boolean().openapi({
description:
"Whether this reaction is from a remote instance (federated).",
example: false,
}),
me: z.boolean().optional().openapi({ me: z.boolean().optional().openapi({
description: description:
"Whether the current authenticated user reacted with this emoji.", "Whether the current authenticated user reacted with this emoji.",