summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoints/users/notes.ts
diff options
context:
space:
mode:
authorMarie <Marie@kaifa.ch>2023-12-23 02:09:23 +0100
committerMarie <Marie@kaifa.ch>2023-12-23 02:09:23 +0100
commit5db583a3eb61d50de14d875ebf7ecef20490e313 (patch)
tree783dd43d2ac660c32e745a4485d499e9ddc43324 /packages/backend/src/server/api/endpoints/users/notes.ts
parentadd: Custom MOTDs (diff)
parentUpdate CHANGELOG.md (diff)
downloadsharkey-5db583a3eb61d50de14d875ebf7ecef20490e313.tar.gz
sharkey-5db583a3eb61d50de14d875ebf7ecef20490e313.tar.bz2
sharkey-5db583a3eb61d50de14d875ebf7ecef20490e313.zip
merge: upstream
Diffstat (limited to 'packages/backend/src/server/api/endpoints/users/notes.ts')
-rw-r--r--packages/backend/src/server/api/endpoints/users/notes.ts221
1 files changed, 115 insertions, 106 deletions
diff --git a/packages/backend/src/server/api/endpoints/users/notes.ts b/packages/backend/src/server/api/endpoints/users/notes.ts
index c3d72c3ba8..b485126ed8 100644
--- a/packages/backend/src/server/api/endpoints/users/notes.ts
+++ b/packages/backend/src/server/api/endpoints/users/notes.ts
@@ -5,17 +5,18 @@
import { Brackets } from 'typeorm';
import { Inject, Injectable } from '@nestjs/common';
-import * as Redis from 'ioredis';
-import type { MiNote, NotesRepository } from '@/models/_.js';
+import type { NotesRepository } from '@/models/_.js';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { NoteEntityService } from '@/core/entities/NoteEntityService.js';
import { DI } from '@/di-symbols.js';
import { CacheService } from '@/core/CacheService.js';
import { IdService } from '@/core/IdService.js';
-import { isUserRelated } from '@/misc/is-user-related.js';
import { QueryService } from '@/core/QueryService.js';
-import { FunoutTimelineService } from '@/core/FunoutTimelineService.js';
-import { ApiError } from '../../error.js';
+import { MetaService } from '@/core/MetaService.js';
+import { MiLocalUser } from '@/models/User.js';
+import { FanoutTimelineEndpointService } from '@/core/FanoutTimelineEndpointService.js';
+import { FanoutTimelineName } from '@/core/FanoutTimelineService.js';
+import { ApiError } from '@/server/api/error.js';
export const meta = {
tags: ['users', 'notes'],
@@ -36,6 +37,12 @@ export const meta = {
code: 'NO_SUCH_USER',
id: '27e494ba-2ac2-48e8-893b-10d4d8c2387b',
},
+
+ bothWithRepliesAndWithFiles: {
+ message: 'Specifying both withReplies and withFiles is not supported',
+ code: 'BOTH_WITH_REPLIES_AND_WITH_FILES',
+ id: '91c8cb9f-36ed-46e7-9ca2-7df96ed6e222',
+ },
},
} as const;
@@ -51,8 +58,8 @@ export const paramDef = {
untilId: { type: 'string', format: 'misskey:id' },
sinceDate: { type: 'integer' },
untilDate: { type: 'integer' },
+ allowPartial: { type: 'boolean', default: false }, // true is recommended but for compatibility false by default
withFiles: { type: 'boolean', default: false },
- excludeNsfw: { type: 'boolean', default: false },
},
required: ['userId'],
} as const;
@@ -60,9 +67,6 @@ export const paramDef = {
@Injectable()
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
constructor(
- @Inject(DI.redisForTimelines)
- private redisForTimelines: Redis.Redis,
-
@Inject(DI.notesRepository)
private notesRepository: NotesRepository,
@@ -70,125 +74,130 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
private queryService: QueryService,
private cacheService: CacheService,
private idService: IdService,
- private funoutTimelineService: FunoutTimelineService,
+ private fanoutTimelineEndpointService: FanoutTimelineEndpointService,
+ private metaService: MetaService,
) {
super(meta, paramDef, async (ps, me) => {
const untilId = ps.untilId ?? (ps.untilDate ? this.idService.gen(ps.untilDate!) : null);
const sinceId = ps.sinceId ?? (ps.sinceDate ? this.idService.gen(ps.sinceDate!) : null);
- const isRangeSpecified = untilId != null && sinceId != null;
const isSelf = me && (me.id === ps.userId);
- if (isRangeSpecified || sinceId == null) {
- const [
- userIdsWhoMeMuting,
- ] = me ? await Promise.all([
- this.cacheService.userMutingsCache.fetch(me.id),
- ]) : [new Set<string>()];
-
- const [noteIdsRes, repliesNoteIdsRes, channelNoteIdsRes] = await Promise.all([
- this.funoutTimelineService.get(ps.withFiles ? `userTimelineWithFiles:${ps.userId}` : `userTimeline:${ps.userId}`, untilId, sinceId),
- ps.withReplies ? this.funoutTimelineService.get(`userTimelineWithReplies:${ps.userId}`, untilId, sinceId) : Promise.resolve([]),
- ps.withChannelNotes ? this.funoutTimelineService.get(`userTimelineWithChannel:${ps.userId}`, untilId, sinceId) : Promise.resolve([]),
- ]);
-
- let noteIds = Array.from(new Set([
- ...noteIdsRes,
- ...repliesNoteIdsRes,
- ...channelNoteIdsRes,
- ]));
- noteIds.sort((a, b) => a > b ? -1 : 1);
- noteIds = noteIds.slice(0, ps.limit);
+ const serverSettings = await this.metaService.fetch();
- if (noteIds.length > 0) {
- const isFollowing = me && Object.hasOwn(await this.cacheService.userFollowingsCache.fetch(me.id), ps.userId);
+ if (ps.withReplies && ps.withFiles) throw new ApiError(meta.errors.bothWithRepliesAndWithFiles);
- const query = this.notesRepository.createQueryBuilder('note')
- .where('note.id IN (:...noteIds)', { noteIds: noteIds })
- .innerJoinAndSelect('note.user', 'user')
- .leftJoinAndSelect('note.reply', 'reply')
- .leftJoinAndSelect('note.renote', 'renote')
- .leftJoinAndSelect('reply.user', 'replyUser')
- .leftJoinAndSelect('renote.user', 'renoteUser')
- .leftJoinAndSelect('note.channel', 'channel');
-
- let timeline = await query.getMany();
-
- timeline = timeline.filter(note => {
- if (me && isUserRelated(note, userIdsWhoMeMuting, true)) return false;
+ // early return if me is blocked by requesting user
+ if (me != null) {
+ const userIdsWhoBlockingMe = await this.cacheService.userBlockedCache.fetch(me.id);
+ if (userIdsWhoBlockingMe.has(ps.userId)) {
+ return [];
+ }
+ }
- if (note.renoteId) {
- if (note.text == null && note.fileIds.length === 0 && !note.hasPoll) {
- if (ps.withRenotes === false) return false;
- }
- }
+ if (!serverSettings.enableFanoutTimeline) {
+ const timeline = await this.getFromDb({
+ untilId,
+ sinceId,
+ limit: ps.limit,
+ userId: ps.userId,
+ withChannelNotes: ps.withChannelNotes,
+ withFiles: ps.withFiles,
+ withRenotes: ps.withRenotes,
+ }, me);
- if (ps.withFiles && note.fileIds.length === 0) return false;
- if (!ps.withReplies && note.replyId) return false;
+ return await this.noteEntityService.packMany(timeline, me);
+ }
- if (note.channel?.isSensitive && !isSelf) return false;
- if (note.visibility === 'specified' && (!me || (me.id !== note.userId && !note.visibleUserIds.some(v => v === me.id)))) return false;
- if (note.visibility === 'followers' && !isFollowing && !isSelf) return false;
+ const redisTimelines: FanoutTimelineName[] = [ps.withFiles ? `userTimelineWithFiles:${ps.userId}` : `userTimeline:${ps.userId}`];
- return true;
- });
+ if (ps.withReplies) redisTimelines.push(`userTimelineWithReplies:${ps.userId}`);
+ if (ps.withChannelNotes) redisTimelines.push(`userTimelineWithChannel:${ps.userId}`);
- // TODO: フィルタで件数が減った場合の埋め合わせ処理
+ const isFollowing = me && Object.hasOwn(await this.cacheService.userFollowingsCache.fetch(me.id), ps.userId);
- timeline.sort((a, b) => a.id > b.id ? -1 : 1);
+ const timeline = await this.fanoutTimelineEndpointService.timeline({
+ untilId,
+ sinceId,
+ limit: ps.limit,
+ allowPartial: ps.allowPartial,
+ me,
+ redisTimelines,
+ useDbFallback: true,
+ ignoreAuthorFromMute: true,
+ excludeReplies: ps.withChannelNotes && !ps.withReplies, // userTimelineWithChannel may include replies
+ excludeNoFiles: ps.withChannelNotes && ps.withFiles, // userTimelineWithChannel may include notes without files
+ excludePureRenotes: !ps.withRenotes,
+ noteFilter: note => {
+ if (note.channel?.isSensitive && !isSelf) return false;
+ if (note.visibility === 'specified' && (!me || (me.id !== note.userId && !note.visibleUserIds.some(v => v === me.id)))) return false;
+ if (note.visibility === 'followers' && !isFollowing && !isSelf) return false;
- if (timeline.length > 0) {
- return await this.noteEntityService.packMany(timeline, me);
- }
- }
- }
+ return true;
+ },
+ dbFallback: async (untilId, sinceId, limit) => await this.getFromDb({
+ untilId,
+ sinceId,
+ limit,
+ userId: ps.userId,
+ withChannelNotes: ps.withChannelNotes,
+ withFiles: ps.withFiles,
+ withRenotes: ps.withRenotes,
+ }, me),
+ });
- //#region fallback to database
- const query = this.queryService.makePaginationQuery(this.notesRepository.createQueryBuilder('note'), ps.sinceId, ps.untilId, ps.sinceDate, ps.untilDate)
- .andWhere('note.userId = :userId', { userId: ps.userId })
- .innerJoinAndSelect('note.user', 'user')
- .leftJoinAndSelect('note.reply', 'reply')
- .leftJoinAndSelect('note.renote', 'renote')
- .leftJoinAndSelect('note.channel', 'channel')
- .leftJoinAndSelect('reply.user', 'replyUser')
- .leftJoinAndSelect('renote.user', 'renoteUser');
+ return timeline;
+ });
+ }
- if (ps.withChannelNotes) {
- if (!isSelf) query.andWhere(new Brackets(qb => {
- qb.orWhere('note.channelId IS NULL');
- qb.orWhere('channel.isSensitive = false');
- }));
- } else {
- query.andWhere('note.channelId IS NULL');
- }
+ private async getFromDb(ps: {
+ untilId: string | null,
+ sinceId: string | null,
+ limit: number,
+ userId: string,
+ withChannelNotes: boolean,
+ withFiles: boolean,
+ withRenotes: boolean,
+ }, me: MiLocalUser | null) {
+ const isSelf = me && (me.id === ps.userId);
- this.queryService.generateVisibilityQuery(query, me);
- if (me) {
- this.queryService.generateMutedUserQuery(query, me, { id: ps.userId });
- this.queryService.generateBlockedUserQuery(query, me);
- }
+ const query = this.queryService.makePaginationQuery(this.notesRepository.createQueryBuilder('note'), ps.sinceId, ps.untilId)
+ .andWhere('note.userId = :userId', { userId: ps.userId })
+ .innerJoinAndSelect('note.user', 'user')
+ .leftJoinAndSelect('note.reply', 'reply')
+ .leftJoinAndSelect('note.renote', 'renote')
+ .leftJoinAndSelect('note.channel', 'channel')
+ .leftJoinAndSelect('reply.user', 'replyUser')
+ .leftJoinAndSelect('renote.user', 'renoteUser');
- if (ps.withFiles) {
- query.andWhere('note.fileIds != \'{}\'');
- }
+ if (ps.withChannelNotes) {
+ if (!isSelf) query.andWhere(new Brackets(qb => {
+ qb.orWhere('note.channelId IS NULL');
+ qb.orWhere('channel.isSensitive = false');
+ }));
+ } else {
+ query.andWhere('note.channelId IS NULL');
+ }
- if (ps.withRenotes === false) {
- query.andWhere(new Brackets(qb => {
- qb.orWhere('note.userId != :userId', { userId: ps.userId });
- qb.orWhere('note.renoteId IS NULL');
- qb.orWhere('note.text IS NOT NULL');
- qb.orWhere('note.fileIds != \'{}\'');
- qb.orWhere('0 < (SELECT COUNT(*) FROM poll WHERE poll."noteId" = note.id)');
- }));
- }
+ this.queryService.generateVisibilityQuery(query, me);
+ if (me) {
+ this.queryService.generateMutedUserQuery(query, me, { id: ps.userId });
+ this.queryService.generateBlockedUserQuery(query, me);
+ }
- if (!ps.withReplies) {
- query.andWhere('note.replyId IS NULL');
- }
+ if (ps.withFiles) {
+ query.andWhere('note.fileIds != \'{}\'');
+ }
- const timeline = await query.limit(ps.limit).getMany();
+ if (ps.withRenotes === false) {
+ query.andWhere(new Brackets(qb => {
+ qb.orWhere('note.userId != :userId', { userId: ps.userId });
+ qb.orWhere('note.renoteId IS NULL');
+ qb.orWhere('note.text IS NOT NULL');
+ qb.orWhere('note.fileIds != \'{}\'');
+ qb.orWhere('0 < (SELECT COUNT(*) FROM poll WHERE poll."noteId" = note.id)');
+ }));
+ }
- return await this.noteEntityService.packMany(timeline, me);
- //#endregion
- });
+ return await query.limit(ps.limit).getMany();
}
}