feat: Per-user renote mute (#10249)

* feat: per-user renote muting

From FoundKey/c414f24a2c https://akkoma.dev/FoundKeyGang/FoundKey

* Update ja-JP.yml

* Delete renote-muting.ts

* rename

* fix ids

* lint

* fix

* Update CHANGELOG.md

* リノートをミュートしたユーザー一覧を見れるように

* 🎨

* add test

* fix test

---------

Co-authored-by: Hélène <pleroma-dev@helene.moe>

packages/backend/src/server/api/endpoints/notes/global-timeline.ts

@@ -89,6 +89,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 				this.queryService.generateMutedUserQuery(query, me);
 				this.queryService.generateMutedNoteQuery(query, me);
 				this.queryService.generateBlockedUserQuery(query, me);
+				this.queryService.generateMutedUserRenotesQueryForNotes(query, me);
 			}
 
 			if (ps.withFiles) {

packages/backend/src/server/api/endpoints/notes/hybrid-timeline.ts

@@ -107,6 +107,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 			this.queryService.generateMutedUserQuery(query, me);
 			this.queryService.generateMutedNoteQuery(query, me);
 			this.queryService.generateBlockedUserQuery(query, me);
+			this.queryService.generateMutedUserRenotesQueryForNotes(query, me);
 
 			if (ps.includeMyRenotes === false) {
 				query.andWhere(new Brackets(qb => {

packages/backend/src/server/api/endpoints/notes/local-timeline.ts

@@ -95,6 +95,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 			if (me) this.queryService.generateMutedUserQuery(query, me);
 			if (me) this.queryService.generateMutedNoteQuery(query, me);
 			if (me) this.queryService.generateBlockedUserQuery(query, me);
+			if (me) this.queryService.generateMutedUserRenotesQueryForNotes(query, me);
 
 			if (ps.withFiles) {
 				query.andWhere('note.fileIds != \'{}\'');

packages/backend/src/server/api/endpoints/notes/timeline.ts

@@ -93,6 +93,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> {
 			this.queryService.generateMutedUserQuery(query, me);
 			this.queryService.generateMutedNoteQuery(query, me);
 			this.queryService.generateBlockedUserQuery(query, me);
+			this.queryService.generateMutedUserRenotesQueryForNotes(query, me);
 
 			if (ps.includeMyRenotes === false) {
 				query.andWhere(new Brackets(qb => {

packages/backend/src/server/api/endpoints/renote-mute/create.ts

@@ -0,0 +1,99 @@
+import { Inject, Injectable } from '@nestjs/common';
+import ms from 'ms';
+import { Endpoint } from '@/server/api/endpoint-base.js';
+import { IdService } from '@/core/IdService.js';
+import type { RenoteMutingsRepository } from '@/models/index.js';
+import type { RenoteMuting } from '@/models/entities/RenoteMuting.js';
+import { GlobalEventService } from '@/core/GlobalEventService.js';
+import { DI } from '@/di-symbols.js';
+import { GetterService } from '@/server/api/GetterService.js';
+import { ApiError } from '../../error.js';
+
+export const meta = {
+	tags: ['account'],
+
+	requireCredential: true,
+
+	kind: 'write:mutes',
+
+	limit: {
+		duration: ms('1hour'),
+		max: 20,
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: '5e0a5dff-1e94-4202-87ae-4d9c89eb2271',
+		},
+
+		muteeIsYourself: {
+			message: 'Mutee is yourself.',
+			code: 'MUTEE_IS_YOURSELF',
+			id: '37285718-52f7-4aef-b7de-c38b8e8a8420',
+		},
+
+		alreadyMuting: {
+			message: 'You are already muting that user.',
+			code: 'ALREADY_MUTING',
+			id: 'ccfecbe4-1f1c-4fc2-8a3d-c3ffee61cb7b',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		userId: { type: 'string', format: 'misskey:id' },
+	},
+	required: ['userId'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+@Injectable()
+export default class extends Endpoint<typeof meta, typeof paramDef> {
+	constructor(
+		@Inject(DI.renoteMutingsRepository)
+		private renoteMutingsRepository: RenoteMutingsRepository,
+
+		private globalEventService: GlobalEventService,
+		private getterService: GetterService,
+		private idService: IdService,
+	) {
+		super(meta, paramDef, async (ps, me) => {
+			const muter = me;
+
+			// 自分自身
+			if (me.id === ps.userId) {
+				throw new ApiError(meta.errors.muteeIsYourself);
+			}
+
+			// Get mutee
+			const mutee = await getterService.getUser(ps.userId).catch(err => {
+				if (err.id === '15348ddd-432d-49c2-8a5a-8069753becff') throw new ApiError(meta.errors.noSuchUser);
+				throw err;
+			});
+
+			// Check if already muting
+			const exist = await this.renoteMutingsRepository.findOneBy({
+				muterId: muter.id,
+				muteeId: mutee.id,
+			});
+
+			if (exist != null) {
+				throw new ApiError(meta.errors.alreadyMuting);
+			}
+
+			// Create mute
+			await this.renoteMutingsRepository.insert({
+				id: this.idService.genId(),
+				createdAt: new Date(),
+				muterId: muter.id,
+				muteeId: mutee.id,
+			} as RenoteMuting);
+
+		// publishUserEvent(user.id, 'mute', mutee);
+		});
+	}
+}

packages/backend/src/server/api/endpoints/renote-mute/delete.ts

@@ -0,0 +1,87 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Endpoint } from '@/server/api/endpoint-base.js';
+import type { RenoteMutingsRepository } from '@/models/index.js';
+import { GlobalEventService } from '@/core/GlobalEventService.js';
+import { DI } from '@/di-symbols.js';
+import { GetterService } from '@/server/api/GetterService.js';
+import { ApiError } from '../../error.js';
+
+export const meta = {
+	tags: ['account'],
+
+	requireCredential: true,
+
+	kind: 'write:mutes',
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: '9b6728cf-638c-4aa1-bedb-e07d8101474d',
+		},
+
+		muteeIsYourself: {
+			message: 'Mutee is yourself.',
+			code: 'MUTEE_IS_YOURSELF',
+			id: '619b1314-0850-4597-a242-e245f3da42af',
+		},
+
+		notMuting: {
+			message: 'You are not muting that user.',
+			code: 'NOT_MUTING',
+			id: '2e4ef874-8bf0-4b4b-b069-4598f6d05817',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		userId: { type: 'string', format: 'misskey:id' },
+	},
+	required: ['userId'],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+@Injectable()
+export default class extends Endpoint<typeof meta, typeof paramDef> {
+	constructor(
+		@Inject(DI.renoteMutingsRepository)
+		private renoteMutingsRepository: RenoteMutingsRepository,
+
+		private globalEventService: GlobalEventService,
+		private getterService: GetterService,
+	) {
+		super(meta, paramDef, async (ps, me) => {
+			const muter = me;
+
+			// Check if the mutee is yourself
+			if (me.id === ps.userId) {
+				throw new ApiError(meta.errors.muteeIsYourself);
+			}
+
+			// Get mutee
+			const mutee = await this.getterService.getUser(ps.userId).catch(err => {
+				if (err.id === '15348ddd-432d-49c2-8a5a-8069753becff') throw new ApiError(meta.errors.noSuchUser);
+				throw err;
+			});
+
+			// Check not muting
+			const exist = await this.renoteMutingsRepository.findOneBy({
+				muterId: muter.id,
+				muteeId: mutee.id,
+			});
+
+			if (exist == null) {
+				throw new ApiError(meta.errors.notMuting);
+			}
+
+			// Delete mute
+			await this.renoteMutingsRepository.delete({
+				id: exist.id,
+			});
+
+			// publishUserEvent(user.id, 'unmute', mutee);
+		});
+	}
+}

packages/backend/src/server/api/endpoints/renote-mute/list.ts

@@ -0,0 +1,57 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Endpoint } from '@/server/api/endpoint-base.js';
+import type { RenoteMutingsRepository } from '@/models/index.js';
+import { QueryService } from '@/core/QueryService.js';
+import { RenoteMutingEntityService } from '@/core/entities/RenoteMutingEntityService.js';
+import { DI } from '@/di-symbols.js';
+
+export const meta = {
+	tags: ['account'],
+
+	requireCredential: true,
+
+	kind: 'read:mutes',
+
+	res: {
+		type: 'array',
+		optional: false, nullable: false,
+		items: {
+			type: 'object',
+			optional: false, nullable: false,
+			ref: 'RenoteMuting',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		limit: { type: 'integer', minimum: 1, maximum: 100, default: 30 },
+		sinceId: { type: 'string', format: 'misskey:id' },
+		untilId: { type: 'string', format: 'misskey:id' },
+	},
+	required: [],
+} as const;
+
+// eslint-disable-next-line import/no-default-export
+@Injectable()
+export default class extends Endpoint<typeof meta, typeof paramDef> {
+	constructor(
+		@Inject(DI.renoteMutingsRepository)
+		private renoteMutingsRepository: RenoteMutingsRepository,
+
+		private renoteMutingEntityService: RenoteMutingEntityService,
+		private queryService: QueryService,
+	) {
+		super(meta, paramDef, async (ps, me) => {
+			const query = this.queryService.makePaginationQuery(this.renoteMutingsRepository.createQueryBuilder('muting'), ps.sinceId, ps.untilId)
+				.andWhere('muting.muterId = :meId', { meId: me.id });
+
+			const mutings = await query
+				.take(ps.limit)
+				.getMany();
+
+			return await this.renoteMutingEntityService.packMany(mutings, me);
+		});
+	}
+}

packages/backend/src/server/api/endpoints/users/relation.ts

@@ -50,6 +50,10 @@ export const meta = {
 						type: 'boolean',
 						optional: false, nullable: false,
 					},
+					isRenoteMuted: {
+						type: 'boolean',
+						optional: false, nullable: false,
+					},
 				},
 			},
 			{
@@ -91,6 +95,10 @@ export const meta = {
 							type: 'boolean',
 							optional: false, nullable: false,
 						},
+						isRenoteMuted: {
+							type: 'boolean',
+							optional: false, nullable: false,
+						},
 					},
 				},
 			},