2020-11-08 18:46:48 +02:00
import time from '@joplin/lib/time' ;
import NoteResource from '@joplin/lib/models/NoteResource' ;
import ResourceService from '@joplin/lib/services/ResourceService' ;
import shim from '@joplin/lib/shim' ;
2019-07-30 09:35:42 +02:00
2020-12-01 20:05:24 +02:00
const { resourceService , decryptionWorker , encryptionService , loadEncryptionMasterKey , allSyncTargetItemsEncrypted , setupDatabaseAndSynchronizer , db , synchronizer , switchClient } = require ( './test-utils.js' ) ;
2021-01-22 19:41:11 +02:00
import Folder from '@joplin/lib/models/Folder' ;
import Note from '@joplin/lib/models/Note' ;
import Resource from '@joplin/lib/models/Resource' ;
import SearchEngine from '@joplin/lib/services/searchengine/SearchEngine' ;
2018-03-15 20:08:46 +02:00
describe ( 'services_ResourceService' , function ( ) {
beforeEach ( async ( done ) = > {
await setupDatabaseAndSynchronizer ( 1 ) ;
2019-04-21 14:49:40 +02:00
await setupDatabaseAndSynchronizer ( 2 ) ;
2018-03-15 20:08:46 +02:00
await switchClient ( 1 ) ;
done ( ) ;
} ) ;
2020-12-01 20:05:24 +02:00
it ( 'should delete orphaned resources' , ( async ( ) = > {
2018-03-15 20:08:46 +02:00
const service = new ResourceService ( ) ;
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
2018-03-15 20:08:46 +02:00
let note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
2019-09-19 23:51:18 +02:00
note1 = await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2020-03-14 01:46:14 +02:00
const resource1 = ( await Resource . all ( ) ) [ 0 ] ;
2018-03-15 20:08:46 +02:00
const resourcePath = Resource . fullPath ( resource1 ) ;
await service . indexNoteResources ( ) ;
await service . deleteOrphanResources ( 0 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( true ) ;
await Note . delete ( note1 . id ) ;
await service . deleteOrphanResources ( 0 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( true ) ;
await service . indexNoteResources ( ) ;
await service . deleteOrphanResources ( 1000 * 60 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( true ) ;
await service . deleteOrphanResources ( 0 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( false ) ;
expect ( await shim . fsDriver ( ) . exists ( resourcePath ) ) . toBe ( false ) ;
2018-03-16 19:39:44 +02:00
expect ( ! ( await NoteResource . all ( ) ) . length ) . toBe ( true ) ;
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should not delete resource if still associated with at least one note' , ( async ( ) = > {
2018-03-16 19:39:44 +02:00
const service = new ResourceService ( ) ;
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
2018-03-16 19:39:44 +02:00
let note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
2020-03-14 01:46:14 +02:00
const note2 = await Note . save ( { title : 'ma deuxième note' , parent_id : folder1.id } ) ;
2019-09-19 23:51:18 +02:00
note1 = await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2020-03-14 01:46:14 +02:00
const resource1 = ( await Resource . all ( ) ) [ 0 ] ;
2018-03-16 19:39:44 +02:00
await service . indexNoteResources ( ) ;
await Note . delete ( note1 . id ) ;
2019-07-30 09:35:42 +02:00
2018-03-16 19:39:44 +02:00
await service . indexNoteResources ( ) ;
2019-07-30 09:35:42 +02:00
2018-03-16 19:39:44 +02:00
await Note . save ( { id : note2.id , body : Resource.markdownTag ( resource1 ) } ) ;
await service . indexNoteResources ( ) ;
await service . deleteOrphanResources ( 0 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( true ) ;
2018-03-15 20:08:46 +02:00
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should not delete a resource that has never been associated with any note, because it probably means the resource came via sync, and associated note has not arrived yet' , ( async ( ) = > {
2018-06-17 17:59:06 +02:00
const service = new ResourceService ( ) ;
2020-11-08 18:46:48 +02:00
await shim . createResourceFromPath ( ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2018-06-17 17:59:06 +02:00
await service . indexNoteResources ( ) ;
await service . deleteOrphanResources ( 0 ) ;
expect ( ( await Resource . all ( ) ) . length ) . toBe ( 1 ) ;
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should not delete resource if it is used in an IMG tag' , ( async ( ) = > {
2018-09-30 20:24:02 +02:00
const service = new ResourceService ( ) ;
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
2018-09-30 20:24:02 +02:00
let note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
2019-09-19 23:51:18 +02:00
note1 = await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2020-03-14 01:46:14 +02:00
const resource1 = ( await Resource . all ( ) ) [ 0 ] ;
2018-09-30 20:24:02 +02:00
await service . indexNoteResources ( ) ;
2019-09-19 23:51:18 +02:00
await Note . save ( { id : note1.id , body : ` This is HTML: <img src=":/ ${ resource1 . id } "/> ` } ) ;
2019-07-30 09:35:42 +02:00
2018-09-30 20:24:02 +02:00
await service . indexNoteResources ( ) ;
2019-07-30 09:35:42 +02:00
2018-09-30 20:24:02 +02:00
await service . deleteOrphanResources ( 0 ) ;
expect ( ! ! ( await Resource . load ( resource1 . id ) ) ) . toBe ( true ) ;
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should not process twice the same change' , ( async ( ) = > {
2018-12-10 02:39:31 +02:00
const service = new ResourceService ( ) ;
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
2020-11-08 18:46:48 +02:00
const note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2018-12-10 02:39:31 +02:00
await service . indexNoteResources ( ) ;
const before = ( await NoteResource . all ( ) ) [ 0 ] ;
await time . sleep ( 0.1 ) ;
await service . indexNoteResources ( ) ;
const after = ( await NoteResource . all ( ) ) [ 0 ] ;
expect ( before . last_seen_time ) . toBe ( after . last_seen_time ) ;
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should not delete resources that are associated with an encrypted note' , ( async ( ) = > {
2019-04-21 14:49:40 +02:00
// https://github.com/laurent22/joplin/issues/1433
//
// Client 1 and client 2 have E2EE setup.
//
// - Client 1 creates note N1 and add resource R1 to it
// - Client 1 syncs
// - Client 2 syncs and get N1
// - Client 2 add resource R2 to N1
// - Client 2 syncs
// - Client 1 syncs
// - Client 1 runs resource indexer - but because N1 hasn't been decrypted yet, it found that R1 is no longer associated with any note
// - Client 1 decrypts notes, but too late
2019-07-30 09:35:42 +02:00
//
2019-04-21 14:49:40 +02:00
// Eventually R1 is deleted because service thinks that it was at some point associated with a note, but no longer.
const masterKey = await loadEncryptionMasterKey ( ) ;
await encryptionService ( ) . enableEncryption ( masterKey , '123456' ) ;
await encryptionService ( ) . loadMasterKeysFromSettings ( ) ;
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
const note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
2019-09-19 23:51:18 +02:00
await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ; // R1
2019-04-21 14:49:40 +02:00
await resourceService ( ) . indexNoteResources ( ) ;
await synchronizer ( ) . start ( ) ;
expect ( await allSyncTargetItemsEncrypted ( ) ) . toBe ( true ) ;
await switchClient ( 2 ) ;
await synchronizer ( ) . start ( ) ;
await encryptionService ( ) . enableEncryption ( masterKey , '123456' ) ;
await encryptionService ( ) . loadMasterKeysFromSettings ( ) ;
await decryptionWorker ( ) . start ( ) ;
{
const n1 = await Note . load ( note1 . id ) ;
2019-09-19 23:51:18 +02:00
await shim . attachFileToNote ( n1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ; // R2
2019-04-21 14:49:40 +02:00
}
await synchronizer ( ) . start ( ) ;
await switchClient ( 1 ) ;
await synchronizer ( ) . start ( ) ;
await resourceService ( ) . indexNoteResources ( ) ;
await resourceService ( ) . deleteOrphanResources ( 0 ) ; // Previously, R1 would be deleted here because it's not indexed
expect ( ( await Resource . all ( ) ) . length ) . toBe ( 2 ) ;
} ) ) ;
2020-12-01 20:05:24 +02:00
it ( 'should double-check if the resource is still linked before deleting it' , ( async ( ) = > {
2019-04-21 14:49:40 +02:00
SearchEngine . instance ( ) . setDb ( db ( ) ) ; // /!\ Note that we use the global search engine here, which we shouldn't but will work for now
2020-03-14 01:46:14 +02:00
const folder1 = await Folder . save ( { title : 'folder1' } ) ;
2019-04-21 14:49:40 +02:00
let note1 = await Note . save ( { title : 'ma note' , parent_id : folder1.id } ) ;
2019-09-19 23:51:18 +02:00
note1 = await shim . attachFileToNote ( note1 , ` ${ __dirname } /../tests/support/photo.jpg ` ) ;
2019-04-21 14:49:40 +02:00
await resourceService ( ) . indexNoteResources ( ) ;
const bodyWithResource = note1 . body ;
await Note . save ( { id : note1.id , body : '' } ) ;
await resourceService ( ) . indexNoteResources ( ) ;
await Note . save ( { id : note1.id , body : bodyWithResource } ) ;
await SearchEngine . instance ( ) . syncTables ( ) ;
await resourceService ( ) . deleteOrphanResources ( 0 ) ;
expect ( ( await Resource . all ( ) ) . length ) . toBe ( 1 ) ; // It should not have deleted the resource
const nr = ( await NoteResource . all ( ) ) [ 0 ] ;
expect ( ! ! nr . is_associated ) . toBe ( true ) ; // And it should have fixed the situation by re-indexing the note content
} ) ) ;
2020-12-01 20:05:24 +02:00
// it('should auto-delete resource even if the associated note was deleted immediately', (async () => {
2020-11-08 18:46:48 +02:00
// // Previoulsy, when a resource was be attached to a note, then the
// // note was immediately deleted, the ResourceService would not have
// // time to quick in an index the resource/note relation. It means
// // that when doing the orphan resource deletion job, those
// // resources would permanently stay behing.
// // https://github.com/laurent22/joplin/issues/932
// const service = new ResourceService();
// let note = await Note.save({});
// note = await shim.attachFileToNote(note, `${__dirname}/../tests/support/photo.jpg`);
// const resource = (await Resource.all())[0];
// const noteIds = await NoteResource.associatedNoteIds(resource.id);
// expect(noteIds[0]).toBe(note.id);
// await Note.save({ id: note.id, body: '' });
// await resourceService().indexNoteResources();
// await service.deleteOrphanResources(0);
// expect((await Resource.all()).length).toBe(0);
// }));
2019-07-30 09:35:42 +02:00
} ) ;