versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-07 08:48:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor(federation): 🚚 Change Like path from /objects/{id} to /likes/{id}

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-03-28 22:06:42 +01:00
parent 3d3e64edab
commit d75254fc71
No known key found for this signature in database
18 changed files with 102 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
api/inbox/index.ts
View file

@ -21,6 +21,7 @@ const route = createRoute({
method: "post",
path: "/inbox",
summary: "Instance federation inbox",
tags: ["Federation"],
request: {
headers: schemas.header,
body: {

79
api/likes/:uuid/index.ts Normal file
View file

@ -0,0 +1,79 @@
import { apiRoute } from "@/api";
import { createRoute, z } from "@hono/zod-openapi";
import { Status as StatusSchema } from "@versia/client/schemas";
import { LikeExtension as LikeSchema } from "@versia/federation/schemas";
import { Like, User } from "@versia/kit/db";
import { Likes } from "@versia/kit/tables";
import { and, eq, sql } from "drizzle-orm";
import { ApiError } from "~/classes/errors/api-error";
import { config } from "~/config.ts";
const route = createRoute({
method: "get",
path: "/likes/{id}",
summary: "Retrieve the Versia representation of a like.",
request: {
params: z.object({
id: StatusSchema.shape.id,
}),
},
tags: ["Federation"],
responses: {
200: {
description: "Like",
content: {
"application/json": {
schema: LikeSchema,
},
},
},
404: {
description:
"Entity not found, is remote, or the requester is not allowed to view it.",
content: {
"application/json": {
schema: ApiError.zodSchema,
},
},
},
},
});
export default apiRoute((app) =>
app.openapi(route, async (context) => {
const { id } = context.req.valid("param");
// Don't fetch a like of a note that is not public or unlisted
// prevents leaking the existence of a private note
const like = await Like.fromSql(
and(
eq(Likes.id, id),
sql`EXISTS (SELECT 1 FROM "Notes" WHERE "Notes"."id" = ${Likes.likedId} AND "Notes"."visibility" IN ('public', 'unlisted'))`,
),
);
if (!like) {
throw ApiError.likeNotFound();
}
const liker = await User.fromId(like.data.likerId);
if (!liker || liker.isRemote()) {
throw ApiError.accountNotFound();
}
// If base_url uses https and request uses http, rewrite request to use https
// This fixes reverse proxy errors
const reqUrl = new URL(context.req.url);
if (
config.http.base_url.protocol === "https:" &&
reqUrl.protocol === "http:"
) {
reqUrl.protocol = "https:";
}
const { headers } = await liker.sign(like.toVersia(), reqUrl, "GET");
return context.json(like.toVersia(), 200, headers.toJSON());
}),
);

1
api/messaging/index.ts
View file

@ -8,6 +8,7 @@ const route = createRoute({
path: "/messaging",
summary: "Endpoint for the Instance Messaging Versia Extension.",
description: "https://versia.pub/extensions/instance-messaging.",
tags: ["Federation"],
request: {
body: {
content: {

1
api/notes/:uuid/index.ts
View file

@ -12,6 +12,7 @@ const route = createRoute({
method: "get",
path: "/notes/{id}",
summary: "Retrieve the Versia representation of a note.",
tags: ["Federation"],
request: {
params: z.object({
id: StatusSchema.shape.id,

1
api/notes/:uuid/quotes.ts
View file

@ -13,6 +13,7 @@ const route = createRoute({
method: "get",
path: "/notes/{id}/quotes",
summary: "Retrieve all quotes of a Versia Note.",
tags: ["Federation"],
request: {
params: z.object({
id: StatusSchema.shape.id,

1
api/notes/:uuid/replies.ts
View file

@ -13,6 +13,7 @@ const route = createRoute({
method: "get",
path: "/notes/{id}/replies",
summary: "Retrieve all replies to a Versia Note.",
tags: ["Federation"],
request: {
params: z.object({
id: StatusSchema.shape.id,

110
api/objects/:id/index.ts
View file

@ -1,110 +0,0 @@
import { apiRoute } from "@/api";
import { createRoute, z } from "@hono/zod-openapi";
import {
LikeExtension as LikeSchema,
Note as NoteSchema,
} from "@versia/federation/schemas";
import { Like, Note, User } from "@versia/kit/db";
import { Likes, Notes } from "@versia/kit/tables";
import { and, eq, inArray, sql } from "drizzle-orm";
import { ApiError } from "~/classes/errors/api-error";
import { config } from "~/config.ts";
import type { KnownEntity } from "~/types/api";
const route = createRoute({
method: "get",
path: "/objects/{id}",
summary: "Get object",
request: {
params: z.object({
id: z.string().uuid(),
}),
},
responses: {
200: {
description: "Object",
content: {
"application/json": {
schema: NoteSchema.or(LikeSchema),
},
},
},
404: {
description: "Object not found",
content: {
"application/json": {
schema: ApiError.zodSchema,
},
},
},
403: {
description: "Cannot view objects from remote instances",
content: {
"application/json": {
schema: ApiError.zodSchema,
},
},
},
},
});
export default apiRoute((app) =>
app.openapi(route, async (context) => {
const { id } = context.req.valid("param");
let foundObject: Note | Like | null = null;
let foundAuthor: User | null = null;
let apiObject: KnownEntity | null = null;
foundObject = await Note.fromSql(
and(
eq(Notes.id, id),
inArray(Notes.visibility, ["public", "unlisted"]),
),
);
apiObject = foundObject ? foundObject.toVersia() : null;
foundAuthor = foundObject ? foundObject.author : null;
if (foundObject) {
if (!(await foundObject.isViewableByUser(null))) {
throw new ApiError(404, "Object not found");
}
} else {
foundObject = await Like.fromSql(
and(
eq(Likes.id, id),
sql`EXISTS (SELECT 1 FROM "Notes" WHERE "Notes"."id" = ${Likes.likedId} AND "Notes"."visibility" IN ('public', 'unlisted'))`,
),
);
apiObject = foundObject ? foundObject.toVersia() : null;
foundAuthor = foundObject
? await User.fromId(foundObject.data.likerId)
: null;
}
if (!(foundObject && apiObject)) {
throw new ApiError(404, "Object not found");
}
if (!foundAuthor) {
throw new ApiError(404, "Author not found");
}
if (foundAuthor?.isRemote()) {
throw new ApiError(403, "Object is from a remote instance");
}
// If base_url uses https and request uses http, rewrite request to use https
// This fixes reverse proxy errors
const reqUrl = new URL(context.req.url);
if (
config.http.base_url.protocol === "https:" &&
reqUrl.protocol === "http:"
) {
reqUrl.protocol = "https:";
}
const { headers } = await foundAuthor.sign(apiObject, reqUrl, "GET");
return context.json(apiObject, 200, headers.toJSON());
}),
);

1
api/users/:uuid/inbox/index.ts
View file

@ -25,6 +25,7 @@ const route = createRoute({
method: "post",
path: "/users/{uuid}/inbox",
summary: "Receive federation inbox",
tags: ["Federation"],
request: {
params: schemas.param,
headers: schemas.header,

1
api/users/:uuid/index.ts
View file

@ -17,6 +17,7 @@ const route = createRoute({
request: {
params: schemas.param,
},
tags: ["Federation"],
responses: {
200: {
description: "User data",

1
api/users/:uuid/outbox/index.ts
View file

@ -27,6 +27,7 @@ const route = createRoute({
params: schemas.param,
query: schemas.query,
},
tags: ["Federation"],
responses: {
200: {
description: "User outbox",

1
api/well-known/host-meta/index.ts
View file

@ -6,6 +6,7 @@ const route = createRoute({
method: "get",
path: "/.well-known/host-meta",
summary: "Well-known host-meta",
tags: ["Federation"],
responses: {
200: {
description: "Host-meta",

1
api/well-known/nodeinfo/2.0/index.ts
View file

@ -8,6 +8,7 @@ const route = createRoute({
method: "get",
path: "/.well-known/nodeinfo/2.0",
summary: "Well-known nodeinfo 2.0",
tags: ["Federation"],
responses: {
200: {
description: "Nodeinfo 2.0",

1
api/well-known/nodeinfo/index.ts
View file

@ -6,6 +6,7 @@ const route = createRoute({
method: "get",
path: "/.well-known/nodeinfo",
summary: "Well-known nodeinfo",
tags: ["Federation"],
responses: {
200: {
description: "Nodeinfo links",

1
api/well-known/versia.ts
View file

@ -12,6 +12,7 @@ const route = createRoute({
method: "get",
path: "/.well-known/versia",
summary: "Get instance metadata",
tags: ["Federation"],
responses: {
200: {
description: "Instance metadata",

1
api/well-known/webfinger/index.ts
View file

@ -36,6 +36,7 @@ const route = createRoute({
request: {
query: schemas.query,
},
tags: ["Federation"],
responses: {
200: {
description: "User information",

2
biome.json
View file

@ -103,6 +103,6 @@
"globals": ["Bun", "HTMLRewriter", "BufferEncoding"]
},
"files": {
"ignore": ["node_modules", "dist", "cache"]
"ignore": ["node_modules", "dist", "cache", "build"]
}
}

2
classes/database/like.ts
View file

@ -146,7 +146,7 @@ export class Like extends BaseInterface<typeof Likes, LikeType> {
}
public getUri(): URL {
return new URL(`/objects/${this.data.id}`, config.http.base_url);
return new URL(`/likes/${this.data.id}`, config.http.base_url);
}
public toVersia(): LikeExtension {

8
classes/errors/api-error.ts
View file

@ -100,6 +100,14 @@ export class ApiError extends Error {
);
}
public static likeNotFound(): ApiError {
return new ApiError(
404,
"Like not found",
"The requested like could not be found.",
);
}
public static pushSubscriptionNotFound(): ApiError {
return new ApiError(
404,