chore: Convert Importer classes to typescript

apps/meteor/app/api/server/v1/import.ts

@@ -10,10 +10,13 @@ import {
 	isDownloadPendingFilesParamsPOST,
 	isDownloadPendingAvatarsParamsPOST,
 	isGetCurrentImportOperationParamsGET,
+	isImportersListParamsGET,
 	isImportAddUsersParamsPOST,
 } from '@rocket.chat/rest-typings';
 import { Meteor } from 'meteor/meteor';
 
+import { PendingAvatarImporter } from '../../../importer-pending-avatars/server/PendingAvatarImporter';
+import { PendingFileImporter } from '../../../importer-pending-files/server/PendingFileImporter';
 import { Importers } from '../../../importer/server';
 import {
 	executeUploadImportFile,
@@ -136,9 +139,8 @@ API.v1.addRoute(
 			}
 
 			const operation = await Import.newOperation(this.userId, importer.name, importer.key);
-
-			importer.instance = new importer.importer(importer, operation); // eslint-disable-line new-cap
-			const count = await importer.instance.prepareFileCount();
+			const instance = new PendingFileImporter(importer, operation);
+			const count = await instance.prepareFileCount();
 
 			return API.v1.success({
 				count,
@@ -162,8 +164,8 @@ API.v1.addRoute(
 			}
 
 			const operation = await Import.newOperation(this.userId, importer.name, importer.key);
-			importer.instance = new importer.importer(importer, operation); // eslint-disable-line new-cap
-			const count = await importer.instance.prepareFileCount();
+			const instance = new PendingAvatarImporter(importer, operation);
+			const count = await instance.prepareFileCount();
 
 			return API.v1.success({
 				count,
@@ -189,6 +191,22 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'importers.list',
+	{
+		authRequired: true,
+		validateParams: isImportersListParamsGET,
+		permissionsRequired: ['run-import'],
+	},
+	{
+		async get() {
+			const importers = Importers.getAllVisible().map(({ key, name }) => ({ key, name }));
+
+			return API.v1.success(importers);
+		},
+	},
+);
+
 API.v1.addRoute(
 	'import.clear',
 	{

apps/meteor/app/importer-csv/server/importer.js → apps/meteor/app/importer-csv/server/CsvImporter.ts

@@ -1,18 +1,23 @@
+import type { IImport } from '@rocket.chat/core-typings';
 import { Settings, Users } from '@rocket.chat/models';
 import { Random } from '@rocket.chat/random';
+import { parse } from 'csv-parse/lib/sync';
 
-import { Base, ProgressStep, ImporterWebsocket } from '../../importer/server';
+import { Importer, ProgressStep, ImporterWebsocket } from '../../importer/server';
+import type { IConverterOptions } from '../../importer/server/classes/ImportDataConverter';
+import type { ImporterProgress } from '../../importer/server/classes/ImporterProgress';
+import type { ImporterInfo } from '../../importer/server/definitions/ImporterInfo';
 
-export class CsvImporter extends Base {
-	constructor(info, importRecord, converterOptions = {}) {
-		super(info, importRecord, converterOptions);
+export class CsvImporter extends Importer {
+	private csvParser: (csv: string) => string[];
 
-		const { parse } = require('csv-parse/lib/sync');
+	constructor(info: ImporterInfo, importRecord: IImport, converterOptions: IConverterOptions = {}) {
+		super(info, importRecord, converterOptions);
 
 		this.csvParser = parse;
 	}
 
-	async prepareUsingLocalFile(fullFilePath) {
+	async prepareUsingLocalFile(fullFilePath: string): Promise<ImporterProgress> {
 		this.logger.debug('start preparing import operation');
 		await this.converter.clearImportData();
 
@@ -40,17 +45,21 @@ export class CsvImporter extends Base {
 		let messagesCount = 0;
 		let usersCount = 0;
 		let channelsCount = 0;
-		const dmRooms = new Map();
-		const roomIds = new Map();
-		const usedUsernames = new Set();
-		const availableUsernames = new Set();
-
-		const getRoomId = (roomName) => {
-			if (!roomIds.has(roomName)) {
-				roomIds.set(roomName, Random.id());
+		const dmRooms = new Set<string>();
+		const roomIds = new Map<string, string>();
+		const usedUsernames = new Set<string>();
+		const availableUsernames = new Set<string>();
+
+		const getRoomId = (roomName: string) => {
+			const roomId = roomIds.get(roomName);
+
+			if (roomId === undefined) {
+				const fallbackRoomId = Random.id();
+				roomIds.set(roomName, fallbackRoomId);
+				return fallbackRoomId;
 			}
 
-			return roomIds.get(roomName);
+			return roomId;
 		};
 
 		for await (const entry of zip.getEntries()) {
@@ -149,7 +158,7 @@ export class CsvImporter extends Base {
 					continue;
 				}
 
-				let data;
+				let data: { username: string; ts: string; text: string; otherUsername?: string; isDirect?: true }[];
 				const msgGroupData = item[1].split('.')[0]; // messages
 				let isDirect = false;
 
@@ -173,6 +182,10 @@ export class CsvImporter extends Base {
 
 				if (isDirect) {
 					for await (const msg of data) {
+						if (!msg.otherUsername) {
+							continue;
+						}
+
 						const sourceId = [msg.username, msg.otherUsername].sort().join('/');
 
 						if (!dmRooms.has(sourceId)) {
@@ -182,7 +195,7 @@ export class CsvImporter extends Base {
 								t: 'd',
 							});
 
-							dmRooms.set(sourceId, true);
+							dmRooms.add(sourceId);
 						}
 
 						const newMessage = {
@@ -217,8 +230,6 @@ export class CsvImporter extends Base {
 				}
 
 				await super.updateRecord({ 'count.messages': messagesCount, 'messagesstatus': null });
-				increaseProgressCount();
-				continue;
 			}
 
 			increaseProgressCount();

apps/meteor/app/importer-csv/server/index.ts

@@ -1,5 +1,8 @@
 import { Importers } from '../../importer/server';
-import { CsvImporterInfo } from '../lib/info';
-import { CsvImporter } from './importer';
+import { CsvImporter } from './CsvImporter';
 
-Importers.add(new CsvImporterInfo(), CsvImporter);
+Importers.add({
+	key: 'csv',
+	name: 'CSV',
+	importer: CsvImporter,
+});

apps/meteor/app/importer-hipchat-enterprise/server/importer.js → apps/meteor/app/importer-hipchat-enterprise/server/HipChatEnterpriseImporter.js

@@ -5,9 +5,10 @@ import { Readable } from 'stream';
 import { Settings } from '@rocket.chat/models';
 import { Meteor } from 'meteor/meteor';
 
-import { Base, ProgressStep } from '../../importer/server';
+import { Importer, ProgressStep } from '../../importer/server';
 
-export class HipChatEnterpriseImporter extends Base {
+/** @deprecated HipChat was discontinued at 2019-02-15 */
+export class HipChatEnterpriseImporter extends Importer {
 	constructor(info, importRecord, converterOptions = {}) {
 		super(info, importRecord, converterOptions);
 

apps/meteor/app/importer-hipchat-enterprise/server/index.ts

@@ -1,5 +1,8 @@
 import { Importers } from '../../importer/server';
-import { HipChatEnterpriseImporterInfo } from '../lib/info';
-import { HipChatEnterpriseImporter } from './importer';
+import { HipChatEnterpriseImporter } from './HipChatEnterpriseImporter';
 
-Importers.add(new HipChatEnterpriseImporterInfo(), HipChatEnterpriseImporter);
+Importers.add({
+	key: 'hipchatenterprise',
+	name: 'HipChat (tar.gz)',
+	importer: HipChatEnterpriseImporter,
+});

apps/meteor/app/importer-pending-avatars/server/importer.js → apps/meteor/app/importer-pending-avatars/server/PendingAvatarImporter.ts

@@ -1,14 +1,15 @@
 import { Users } from '@rocket.chat/models';
 
-import { Base, ProgressStep, Selection } from '../../importer/server';
+import { Importer, ProgressStep, Selection } from '../../importer/server';
+import type { ImporterProgress } from '../../importer/server/classes/ImporterProgress';
 import { setAvatarFromServiceWithValidation } from '../../lib/server/functions/setUserAvatar';
 
-export class PendingAvatarImporter extends Base {
+export class PendingAvatarImporter extends Importer {
 	async prepareFileCount() {
 		this.logger.debug('start preparing import operation');
 		await super.updateProgress(ProgressStep.PREPARING_STARTED);
 
-		const users = await Users.findAllUsersWithPendingAvatar();
+		const users = Users.findAllUsersWithPendingAvatar();
 		const fileCount = await users.count();
 
 		if (fileCount === 0) {
@@ -19,26 +20,26 @@ export class PendingAvatarImporter extends Base {
 		await this.updateRecord({ 'count.messages': fileCount, 'messagesstatus': null });
 		await this.addCountToTotal(fileCount);
 
-		const fileData = new Selection(this.name, [], [], fileCount);
+		const fileData = new Selection(this.info.name, [], [], fileCount);
 		await this.updateRecord({ fileData });
 
 		await super.updateProgress(ProgressStep.IMPORTING_FILES);
 		setImmediate(() => {
-			this.startImport(fileData);
+			void this.startImport(fileData);
 		});
 
 		return fileCount;
 	}
 
-	async startImport() {
-		const pendingFileUserList = await Users.findAllUsersWithPendingAvatar();
+	async startImport(importSelection: Selection): Promise<ImporterProgress> {
+		const pendingFileUserList = Users.findAllUsersWithPendingAvatar();
 		try {
 			for await (const user of pendingFileUserList) {
 				try {
 					const { _pendingAvatarUrl: url, name, _id } = user;
 
 					try {
-						if (!url || !url.startsWith('http')) {
+						if (!url?.startsWith('http')) {
 							continue;
 						}
 
@@ -57,9 +58,9 @@ export class PendingAvatarImporter extends Base {
 			}
 		} catch (error) {
 			// If the cursor expired, restart the method
-			if (error && error.codeName === 'CursorNotFound') {
+			if (this.isCursorNotFoundError(error)) {
 				this.logger.info('CursorNotFound');
-				return this.startImport();
+				return this.startImport(importSelection);
 			}
 
 			await super.updateProgress(ProgressStep.ERROR);

apps/meteor/app/importer-pending-avatars/server/index.ts

@@ -1,5 +1,9 @@
 import { Importers } from '../../importer/server';
-import { PendingAvatarImporter } from './importer';
-import { PendingAvatarImporterInfo } from './info';
+import { PendingAvatarImporter } from './PendingAvatarImporter';
 
-Importers.add(new PendingAvatarImporterInfo(), PendingAvatarImporter);
+Importers.add({
+	key: 'pending-avatars',
+	name: 'Pending Avatars',
+	visible: false,
+	importer: PendingAvatarImporter,
+});