import InteropService from '../../services/interop/InteropService'; import { CustomExportContext, CustomImportContext, ExportModuleOutputFormat, ModuleType } from '../../services/interop/types'; import shim from '../../shim'; import { fileContentEqual, setupDatabaseAndSynchronizer, switchClient, checkThrowAsync, exportDir, supportDir } from '../../testing/test-utils'; import Folder from '../../models/Folder'; import Note from '../../models/Note'; import Tag from '../../models/Tag'; import Resource from '../../models/Resource'; import * as fs from 'fs-extra'; import { FolderEntity, NoteEntity, ResourceEntity } from '../database/types'; import { ModelType } from '../../BaseModel'; import * as ArrayUtils from '../../ArrayUtils'; import InteropService_Importer_Custom from './InteropService_Importer_Custom'; import InteropService_Exporter_Custom from './InteropService_Exporter_Custom'; import Module, { makeExportModule, makeImportModule } from './Module'; async function recreateExportDir() { const dir = exportDir(); await fs.remove(dir); await fs.mkdirp(dir); } // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied function fieldsEqual(model1: any, model2: any, fieldNames: string[]) { for (let i = 0; i < fieldNames.length; i++) { const f = fieldNames[i]; expect(model1[f]).toBe(model2[f]); } } function memoryExportModule() { interface Item { type: number; // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied object: any; } interface Resource { filePath: string; object: ResourceEntity; } interface Result { destPath: string; items: Item[]; resources: Resource[]; } const result: Result = { destPath: '', items: [], resources: [], }; const module: Module = makeExportModule({ description: 'Memory Export Module', format: ExportModuleOutputFormat.Memory, fileExtensions: ['memory'], }, () => { return new InteropService_Exporter_Custom({ onInit: async (context: CustomExportContext) => { result.destPath = context.destPath; }, // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied onProcessItem: async (_context: CustomExportContext, itemType: number, item: any) => { result.items.push({ type: itemType, object: item, }); }, // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied onProcessResource: async (_context: CustomExportContext, resource: any, filePath: string) => { result.resources.push({ filePath: filePath, object: resource, }); }, onClose: async (_context: CustomExportContext) => { // nothing }, }); }); return { result, module }; } describe('services_InteropService', () => { beforeEach(async () => { await setupDatabaseAndSynchronizer(1); await switchClient(1); await recreateExportDir(); }); it('should export and import folders', (async () => { const service = InteropService.instance(); let folder1 = await Folder.save({ title: 'folder1' }); folder1 = await Folder.load(folder1.id); const filePath = `${exportDir()}/test.jex`; await service.export({ path: filePath }); await Folder.delete(folder1.id); await service.import({ path: filePath }); // Check that a new folder, with a new ID, has been created expect(await Folder.count()).toBe(1); const folder2 = (await Folder.all())[0]; expect(folder2.id).not.toBe(folder1.id); expect(folder2.title).toBe(folder1.title); await service.import({ path: filePath }); // As there was already a folder with the same title, check that the new one has been renamed await Folder.delete(folder2.id); const folder3 = (await Folder.all())[0]; expect(await Folder.count()).toBe(1); expect(folder3.title).not.toBe(folder2.title); let fieldNames = Folder.fieldNames(); fieldNames = ArrayUtils.removeElement(fieldNames, 'id'); fieldNames = ArrayUtils.removeElement(fieldNames, 'title'); fieldsEqual(folder3, folder1, fieldNames); })); it('should import folders and de-duplicate titles when needed', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder' }); const folder2 = await Folder.save({ title: 'folder' }); const filePath = `${exportDir()}/test.jex`; await service.export({ path: filePath }); await Folder.delete(folder1.id); await Folder.delete(folder2.id); await service.import({ path: filePath }); const allFolders = await Folder.all(); // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied expect(allFolders.map((f: any) => f.title).sort().join(' - ')).toBe('folder - folder (1)'); })); it('should import folders, and only de-duplicate titles when needed', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder1' }); const folder2 = await Folder.save({ title: 'folder2' }); await Folder.save({ title: 'Sub', parent_id: folder1.id }); await Folder.save({ title: 'Sub', parent_id: folder2.id }); const filePath = `${exportDir()}/test.jex`; await service.export({ path: filePath }); await Folder.delete(folder1.id); await Folder.delete(folder2.id); await service.import({ path: filePath }); const importedFolder1 = await Folder.loadByTitle('folder1'); const importedFolder2 = await Folder.loadByTitle('folder2'); const importedSub1 = await Folder.load((await Folder.childrenIds(importedFolder1.id))[0]); const importedSub2 = await Folder.load((await Folder.childrenIds(importedFolder2.id))[0]); expect(importedSub1.title).toBe('Sub'); expect(importedSub2.title).toBe('Sub'); })); it('should export and import folders and notes', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder1' }); let note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); note1 = await Note.load(note1.id); const filePath = `${exportDir()}/test.jex`; await service.export({ path: filePath }); await Folder.delete(folder1.id); await Note.delete(note1.id); await service.import({ path: filePath }); expect(await Note.count()).toBe(1); let note2 = (await Note.all())[0]; const folder2 = (await Folder.all())[0]; expect(note1.parent_id).not.toBe(note2.parent_id); expect(note1.id).not.toBe(note2.id); expect(note2.parent_id).toBe(folder2.id); let fieldNames = Note.fieldNames(); fieldNames = ArrayUtils.removeElement(fieldNames, 'id'); fieldNames = ArrayUtils.removeElement(fieldNames, 'parent_id'); fieldsEqual(note1, note2, fieldNames); await service.import({ path: filePath }); note2 = (await Note.all())[0]; const note3 = (await Note.all())[1]; expect(note2.id).not.toBe(note3.id); expect(note2.parent_id).not.toBe(note3.parent_id); fieldsEqual(note2, note3, fieldNames); })); it('should export and import notes to specific folder', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder1' }); let note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); note1 = await Note.load(note1.id); const filePath = `${exportDir()}/test.jex`; await service.export({ path: filePath }); await Note.delete(note1.id); await service.import({ path: filePath, destinationFolderId: folder1.id }); expect(await Note.count()).toBe(1); expect(await Folder.count()).toBe(1); expect(await checkThrowAsync(async () => await service.import({ path: filePath, destinationFolderId: 'oops' }))).toBe(true); })); it('should export and import tags', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); const note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); let tag1 = await Tag.save({ title: 'mon tag' }); tag1 = await Tag.load(tag1.id); await Tag.addNote(tag1.id, note1.id); await service.export({ path: filePath }); await Folder.delete(folder1.id); await Note.delete(note1.id); await Tag.delete(tag1.id); await service.import({ path: filePath }); expect(await Tag.count()).toBe(1); const tag2 = (await Tag.all())[0]; const note2 = (await Note.all())[0]; expect(tag1.id).not.toBe(tag2.id); let fieldNames = Note.fieldNames(); fieldNames = ArrayUtils.removeElement(fieldNames, 'id'); fieldsEqual(tag1, tag2, fieldNames); let noteIds = await Tag.noteIds(tag2.id); expect(noteIds.length).toBe(1); expect(noteIds[0]).toBe(note2.id); await service.import({ path: filePath }); // If importing again, no new tag should be created as one with // the same name already existed. The newly imported note should // however go under that already existing tag. expect(await Tag.count()).toBe(1); noteIds = await Tag.noteIds(tag2.id); expect(noteIds.length).toBe(2); })); it('should export and import resources', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); let note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); await shim.attachFileToNote(note1, `${supportDir}/photo.jpg`); note1 = await Note.load(note1.id); let resourceIds = await Note.linkedResourceIds(note1.body); const resource1 = await Resource.load(resourceIds[0]); await service.export({ path: filePath }); await Note.delete(note1.id); await service.import({ path: filePath }); expect(await Resource.count()).toBe(2); const note2 = (await Note.all())[0]; expect(note2.body).not.toBe(note1.body); resourceIds = await Note.linkedResourceIds(note2.body); expect(resourceIds.length).toBe(1); const resource2 = await Resource.load(resourceIds[0]); expect(resource2.id).not.toBe(resource1.id); let fieldNames = Note.fieldNames(); fieldNames = ArrayUtils.removeElement(fieldNames, 'id'); fieldsEqual(resource1, resource2, fieldNames); const resourcePath1 = Resource.fullPath(resource1); const resourcePath2 = Resource.fullPath(resource2); expect(resourcePath1).not.toBe(resourcePath2); expect(fileContentEqual(resourcePath1, resourcePath2)).toBe(true); })); it('should export and import single notes', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); const note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); await service.export({ path: filePath, sourceNoteIds: [note1.id] }); await Note.delete(note1.id); await Folder.delete(folder1.id); await service.import({ path: filePath }); expect(await Note.count()).toBe(1); expect(await Folder.count()).toBe(1); const folder2 = (await Folder.all())[0]; expect(folder2.title).toBe('test'); })); it('should export and import single folders', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); const note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); await service.export({ path: filePath, sourceFolderIds: [folder1.id] }); await Note.delete(note1.id); await Folder.delete(folder1.id); await service.import({ path: filePath }); expect(await Note.count()).toBe(1); expect(await Folder.count()).toBe(1); const folder2 = (await Folder.all())[0]; expect(folder2.title).toBe('folder1'); })); it('should export and import folder and its sub-folders', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); const folder2 = await Folder.save({ title: 'folder2', parent_id: folder1.id }); const folder3 = await Folder.save({ title: 'folder3', parent_id: folder2.id }); const folder4 = await Folder.save({ title: 'folder4', parent_id: folder2.id }); const note1 = await Note.save({ title: 'ma note', parent_id: folder4.id }); await service.export({ path: filePath, sourceFolderIds: [folder1.id] }); await Note.delete(note1.id); await Folder.delete(folder1.id); await Folder.delete(folder2.id); await Folder.delete(folder3.id); await Folder.delete(folder4.id); await service.import({ path: filePath }); expect(await Note.count()).toBe(1); expect(await Folder.count()).toBe(4); const folder1_2 = await Folder.loadByTitle('folder1'); const folder2_2 = await Folder.loadByTitle('folder2'); const folder3_2 = await Folder.loadByTitle('folder3'); const folder4_2 = await Folder.loadByTitle('folder4'); const note1_2 = await Note.loadByTitle('ma note'); expect(folder2_2.parent_id).toBe(folder1_2.id); expect(folder3_2.parent_id).toBe(folder2_2.id); expect(folder4_2.parent_id).toBe(folder2_2.id); expect(note1_2.parent_id).toBe(folder4_2.id); })); it('should export and import links to notes', (async () => { const service = InteropService.instance(); const filePath = `${exportDir()}/test.jex`; const folder1 = await Folder.save({ title: 'folder1' }); const note1 = await Note.save({ title: 'ma note', parent_id: folder1.id }); const note2 = await Note.save({ title: 'ma deuxième note', body: `Lien vers première note : ${Note.markdownTag(note1)}`, parent_id: folder1.id }); await service.export({ path: filePath, sourceFolderIds: [folder1.id] }); await Note.delete(note1.id); await Note.delete(note2.id); await Folder.delete(folder1.id); await service.import({ path: filePath }); expect(await Note.count()).toBe(2); expect(await Folder.count()).toBe(1); const note1_2 = await Note.loadByTitle('ma note'); const note2_2 = await Note.loadByTitle('ma deuxième note'); expect(note2_2.body.indexOf(note1_2.id) >= 0).toBe(true); })); it('should export selected notes in md format', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder1' }); let note11 = await Note.save({ title: 'title note11', parent_id: folder1.id }); note11 = await Note.load(note11.id); const note12 = await Note.save({ title: 'title note12', parent_id: folder1.id }); await Note.load(note12.id); let folder2 = await Folder.save({ title: 'folder2', parent_id: folder1.id }); folder2 = await Folder.load(folder2.id); let note21 = await Note.save({ title: 'title note21', parent_id: folder2.id }); note21 = await Note.load(note21.id); await Folder.save({ title: 'folder3', parent_id: folder1.id }); await Folder.load(folder2.id); const outDir = exportDir(); await service.export({ path: outDir, format: ExportModuleOutputFormat.Markdown, sourceNoteIds: [note11.id, note21.id] }); // verify that the md files exist expect(await shim.fsDriver().exists(`${outDir}/folder1`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/title note11.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/title note12.md`)).toBe(false); expect(await shim.fsDriver().exists(`${outDir}/folder1/folder2`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/folder2/title note21.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder3`)).toBe(false); })); it('should export MD with unicode filenames', (async () => { const service = InteropService.instance(); const folder1 = await Folder.save({ title: 'folder1' }); const folder2 = await Folder.save({ title: 'ジョプリン' }); await Note.save({ title: '生活', parent_id: folder1.id }); await Note.save({ title: '生活', parent_id: folder1.id }); await Note.save({ title: '生活', parent_id: folder1.id }); await Note.save({ title: '', parent_id: folder1.id }); await Note.save({ title: '', parent_id: folder1.id }); await Note.save({ title: 'salut, ça roule ?', parent_id: folder1.id }); await Note.save({ title: 'ジョプリン', parent_id: folder2.id }); const outDir = exportDir(); await service.export({ path: outDir, format: ExportModuleOutputFormat.Markdown }); expect(await shim.fsDriver().exists(`${outDir}/folder1/生活.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/生活-1.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/生活-2.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/Untitled.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/Untitled-1.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/folder1/salut, ça roule _.md`)).toBe(true); expect(await shim.fsDriver().exists(`${outDir}/ジョプリン/ジョプリン.md`)).toBe(true); })); it('should export a notebook as MD', (async () => { const folder1 = await Folder.save({ title: 'testexportfolder' }); await Note.save({ title: 'textexportnote1', parent_id: folder1.id }); await Note.save({ title: 'textexportnote2', parent_id: folder1.id }); const service = InteropService.instance(); await service.export({ path: exportDir(), format: ExportModuleOutputFormat.Markdown, sourceFolderIds: [folder1.id], }); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote1.md`)).toBe(true); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote2.md`)).toBe(true); })); it('should export conflict notes', (async () => { const folder1 = await Folder.save({ title: 'testexportfolder' }); await Note.save({ title: 'textexportnote1', parent_id: folder1.id, is_conflict: 1 }); await Note.save({ title: 'textexportnote2', parent_id: folder1.id }); const service = InteropService.instance(); await service.export({ path: exportDir(), format: ExportModuleOutputFormat.Markdown, sourceFolderIds: [folder1.id], includeConflicts: false, }); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote1.md`)).toBe(false); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote2.md`)).toBe(true); await recreateExportDir(); await service.export({ path: exportDir(), format: ExportModuleOutputFormat.Markdown, sourceFolderIds: [folder1.id], includeConflicts: true, }); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote1.md`)).toBe(true); expect(await shim.fsDriver().exists(`${exportDir()}/testexportfolder/textexportnote2.md`)).toBe(true); })); it('should not try to export folders with a non-existing parent', (async () => { // Handles and edge case where user has a folder but this folder with a parent // that doesn't exist. Can happen for example in this case: // // - folder1/folder2 // - Client 1 sync folder2, but not folder1 // - Client 2 sync and get folder2 only // - Client 2 export data // => Crash if we don't handle this case await Folder.save({ title: 'orphan', parent_id: '0c5bbd8a1b5a48189484a412a7e534cc' }); const service = InteropService.instance(); const result = await service.export({ path: exportDir(), format: ExportModuleOutputFormat.Markdown, }); expect(result.warnings.length).toBe(0); })); it('should not export certain note properties', (async () => { const folder = await Folder.save({ title: 'folder', share_id: 'some_id', is_shared: 1 }); let note = await Note.save({ title: 'note', is_shared: 1, share_id: 'someid', parent_id: folder.id }); note = await shim.attachFileToNote(note, `${supportDir}/photo.jpg`); const resourceId = (await Note.linkedResourceIds(note.body))[0]; await Resource.save({ id: resourceId, share_id: 'some_id', is_shared: 1 }); const service = InteropService.instance(); const { result, module } = memoryExportModule(); service.registerModule(module); await service.export({ format: ExportModuleOutputFormat.Memory, }); const exportedNote = (result.items.find(i => i.type === ModelType.Note)).object as NoteEntity; expect(exportedNote.share_id).toBe(''); expect(exportedNote.is_shared).toBe(0); const exportedFolder = (result.items.find(i => i.type === ModelType.Folder)).object as FolderEntity; expect(exportedFolder.share_id).toBe(''); expect(exportedFolder.is_shared).toBe(0); const exportedResource = (result.items.find(i => i.type === ModelType.Resource)).object as ResourceEntity; expect(exportedResource.share_id).toBe(''); expect(exportedResource.is_shared).toBe(0); })); it('should allow registering new import modules', (async () => { const testImportFilePath = `${exportDir()}/testImport${Math.random()}.test`; await shim.fsDriver().writeFile(testImportFilePath, 'test', 'utf8'); const result = { hasBeenExecuted: false, sourcePath: '', }; const module = makeImportModule({ type: ModuleType.Importer, description: 'Test Import Module', format: 'testing', fileExtensions: ['test'], }, () => { return new InteropService_Importer_Custom({ onExec: async (context: CustomImportContext) => { result.hasBeenExecuted = true; result.sourcePath = context.sourcePath; }, }); }); const service = InteropService.instance(); service.registerModule(module); await service.import({ format: 'testing', path: testImportFilePath, }); expect(result.hasBeenExecuted).toBe(true); expect(result.sourcePath).toBe(testImportFilePath); })); it('should allow registering new export modules', (async () => { const folder1 = await Folder.save({ title: 'folder1' }); const note1 = await Note.save({ title: 'note1', parent_id: folder1.id }); await Note.save({ title: 'note2', parent_id: folder1.id }); await shim.attachFileToNote(note1, `${supportDir}/photo.jpg`); const filePath = `${exportDir()}/example.test`; // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied const result: any = { destPath: '', itemTypes: [], items: [], resources: [], filePaths: [], closeCalled: false, }; const module: Module = makeExportModule({ type: ModuleType.Exporter, description: 'Test Export Module', // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied format: 'testing' as any, fileExtensions: ['test'], }, () => { return new InteropService_Exporter_Custom({ onInit: async (context: CustomExportContext) => { result.destPath = context.destPath; }, // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied onProcessItem: async (_context: CustomExportContext, itemType: number, item: any) => { result.itemTypes.push(itemType); result.items.push(item); }, // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied onProcessResource: async (_context: CustomExportContext, resource: any, filePath: string) => { result.resources.push(resource); result.filePaths.push(filePath); }, onClose: async (_context: CustomExportContext) => { result.closeCalled = true; }, }); }); const service = InteropService.instance(); service.registerModule(module); await service.export({ // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied format: 'testing' as any, path: filePath, }); expect(result.destPath).toBe(filePath); expect(result.itemTypes.sort().join('_')).toBe('1_1_2_4'); expect(result.items.length).toBe(4); // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied expect(result.items.map((o: any) => o.title).sort().join('_')).toBe('folder1_note1_note2_photo.jpg'); expect(result.resources.length).toBe(1); expect(result.resources[0].title).toBe('photo.jpg'); expect(result.filePaths.length).toBe(1); expect(!!result.filePaths[0]).toBe(true); expect(result.closeCalled).toBe(true); })); });