feat: notification grouping

Resolve #12211

packages/backend/src/server/api/EndpointsModule.ts

@@ -217,6 +217,7 @@ import * as ep___i_importMuting from './endpoints/i/import-muting.js';
 import * as ep___i_importUserLists from './endpoints/i/import-user-lists.js';
 import * as ep___i_importAntennas from './endpoints/i/import-antennas.js';
 import * as ep___i_notifications from './endpoints/i/notifications.js';
+import * as ep___i_notificationsGrouped from './endpoints/i/notifications-grouped.js';
 import * as ep___i_pageLikes from './endpoints/i/page-likes.js';
 import * as ep___i_pages from './endpoints/i/pages.js';
 import * as ep___i_pin from './endpoints/i/pin.js';
@@ -574,6 +575,7 @@ const $i_importMuting: Provider = { provide: 'ep:i/import-muting', useClass: ep_
 const $i_importUserLists: Provider = { provide: 'ep:i/import-user-lists', useClass: ep___i_importUserLists.default };
 const $i_importAntennas: Provider = { provide: 'ep:i/import-antennas', useClass: ep___i_importAntennas.default };
 const $i_notifications: Provider = { provide: 'ep:i/notifications', useClass: ep___i_notifications.default };
+const $i_notificationsGrouped: Provider = { provide: 'ep:i/notifications-grouped', useClass: ep___i_notificationsGrouped.default };
 const $i_pageLikes: Provider = { provide: 'ep:i/page-likes', useClass: ep___i_pageLikes.default };
 const $i_pages: Provider = { provide: 'ep:i/pages', useClass: ep___i_pages.default };
 const $i_pin: Provider = { provide: 'ep:i/pin', useClass: ep___i_pin.default };
@@ -935,6 +937,7 @@ const $retention: Provider = { provide: 'ep:retention', useClass: ep___retention
 		$i_importUserLists,
 		$i_importAntennas,
 		$i_notifications,
+		$i_notificationsGrouped,
 		$i_pageLikes,
 		$i_pages,
 		$i_pin,
@@ -1290,6 +1293,7 @@ const $retention: Provider = { provide: 'ep:retention', useClass: ep___retention
 		$i_importUserLists,
 		$i_importAntennas,
 		$i_notifications,
+		$i_notificationsGrouped,
 		$i_pageLikes,
 		$i_pages,
 		$i_pin,

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

@@ -217,6 +217,7 @@ import * as ep___i_importMuting from './endpoints/i/import-muting.js';
 import * as ep___i_importUserLists from './endpoints/i/import-user-lists.js';
 import * as ep___i_importAntennas from './endpoints/i/import-antennas.js';
 import * as ep___i_notifications from './endpoints/i/notifications.js';
+import * as ep___i_notificationsGrouped from './endpoints/i/notifications-grouped.js';
 import * as ep___i_pageLikes from './endpoints/i/page-likes.js';
 import * as ep___i_pages from './endpoints/i/pages.js';
 import * as ep___i_pin from './endpoints/i/pin.js';
@@ -572,6 +573,7 @@ const eps = [
 	['i/import-user-lists', ep___i_importUserLists],
 	['i/import-antennas', ep___i_importAntennas],
 	['i/notifications', ep___i_notifications],
+	['i/notifications-grouped', ep___i_notificationsGrouped],
 	['i/page-likes', ep___i_pageLikes],
 	['i/pages', ep___i_pages],
 	['i/pin', ep___i_pin],

packages/backend/src/server/api/endpoints/i/notifications-grouped.ts

@@ -0,0 +1,178 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and other misskey contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import { Brackets, In } from 'typeorm';
+import * as Redis from 'ioredis';
+import { Inject, Injectable } from '@nestjs/common';
+import type { NotesRepository } from '@/models/_.js';
+import { obsoleteNotificationTypes, notificationTypes, FilterUnionByProperty } from '@/types.js';
+import { Endpoint } from '@/server/api/endpoint-base.js';
+import { NoteReadService } from '@/core/NoteReadService.js';
+import { NotificationEntityService } from '@/core/entities/NotificationEntityService.js';
+import { NotificationService } from '@/core/NotificationService.js';
+import { DI } from '@/di-symbols.js';
+import { IdService } from '@/core/IdService.js';
+import { MiGroupedNotification, MiNotification } from '@/models/Notification.js';
+
+export const meta = {
+	tags: ['account', 'notifications'],
+
+	requireCredential: true,
+
+	limit: {
+		duration: 30000,
+		max: 30,
+	},
+
+	kind: 'read:notifications',
+
+	res: {
+		type: 'array',
+		optional: false, nullable: false,
+		items: {
+			type: 'object',
+			optional: false, nullable: false,
+			ref: 'Notification',
+		},
+	},
+} as const;
+
+export const paramDef = {
+	type: 'object',
+	properties: {
+		limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+		sinceId: { type: 'string', format: 'misskey:id' },
+		untilId: { type: 'string', format: 'misskey:id' },
+		markAsRead: { type: 'boolean', default: true },
+		// 後方互換のため、廃止された通知タイプも受け付ける
+		includeTypes: { type: 'array', items: {
+			type: 'string', enum: [...notificationTypes, ...obsoleteNotificationTypes],
+		} },
+		excludeTypes: { type: 'array', items: {
+			type: 'string', enum: [...notificationTypes, ...obsoleteNotificationTypes],
+		} },
+	},
+	required: [],
+} as const;
+
+@Injectable()
+export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
+	constructor(
+		@Inject(DI.redis)
+		private redisClient: Redis.Redis,
+
+		@Inject(DI.notesRepository)
+		private notesRepository: NotesRepository,
+
+		private idService: IdService,
+		private notificationEntityService: NotificationEntityService,
+		private notificationService: NotificationService,
+		private noteReadService: NoteReadService,
+	) {
+		super(meta, paramDef, async (ps, me) => {
+			const EXTRA_LIMIT = 100;
+
+			// includeTypes が空の場合はクエリしない
+			if (ps.includeTypes && ps.includeTypes.length === 0) {
+				return [];
+			}
+			// excludeTypes に全指定されている場合はクエリしない
+			if (notificationTypes.every(type => ps.excludeTypes?.includes(type))) {
+				return [];
+			}
+
+			const includeTypes = ps.includeTypes && ps.includeTypes.filter(type => !(obsoleteNotificationTypes).includes(type as any)) as typeof notificationTypes[number][];
+			const excludeTypes = ps.excludeTypes && ps.excludeTypes.filter(type => !(obsoleteNotificationTypes).includes(type as any)) as typeof notificationTypes[number][];
+
+			const limit = (ps.limit + EXTRA_LIMIT) + (ps.untilId ? 1 : 0) + (ps.sinceId ? 1 : 0); // untilIdに指定したものも含まれるため+1
+			const notificationsRes = await this.redisClient.xrevrange(
+				`notificationTimeline:${me.id}`,
+				ps.untilId ? this.idService.parse(ps.untilId).date.getTime() : '+',
+				ps.sinceId ? this.idService.parse(ps.sinceId).date.getTime() : '-',
+				'COUNT', limit);
+
+			if (notificationsRes.length === 0) {
+				return [];
+			}
+
+			let notifications = notificationsRes.map(x => JSON.parse(x[1][1])).filter(x => x.id !== ps.untilId && x !== ps.sinceId) as MiNotification[];
+
+			if (includeTypes && includeTypes.length > 0) {
+				notifications = notifications.filter(notification => includeTypes.includes(notification.type));
+			} else if (excludeTypes && excludeTypes.length > 0) {
+				notifications = notifications.filter(notification => !excludeTypes.includes(notification.type));
+			}
+
+			if (notifications.length === 0) {
+				return [];
+			}
+
+			// Mark all as read
+			if (ps.markAsRead) {
+				this.notificationService.readAllNotification(me.id);
+			}
+
+			// grouping
+			let groupedNotifications = [notifications[0]] as MiGroupedNotification[];
+			for (let i = 1; i < notifications.length; i++) {
+				const notification = notifications[i];
+				const prev = notifications[i - 1];
+				let prevGroupedNotification = groupedNotifications.at(-1)!;
+
+				if (prev.type === 'reaction' && notification.type === 'reaction' && prev.noteId === notification.noteId) {
+					if (prevGroupedNotification.type !== 'reaction:grouped') {
+						groupedNotifications[groupedNotifications.length - 1] = {
+							type: 'reaction:grouped',
+							id: '',
+							createdAt: prev.createdAt,
+							noteId: prev.noteId!,
+							reactions: [{
+								userId: prev.notifierId!,
+								reaction: prev.reaction!,
+							}],
+						};
+						prevGroupedNotification = groupedNotifications.at(-1)!;
+					}
+					(prevGroupedNotification as FilterUnionByProperty<MiGroupedNotification, 'type', 'reaction:grouped'>).reactions.push({
+						userId: notification.notifierId!,
+						reaction: notification.reaction!,
+					});
+					prevGroupedNotification.id = notification.id;
+					continue;
+				}
+				if (prev.type === 'renote' && notification.type === 'renote' && prev.targetNoteId === notification.targetNoteId) {
+					if (prevGroupedNotification.type !== 'renote:grouped') {
+						groupedNotifications[groupedNotifications.length - 1] = {
+							type: 'renote:grouped',
+							id: '',
+							createdAt: notification.createdAt,
+							noteId: prev.noteId!,
+							userIds: [prev.notifierId!],
+						};
+						prevGroupedNotification = groupedNotifications.at(-1)!;
+					}
+					(prevGroupedNotification as FilterUnionByProperty<MiGroupedNotification, 'type', 'renote:grouped'>).userIds.push(notification.notifierId!);
+					prevGroupedNotification.id = notification.id;
+					continue;
+				}
+
+				groupedNotifications.push(notification);
+			}
+
+			groupedNotifications = groupedNotifications.slice(0, ps.limit);
+
+			const noteIds = groupedNotifications
+				.filter((notification): notification is FilterUnionByProperty<MiNotification, 'type', 'mention' | 'reply' | 'quote'> => ['mention', 'reply', 'quote'].includes(notification.type))
+				.map(notification => notification.noteId!);
+
+			if (noteIds.length > 0) {
+				const notes = await this.notesRepository.findBy({ id: In(noteIds) });
+				this.noteReadService.read(me.id, notes);
+			}
+
+			return await this.notificationEntityService.packGroupedMany(groupedNotifications, me.id);
+		});
+	}
+}

packages/backend/src/server/api/endpoints/i/notifications.ts

@@ -7,7 +7,7 @@ import { Brackets, In } from 'typeorm';
 import * as Redis from 'ioredis';
 import { Inject, Injectable } from '@nestjs/common';
 import type { NotesRepository } from '@/models/_.js';
-import { obsoleteNotificationTypes, notificationTypes } from '@/types.js';
+import { obsoleteNotificationTypes, notificationTypes, FilterUnionByProperty } from '@/types.js';
 import { Endpoint } from '@/server/api/endpoint-base.js';
 import { NoteReadService } from '@/core/NoteReadService.js';
 import { NotificationEntityService } from '@/core/entities/NotificationEntityService.js';
@@ -113,8 +113,8 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 			}
 
 			const noteIds = notifications
-				.filter(notification => ['mention', 'reply', 'quote'].includes(notification.type))
-				.map(notification => notification.noteId!);
+				.filter((notification): notification is FilterUnionByProperty<MiNotification, 'type', 'mention' | 'reply' | 'quote'> => ['mention', 'reply', 'quote'].includes(notification.type))
+				.map(notification => notification.noteId);
 
 			if (noteIds.length > 0) {
 				const notes = await this.notesRepository.findBy({ id: In(noteIds) });

packages/backend/src/server/api/endpoints/notifications/create.ts

@@ -42,8 +42,8 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 			this.notificationService.createNotification(user.id, 'app', {
 				appAccessTokenId: token ? token.id : null,
 				customBody: ps.body,
-				customHeader: ps.header ?? token?.name,
-				customIcon: ps.icon ?? token?.iconUrl,
+				customHeader: ps.header ?? token?.name ?? null,
+				customIcon: ps.icon ?? token?.iconUrl ?? null,
 			});
 		});
 	}