import Setting from './Setting';
import BaseModel from '../BaseModel';
import shim from '../shim';
import markdownUtils from '../markdownUtils';
import { sortedIds, createNTestNotes, expectThrow, setupDatabaseAndSynchronizer, switchClient, checkThrowAsync, supportDir, expectNotThrow, simulateReadOnlyShareEnv, msleep, db, encryptionService, revisionService } from '../testing/test-utils';
import Folder from './Folder';
import Note from './Note';
import Tag from './Tag';
import ItemChange from './ItemChange';
import Resource from './Resource';
import { NoteEntity, ResourceEntity } from '../services/database/types';
import { toForwardSlashes } from '../path-utils';
import * as ArrayUtils from '../ArrayUtils';
import { ErrorCode } from '../errors';
import ResourceService from '../services/ResourceService';
import NoteResource from './NoteResource';
import { serializeWhiteboard } from '../services/whiteboard/serialize';
import { Canvas } from '../services/whiteboard/jsoncanvas';
import SearchEngine from '../services/search/SearchEngine';
import { getTrashFolderId } from '../services/trash';
import getConflictFolderId from './utils/getConflictFolderId';
import Revision from './Revision';
import RevisionService from '../services/RevisionService';
import NoteLockKey from '../services/noteLock/NoteLockKey';
import NoteLockSession from '../services/noteLock/NoteLockSession';
import NoteLockService from '../services/noteLock/NoteLockService';
import EncryptionService from '../services/e2ee/EncryptionService';
async function allItems() {
const folders = await Folder.all();
const notes = await Note.all();
return folders.concat(notes);
}
describe('models/Note', () => {
beforeEach(async () => {
await setupDatabaseAndSynchronizer(1);
await switchClient(1);
NoteLockKey.destroyInstance();
NoteLockSession.destroyInstance();
NoteLockService.destroyInstance();
EncryptionService.instance_ = encryptionService();
Setting.setValue('featureFlag.noteLock', true);
});
it('should find resource and note IDs', (async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const note1 = await Note.save({ title: 'ma note', parent_id: folder1.id });
let note2 = await Note.save({ title: 'ma deuxième note', body: `Lien vers première note : ${Note.markdownTag(note1)}`, parent_id: folder1.id });
let items = await Note.linkedItems(note2.body);
expect(items.length).toBe(1);
expect(items[0].id).toBe(note1.id);
await shim.attachFileToNote(note2, `${supportDir}/photo.jpg`);
note2 = await Note.load(note2.id);
items = await Note.linkedItems(note2.body);
expect(items.length).toBe(2);
expect(items[0].type_).toBe(BaseModel.TYPE_NOTE);
expect(items[1].type_).toBe(BaseModel.TYPE_RESOURCE);
const resource2 = await shim.createResourceFromPath(`${supportDir}/photo.jpg`);
const resource3 = await shim.createResourceFromPath(`${supportDir}/photo.jpg`);
note2.body += `
`;
note2.body += `
`;
items = await Note.linkedItems(note2.body);
expect(items.length).toBe(4);
}));
it('should find linked items', (async () => {
const testCases = [
['[](:/06894e83b8f84d3d8cbe0f1587f9e226)', ['06894e83b8f84d3d8cbe0f1587f9e226']],
['[](:/06894e83b8f84d3d8cbe0f1587f9e226) [](:/06894e83b8f84d3d8cbe0f1587f9e226)', ['06894e83b8f84d3d8cbe0f1587f9e226']],
['[](:/06894e83b8f84d3d8cbe0f1587f9e226) [](:/06894e83b8f84d3d8cbe0f1587f9e227)', ['06894e83b8f84d3d8cbe0f1587f9e226', '06894e83b8f84d3d8cbe0f1587f9e227']],
['[](:/06894e83b8f84d3d8cbe0f1587f9e226 "some title")', ['06894e83b8f84d3d8cbe0f1587f9e226']],
];
for (let i = 0; i < testCases.length; i++) {
const t = testCases[i];
const input = t[0] as string;
const expected = t[1] as string[];
const actual = Note.linkedItemIds(input) as string[];
const contentEquals = ArrayUtils.contentEquals(actual, expected);
// console.info(contentEquals, input, expected, actual);
expect(contentEquals).toBe(true);
}
}));
test.each<[string, string[]]>([
// Single file card pointing at a resource.
[
JSON.stringify({
nodes: [
{ id: 'a', type: 'file', x: 0, y: 0, width: 100, height: 100, file: ':/06894e83b8f84d3d8cbe0f1587f9e226' },
],
edges: [],
}),
['06894e83b8f84d3d8cbe0f1587f9e226'],
],
// Multiple file cards — duplicates collapse, external paths are skipped.
[
JSON.stringify({
nodes: [
{ id: 'a', type: 'file', x: 0, y: 0, width: 100, height: 100, file: ':/06894e83b8f84d3d8cbe0f1587f9e226' },
{ id: 'b', type: 'file', x: 0, y: 0, width: 100, height: 100, file: ':/06894e83b8f84d3d8cbe0f1587f9e227' },
{ id: 'c', type: 'file', x: 0, y: 0, width: 100, height: 100, file: ':/06894e83b8f84d3d8cbe0f1587f9e226' },
{ id: 'd', type: 'file', x: 0, y: 0, width: 100, height: 100, file: 'https://example.com/photo.png' },
],
edges: [],
}),
['06894e83b8f84d3d8cbe0f1587f9e226', '06894e83b8f84d3d8cbe0f1587f9e227'],
],
// Non-file node types (text/link/group) don't reference items.
[
JSON.stringify({
nodes: [
{ id: 'a', type: 'text', x: 0, y: 0, width: 100, height: 100, text: 'hello' },
{ id: 'b', type: 'link', x: 0, y: 0, width: 100, height: 100, url: 'https://example.com' },
{ id: 'c', type: 'group', x: 0, y: 0, width: 100, height: 100, label: 'Section' },
],
edges: [],
}),
[],
],
])('should find linked items inside jsoncanvas fences', (canvasJson, expected) => {
const body = `\`\`\`jsoncanvas\n${canvasJson}\n\`\`\``;
const actual = Note.linkedItemIds(body);
expect(ArrayUtils.contentEquals(actual, expected)).toBe(true);
});
it('should merge fence refs with surrounding markdown links', () => {
const canvas: Canvas = {
nodes: [
{ id: 'a', type: 'file', x: 0, y: 0, width: 100, height: 100, file: ':/06894e83b8f84d3d8cbe0f1587f9e226' },
],
edges: [],
};
const body = `Intro [foo](:/06894e83b8f84d3d8cbe0f1587f9e227)\n\n${serializeWhiteboard('', canvas)}`;
const actual = Note.linkedItemIds(body);
expect(ArrayUtils.contentEquals(
actual,
['06894e83b8f84d3d8cbe0f1587f9e226', '06894e83b8f84d3d8cbe0f1587f9e227'],
)).toBe(true);
});
it('should associate whiteboard-referenced resources so they are not orphaned', (async () => {
// End-to-end: a resource referenced only from a jsoncanvas card must
// still be picked up by ResourceService.indexNoteResources, registered
// in note_resources, and survive the orphan reaper.
const folder = await Folder.save({ title: 'folder' });
const resource = await shim.createResourceFromPath(`${supportDir}/photo.jpg`);
const canvas: Canvas = {
nodes: [
{ id: 'card', type: 'file', x: 0, y: 0, width: 200, height: 160, file: `:/${resource.id}` },
],
edges: [],
};
const note = await Note.save({
title: 'whiteboard',
parent_id: folder.id,
body: serializeWhiteboard('', canvas),
});
const service = new ResourceService();
await service.indexNoteResources();
expect(await NoteResource.associatedNoteIds(resource.id)).toEqual([note.id]);
// Orphan reaper must NOT remove a resource that's still referenced by
// a whiteboard card — even though the ref lives outside markdown link
// syntax.
await service.deleteOrphanResources(0);
expect(!!(await Resource.load(resource.id))).toBe(true);
}));
it('should change the type of notes', (async () => {
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);
let changedNote = Note.changeNoteType(note1, 'todo');
expect(changedNote === note1).toBe(false);
expect(!!changedNote.is_todo).toBe(true);
await Note.save(changedNote);
note1 = await Note.load(note1.id);
changedNote = Note.changeNoteType(note1, 'todo');
expect(changedNote === note1).toBe(true);
expect(!!changedNote.is_todo).toBe(true);
note1 = await Note.load(note1.id);
changedNote = Note.changeNoteType(note1, 'note');
expect(changedNote === note1).toBe(false);
expect(!!changedNote.is_todo).toBe(false);
}));
it('should still save a note after a save was rejected by validation', (async () => {
const note = await Note.save({ title: 'ok' });
await expect(Note.save({ id: note.id, title: `bad${String.fromCharCode(0)}title` }, { userSideValidation: true })).rejects.toThrow(/null byte/);
// Deadlocks on the note's save mutex if the rejected save above failed to release it.
const saved = await Note.save({ id: note.id, title: 'fixed' });
expect(saved.title).toBe('fixed');
}));
it('should serialize and unserialize without modifying data', (async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const testCases = [
[{ title: '', body: 'Body and no title\nSecond line\nThird Line', parent_id: folder1.id },
'', 'Body and no title\nSecond line\nThird Line'],
[{ title: 'Note title', body: 'Body and title', parent_id: folder1.id },
'Note title', 'Body and title'],
[{ title: 'Title and no body', body: '', parent_id: folder1.id },
'Title and no body', ''],
];
for (let i = 0; i < testCases.length; i++) {
const t = testCases[i];
const input = t[0] as NoteEntity;
const note1 = await Note.save(input);
const serialized = await Note.serialize(note1);
const unserialized = await Note.unserialize(serialized);
expect(unserialized.title).toBe(input.title);
expect(unserialized.body).toBe(input.body);
}
}));
it('should add lock defaults for old sync notes', () => {
expect(Note.filter({
is_locked: undefined,
extracted_resource_ids: undefined,
})).toMatchObject({
is_locked: 0,
extracted_resource_ids: '',
});
expect(Note.filter({
is_locked: null,
extracted_resource_ids: null,
})).toMatchObject({
is_locked: 0,
extracted_resource_ids: '',
});
});
it('should default lock fields for new notes', async () => {
const note = await Note.save({});
const loadedNote = await Note.load(note.id);
expect(loadedNote.is_locked).toBe(0);
expect(loadedNote.extracted_resource_ids).toBe('');
});
it('should include lock state in preview fields', () => {
expect(Note.previewFields()).toContain('is_locked');
expect(Note.previewFields()).not.toContain('extracted_resource_ids');
});
const resourceId1 = '06894e83b8f84d3d8cbe0f1587f9e226';
const resourceId2 = '06894e83b8f84d3d8cbe0f1587f9e227';
test.each<[string[], string]>([
[[], ''],
[[' '], ''],
[[resourceId1], resourceId1],
[[` ${resourceId1} `, resourceId2], `${resourceId1},${resourceId2}`],
[[resourceId1, resourceId1, 'invalid'], resourceId1],
])('should serialize extracted resource IDs: %j', (resourceIds, expected) => {
expect(Note.serializeExtractedResourceIds(resourceIds)).toBe(expected);
});
test.each<[string, string[]]>([
['', []],
[' ', []],
[',,', []],
[resourceId1, [resourceId1]],
[`${resourceId1},,${resourceId2}`, [resourceId1, resourceId2]],
[` ${resourceId1}, ${resourceId2} `, [resourceId1, resourceId2]],
[`${resourceId1},${resourceId1},invalid`, [resourceId1]],
])('should unserialize extracted resource IDs: %j', (serializedIds, expected) => {
expect(Note.unserializeExtractedResourceIds(serializedIds)).toEqual(expected);
});
it('should store note lock ciphertext while decrypting only gated loads', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const resourceId1 = '06894e83b8f84d3d8cbe0f1587f9e226';
const resourceId2 = '06894e83b8f84d3d8cbe0f1587f9e227';
const plainTextBody = `secret [](:/${resourceId1}) [](:/${resourceId2})`;
const note = await Note.save({
body: plainTextBody,
is_locked: 1,
}, { useNoteLock: true });
const storedNote = await Note.load(note.id);
expect(note.body).toBe(plainTextBody);
expect(storedNote.body).not.toBe(plainTextBody);
expect(storedNote.extracted_resource_ids).toBe(`${resourceId1},${resourceId2}`);
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(plainTextBody);
await expect(Note.load(note.id, { fields: ['id', 'is_locked'], useNoteLock: true })).rejects.toThrow();
await expect(Note.load(note.id, { fields: ['id', 'body'], useNoteLock: true })).rejects.toThrow('Gated note lock load is missing lock state');
// Resolves empty like a plain load, so callers keep their deleted-note handling.
await expect(Note.load('0123456789abcdef0123456789abcdef', { useNoteLock: true })).resolves.toBeUndefined();
// A row still encrypted by sync has no note lock body yet, so it comes back untouched.
const syncEncryptedId = '0123456789abcdef0123456789abcdee';
await Note.save({ id: syncEncryptedId, parent_id: '', is_locked: 1, encryption_applied: 1, encryption_cipher_text: 'cipher' }, { isNew: true });
expect(await Note.load(syncEncryptedId, { useNoteLock: true })).toMatchObject({ encryption_applied: 1, body: '' });
await Note.save(await Note.load(note.id, { useNoteLock: true }), { useNoteLock: true });
expect((await Note.load(note.id)).body).not.toBe(plainTextBody);
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(plainTextBody);
await expect(Note.save({
id: note.id,
body: 'must not be stored',
}, { useNoteLock: true })).rejects.toThrow('Gated note lock save is missing decrypted state');
await expect(Note.save({
id: note.id,
is_locked: 1,
}, { useNoteLock: true })).rejects.toThrow('Gated note lock save is missing body');
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(plainTextBody);
await Note.save({
...await Note.load(note.id, { useNoteLock: true }),
body: `${plainTextBody} edited`,
}, { useNoteLock: true });
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(`${plainTextBody} edited`);
await Note.save({
...await Note.load(note.id, { useNoteLock: true }),
body: 'unlocked',
is_locked: 0,
}, { useNoteLock: true });
const unlockedNote = await Note.load(note.id);
expect(unlockedNote.body).toBe('unlocked');
expect(unlockedNote.extracted_resource_ids).toBe('');
});
it('should encrypt an ungated partial save whose body is plaintext for a locked note', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const resourceId = '06894e83b8f84d3d8cbe0f1587f9e226';
const note = await Note.save({ body: 'secret', is_locked: 1 }, { useNoteLock: true });
// Gated loaded data saved in full through an ungated path is refused, and so is a lock
// change without the body.
await expect(Note.save({ ...await Note.load(note.id, { useNoteLock: true }), body: 'edited' })).rejects.toThrow('must be gated when the body was loaded using a gated load');
await expect(Note.save({ id: note.id, is_locked: 0 })).rejects.toThrow('Saves that change is_locked must include the body field');
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe('secret');
// A fresh partial save picks up the row's lock state and keeps the lock fields together
// even when the caller restricts the saved fields, and the caller still gets the plaintext back.
const partialBody = `partial [](:/${resourceId})`;
expect((await Note.save({ id: note.id, body: partialBody }, { fields: ['body'] })).body).toBe(partialBody);
const storedNote = await Note.load(note.id);
expect(storedNote.is_locked).toBe(1);
expect(storedNote.body).not.toBe(partialBody);
expect(storedNote.extracted_resource_ids).toBe(resourceId);
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(partialBody);
// An ungated load returns ciphertext, which passes through unchanged, like sync data does.
await Note.save({ id: note.id, body: storedNote.body });
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(partialBody);
// With the session locked there is no key to encrypt with, so the save fails closed.
NoteLockSession.instance().lock();
await expect(Note.save({ id: note.id, body: 'plain while locked' })).rejects.toThrow('Note lock session is locked');
await NoteLockSession.instance().unlock('123456');
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(partialBody);
// Only a complete header marks ciphertext, so a body that merely starts like one is still encrypted.
await Note.save({ id: note.id, body: 'JLD01 shopping list' });
expect((await Note.load(note.id)).body).not.toBe('JLD01 shopping list');
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe('JLD01 shopping list');
// A save while sync still holds the row encrypted is encrypted too, in case decryption never runs.
await Note.save({ id: note.id, body: 'before decryption', encryption_applied: 1 });
expect((await Note.load(note.id)).body).not.toBe('before decryption');
});
it('should save a note object that the store has frozen', async () => {
const note = await Note.save({ title: 'note', body: 'plain' });
await Note.save(Object.freeze({ ...note, body: 'edited' }));
expect((await Note.load(note.id)).body).toBe('edited');
});
it('should treat a locked note as a normal note while the feature is disabled', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const note = await Note.save({
body: 'secret',
is_locked: 1,
}, { useNoteLock: true });
const cipherText = (await Note.load(note.id)).body;
Setting.setValue('featureFlag.noteLock', false);
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe(cipherText);
await Note.save({ id: note.id, is_locked: 1, body: 'overwrite' });
expect((await Note.load(note.id)).body).toBe('overwrite');
});
it('should find a locked note anywhere in a notebook tree', async () => {
const parent = await Folder.save({ title: 'parent' });
const child = await Folder.save({ title: 'child', parent_id: parent.id });
const other = await Folder.save({ title: 'other' });
await Note.save({ title: 'plain', body: 'plain', parent_id: parent.id });
await Note.save({ title: 'other plain', body: 'plain', parent_id: other.id });
const locked = await Note.save({ title: 'locked', body: 'JLD01cipher', parent_id: child.id });
await db().exec('UPDATE notes SET is_locked = 1 WHERE id = ?', [locked.id]);
expect(await Note.hasLockedNoteInFolderTrees([parent.id])).toBe(true);
expect(await Note.hasLockedNoteInFolderTrees([child.id])).toBe(true);
expect(await Note.hasLockedNoteInFolderTrees([other.id])).toBe(false);
});
it('should refuse to save a decrypted locked note once the feature is disabled', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const note = await Note.save({ body: 'secret', is_locked: 1 }, { useNoteLock: true });
const lockedNote = await Note.load(note.id, { useNoteLock: true });
const unlockedNote = await Note.load((await Note.save({ body: 'plain' })).id, { useNoteLock: true });
const cipherText = (await Note.load(note.id)).body;
Setting.setValue('featureFlag.noteLock', false);
const error = 'Locked notes cannot be saved while the note lock feature is turned off';
await expect(Note.save({ ...lockedNote, body: 'edited' }, { useNoteLock: true })).rejects.toThrow(error);
await expect(Note.save({ id: note.id, body: 'edited', isDecrypted: true } as NoteEntity, { useNoteLock: true })).rejects.toThrow(error);
expect((await Note.load(note.id)).body).toBe(cipherText);
await Note.save({ ...unlockedNote, body: 'plain edited' }, { useNoteLock: true });
expect((await Note.load(unlockedNote.id)).body).toBe('plain edited');
});
it('should encrypt a gated save with a captured key while the session is locked, but not after a key rotation', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const note = await Note.save({ body: 'secret', is_locked: 1 }, { useNoteLock: true });
const capturedKey = NoteLockSession.instance().decryptedKey();
NoteLockSession.instance().lock();
const updatedNote = { ...await Note.load(note.id), body: 'updated', isDecrypted: true };
await Note.save(updatedNote, { useNoteLock: true, noteLockKey: capturedKey });
await NoteLockSession.instance().unlock('123456');
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe('updated');
await NoteLockSession.instance().reset('654321');
const bodyBeforeStaleAttempt = (await Note.load(note.id)).body;
const staleNote = { ...await Note.load(note.id), body: 'stale', isDecrypted: true };
await expect(Note.save(staleNote, { useNoteLock: true, noteLockKey: capturedKey })).rejects.toThrow('Note lock key changed during operation');
expect((await Note.load(note.id)).body).toBe(bodyBeforeStaleAttempt);
});
it('should refuse a gated save of a locked note whose body does not come from a gated load', async () => {
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const note = await Note.save({ body: 'secret', is_locked: 1 }, { useNoteLock: true });
expect(note).toMatchObject({ isDecrypted: true });
expect(await Note.load(note.id, { useNoteLock: true })).toMatchObject({ isDecrypted: true });
expect('isDecrypted' in await Note.load(note.id)).toBe(false);
// The ungated load returned cipher text, so saving it back through the gated path would
// encrypt it a second time.
await expect(Note.save({ ...await Note.load(note.id) }, { useNoteLock: true })).rejects.toThrow('Gated note lock save is missing decrypted state');
const saved = await Note.save({ ...await Note.load(note.id, { useNoteLock: true }), body: 'edited' }, { useNoteLock: true });
expect(saved).toMatchObject({ isDecrypted: true, body: 'edited' });
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe('edited');
// The editor saves partial notes without share_id, which makes the dispatch path reload the
// note with a field list built from the saved note's keys - the marker must not leak into it.
const editorShapedNote = { id: note.id, deleted_time: 0, title: 'edited', body: 'edited again', is_locked: 1, isDecrypted: true };
const editorShaped = await Note.save(editorShapedNote, { useNoteLock: true });
expect(editorShaped).toMatchObject({ isDecrypted: true, body: 'edited again' });
expect((await Note.load(note.id, { useNoteLock: true })).body).toBe('edited again');
const unlocked = await Note.save({ ...await Note.load(note.id, { useNoteLock: true }), is_locked: 0 }, { useNoteLock: true });
expect(unlocked).toMatchObject({ isDecrypted: true });
});
it('should fail closed when note lock encryption cannot decrypt or encrypt', async () => {
const noteLockKey = NoteLockKey.instance();
const session = NoteLockSession.instance();
await noteLockKey.create('123456');
await session.unlock('123456');
const note = await Note.save({
body: 'secret',
is_locked: 1,
}, { useNoteLock: true });
session.lock();
await expect(Note.save({
body: 'must not be stored',
is_locked: 1,
}, { useNoteLock: true })).rejects.toThrow('Note lock session is locked');
expect(await Note.all()).toHaveLength(1);
await session.unlock('123456');
const corruptedBody = `${note.body}invalid`;
await db().exec('UPDATE notes SET body = ? WHERE id = ?', [corruptedBody, note.id]);
await expect(Note.load(note.id, { useNoteLock: true })).rejects.toThrow();
expect((await Note.load(note.id)).body).toBe(corruptedBody);
const incompleteBody = note.body.slice(0, -1);
await db().exec('UPDATE notes SET body = ? WHERE id = ?', [incompleteBody, note.id]);
await expect(Note.load(note.id, { useNoteLock: true })).rejects.toThrow();
expect((await Note.load(note.id)).body).toBe(incompleteBody);
});
it('should clear plaintext revision data when locking a note', async () => {
const note = await Note.save({ body: 'plain text' });
await Note.save({ id: note.id, body: 'updated plain text' });
await revisionService().collectRevisions();
expect(await Revision.countRevisions(Note.modelType(), note.id)).toBe(1);
const encryptedRevision = await Revision.save({
item_type: Note.modelType(),
item_id: note.id,
item_updated_time: Date.now(),
is_locked: 1,
});
await NoteLockKey.instance().create('123456');
await NoteLockSession.instance().unlock('123456');
const lockedNote = { ...await Note.load(note.id), is_locked: 1, isDecrypted: true };
await Note.save(lockedNote, { useNoteLock: true });
expect(await Revision.countRevisions(Note.modelType(), note.id)).toBe(1);
expect(await Revision.load(encryptedRevision.id)).toBeTruthy();
await ItemChange.waitForAllSaved();
expect(await ItemChange.oldNoteContent(note.id)).toBe(null);
});
it('should reset fields for a duplicate', (async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const note1 = await Note.save({ title: 'note', parent_id: folder1.id });
await msleep(1);
const duplicatedNote = await Note.duplicate(note1.id);
expect(duplicatedNote !== note1).toBe(true);
expect(duplicatedNote.created_time !== note1.created_time).toBe(true);
expect(duplicatedNote.updated_time !== note1.updated_time).toBe(true);
expect(duplicatedNote.user_created_time !== note1.user_created_time).toBe(true);
expect(duplicatedNote.user_updated_time !== note1.user_updated_time).toBe(true);
}));
it('should duplicate a note with tags', (async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const tag1 = await Tag.save({ title: 'tag1' });
const tag2 = await Tag.save({ title: 'tag2' });
const originalNote = await Note.save({ title: 'originalNote', parent_id: folder1.id });
await Tag.addNote(tag1.id, originalNote.id);
await Tag.addNote(tag2.id, originalNote.id);
const duplicatedNote = await Note.duplicate(originalNote.id);
const duplicatedNoteTags = await Tag.tagsByNoteId(duplicatedNote.id);
expect(duplicatedNoteTags.find(o => o.id === tag1.id)).toBeDefined();
expect(duplicatedNoteTags.find(o => o.id === tag2.id)).toBeDefined();
expect(duplicatedNoteTags.length).toBe(2);
}));
it('should also duplicate resources when duplicating a note', (async () => {
const folder = await Folder.save({ title: 'folder' });
let note = await Note.save({ title: 'note', parent_id: folder.id });
await shim.attachFileToNote(note, `${supportDir}/photo.jpg`);
const resource = (await Resource.all())[0];
expect((await Resource.all()).length).toBe(1);
const duplicatedNote = await Note.duplicate(note.id, { duplicateResources: true });
const resources: ResourceEntity[] = await Resource.all();
expect(resources.length).toBe(2);
const duplicatedResource = resources.find(r => r.id !== resource.id);
note = await Note.load(note.id);
expect(note.body).toContain(resource.id);
expect(duplicatedNote.body).toContain(duplicatedResource.id);
expect(duplicatedResource.share_id).toBe('');
expect(duplicatedResource.is_shared).toBe(0);
}));
it('should delete a set of notes', (async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const noOfNotes = 20;
await createNTestNotes(noOfNotes, folder1);
const noteIds = await Folder.noteIds(folder1.id);
await Note.batchDelete(noteIds);
const all = await allItems();
expect(all.length).toBe(1);
expect(all[0].id).toBe(folder1.id);
}));
it('should delete only the selected notes', (async () => {
const f1 = await Folder.save({ title: 'folder1' });
const f2 = await Folder.save({ title: 'folder2', parent_id: f1.id });
const noOfNotes = 20;
await createNTestNotes(noOfNotes, f1, null, 'note1');
await createNTestNotes(noOfNotes, f2, null, 'note1');
const allBeforeDelete = await allItems();
const notesInFolder1IDs = await Folder.noteIds(f1.id);
const notesInFolder2IDs = await Folder.noteIds(f2.id);
const notesToRemoveFromFolder1 = notesInFolder1IDs.slice(0, 6);
const notesToRemoveFromFolder2 = notesInFolder2IDs.slice(11, 14);
await Note.batchDelete(notesToRemoveFromFolder1);
await Note.batchDelete(notesToRemoveFromFolder2);
const allAfterDelete = await allItems();
const expectedLength = allBeforeDelete.length - notesToRemoveFromFolder1.length - notesToRemoveFromFolder2.length;
expect(allAfterDelete.length).toBe(expectedLength);
// Common elements between the to-be-deleted notes and the notes and folders remaining after the delete
const intersection = [...notesToRemoveFromFolder1, ...notesToRemoveFromFolder2].filter(x => allAfterDelete.includes(x));
// Should be empty
expect(intersection.length).toBe(0);
}));
it('should delete nothing', (async () => {
const f1 = await Folder.save({ title: 'folder1' });
const f2 = await Folder.save({ title: 'folder2', parent_id: f1.id });
const f3 = await Folder.save({ title: 'folder3', parent_id: f2.id });
const f4 = await Folder.save({ title: 'folder4', parent_id: f1.id });
const noOfNotes = 20;
await createNTestNotes(noOfNotes, f1, null, 'note1');
await createNTestNotes(noOfNotes, f2, null, 'note2');
await createNTestNotes(noOfNotes, f3, null, 'note3');
await createNTestNotes(noOfNotes, f4, null, 'note4');
const beforeDelete = await allItems();
await Note.batchDelete([]);
const afterDelete = await allItems();
expect(sortedIds(afterDelete)).toEqual(sortedIds(beforeDelete));
}));
it('should not move to conflict folder', (async () => {
const folder1 = await Folder.save({ title: 'Folder' });
const folder2 = await Folder.save({ title: Folder.conflictFolderTitle(), id: Folder.conflictFolderId() });
const note1 = await Note.save({ title: 'note', parent_id: folder1.id });
const hasThrown = await checkThrowAsync(async () => await Folder.moveToFolder(note1.id, folder2.id));
expect(hasThrown).toBe(true);
const note = await Note.load(note1.id);
expect(note.parent_id).toEqual(folder1.id);
}));
it('should not copy to conflict folder', (async () => {
const folder1 = await Folder.save({ title: 'Folder' });
const folder2 = await Folder.save({ title: Folder.conflictFolderTitle(), id: Folder.conflictFolderId() });
const note1 = await Note.save({ title: 'note', parent_id: folder1.id });
const hasThrown = await checkThrowAsync(async () => await Note.copyToFolder(note1.id, folder2.id));
expect(hasThrown).toBe(true);
}));
it('should convert resource paths from internal to external paths', (async () => {
const resourceDirName = Setting.value('resourceDirName');
const resourceDir = Setting.value('resourceDir');
const r1 = await shim.createResourceFromPath(`${supportDir}/photo.jpg`);
const r2 = await shim.createResourceFromPath(`${supportDir}/photo.jpg`);
const r3 = await shim.createResourceFromPath(`${supportDir}/welcome.pdf`);
const note1 = await Note.save({ title: 'note1' });
const t1 = r1.updated_time;
const t2 = r2.updated_time;
const resourceDirE = markdownUtils.escapeLinkUrl(toForwardSlashes(resourceDir));
const fileProtocol = `file://${process.platform === 'win32' ? '/' : ''}`;
const testCases: [boolean, string, string][] = [
[
false,
'',
'',
],
[
true,
'',
'',
],
[
false,
``,
``,
],
[
false,
`  `,
`  `,
],
[
true,
``,
``,
],
[
true,
`  `,
`  `,
],
[
true,
``,
``,
],
];
for (const testCase of testCases) {
const [useAbsolutePaths, input, expected] = testCase;
const internalToExternal = await Note.replaceResourceInternalToExternalLinks(input, { useAbsolutePaths });
expect(internalToExternal).toBe(expected);
const externalToInternal = await Note.replaceResourceExternalToInternalLinks(internalToExternal, { useAbsolutePaths });
expect(externalToInternal).toBe(input);
}
{
const result = await Note.replaceResourceExternalToInternalLinks(`[](joplin://${note1.id})`);
expect(result).toBe(`[](:/${note1.id})`);
}
{
// This is a regular file path that contains the resourceDirName
// inside but it shouldn't be changed.
//
// https://github.com/laurent22/joplin/issues/5034
const noChangeInput = `[docs](file:///c:/foo/${resourceDirName}/docs)`;
const result = await Note.replaceResourceExternalToInternalLinks(noChangeInput, { useAbsolutePaths: false });
expect(result).toBe(noChangeInput);
}
}));
it('should perform natural sorting', (async () => {
const folder1 = await Folder.save({});
const sortedNotes = await Note.previews(folder1.id, {
fields: ['id', 'title'],
order: [{ by: 'title', dir: 'ASC' }],
});
expect(sortedNotes.length).toBe(0);
const note0 = await Note.save({ title: 'A3', parent_id: folder1.id, is_todo: 0 });
const note1 = await Note.save({ title: 'A20', parent_id: folder1.id, is_todo: 0 });
const note2 = await Note.save({ title: 'A100', parent_id: folder1.id, is_todo: 0 });
const note3 = await Note.save({ title: 'égalité', parent_id: folder1.id, is_todo: 0 });
const note4 = await Note.save({ title: 'z', parent_id: folder1.id, is_todo: 0 });
const sortedNotes2 = await Note.previews(folder1.id, {
fields: ['id', 'title'],
order: [{ by: 'title', dir: 'ASC' }],
});
expect(sortedNotes2.length).toBe(5);
expect(sortedNotes2[0].id).toBe(note0.id);
expect(sortedNotes2[1].id).toBe(note1.id);
expect(sortedNotes2[2].id).toBe(note2.id);
expect(sortedNotes2[3].id).toBe(note3.id);
expect(sortedNotes2[4].id).toBe(note4.id);
const todo3 = Note.changeNoteType(note3, 'todo');
const todo4 = Note.changeNoteType(note4, 'todo');
await Note.save(todo3);
await Note.save(todo4);
const sortedNotes3 = await Note.previews(folder1.id, {
fields: ['id', 'title'],
order: [{ by: 'title', dir: 'ASC' }],
uncompletedTodosOnTop: true,
});
expect(sortedNotes3.length).toBe(5);
expect(sortedNotes3[0].id).toBe(note3.id);
expect(sortedNotes3[1].id).toBe(note4.id);
expect(sortedNotes3[2].id).toBe(note0.id);
expect(sortedNotes3[3].id).toBe(note1.id);
expect(sortedNotes3[4].id).toBe(note2.id);
}));
it('should create a conflict note', async () => {
const folder = await Folder.save({ title: 'Source Folder' });
const origNote = await Note.save({ title: 'note', parent_id: folder.id, share_id: 'SHARE', is_shared: 1 });
const conflictedNote = await Note.createConflictNote(origNote, ItemChange.SOURCE_SYNC);
expect(conflictedNote.is_conflict).toBe(1);
expect(conflictedNote.conflict_original_id).toBe(origNote.id);
expect(conflictedNote.parent_id).toBe(folder.id);
expect(conflictedNote.is_shared).toBeUndefined();
expect(conflictedNote.share_id).toBe('');
});
it('should copy conflicted note to target folder and cancel conflict', (async () => {
const srcfolder = await Folder.save({ title: 'Source Folder' });
const targetfolder = await Folder.save({ title: 'Target Folder' });
const note1 = await Note.save({ title: 'note', parent_id: srcfolder.id });
const conflictedNote = await Note.createConflictNote(note1, ItemChange.SOURCE_SYNC);
const note2 = await Note.copyToFolder(conflictedNote.id, targetfolder.id);
expect(note2.id === conflictedNote.id).toBe(false);
expect(note2.title).toBe(conflictedNote.title);
expect(note2.is_conflict).toBe(0);
expect(note2.conflict_original_id).toBe('');
expect(note2.parent_id).toBe(targetfolder.id);
}));
it('should move conflicted note to target folder and cancel conflict', (async () => {
const srcFolder = await Folder.save({ title: 'Source Folder' });
const targetFolder = await Folder.save({ title: 'Target Folder' });
const note1 = await Note.save({ title: 'note', parent_id: srcFolder.id });
const conflictedNote = await Note.createConflictNote(note1, ItemChange.SOURCE_SYNC);
const movedNote = await Note.moveToFolder(conflictedNote.id, targetFolder.id);
expect(movedNote.parent_id).toBe(targetFolder.id);
expect(movedNote.is_conflict).toBe(0);
expect(movedNote.conflict_original_id).toBe('');
}));
it('should take the share_id of the target folder when moving a note', (async () => {
const sharedFolder = await Folder.save({ title: 'Shared', share_id: 'share-1' });
const folder = await Folder.save({ title: 'Folder' });
const note = await Note.save({ title: 'note', parent_id: sharedFolder.id, share_id: 'share-1' });
await Note.moveToFolder(note.id, folder.id);
expect((await Note.load(note.id)).share_id).toBe('');
await Note.moveToFolder(note.id, sharedFolder.id);
expect((await Note.load(note.id)).share_id).toBe('share-1');
}));
function testResourceReplacement(body: string, pathsToTry: string[], expected: string) {
expect(Note['replaceResourceExternalToInternalLinks_'](pathsToTry, body)).toBe(expected);
}
test('basic replacement', () => {
const body = '';
const pathsToTry = ['file:///C:Users/Username/resources'];
const expected = '';
testResourceReplacement(body, pathsToTry, expected);
});
test('replacement with spaces', () => {
const body = '';
const pathsToTry = ['file:///C:Users/Username with spaces/resources'];
const expected = '';
testResourceReplacement(body, pathsToTry, expected);
});
test('replacement with Non-ASCII', () => {
const body = '';
const pathsToTry = ['file:///C:Users/UsernameWithéàö/resources'];
const expected = '';
testResourceReplacement(body, pathsToTry, expected);
});
test('replacement with Non-ASCII and spaces', () => {
const body = '';
const pathsToTry = ['file:///C:Users/Username With éàö/resources'];
const expected = '';
testResourceReplacement(body, pathsToTry, expected);
});
it('should not allow modifying a read-only note', async () => {
const folder = await Folder.save({ });
const note = await Note.save({ parent_id: folder.id });
const cleanup = simulateReadOnlyShareEnv('123456789');
await expectNotThrow(async () => await Note.save({ id: note.id, title: 'can do this' }));
await Folder.save({ id: folder.id, share_id: '123456789' });
await Note.save({ id: note.id, share_id: '123456789' });
await expectThrow(async () => await Note.save({ id: note.id, title: 'cannot do this!' }), ErrorCode.IsReadOnly);
await expectNotThrow(async () => await Note.save({ id: note.id, title: 'But it can be updated via sync' }, { changeSource: ItemChange.SOURCE_SYNC }));
cleanup();
});
it('should not allow deleting a read-only note', async () => {
const folder = await Folder.save({ });
const note1 = await Note.save({ parent_id: folder.id });
const cleanup = simulateReadOnlyShareEnv('123456789');
await Folder.save({ id: folder.id, share_id: '123456789' });
await Note.save({ id: note1.id, share_id: '123456789' });
await expectThrow(async () => await Note.delete(note1.id), ErrorCode.IsReadOnly);
cleanup();
});
it('should not allow creating a new note as a child of a read-only folder', (async () => {
const cleanup = simulateReadOnlyShareEnv('123456789');
const readonlyFolder = await Folder.save({ share_id: '123456789' });
await expectThrow(async () => Note.save({ parent_id: readonlyFolder.id }), ErrorCode.IsReadOnly);
cleanup();
}));
it('should not allow adding an existing note as a child of a read-only folder', (async () => {
const cleanup = simulateReadOnlyShareEnv('123456789');
const readonlyFolder = await Folder.save({ share_id: '123456789' });
const note = await Note.save({});
await expectThrow(async () => Note.save({ id: note.id, parent_id: readonlyFolder.id }), ErrorCode.IsReadOnly);
cleanup();
}));
it('should delete a note to trash', async () => {
const folder = await Folder.save({});
const note1 = await Note.save({ title: 'note1', parent_id: folder.id });
const note2 = await Note.save({ title: 'note2', parent_id: folder.id });
const previousUpdatedTime = note1.updated_time;
await msleep(1);
await Note.delete(note1.id, { toTrash: true });
{
const n1 = await Note.load(note1.id);
expect(n1.deleted_time).toBeGreaterThan(0);
expect(n1.updated_time).toBeGreaterThan(previousUpdatedTime);
expect(n1.deleted_time).toBe(n1.updated_time);
const n2 = await Note.load(note2.id);
expect(n2.deleted_time).toBe(0);
}
{
const previews = await Note.previews(folder.id);
expect(previews.length).toBe(1);
expect(previews.find(n => n.id === note2.id)).toBeTruthy();
}
{
const engine = new SearchEngine();
engine.setDb(db());
await engine.syncTables();
const results = await engine.search('note*');
expect(results.length).toBe(1);
expect(results[0].id).toBe(note2.id);
}
});
it('should return the notes from the trash', async () => {
const folder = await Folder.save({});
const note1 = await Note.save({ title: 'note1', parent_id: folder.id });
const note2 = await Note.save({ title: 'note2', parent_id: folder.id });
const note3 = await Note.save({ title: 'note3', parent_id: folder.id });
await Note.delete(note1.id, { toTrash: true });
await Note.delete(note2.id, { toTrash: true });
const folderNotes = await Note.previews(folder.id);
const trashNotes = await Note.previews(getTrashFolderId());
expect(folderNotes.map(f => f.id).sort()).toEqual([note3.id]);
expect(trashNotes.map(f => f.id).sort()).toEqual([note1.id, note2.id].sort());
});
it('should handle folders within the trash', async () => {
const folder1 = await Folder.save({ title: 'folder1 ' });
const folder2 = await Folder.save({ title: 'folder2 ' });
const note1 = await Note.save({ title: 'note1', parent_id: folder1.id });
const note2 = await Note.save({ title: 'note2', parent_id: folder1.id });
await Note.save({ title: 'note3', parent_id: folder2.id });
const note4 = await Note.save({ title: 'note4', parent_id: folder2.id });
await Folder.delete(folder1.id, { toTrash: true, deleteChildren: true });
await Note.delete(note4.id, { toTrash: true });
// Note 4 should be at the root of the trash since its associated folder
// has not been deleted.
{
const trashNotes = await Note.previews(getTrashFolderId());
expect(trashNotes.length).toBe(1);
expect(trashNotes[0].id).toBe(note4.id);
}
// Note 1 and 2 should be within a "folder1" sub-folder within the trash
// since that folder has been deleted too.
{
const trashNotes = await Note.previews(folder1.id);
expect(trashNotes.length).toBe(2);
expect(trashNotes.map(n => n.id).sort()).toEqual([note1.id, note2.id].sort());
}
});
it('should allow deleting conflicts to the trash', async () => {
const folder = await Folder.save({});
const notes = [];
for (let i = 0; i < 3; i++) {
notes.push(await Note.save({ title: `note${i}`, parent_id: folder.id, is_conflict: 1 }));
}
// Should be in the conflicts folder
expect(await Note.previews(getTrashFolderId())).toHaveLength(0);
expect(await Note.previews(getConflictFolderId())).toHaveLength(3);
expect(await Note.conflictedCount()).toBe(3);
// Should be moved to the trash folder on delete
for (const note of notes) {
await Note.delete(note.id, { toTrash: true });
}
expect(await Note.previews(getTrashFolderId())).toHaveLength(3);
expect(await Note.previews(getConflictFolderId())).toHaveLength(0);
expect(await Note.conflictedCount()).toBe(0);
});
it('should delete the revisions when permanently deleting a note', (async () => {
const service = new RevisionService();
const folder = await Folder.save({ title: 'folder1' });
const note = await Note.save({ title: 'my note', parent_id: folder.id });
await Note.save({
id: note.id,
body: 'something something',
});
await service.collectRevisions();
const revisionsCountBefore = await Revision.countRevisions(Note.modelType(), note.id);
expect(revisionsCountBefore).toBe(1);
await Note.delete(note.id, { toTrash: false });
const revisionsCountAfter = await Revision.countRevisions(Note.modelType(), note.id);
expect(revisionsCountAfter).toBe(0);
}));
it('should not delete the revisions when sending to trash', (async () => {
const service = new RevisionService();
const folder = await Folder.save({ title: 'folder1' });
const note = await Note.save({ title: 'my note', parent_id: folder.id });
await Note.save({
id: note.id,
body: 'something something',
});
await service.collectRevisions();
const revisionsCountBefore = await Revision.countRevisions(Note.modelType(), note.id);
expect(revisionsCountBefore).toBe(1);
await Note.delete(note.id, { toTrash: true });
const revisionsCountAfter = await Revision.countRevisions(Note.modelType(), note.id);
expect(revisionsCountAfter).toBe(1);
}));
test('allByTitleAndParent should query by title and parent ID', async () => {
const folder1 = await Folder.save({ title: 'folder1' });
const folder2 = await Folder.save({ title: 'folder2' });
const note1 = await Note.save({ title: 'note', parent_id: folder1.id });
await Note.save({ title: 'note', parent_id: folder2.id });
// Filtering on no parents should return an empty array
expect(
await Note.allByTitleAndParent({ title: 'note', whereParentIn: [], fields: ['id'] }),
).toEqual([]);
const allInFolder1 = (await Note.allByTitleAndParent({
title: 'note', whereParentIn: [folder1.id], fields: ['id'],
})).map(n => n.id);
expect(allInFolder1).toEqual([note1.id]);
});
});