feat: make possible to export favorited notes

#9331

packages/backend/src/queue/DbQueueProcessorsService.ts

@@ -2,6 +2,7 @@ import { Inject, Injectable } from '@nestjs/common';
 import type { DbJobData } from '@/queue/types.js';
 import { DI } from '@/di-symbols.js';
 import type { Config } from '@/config.js';
+import { bindThis } from '@/decorators.js';
 import { DeleteDriveFilesProcessorService } from './processors/DeleteDriveFilesProcessorService.js';
 import { ExportCustomEmojisProcessorService } from './processors/ExportCustomEmojisProcessorService.js';
 import { ExportNotesProcessorService } from './processors/ExportNotesProcessorService.js';
@@ -15,8 +16,8 @@ import { ImportBlockingProcessorService } from './processors/ImportBlockingProce
 import { ImportUserListsProcessorService } from './processors/ImportUserListsProcessorService.js';
 import { ImportCustomEmojisProcessorService } from './processors/ImportCustomEmojisProcessorService.js';
 import { DeleteAccountProcessorService } from './processors/DeleteAccountProcessorService.js';
+import { ExportFavoritesProcessorService } from './processors/ExportFavoritesProcessorService.js';
 import type Bull from 'bull';
-import { bindThis } from '@/decorators.js';
 
 @Injectable()
 export class DbQueueProcessorsService {
@@ -27,6 +28,7 @@ export class DbQueueProcessorsService {
 		private deleteDriveFilesProcessorService: DeleteDriveFilesProcessorService,
 		private exportCustomEmojisProcessorService: ExportCustomEmojisProcessorService,
 		private exportNotesProcessorService: ExportNotesProcessorService,
+		private exportFavoritesProcessorService: ExportFavoritesProcessorService,
 		private exportFollowingProcessorService: ExportFollowingProcessorService,
 		private exportMutingProcessorService: ExportMutingProcessorService,
 		private exportBlockingProcessorService: ExportBlockingProcessorService,
@@ -45,6 +47,7 @@ export class DbQueueProcessorsService {
 		q.process('deleteDriveFiles', (job, done) => this.deleteDriveFilesProcessorService.process(job, done));
 		q.process('exportCustomEmojis', (job, done) => this.exportCustomEmojisProcessorService.process(job, done));
 		q.process('exportNotes', (job, done) => this.exportNotesProcessorService.process(job, done));
+		q.process('exportFavorites', (job, done) => this.exportFavoritesProcessorService.process(job, done));
 		q.process('exportFollowing', (job, done) => this.exportFollowingProcessorService.process(job, done));
 		q.process('exportMuting', (job, done) => this.exportMutingProcessorService.process(job, done));
 		q.process('exportBlocking', (job, done) => this.exportBlockingProcessorService.process(job, done));

packages/backend/src/queue/QueueProcessorModule.ts

@@ -30,6 +30,7 @@ import { ImportUserListsProcessorService } from './processors/ImportUserListsPro
 import { ResyncChartsProcessorService } from './processors/ResyncChartsProcessorService.js';
 import { TickChartsProcessorService } from './processors/TickChartsProcessorService.js';
 import { AggregateRetentionProcessorService } from './processors/AggregateRetentionProcessorService.js';
+import { ExportFavoritesProcessorService } from './processors/ExportFavoritesProcessorService.js';
 
 @Module({
 	imports: [
@@ -45,6 +46,7 @@ import { AggregateRetentionProcessorService } from './processors/AggregateRetent
 		DeleteDriveFilesProcessorService,
 		ExportCustomEmojisProcessorService,
 		ExportNotesProcessorService,
+		ExportFavoritesProcessorService,
 		ExportFollowingProcessorService,
 		ExportMutingProcessorService,
 		ExportBlockingProcessorService,

packages/backend/src/queue/processors/ExportFavoritesProcessorService.ts

@@ -0,0 +1,162 @@
+import * as fs from 'node:fs';
+import { Inject, Injectable } from '@nestjs/common';
+import { IsNull, MoreThan } from 'typeorm';
+import { format as dateFormat } from 'date-fns';
+import { DI } from '@/di-symbols.js';
+import type { NoteFavorite, NoteFavoritesRepository, NotesRepository, PollsRepository, User, UsersRepository } from '@/models/index.js';
+import type { Config } from '@/config.js';
+import type Logger from '@/logger.js';
+import { DriveService } from '@/core/DriveService.js';
+import { createTemp } from '@/misc/create-temp.js';
+import type { Poll } from '@/models/entities/Poll.js';
+import type { Note } from '@/models/entities/Note.js';
+import { bindThis } from '@/decorators.js';
+import { QueueLoggerService } from '../QueueLoggerService.js';
+import type Bull from 'bull';
+import type { DbUserJobData } from '../types.js';
+
+@Injectable()
+export class ExportFavoritesProcessorService {
+	private logger: Logger;
+
+	constructor(
+		@Inject(DI.config)
+		private config: Config,
+
+		@Inject(DI.usersRepository)
+		private usersRepository: UsersRepository,
+
+		@Inject(DI.pollsRepository)
+		private pollsRepository: PollsRepository,
+
+		@Inject(DI.notesRepository)
+		private notesRepository: NotesRepository,
+
+		@Inject(DI.noteFavoritesRepository)
+		private noteFavoritesRepository: NoteFavoritesRepository,
+
+		private driveService: DriveService,
+		private queueLoggerService: QueueLoggerService,
+	) {
+		this.logger = this.queueLoggerService.logger.createSubLogger('export-favorites');
+	}
+
+	@bindThis
+	public async process(job: Bull.Job<DbUserJobData>, done: () => void): Promise<void> {
+		this.logger.info(`Exporting favorites of ${job.data.user.id} ...`);
+
+		const user = await this.usersRepository.findOneBy({ id: job.data.user.id });
+		if (user == null) {
+			done();
+			return;
+		}
+
+		// Create temp file
+		const [path, cleanup] = await createTemp();
+
+		this.logger.info(`Temp file is ${path}`);
+
+		try {
+			const stream = fs.createWriteStream(path, { flags: 'a' });
+
+			const write = (text: string): Promise<void> => {
+				return new Promise<void>((res, rej) => {
+					stream.write(text, err => {
+						if (err) {
+							this.logger.error(err);
+							rej(err);
+						} else {
+							res();
+						}
+					});
+				});
+			};
+
+			await write('[');
+
+			let exportedFavoritesCount = 0;
+			let cursor: NoteFavorite['id'] | null = null;
+
+			while (true) {
+				const favorites = await this.noteFavoritesRepository.find({
+					where: {
+						userId: user.id,
+						...(cursor ? { id: MoreThan(cursor) } : {}),
+					},
+					take: 100,
+					order: {
+						id: 1,
+					},
+					relations: ['note', 'note.user'],
+				}) as (NoteFavorite & { note: Note & { user: User } })[];
+
+				if (favorites.length === 0) {
+					job.progress(100);
+					break;
+				}
+
+				cursor = favorites[favorites.length - 1].id;
+
+				for (const favorite of favorites) {
+					let poll: Poll | undefined;
+					if (favorite.note.hasPoll) {
+						poll = await this.pollsRepository.findOneByOrFail({ noteId: favorite.note.id });
+					}
+					const content = JSON.stringify(serialize(favorite, poll));
+					const isFirst = exportedFavoritesCount === 0;
+					await write(isFirst ? content : ',\n' + content);
+					exportedFavoritesCount++;
+				}
+
+				const total = await this.noteFavoritesRepository.countBy({
+					userId: user.id,
+				});
+
+				job.progress(exportedFavoritesCount / total);
+			}
+
+			await write(']');
+
+			stream.end();
+			this.logger.succ(`Exported to: ${path}`);
+
+			const fileName = 'favorites-' + dateFormat(new Date(), 'yyyy-MM-dd-HH-mm-ss') + '.json';
+			const driveFile = await this.driveService.addFile({ user, path, name: fileName, force: true });
+
+			this.logger.succ(`Exported to: ${driveFile.id}`);
+		} finally {
+			cleanup();
+		}
+
+		done();
+	}
+}
+
+function serialize(favorite: NoteFavorite & { note: Note & { user: User } }, poll: Poll | null = null): Record<string, unknown> {
+	return {
+		id: favorite.id,
+		createdAt: favorite.createdAt,
+		note: {
+			id: favorite.note.id,
+			text: favorite.note.text,
+			createdAt: favorite.note.createdAt,
+			fileIds: favorite.note.fileIds,
+			replyId: favorite.note.replyId,
+			renoteId: favorite.note.renoteId,
+			poll: poll,
+			cw: favorite.note.cw,
+			visibility: favorite.note.visibility,
+			visibleUserIds: favorite.note.visibleUserIds,
+			localOnly: favorite.note.localOnly,
+			uri: favorite.note.uri,
+			url: favorite.note.url,
+			user: {
+				id: favorite.note.user.id,
+				name: favorite.note.user.name,
+				username: favorite.note.user.username,
+				host: favorite.note.user.host,
+				uri: favorite.note.user.uri,
+			},
+		},
+	};
+}