Filter User / Instance Mutes in FanoutTimelineEndpointService (#12565)

* fix: unnecessary logging in FanoutTimelineEndpointService * chore: TimelineOptions * chore: add FanoutTimelineName type * chore: forbid specifying both withReplies and withFiles since it's not implemented correctly * chore: filter mutes, replies, renotes, files in FanoutTimelineEndpointService * revert unintended changes * use isReply in NoteCreateService * fix: excludePureRenotes is not implemented * fix: replies to me is excluded from local timeline * chore(frontend): forbid enabling both withReplies and withFiles * docs(changelog): インスタンスミュートが効かない問題の修正について言及
2023-12-04 14:38:21 +09:00
parent b2c4973cda
commit 18109fcef7
15 changed files with 176 additions and 179 deletions
--- a/packages/backend/src/core/FanoutTimelineEndpointService.ts
+++ b/packages/backend/src/core/FanoutTimelineEndpointService.ts
@@ -11,7 +11,29 @@ import type { MiNote } from '@/models/Note.js';
 import { Packed } from '@/misc/json-schema.js';
 import type { NotesRepository } from '@/models/_.js';
 import { NoteEntityService } from '@/core/entities/NoteEntityService.js';
-import { FanoutTimelineService } from '@/core/FanoutTimelineService.js';
+import { FanoutTimelineName, FanoutTimelineService } from '@/core/FanoutTimelineService.js';
+import { isUserRelated } from '@/misc/is-user-related.js';
+import { isPureRenote } from '@/misc/is-pure-renote.js';
+import { CacheService } from '@/core/CacheService.js';
+import { isReply } from '@/misc/is-reply.js';
+import { isInstanceMuted } from '@/misc/is-instance-muted.js';
+
+type TimelineOptions = {
+	untilId: string | null,
+	sinceId: string | null,
+	limit: number,
+	allowPartial: boolean,
+	me?: { id: MiUser['id'] } | undefined | null,
+	useDbFallback: boolean,
+	redisTimelines: FanoutTimelineName[],
+	noteFilter?: (note: MiNote) => boolean,
+	alwaysIncludeMyNotes?: boolean;
+	ignoreAuthorFromMute?: boolean;
+	excludeNoFiles?: boolean;
+	excludeReplies?: boolean;
+	excludePureRenotes: boolean;
+	dbFallback: (untilId: string | null, sinceId: string | null, limit: number) => Promise<MiNote[]>,
+};

@Injectable()
 export class FanoutTimelineEndpointService {
@@ -20,37 +42,18 @@ export class FanoutTimelineEndpointService {
 		private notesRepository: NotesRepository,

 		private noteEntityService: NoteEntityService,
+		private cacheService: CacheService,
 		private fanoutTimelineService: FanoutTimelineService,
 	) {
 	}

 	@bindThis
-	async timeline(ps: {
-		untilId: string | null,
-		sinceId: string | null,
-		limit: number,
-		allowPartial: boolean,
-		me?: { id: MiUser['id'] } | undefined | null,
-		useDbFallback: boolean,
-		redisTimelines: string[],
-		noteFilter: (note: MiNote) => boolean,
-		dbFallback: (untilId: string | null, sinceId: string | null, limit: number) => Promise<MiNote[]>,
-	}): Promise<Packed<'Note'>[]> {
+	async timeline(ps: TimelineOptions): Promise<Packed<'Note'>[]> {
 		return await this.noteEntityService.packMany(await this.getMiNotes(ps), ps.me);
 	}

 	@bindThis
-	private async getMiNotes(ps: {
-		untilId: string | null,
-		sinceId: string | null,
-		limit: number,
-		allowPartial: boolean,
-		me?: { id: MiUser['id'] } | undefined | null,
-		useDbFallback: boolean,
-		redisTimelines: string[],
-		noteFilter: (note: MiNote) => boolean,
-		dbFallback: (untilId: string | null, sinceId: string | null, limit: number) => Promise<MiNote[]>,
-	}): Promise<MiNote[]> {
+	private async getMiNotes(ps: TimelineOptions): Promise<MiNote[]> {
 		let noteIds: string[];
 		let shouldFallbackToDb = false;

@@ -67,10 +70,57 @@ export class FanoutTimelineEndpointService {
 		shouldFallbackToDb = shouldFallbackToDb || (noteIds.length === 0);

 		if (!shouldFallbackToDb) {
+			let filter = ps.noteFilter ?? (_note => true);
+
+			if (ps.alwaysIncludeMyNotes && ps.me) {
+				const me = ps.me;
+				const parentFilter = filter;
+				filter = (note) => note.userId === me.id || parentFilter(note);
+			}
+
+			if (ps.excludeNoFiles) {
+				const parentFilter = filter;
+				filter = (note) => note.fileIds.length !== 0 && parentFilter(note);
+			}
+
+			if (ps.excludeReplies) {
+				const parentFilter = filter;
+				filter = (note) => !isReply(note, ps.me?.id) && parentFilter(note);
+			}
+
+			if (ps.excludePureRenotes) {
+				const parentFilter = filter;
+				filter = (note) => !isPureRenote(note) && parentFilter(note);
+			}
+
+			if (ps.me) {
+				const me = ps.me;
+				const [
+					userIdsWhoMeMuting,
+					userIdsWhoMeMutingRenotes,
+					userIdsWhoBlockingMe,
+					userMutedInstances,
+				] = await Promise.all([
+					this.cacheService.userMutingsCache.fetch(ps.me.id),
+					this.cacheService.renoteMutingsCache.fetch(ps.me.id),
+					this.cacheService.userBlockedCache.fetch(ps.me.id),
+					this.cacheService.userProfileCache.fetch(me.id).then(p => new Set(p.mutedInstances)),
+				]);
+
+				const parentFilter = filter;
+				filter = (note) => {
+					if (isUserRelated(note, userIdsWhoBlockingMe, ps.ignoreAuthorFromMute)) return false;
+					if (isUserRelated(note, userIdsWhoMeMuting, ps.ignoreAuthorFromMute)) return false;
+					if (isPureRenote(note) && isUserRelated(note, userIdsWhoMeMutingRenotes, ps.ignoreAuthorFromMute)) return false;
+					if (isInstanceMuted(note, userMutedInstances)) return false;
+
+					return parentFilter(note);
+				};
+			}
+
 			const redisTimeline: MiNote[] = [];
 			let readFromRedis = 0;
 			let lastSuccessfulRate = 1; // rateをキャッシュする？
-			let trialCount = 1;

 			while ((redisResultIds.length - readFromRedis) !== 0) {
 				const remainingToRead = ps.limit - redisTimeline.length;
@@ -81,12 +131,10 @@ export class FanoutTimelineEndpointService {

 				readFromRedis += noteIds.length;

-				const gotFromDb = await this.getAndFilterFromDb(noteIds, ps.noteFilter);
+				const gotFromDb = await this.getAndFilterFromDb(noteIds, filter);
 				redisTimeline.push(...gotFromDb);
 				lastSuccessfulRate = gotFromDb.length / noteIds.length;

-				console.log(`fanoutTimelineTrial#${trialCount++}: req: ${ps.limit}, tried: ${noteIds.length}, got: ${gotFromDb.length}, rate: ${lastSuccessfulRate}, total: ${redisTimeline.length}, fromRedis: ${redisResultIds.length}`);
-
 				if (ps.allowPartial ? redisTimeline.length !== 0 : redisTimeline.length >= ps.limit) {
 					// 十分Redisからとれた
 					return redisTimeline.slice(0, ps.limit);
@@ -97,7 +145,6 @@ export class FanoutTimelineEndpointService {
 			const remainingToRead = ps.limit - redisTimeline.length;
 			const gotFromDb = await ps.dbFallback(noteIds[noteIds.length - 1], ps.sinceId, remainingToRead);
 			redisTimeline.push(...gotFromDb);
-			console.log(`fanoutTimelineTrial#db: req: ${ps.limit}, tried: ${remainingToRead}, got: ${gotFromDb.length}, since: ${noteIds[noteIds.length - 1]}, until: ${ps.untilId}, total: ${redisTimeline.length}`);
 			return redisTimeline;
 		}

--- a/packages/backend/src/core/FanoutTimelineService.ts
+++ b/packages/backend/src/core/FanoutTimelineService.ts
@@ -9,6 +9,34 @@ import { DI } from '@/di-symbols.js';
 import { bindThis } from '@/decorators.js';
 import { IdService } from '@/core/IdService.js';

+export type FanoutTimelineName =
+	// home timeline
+	| `homeTimeline:${string}`
+	| `homeTimelineWithFiles:${string}` // only notes with files are included
+	// local timeline
+	| `localTimeline` // replies are not included
+	| `localTimelineWithFiles` // only non-reply notes with files are included
+	| `localTimelineWithReplies` // only replies are included
+
+	// antenna
+	| `antennaTimeline:${string}`
+
+	// user timeline
+	| `userTimeline:${string}` // replies are not included
+	| `userTimelineWithFiles:${string}` // only non-reply notes with files are included
+	| `userTimelineWithReplies:${string}` // only replies are included
+	| `userTimelineWithChannel:${string}` // only channel notes are included, replies are included
+
+	// user list timelines
+	| `userListTimeline:${string}`
+	| `userListTimelineWithFiles:${string}` // only notes with files are included
+
+	// channel timelines
+	| `channelTimeline:${string}` // replies are included
+
+	// role timelines
+	| `roleTimeline:${string}` // any notes are included
+
@Injectable()
 export class FanoutTimelineService {
 	constructor(
@@ -20,7 +48,7 @@ export class FanoutTimelineService {
 	}

 	@bindThis
-	public push(tl: string, id: string, maxlen: number, pipeline: Redis.ChainableCommander) {
+	public push(tl: FanoutTimelineName, id: string, maxlen: number, pipeline: Redis.ChainableCommander) {
 		// リモートから遅れて届いた(もしくは後から追加された)投稿日時が古い投稿が追加されるとページネーション時に問題を引き起こすため、
 		// 3分以内に投稿されたものでない場合、Redisにある最古のIDより新しい場合のみ追加する
 		if (this.idService.parse(id).date.getTime() > Date.now() - 1000 * 60 * 3) {
@@ -41,7 +69,7 @@ export class FanoutTimelineService {
 	}

 	@bindThis
-	public get(name: string, untilId?: string | null, sinceId?: string | null) {
+	public get(name: FanoutTimelineName, untilId?: string | null, sinceId?: string | null) {
 		if (untilId && sinceId) {
 			return this.redisForTimelines.lrange('list:' + name, 0, -1)
 				.then(ids => ids.filter(id => id < untilId && id > sinceId).sort((a, b) => a > b ? -1 : 1));
@@ -58,7 +86,7 @@ export class FanoutTimelineService {
 	}

 	@bindThis
-	public getMulti(name: string[], untilId?: string | null, sinceId?: string | null): Promise<string[][]> {
+	public getMulti(name: FanoutTimelineName[], untilId?: string | null, sinceId?: string | null): Promise<string[][]> {
 		const pipeline = this.redisForTimelines.pipeline();
 		for (const n of name) {
 			pipeline.lrange('list:' + n, 0, -1);
@@ -79,7 +107,7 @@ export class FanoutTimelineService {
 	}

 	@bindThis
-	public purge(name: string) {
+	public purge(name: FanoutTimelineName) {
 		return this.redisForTimelines.del('list:' + name);
 	}
 }
--- a/packages/backend/src/core/NoteCreateService.ts
+++ b/packages/backend/src/core/NoteCreateService.ts
@@ -57,6 +57,7 @@ import { FeaturedService } from '@/core/FeaturedService.js';
 import { FanoutTimelineService } from '@/core/FanoutTimelineService.js';
 import { UtilityService } from '@/core/UtilityService.js';
 import { UserBlockingService } from '@/core/UserBlockingService.js';
+import { isReply } from '@/misc/is-reply.js';

 type NotificationType = 'reply' | 'renote' | 'quote' | 'mention';

@@ -891,7 +892,7 @@ export class NoteCreateService implements OnApplicationShutdown {
 				if (note.visibility === 'specified' && !note.visibleUserIds.some(v => v === following.followerId)) continue;

 				// 「自分自身への返信 or そのフォロワーへの返信」のどちらでもない場合
-				if (note.replyId && !(note.replyUserId === note.userId || note.replyUserId === following.followerId)) {
+				if (isReply(note, following.followerId)) {
 					if (!following.withReplies) continue;
 				}

@@ -909,7 +910,7 @@ export class NoteCreateService implements OnApplicationShutdown {
 				) continue;

 				// 「自分自身への返信 or そのリストの作成者への返信」のどちらでもない場合
-				if (note.replyId && !(note.replyUserId === note.userId || note.replyUserId === userListMembership.userListUserId)) {
+				if (isReply(note, userListMembership.userListUserId)) {
 					if (!userListMembership.withReplies) continue;
 				}

@@ -927,7 +928,7 @@ export class NoteCreateService implements OnApplicationShutdown {
 			}

 			// 自分自身以外への返信
-			if (note.replyId && note.replyUserId !== note.userId) {
+			if (isReply(note)) {
 				this.fanoutTimelineService.push(`userTimelineWithReplies:${user.id}`, note.id, note.userHost == null ? meta.perLocalUserUserTimelineCacheMax : meta.perRemoteUserUserTimelineCacheMax, r);

 				if (note.visibility === 'public' && note.userHost == null) {