Reorganize api endpoints (fixes LemmyNet#2022) (LemmyNet#5216)

* Reorganize api endpoints (fixes LemmyNet#2022) * scopes * move message rate limit * move rate limit * apply suggestions * move my_user to separate endpoint * remove taglines and custom emojis from siteview * routes for api v3 and v4 * remove new features from api v3 * js client * replace occurences of `v3`, fix routes * replace getSite().my_user with getMyUser() * update * update config * remove web:: * update * prettier * lockfile * v * fix settings * move block endpoints * more changes * fmt * update * change some routes * lockfile * Add comment about deprecation
dockur · Dec 7, 2024 · 5e7b30a · 5e7b30a
1 parent adadb45
commit 5e7b30a
Show file tree

Hide file tree

Showing 29 changed files with 558 additions and 216 deletions.
diff --git a/api_tests/package.json b/api_tests/package.json
@@ -28,7 +28,7 @@
     "eslint": "^9.14.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.5.0",
-    "lemmy-js-client": "0.20.0-instance-blocks.5",
+    "lemmy-js-client": "0.20.0-api-v4.16",
     "prettier": "^3.2.5",
     "ts-jest": "^29.1.0",
     "typescript": "^5.5.4",

diff --git a/api_tests/pnpm-lock.yaml b/api_tests/pnpm-lock.yaml
diff --git a/api_tests/prepare-drone-federation-test.sh b/api_tests/prepare-drone-federation-test.sh
@@ -82,13 +82,13 @@ LEMMY_CONFIG_LOCATION=./docker/federation/lemmy_epsilon.hjson \
   target/lemmy_server >$LOG_DIR/lemmy_epsilon.out 2>&1 &
 
 echo "wait for all instances to start"
-while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-alpha:8541/api/v3/site')" != "200" ]]; do sleep 1; done
+while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-alpha:8541/api/v4/site')" != "200" ]]; do sleep 1; done
 echo "alpha started"
-while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-beta:8551/api/v3/site')" != "200" ]]; do sleep 1; done
+while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-beta:8551/api/v4/site')" != "200" ]]; do sleep 1; done
 echo "beta started"
-while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-gamma:8561/api/v3/site')" != "200" ]]; do sleep 1; done
+while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-gamma:8561/api/v4/site')" != "200" ]]; do sleep 1; done
 echo "gamma started"
-while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-delta:8571/api/v3/site')" != "200" ]]; do sleep 1; done
+while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-delta:8571/api/v4/site')" != "200" ]]; do sleep 1; done
 echo "delta started"
-while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-epsilon:8581/api/v3/site')" != "200" ]]; do sleep 1; done
+while [[ "$(curl -s -o /dev/null -w '%{http_code}' 'lemmy-epsilon:8581/api/v4/site')" != "200" ]]; do sleep 1; done
 echo "epsilon started. All started"
diff --git a/api_tests/src/comment.spec.ts b/api_tests/src/comment.spec.ts
@@ -699,10 +699,10 @@ test("Check that activity from another instance is sent to third instance", asyn
 
 test("Fetch in_reply_tos: A is unsubbed from B, B makes a post, and some embedded comments, A subs to B, B updates the lowest level comment, A fetches both the post and all the inreplyto comments for that post.", async () => {
   // Unfollow all remote communities
-  let site = await unfollowRemotes(alpha);
-  expect(
-    site.my_user?.follows.filter(c => c.community.local == false).length,
-  ).toBe(0);
+  let my_user = await unfollowRemotes(alpha);
+  expect(my_user.follows.filter(c => c.community.local == false).length).toBe(
+    0,
+  );
 
   // B creates a post, and two comments, should be invisible to A
   let postOnBetaRes = await createPost(beta, 2);

diff --git a/api_tests/src/community.spec.ts b/api_tests/src/community.spec.ts
@@ -32,6 +32,7 @@ import {
   longDelay,
   editCommunity,
   unfollows,
+  getMyUser,
   userBlockInstance,
 } from "./shared";
 import { AdminAllowInstanceParams } from "lemmy-js-client/dist/types/AdminAllowInstanceParams";
@@ -226,7 +227,7 @@ test("Admin actions in remote community are not federated to origin", async () =
   if (!betaCommunity) {
     throw "Missing beta community";
   }
-  let bannedUserInfo1 = (await getSite(gamma)).my_user?.local_user_view.person;
+  let bannedUserInfo1 = (await getMyUser(gamma)).local_user_view.person;
   if (!bannedUserInfo1) {
     throw "Missing banned user 1";
   }

diff --git a/api_tests/src/follow.spec.ts b/api_tests/src/follow.spec.ts
@@ -12,6 +12,7 @@ import {
   registerUser,
   unfollows,
   delay,
+  getMyUser,
 } from "./shared";
 
 beforeAll(setupLogins);
@@ -85,8 +86,8 @@ test("Follow federated community", async () => {
   );
 
   // Check it from local
-  let site = await getSite(alpha);
-  let remoteCommunityId = site.my_user?.follows.find(
+  let my_user = await getMyUser(alpha);
+  let remoteCommunityId = my_user?.follows.find(
     c =>
       c.community.local == false &&
       c.community.id === betaCommunityInitial.community.id,
@@ -102,9 +103,9 @@ test("Follow federated community", async () => {
   expect(unfollow.community_view.subscribed).toBe("NotSubscribed");
 
   // Make sure you are unsubbed locally
-  let siteUnfollowCheck = await getSite(alpha);
+  let siteUnfollowCheck = await getMyUser(alpha);
   expect(
-    siteUnfollowCheck.my_user?.follows.find(
+    siteUnfollowCheck.follows.find(
       c => c.community.id === betaCommunityInitial.community.id,
     ),
   ).toBe(undefined);

diff --git a/api_tests/src/image.spec.ts b/api_tests/src/image.spec.ts
@@ -32,6 +32,7 @@ import {
   createPostWithThumbnail,
   sampleImage,
   sampleSite,
+  getMyUser,
 } from "./shared";
 
 beforeAll(setupLogins);
@@ -129,9 +130,9 @@ test("Purge user, uploaded image removed", async () => {
   expect(content.length).toBeGreaterThan(0);
 
   // purge user
-  let site = await getSite(user);
+  let my_user = await getMyUser(user);
   const purgeForm: PurgePerson = {
-    person_id: site.my_user!.local_user_view.person.id,
+    person_id: my_user.local_user_view.person.id,
   };
   const delete_ = await alphaImage.purgePerson(purgeForm);
   expect(delete_.success).toBe(true);
@@ -199,11 +200,11 @@ test("Images in remote image post are proxied if setting enabled", async () => {
   // remote image gets proxied after upload
   expect(
     post.thumbnail_url?.startsWith(
-      "http://lemmy-gamma:8561/api/v3/image_proxy?url",
+      "http://lemmy-gamma:8561/api/v4/image_proxy?url",
     ),
   ).toBeTruthy();
   expect(
-    post.body?.startsWith("![](http://lemmy-gamma:8561/api/v3/image_proxy?url"),
+    post.body?.startsWith("![](http://lemmy-gamma:8561/api/v4/image_proxy?url"),
   ).toBeTruthy();
 
   // Make sure that it ends with jpg, to be sure its an image
@@ -222,12 +223,12 @@ test("Images in remote image post are proxied if setting enabled", async () => {
 
   expect(
     epsilonPost.thumbnail_url?.startsWith(
-      "http://lemmy-epsilon:8581/api/v3/image_proxy?url",
+      "http://lemmy-epsilon:8581/api/v4/image_proxy?url",
     ),
   ).toBeTruthy();
   expect(
     epsilonPost.body?.startsWith(
-      "![](http://lemmy-epsilon:8581/api/v3/image_proxy?url",
+      "![](http://lemmy-epsilon:8581/api/v4/image_proxy?url",
     ),
   ).toBeTruthy();
 
@@ -249,7 +250,7 @@ test("Thumbnail of remote image link is proxied if setting enabled", async () =>
   // remote image gets proxied after upload
   expect(
     post.thumbnail_url?.startsWith(
-      "http://lemmy-gamma:8561/api/v3/image_proxy?url",
+      "http://lemmy-gamma:8561/api/v4/image_proxy?url",
     ),
   ).toBeTruthy();
 
@@ -267,7 +268,7 @@ test("Thumbnail of remote image link is proxied if setting enabled", async () =>
 
   expect(
     epsilonPost.thumbnail_url?.startsWith(
-      "http://lemmy-epsilon:8581/api/v3/image_proxy?url",
+      "http://lemmy-epsilon:8581/api/v4/image_proxy?url",
     ),
   ).toBeTruthy();
 

diff --git a/api_tests/src/post.spec.ts b/api_tests/src/post.spec.ts
@@ -38,6 +38,7 @@ import {
   alphaUrl,
   loginUser,
   createCommunity,
+  getMyUser,
 } from "./shared";
 import { PostView } from "lemmy-js-client/dist/types/PostView";
 import { AdminBlockInstanceParams } from "lemmy-js-client/dist/types/AdminBlockInstanceParams";
@@ -451,8 +452,7 @@ test("Enforce site ban federation for local user", async () => {
 
   // create a test user
   let alphaUserHttp = await registerUser(alpha, alphaUrl);
-  let alphaUserPerson = (await getSite(alphaUserHttp)).my_user?.local_user_view
-    .person;
+  let alphaUserPerson = (await getMyUser(alphaUserHttp)).local_user_view.person;
   let alphaUserActorId = alphaUserPerson?.actor_id;
   if (!alphaUserActorId) {
     throw "Missing alpha user actor id";
@@ -532,8 +532,7 @@ test("Enforce site ban federation for federated user", async () => {
 
   // create a test user
   let alphaUserHttp = await registerUser(alpha, alphaUrl);
-  let alphaUserPerson = (await getSite(alphaUserHttp)).my_user?.local_user_view
-    .person;
+  let alphaUserPerson = (await getMyUser(alphaUserHttp)).local_user_view.person;
   let alphaUserActorId = alphaUserPerson?.actor_id;
   if (!alphaUserActorId) {
     throw "Missing alpha user actor id";
@@ -563,8 +562,7 @@ test("Enforce site ban federation for federated user", async () => {
   expect(banAlphaOnBeta.banned).toBe(true);
 
   // The beta site ban should NOT be federated to alpha
-  let alphaPerson2 = (await getSite(alphaUserHttp)).my_user!.local_user_view
-    .person;
+  let alphaPerson2 = (await getMyUser(alphaUserHttp)).local_user_view.person;
   expect(alphaPerson2.banned).toBe(false);
 
   // existing alpha post should be removed on beta

diff --git a/api_tests/src/shared.ts b/api_tests/src/shared.ts
@@ -16,6 +16,7 @@ import {
   LemmyHttp,
   ListCommunityPendingFollows,
   ListCommunityPendingFollowsResponse,
+  MyUserInfo,
   PersonId,
   PostView,
   PrivateMessageReportResponse,
@@ -761,6 +762,10 @@ export async function getSite(api: LemmyHttp): Promise<GetSiteResponse> {
   return api.getSite();
 }
 
+export async function getMyUser(api: LemmyHttp): Promise<MyUserInfo> {
+  return api.getMyUser();
+}
+
 export async function listPrivateMessages(
   api: LemmyHttp,
 ): Promise<PrivateMessagesResponse> {
@@ -770,19 +775,16 @@ export async function listPrivateMessages(
   return api.getPrivateMessages(form);
 }
 
-export async function unfollowRemotes(
-  api: LemmyHttp,
-): Promise<GetSiteResponse> {
+export async function unfollowRemotes(api: LemmyHttp): Promise<MyUserInfo> {
   // Unfollow all remote communities
-  let site = await getSite(api);
+  let my_user = await getMyUser(api);
   let remoteFollowed =
-    site.my_user?.follows.filter(c => c.community.local == false) ?? [];
+    my_user.follows.filter(c => c.community.local == false) ?? [];
   await Promise.all(
     remoteFollowed.map(cu => followCommunity(api, false, cu.community.id)),
   );
 
-  let siteRes = await getSite(api);
-  return siteRes;
+  return await getMyUser(api);
 }
 
 export async function followBeta(api: LemmyHttp): Promise<CommunityResponse> {

diff --git a/api_tests/src/user.spec.ts b/api_tests/src/user.spec.ts
@@ -22,6 +22,7 @@ import {
   alphaImage,
   unfollows,
   saveUserSettingsBio,
+  getMyUser,
   getPersonDetails,
 } from "./shared";
 import {
@@ -50,12 +51,9 @@ function assertUserFederation(userOne?: PersonView, userTwo?: PersonView) {
 test("Create user", async () => {
   let user = await registerUser(alpha, alphaUrl);
 
-  let site = await getSite(user);
-  expect(site.my_user).toBeDefined();
-  if (!site.my_user) {
-    throw "Missing site user";
-  }
-  apShortname = `${site.my_user.local_user_view.person.name}@lemmy-alpha:8541`;
+  let my_user = await getMyUser(user);
+  expect(my_user).toBeDefined();
+  apShortname = `${my_user.local_user_view.person.name}@lemmy-alpha:8541`;
 });
 
 test("Set some user settings, check that they are federated", async () => {
@@ -70,8 +68,8 @@ test("Set some user settings, check that they are federated", async () => {
   };
   await saveUserSettings(beta, form);
 
-  let site = await getSite(beta);
-  expect(site.my_user?.local_user_view.local_user.theme).toBe("test");
+  let my_user = await getMyUser(beta);
+  expect(my_user.local_user_view.local_user.theme).toBe("test");
 });
 
 test("Delete user", async () => {
@@ -127,8 +125,10 @@ test("Requests with invalid auth should be treated as unauthenticated", async ()
     headers: { Authorization: "Bearer foobar" },
     fetchFunction,
   });
+  await expect(getMyUser(invalid_auth)).rejects.toStrictEqual(
+    Error("incorrect_login"),
+  );
   let site = await getSite(invalid_auth);
-  expect(site.my_user).toBeUndefined();
   expect(site.site_view).toBeDefined();
 
   let form: GetPosts = {};
@@ -141,12 +141,9 @@ test("Create user with Arabic name", async () => {
   const name = "تجريب" + Math.random().toString().slice(2, 10);
   let user = await registerUser(alpha, alphaUrl, name);
 
-  let site = await getSite(user);
-  expect(site.my_user).toBeDefined();
-  if (!site.my_user) {
-    throw "Missing site user";
-  }
-  apShortname = `${site.my_user.local_user_view.person.name}@lemmy-alpha:8541`;
+  let my_user = await getMyUser(user);
+  expect(my_user).toBeDefined();
+  apShortname = `${my_user.local_user_view.person.name}@lemmy-alpha:8541`;
 
   let betaPerson1 = (await resolvePerson(beta, apShortname)).person;
   expect(betaPerson1!.person.name).toBe(name);
@@ -167,13 +164,12 @@ test("Create user with accept-language", async () => {
   });
   let user = await registerUser(lemmy_http, alphaUrl);
 
+  let my_user = await getMyUser(user);
+  expect(my_user).toBeDefined();
+  expect(my_user?.local_user_view.local_user.interface_language).toBe("fr");
   let site = await getSite(user);
-  expect(site.my_user).toBeDefined();
-  expect(site.my_user?.local_user_view.local_user.interface_language).toBe(
-    "fr",
-  );
   let langs = site.all_languages
-    .filter(a => site.my_user?.discussion_languages.includes(a.id))
+    .filter(a => my_user.discussion_languages.includes(a.id))
     .map(l => l.code);
   // should have languages from accept header, as well as "undetermined"
   // which is automatically enabled by backend
@@ -219,8 +215,8 @@ test("Set a new avatar, old avatar is deleted", async () => {
   // Now try to save a user settings, with the icon missing,
   // and make sure it doesn't clear the data, or delete the image
   await saveUserSettingsBio(alpha);
-  let site = await getSite(alpha);
-  expect(site.my_user?.local_user_view.person.avatar).toBe(upload2.url);
+  let my_user = await getMyUser(alpha);
+  expect(my_user.local_user_view.person.avatar).toBe(upload2.url);
 
   // make sure only the new avatar is kept
   const listMediaRes4 = await alphaImage.listMedia();

diff --git a/config/defaults.hjson b/config/defaults.hjson
@@ -66,7 +66,7 @@
       # or
 
       # If enabled, all images from remote domains are rewritten to pass through
-      # `/api/v3/image_proxy`, including embedded images in markdown. Images are stored temporarily
+      # `/api/v4/image_proxy`, including embedded images in markdown. Images are stored temporarily
       # in pict-rs for caching. This improves privacy as users don't expose their IP to untrusted
       # servers, and decreases load on other servers. However it increases bandwidth use for the
       # local server.

diff --git a/crates/api/src/community/block.rs b/crates/api/src/community/block.rs
@@ -17,7 +17,7 @@ use lemmy_db_views_actor::structs::CommunityView;
 use lemmy_utils::error::{LemmyErrorExt, LemmyErrorType, LemmyResult};
 
 #[tracing::instrument(skip(context))]
-pub async fn block_community(
+pub async fn user_block_community(
   data: Json<BlockCommunity>,
   context: Data<LemmyContext>,
   local_user_view: LocalUserView,

diff --git a/crates/api/src/local_user/block.rs b/crates/api/src/local_user/block.rs
@@ -12,7 +12,7 @@ use lemmy_db_views_actor::structs::PersonView;
 use lemmy_utils::error::{LemmyErrorExt, LemmyErrorType, LemmyResult};
 
 #[tracing::instrument(skip(context))]
-pub async fn block_person(
+pub async fn user_block_person(
   data: Json<BlockPerson>,
   context: Data<LemmyContext>,
   local_user_view: LocalUserView,

diff --git a/crates/api/src/local_user/mod.rs b/crates/api/src/local_user/mod.rs
@@ -15,5 +15,6 @@ pub mod report_count;
 pub mod reset_password;
 pub mod save_settings;
 pub mod update_totp;
+pub mod user_block_instance;
 pub mod validate_auth;
 pub mod verify_email;
diff --git a/crates/api/src/site/user_block_instance.rs → ...api/src/local_user/user_block_instance.rs b/crates/api/src/site/user_block_instance.rs → ...api/src/local_user/user_block_instance.rs