gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-03-01 14:22:32 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

better reporting for search parsing errors

Browse Source
This commit is contained in:
zadam 2020-07-22 22:52:15 +02:00
parent 60e8bd98b9
commit 3109233d4f
7 changed files with 53 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
package-lock.json generated
View File

@ -2605,9 +2605,9 @@
}
},
"dayjs": {
"version": "1.8.29",
"resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.8.29.tgz",
"integrity": "sha512-Vm6teig8ZWK7rH/lxzVGxZJCljPdmUr6q/3f4fr5F0VWNGVkZEjZOQJsAN8hUHUqn+NK4XHNEpJZS1MwLyDcLw=="
"version": "1.8.30",
"resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.8.30.tgz",
"integrity": "sha512-5s5IGuP5bVvIbOWkEDcfmXsUj24fZW1NMHVVSdSFF/kW8d+alZcI9SpBKC+baEyBe+z3fUp17y75ulstv5swUw=="
},
"debug": {
"version": "4.1.1",

2
package.json
View File

@ -31,7 +31,7 @@
"commonmark": "0.29.1",
"cookie-parser": "1.4.5",
"csurf": "1.11.0",
"dayjs": "1.8.29",
"dayjs": "1.8.30",
"debug": "4.1.1",
"ejs": "3.1.3",
"electron-debug": "3.1.0",

46
spec/search/parser.spec.js
View File

@ -1,15 +1,19 @@
const ParsingContext = require("../../src/services/search/parsing_context.js");
const parse = require('../../src/services/search/services/parse.js');
function tokens(...args) {
return args.map(arg => {
function tokens(toks, cur = 0) {
return toks.map(arg => {
if (Array.isArray(arg)) {
return arg;
return tokens(arg, cur);
}
else {
cur += arg.length;
return {
token: arg,
inQuotes: false
inQuotes: false,
startIndex: cur - arg.length,
endIndex: cur - 1
};
}
});
@ -18,7 +22,7 @@ function tokens(...args) {
describe("Parser", () => {
it("fulltext parser without content", () => {
const rootExp = parse({
fulltextTokens: tokens("hello", "hi"),
fulltextTokens: tokens(["hello", "hi"]),
expressionTokens: [],
parsingContext: new ParsingContext({includeNoteContent: false})
});
@ -29,7 +33,7 @@ describe("Parser", () => {
it("fulltext parser with content", () => {
const rootExp = parse({
fulltextTokens: tokens("hello", "hi"),
fulltextTokens: tokens(["hello", "hi"]),
expressionTokens: [],
parsingContext: new ParsingContext({includeNoteContent: true})
});
@ -50,7 +54,7 @@ describe("Parser", () => {
it("simple label comparison", () => {
const rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#mylabel", "=", "text"),
expressionTokens: tokens(["#mylabel", "=", "text"]),
parsingContext: new ParsingContext()
});
@ -63,7 +67,7 @@ describe("Parser", () => {
it("simple attribute negation", () => {
let rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#!mylabel"),
expressionTokens: tokens(["#!mylabel"]),
parsingContext: new ParsingContext()
});
@ -74,7 +78,7 @@ describe("Parser", () => {
rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("~!myrelation"),
expressionTokens: tokens(["~!myrelation"]),
parsingContext: new ParsingContext()
});
@ -87,7 +91,7 @@ describe("Parser", () => {
it("simple label AND", () => {
const rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "text", "and", "#second", "=", "text"),
expressionTokens: tokens(["#first", "=", "text", "and", "#second", "=", "text"]),
parsingContext: new ParsingContext(true)
});
@ -104,7 +108,7 @@ describe("Parser", () => {
it("simple label AND without explicit AND", () => {
const rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "text", "#second", "=", "text"),
expressionTokens: tokens(["#first", "=", "text", "#second", "=", "text"]),
parsingContext: new ParsingContext()
});
@ -121,7 +125,7 @@ describe("Parser", () => {
it("simple label OR", () => {
const rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "text", "or", "#second", "=", "text"),
expressionTokens: tokens(["#first", "=", "text", "or", "#second", "=", "text"]),
parsingContext: new ParsingContext()
});
@ -137,8 +141,8 @@ describe("Parser", () => {
it("fulltext and simple label", () => {
const rootExp = parse({
fulltextTokens: tokens("hello"),
expressionTokens: tokens("#mylabel", "=", "text"),
fulltextTokens: tokens(["hello"]),
expressionTokens: tokens(["#mylabel", "=", "text"]),
parsingContext: new ParsingContext()
});
@ -155,7 +159,7 @@ describe("Parser", () => {
it("label sub-expression", () => {
const rootExp = parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "text", "or", tokens("#second", "=", "text", "and", "#third", "=", "text")),
expressionTokens: tokens(["#first", "=", "text", "or", ["#second", "=", "text", "and", "#third", "=", "text"]]),
parsingContext: new ParsingContext()
});
@ -182,7 +186,7 @@ describe("Invalid expressions", () => {
parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "="),
expressionTokens: tokens(["#first", "="]),
parsingContext
});
@ -191,24 +195,26 @@ describe("Invalid expressions", () => {
it("comparison between labels is impossible", () => {
let parsingContext = new ParsingContext();
parsingContext.originalQuery = "#first = #second";
parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "#second"),
expressionTokens: tokens(["#first", "=", "#second"]),
parsingContext
});
expect(parsingContext.error).toEqual(`Error near token "#second", it's possible to compare with constant only.`);
expect(parsingContext.error).toEqual(`Error near token "#second" in "#first = #second", it's possible to compare with constant only.`);
parsingContext = new ParsingContext();
parsingContext.originalQuery = "#first = note.relations.second";
parse({
fulltextTokens: [],
expressionTokens: tokens("#first", "=", "note", ".", "relations", "second"),
expressionTokens: tokens(["#first", "=", "note", ".", "relations", "second"]),
parsingContext
});
expect(parsingContext.error).toEqual(`Error near token "note", it's possible to compare with constant only.`);
expect(parsingContext.error).toEqual(`Error near token "note" in "#first = note.relations.s...", it's possible to compare with constant only.`);
const rootExp = parse({
fulltextTokens: [],

1
src/services/search/parsing_context.js
View File

@ -5,6 +5,7 @@ class ParsingContext {
this.includeNoteContent = !!params.includeNoteContent;
this.fuzzyAttributeSearch = !!params.fuzzyAttributeSearch;
this.highlightedTokens = [];
this.originalQuery = "";
this.error = null;
}

6
src/services/search/services/handle_parens.js
View File

@ -1,7 +1,7 @@
/**
* This will create a recursive object from list of tokens - tokens between parenthesis are grouped in a single array
*/
function handle_parens(tokens) {
function handleParens(tokens) {
if (tokens.length === 0) {
return [];
}
@ -34,10 +34,10 @@ function handle_parens(tokens) {
tokens = [
...tokens.slice(0, leftIdx),
handle_parens(tokens.slice(leftIdx + 1, rightIdx)),
handleParens(tokens.slice(leftIdx + 1, rightIdx)),
...tokens.slice(rightIdx + 1)
];
}
}
module.exports = handle_parens;
module.exports = handleParens;

24
src/services/search/services/parse.js
View File

@ -51,6 +51,16 @@ function getExpression(tokens, parsingContext, level = 0) {
let i;
function context(i) {
let {startIndex, endIndex} = tokens[i];
startIndex = Math.max(0, startIndex - 20);
endIndex = Math.min(parsingContext.originalQuery.length, endIndex + 20);
return '"' + (startIndex !== 0 ? "..." : "")
+ parsingContext.originalQuery.substr(startIndex, endIndex - startIndex)
+ (endIndex !== parsingContext.originalQuery.length ? "..." : "") + '"';
}
function parseNoteProperty() {
if (tokens[i].token !== '.') {
parsingContext.addError('Expected "." to separate field path');
@ -65,7 +75,7 @@ function getExpression(tokens, parsingContext, level = 0) {
const operator = tokens[i].token;
if (!isOperator(operator)) {
parsingContext.addError(`After content expected operator, but got "${tokens[i].token}"`);
parsingContext.addError(`After content expected operator, but got "${tokens[i].token}" in ${context(i)}`);
return;
}
@ -97,7 +107,7 @@ function getExpression(tokens, parsingContext, level = 0) {
if (tokens[i].token === 'labels') {
if (tokens[i + 1].token !== '.') {
parsingContext.addError(`Expected "." to separate field path, got "${tokens[i + 1].token}"`);
parsingContext.addError(`Expected "." to separate field path, got "${tokens[i + 1].token}" in ${context(i)}`);
return;
}
@ -108,7 +118,7 @@ function getExpression(tokens, parsingContext, level = 0) {
if (tokens[i].token === 'relations') {
if (tokens[i + 1].token !== '.') {
parsingContext.addError(`Expected "." to separate field path, got "${tokens[i + 1].token}"`);
parsingContext.addError(`Expected "." to separate field path, got "${tokens[i + 1].token}" in ${context(i)}`);
return;
}
@ -124,7 +134,7 @@ function getExpression(tokens, parsingContext, level = 0) {
const comparator = comparatorBuilder(operator, comparedValue);
if (!comparator) {
parsingContext.addError(`Can't find operator '${operator}'`);
parsingContext.addError(`Can't find operator '${operator}' in ${context(i)}`);
return;
}
@ -133,7 +143,7 @@ function getExpression(tokens, parsingContext, level = 0) {
return new PropertyComparisonExp(propertyName, comparator);
}
parsingContext.addError(`Unrecognized note property "${tokens[i].token}"`);
parsingContext.addError(`Unrecognized note property "${tokens[i].token}" in ${context(i)}`);
}
function parseAttribute(name) {
@ -161,7 +171,7 @@ function getExpression(tokens, parsingContext, level = 0) {
if (!tokens[i + 2].inQuotes
&& (comparedValue.startsWith('#') || comparedValue.startsWith('~') || comparedValue === 'note')) {
parsingContext.addError(`Error near token "${comparedValue}", it's possible to compare with constant only.`);
parsingContext.addError(`Error near token "${comparedValue}" in ${context(i)}, it's possible to compare with constant only.`);
return;
}
@ -174,7 +184,7 @@ function getExpression(tokens, parsingContext, level = 0) {
const comparator = comparatorBuilder(operator, comparedValue);
if (!comparator) {
parsingContext.addError(`Can't find operator '${operator}'`);
parsingContext.addError(`Can't find operator '${operator}' in ${context(i)}`);
} else {
i += 2;

3
src/services/search/services/search.js
View File

@ -57,7 +57,8 @@ function parseQueryToExpression(query, parsingContext) {
const expression = parse({
fulltextTokens,
expressionTokens: structuredExpressionTokens,
parsingContext
parsingContext,
originalQuery: query
});
return expression;