Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-10-31 04:51:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

revert consistency checks refactoring for now

Browse Source
This commit is contained in:
azivner 2019-01-21 22:46:27 +01:00
parent 24d02d9cf5
commit e17b26c883
1 changed files with 111 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

306
src/services/consistency_checks.js
View File

@ -5,29 +5,23 @@ const sqlInit = require('./sql_init');
const log = require('./log'); const log = require('./log');
const messagingService = require('./messaging'); const messagingService = require('./messaging');
const syncMutexService = require('./sync_mutex'); const syncMutexService = require('./sync_mutex');
const repository = require('./repository'); const repository = require('./repository.js');
const cls = require('./cls'); const cls = require('./cls');
const Branch = require('../entities/branch');
let outstandingConsistencyErrors = false; async function runCheck(query, errorText, errorList) {
const result = await sql.getColumn(query);
async function runCheck(recoverable, query, errorText) { if (result.length > 0) {
const results = await sql.getRows(query); const resultText = result.map(val => "'" + val + "'").join(', ');
if (results.length > 0) { const err = errorText + ": " + resultText;
const resultText = results.map(row => "'" + row.value + "'").join(', '); errorList.push(err);
log.error(errorText + ": " + resultText); log.error(err);
if (!recoverable) {
outstandingConsistencyErrors = true;
} }
} }
return results; async function checkTreeCycles(errorList) {
}
async function checkTreeCycles() {
const childToParents = {}; const childToParents = {};
const rows = await sql.getRows("SELECT noteId, parentNoteId FROM branches WHERE isDeleted = 0"); const rows = await sql.getRows("SELECT noteId, parentNoteId FROM branches WHERE isDeleted = 0");
@ -39,7 +33,7 @@ async function checkTreeCycles() {
childToParents[childNoteId].push(parentNoteId); childToParents[childNoteId].push(parentNoteId);
} }
function checkTreeCycle(noteId, path) { function checkTreeCycle(noteId, path, errorList) {
if (noteId === 'root') { if (noteId === 'root') {
return; return;
} }
@ -51,15 +45,13 @@ async function checkTreeCycles() {
for (const parentNoteId of childToParents[noteId]) { for (const parentNoteId of childToParents[noteId]) {
if (path.includes(parentNoteId)) { if (path.includes(parentNoteId)) {
log.error(`Tree cycle detected at parent-child relationship: ${parentNoteId} - ${noteId}, whole path: ${path}`); errorList.push(`Tree cycle detected at parent-child relationship: ${parentNoteId} - ${noteId}, whole path: ${path}`);
outstandingConsistencyErrors = true;
} }
else { else {
const newPath = path.slice(); const newPath = path.slice();
newPath.push(noteId); newPath.push(noteId);
checkTreeCycle(parentNoteId, newPath); checkTreeCycle(parentNoteId, newPath, errorList);
} }
} }
} }
@ -67,141 +59,130 @@ async function checkTreeCycles() {
const noteIds = Object.keys(childToParents); const noteIds = Object.keys(childToParents);
for (const noteId of noteIds) { for (const noteId of noteIds) {
checkTreeCycle(noteId, []); checkTreeCycle(noteId, [], errorList);
} }
if (childToParents['root'].length !== 1 || childToParents['root'][0] !== 'none') { if (childToParents['root'].length !== 1 || childToParents['root'][0] !== 'none') {
log.error('Incorrect root parent: ' + JSON.stringify(childToParents['root'])); errorList.push('Incorrect root parent: ' + JSON.stringify(childToParents['root']));
outstandingConsistencyErrors = true;
} }
} }
async function runSyncRowChecks(table, key) { async function runSyncRowChecks(table, key, errorList) {
await runCheck(false, ` await runCheck(`
SELECT SELECT
${key} AS value ${key}
FROM FROM
${table} ${table}
LEFT JOIN sync ON sync.entityName = '${table}' AND entityId = ${key} LEFT JOIN sync ON sync.entityName = '${table}' AND entityId = ${key}
WHERE WHERE
sync.id IS NULL AND ` + (table === 'options' ? 'isSynced = 1' : '1'), sync.id IS NULL AND ` + (table === 'options' ? 'isSynced = 1' : '1'),
`Missing sync records for ${key} in table ${table}`); `Missing sync records for ${key} in table ${table}`, errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
entityId AS value entityId
FROM FROM
sync sync
LEFT JOIN ${table} ON entityId = ${key} LEFT JOIN ${table} ON entityId = ${key}
WHERE WHERE
sync.entityName = '${table}' sync.entityName = '${table}'
AND ${key} IS NULL`, AND ${key} IS NULL`,
`Missing ${table} records for existing sync rows`); `Missing ${table} records for existing sync rows`, errorList);
} }
async function fixEmptyRelationTargets() { async function fixEmptyRelationTargets(errorList) {
const emptyRelations = await repository.getEntities("SELECT * FROM attributes WHERE isDeleted = 0 AND type = 'relation' AND value = ''"); const emptyRelations = await repository.getEntities("SELECT * FROM attributes WHERE isDeleted = 0 AND type = 'relation' AND value = ''");
for (const relation of emptyRelations) { for (const relation of emptyRelations) {
relation.isDeleted = true; relation.isDeleted = true;
await relation.save(); await relation.save();
log.error(`Relation ${relation.attributeId} of name "${relation.name} has empty target. Autofixed.`); errorList.push(`Relation ${relation.attributeId} of name "${relation.name} has empty target. Autofixed.`);
} }
} }
async function checkMissingBranches() { async function runAllChecks() {
const notes = await runCheck(true, ` const errorList = [];
await runCheck(`
SELECT SELECT
noteId AS value noteId
FROM FROM
notes notes
LEFT JOIN branches USING(noteId) LEFT JOIN branches USING(noteId)
WHERE WHERE
noteId != 'root' noteId != 'root'
AND branches.branchId IS NULL`, AND branches.branchId IS NULL`,
"Missing branches for following note IDs"); "Missing branches records for following note IDs", errorList);
for (const {value: noteId} of notes) { await runCheck(`
const branch = await new Branch({
parentNoteId: 'root',
noteId: noteId,
prefix: 'recovered'
}).save();
log.info(`Created missing branch ${branch.branchId} for note ${noteId}`);
}
}
async function checkMissingNotes() {
const records = await runCheck(true, `
SELECT SELECT
branchId || ' > ' || branches.noteId AS value, branchId, branches.noteId branchId || ' > ' || branches.noteId
FROM FROM
branches branches
LEFT JOIN notes USING(noteId) LEFT JOIN notes USING(noteId)
WHERE WHERE
notes.noteId IS NULL`, notes.noteId IS NULL`,
"Missing notes records for following branch ID > note ID"); "Missing notes records for following branch ID > note ID", errorList);
for (const {branchId, noteId} of records) { await runCheck(`
const branch = await repository.getBranch(branchId);
branch.isDeleted = true;
await branch.save();
log.info(`Removed ${branchId} because it pointed to the missing ${noteId}`);
}
}
async function checkAllDeletedNotesBranchesAreDeleted() {
const branches = await runCheck(true, `
SELECT SELECT
branchId AS value, branchId, noteId branchId
FROM FROM
branches branches
JOIN notes USING(noteId) JOIN notes USING(noteId)
WHERE WHERE
notes.isDeleted = 1 notes.isDeleted = 1
AND branches.isDeleted = 0`, AND branches.isDeleted = 0`,
"Branch is not deleted even though main note is deleted for following branch IDs"); "Branch is not deleted even though main note is deleted for following branch IDs", errorList);
for (const {branchId, noteId} of branches) { await runCheck(`
const branch = await repository.getBranch(branchId);
branch.isDeleted = true;
await branch.save();
log.info(`Branch ${branchId} has been deleted since associated note ${noteId} is deleted.`);
}
}
async function checkAllNotesShouldHaveUndeletedBranch() {
// we do extra JOIN to eliminate orphan notes without branches (which are reported separately)
const notes = await runCheck(true, `
SELECT SELECT
DISTINCT noteId AS value child.branchId
FROM
branches AS child
WHERE
child.isDeleted = 0
AND child.parentNoteId != 'none'
AND (SELECT COUNT(*) FROM branches AS parent WHERE parent.noteId = child.parentNoteId
AND parent.isDeleted = 0) = 0`,
"All parent branches are deleted but child branch is not for these child branch IDs", errorList);
// we do extra JOIN to eliminate orphan notes without branches (which are reported separately)
await runCheck(`
SELECT
DISTINCT noteId
FROM FROM
notes notes
JOIN branches USING(noteId) JOIN branches USING(noteId)
WHERE WHERE
(SELECT COUNT(*) FROM branches WHERE notes.noteId = branches.noteId AND branches.isDeleted = 0) = 0 (SELECT COUNT(*) FROM branches WHERE notes.noteId = branches.noteId AND branches.isDeleted = 0) = 0
AND notes.isDeleted = 0 AND notes.isDeleted = 0
`, 'No undeleted branches for note IDs'); `, 'No undeleted branches for note IDs', errorList);
for (const {value: noteId} of notes) { await runCheck(`
const branch = await new Branch({
parentNoteId: 'root',
noteId: noteId,
prefix: 'recovered'
}).save();
log.info(`Created missing branch ${branch.branchId} for note ${noteId}`);
}
}
async function checkDuplicateParentChildBranches() {
const records = await runCheck(true, `
SELECT SELECT
branches.parentNoteId || ' > ' || branches.noteId AS value, noteId, parentNoteId child.parentNoteId || ' > ' || child.noteId
FROM branches
AS child
LEFT JOIN branches AS parent ON parent.noteId = child.parentNoteId
WHERE
parent.noteId IS NULL
AND child.parentNoteId != 'none'`,
"Not existing parent in the following parent > child relations", errorList);
await runCheck(`
SELECT
noteRevisionId || ' > ' || note_revisions.noteId
FROM
note_revisions LEFT JOIN notes USING(noteId)
WHERE
notes.noteId IS NULL`,
"Missing notes records for following note revision ID > note ID", errorList);
await runCheck(`
SELECT
branches.parentNoteId || ' > ' || branches.noteId
FROM FROM
branches branches
WHERE WHERE
@ -211,72 +192,11 @@ async function checkDuplicateParentChildBranches() {
branches.noteId branches.noteId
HAVING HAVING
COUNT(*) > 1`, COUNT(*) > 1`,
"Duplicate undeleted parent note <-> note relationship - parent note ID > note ID"); "Duplicate undeleted parent note <-> note relationship - parent note ID > note ID", errorList);
for (const {noteId, parentNoteId} of records) { await runCheck(`
const branches = await repository.getEntities(`SELECT * FROM branches WHERE noteId = ? and parentNoteId = ? and isDeleted = 1`, [noteId, parentNoteId]);
if (branches.length <= 1) {
log.error("Inconsistent detection of duplicate parent note <-> relationships.");
}
// delete all but the first branch
for (const branch of branches.slice(1)) {
branch.isDeleted = true;
await branch.save();
}
}
}
async function runAllChecks() {
outstandingConsistencyErrors = false;
await checkMissingBranches();
await checkMissingNotes();
await checkAllDeletedNotesBranchesAreDeleted();
await runCheck(false, `
SELECT SELECT
child.parentNoteId || ' > ' || child.noteId AS value noteId
FROM branches
AS child
LEFT JOIN branches AS parent ON parent.noteId = child.parentNoteId
WHERE
parent.noteId IS NULL
AND child.parentNoteId != 'none'`,
"Not existing parent in the following parent > child relations");
// FIXME - does this make sense? Specifically branch - branch comparison seems strange
await runCheck(false, `
SELECT
child.branchId AS value
FROM
branches AS child
WHERE
child.isDeleted = 0
AND child.parentNoteId != 'none'
AND (SELECT COUNT(*) FROM branches AS parent WHERE parent.noteId = child.parentNoteId
AND parent.isDeleted = 0) = 0`,
"All parent branches are deleted but child branch is not for these child branch IDs");
await checkAllNotesShouldHaveUndeletedBranch();
await runCheck(false, `
SELECT
noteRevisionId || ' > ' || note_revisions.noteId AS value
FROM
note_revisions LEFT JOIN notes USING(noteId)
WHERE
notes.noteId IS NULL`,
"Missing notes records for following note revision ID > note ID");
await checkDuplicateParentChildBranches();
await runCheck(false, `
SELECT
noteId AS value
FROM FROM
notes notes
WHERE WHERE
@ -287,33 +207,33 @@ async function runAllChecks() {
AND type != 'image' AND type != 'image'
AND type != 'search' AND type != 'search'
AND type != 'relation-map'`, AND type != 'relation-map'`,
"Note has invalid type"); "Note has invalid type", errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
noteId AS value noteId
FROM FROM
notes notes
WHERE WHERE
isDeleted = 0 isDeleted = 0
AND content IS NULL`, AND content IS NULL`,
"Note content is null even though it is not deleted"); "Note content is null even though it is not deleted", errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
parentNoteId AS value parentNoteId
FROM FROM
branches branches
JOIN notes ON notes.noteId = branches.parentNoteId JOIN notes ON notes.noteId = branches.parentNoteId
WHERE WHERE
type == 'search'`, type == 'search'`,
"Search note has children"); "Search note has children", errorList);
await fixEmptyRelationTargets(); await fixEmptyRelationTargets(errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
attributeId AS value attributeId
FROM FROM
attributes attributes
WHERE WHERE
@ -321,22 +241,22 @@ async function runAllChecks() {
AND type != 'label-definition' AND type != 'label-definition'
AND type != 'relation' AND type != 'relation'
AND type != 'relation-definition'`, AND type != 'relation-definition'`,
"Attribute has invalid type"); "Attribute has invalid type", errorList);
await runCheck(false,` await runCheck(`
SELECT SELECT
attributeId AS value attributeId
FROM FROM
attributes attributes
LEFT JOIN notes ON attributes.noteId = notes.noteId AND notes.isDeleted = 0 LEFT JOIN notes ON attributes.noteId = notes.noteId AND notes.isDeleted = 0
WHERE WHERE
attributes.isDeleted = 0 attributes.isDeleted = 0
AND notes.noteId IS NULL`, AND notes.noteId IS NULL`,
"Attribute reference to the owning note is broken"); "Attribute reference to the owning note is broken", errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
attributeId AS value attributeId
FROM FROM
attributes attributes
LEFT JOIN notes AS targetNote ON attributes.value = targetNote.noteId AND targetNote.isDeleted = 0 LEFT JOIN notes AS targetNote ON attributes.value = targetNote.noteId AND targetNote.isDeleted = 0
@ -344,22 +264,22 @@ async function runAllChecks() {
attributes.type = 'relation' attributes.type = 'relation'
AND attributes.isDeleted = 0 AND attributes.isDeleted = 0
AND targetNote.noteId IS NULL`, AND targetNote.noteId IS NULL`,
"Relation reference to the target note is broken"); "Relation reference to the target note is broken", errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
linkId AS value linkId
FROM FROM
links links
WHERE WHERE
type != 'image' type != 'image'
AND type != 'hyper' AND type != 'hyper'
AND type != 'relation-map'`, AND type != 'relation-map'`,
"Link type is invalid"); "Link type is invalid", errorList);
await runCheck(false, ` await runCheck(`
SELECT SELECT
linkId AS value linkId
FROM FROM
links links
LEFT JOIN notes AS sourceNote ON sourceNote.noteId = links.noteId AND sourceNote.isDeleted = 0 LEFT JOIN notes AS sourceNote ON sourceNote.noteId = links.noteId AND sourceNote.isDeleted = 0
@ -368,39 +288,39 @@ async function runAllChecks() {
links.isDeleted = 0 links.isDeleted = 0
AND (sourceNote.noteId IS NULL AND (sourceNote.noteId IS NULL
OR targetNote.noteId IS NULL)`, OR targetNote.noteId IS NULL)`,
"Link to source/target note link is broken"); "Link to source/target note link is broken", errorList);
await runSyncRowChecks("notes", "noteId"); await runSyncRowChecks("notes", "noteId", errorList);
await runSyncRowChecks("note_revisions", "noteRevisionId"); await runSyncRowChecks("note_revisions", "noteRevisionId", errorList);
await runSyncRowChecks("branches", "branchId"); await runSyncRowChecks("branches", "branchId", errorList);
await runSyncRowChecks("recent_notes", "branchId"); await runSyncRowChecks("recent_notes", "branchId", errorList);
await runSyncRowChecks("attributes", "attributeId"); await runSyncRowChecks("attributes", "attributeId", errorList);
await runSyncRowChecks("api_tokens", "apiTokenId"); await runSyncRowChecks("api_tokens", "apiTokenId", errorList);
await runSyncRowChecks("options", "name"); await runSyncRowChecks("options", "name", errorList);
if (outstandingConsistencyErrors) { if (errorList.length === 0) {
// we run this only if basic checks passed since this assumes basic data consistency // we run this only if basic checks passed since this assumes basic data consistency
await checkTreeCycles(); await checkTreeCycles(errorList);
} }
return !outstandingConsistencyErrors; return errorList;
} }
async function runChecks() { async function runChecks() {
let errorList;
let elapsedTimeMs; let elapsedTimeMs;
let dbConsistent;
await syncMutexService.doExclusively(async () => { await syncMutexService.doExclusively(async () => {
const startTime = new Date(); const startTime = new Date();
dbConsistent = await runAllChecks(); errorList = await runAllChecks();
elapsedTimeMs = new Date().getTime() - startTime.getTime(); elapsedTimeMs = new Date().getTime() - startTime.getTime();
}); });
if (!dbConsistent) { if (errorList.length > 0) {
log.info(`Consistency checks failed (took ${elapsedTimeMs}ms)`); log.info(`Consistency checks failed (took ${elapsedTimeMs}ms) with these errors: ` + JSON.stringify(errorList));
messagingService.sendMessageToAllClients({type: 'consistency-checks-failed'}); messagingService.sendMessageToAllClients({type: 'consistency-checks-failed'});
} }