Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[7.x] Fix vega specification parsing (#67963) #68867

Merged
merged 1 commit into from
Jun 11, 2020
Merged

[7.x] Fix vega specification parsing (#67963) #68867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/visualize/vega.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,19 @@ except that the time range is shifted back by 10 minutes:
// the auto-generated "MUST-NOT" clause
"%dashboard_context-must_not_clause%"
]
filter: [
// This string will be replaced
// with the auto-generated "FILTER" clause
"%dashboard_context-filter_clause%"
]
}
}
}
}
----

NOTE: When using `"%context%": true` or defining a value for "%timefield%"` the body cannot contain a query. To customize the query within the VEGA specification (e.g. add an additional filter, or shift the timefilter), define your query and use the placeholders as in the example above. The placeholders will be replaced by the actual context of the dashboard or visualization once parsed.

The `"%timefilter%"` can also be used to specify a single min or max
value. The date_histogram's `extended_bounds` can be set
with two values - min and max. Instead of hardcoding a value, you may
Expand Down
19 changes: 17 additions & 2 deletions src/plugins/vis_type_vega/public/data_model/es_query_parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { isPlainObject, cloneDeep } from 'lodash';
const TIMEFILTER = '%timefilter%';
const AUTOINTERVAL = '%autointerval%';
const MUST_CLAUSE = '%dashboard_context-must_clause%';
const FILTER_CLAUSE = '%dashboard_context-filter_clause%';
const MUST_NOT_CLAUSE = '%dashboard_context-must_not_clause%';

// These values may appear in the 'url': { ... } object
Expand Down Expand Up @@ -203,8 +204,22 @@ export class EsQueryParser {
// For arrays, replace MUST_CLAUSE and MUST_NOT_CLAUSE string elements
for (let pos = 0; pos < obj.length; ) {
const item = obj[pos];
if (isQuery && (item === MUST_CLAUSE || item === MUST_NOT_CLAUSE)) {
const ctxTag = item === MUST_CLAUSE ? 'must' : 'must_not';
if (
isQuery &&
(item === FILTER_CLAUSE || item === MUST_CLAUSE || item === MUST_NOT_CLAUSE)
) {
let ctxTag = '';
switch (item) {
case FILTER_CLAUSE:
ctxTag = 'filter';
break;
case MUST_CLAUSE:
ctxTag = 'must';
break;
case MUST_NOT_CLAUSE:
ctxTag = 'must_not';
break;
}
const ctx = cloneDeep(this._filters);
if (ctx && ctx.bool && ctx.bool[ctxTag]) {
if (Array.isArray(ctx.bool[ctxTag])) {
Expand Down
35 changes: 29 additions & 6 deletions src/plugins/vis_type_vega/public/data_model/es_query_parser.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ const day = 24 * hour;

const rangeStart = 10 * day;
const rangeEnd = 12 * day;
const ctxArr = { bool: { must: [{ match_all: { c: 3 } }], must_not: [{ d: 4 }] } };
const ctxObj = { bool: { must: { match_all: { a: 1 } }, must_not: { b: 2 } } };
const ctxArr = {
bool: { must: [{ match_all: { c: 3 } }], must_not: [{ d: 4 }], filter: [{ f: 6 }] },
};
const ctxObj = {
bool: { must: { match_all: { a: 1 } }, must_not: { b: 2 }, filter: { e: 6 } },
};

function create(min, max, dashboardCtx) {
const inst = new EsQueryParser(
Expand Down Expand Up @@ -152,16 +156,34 @@ describe(`EsQueryParser.injectQueryContextVars`, () => {
test(
`mixed clause arr`,
check(
{ arr: [1, '%dashboard_context-must_clause%', 2, '%dashboard_context-must_not_clause%'] },
{ arr: [1, ...ctxArr.bool.must, 2, ...ctxArr.bool.must_not] },
{
arr: [
1,
'%dashboard_context-must_clause%',
2,
'%dashboard_context-must_not_clause%',
3,
'%dashboard_context-filter_clause%',
],
},
{ arr: [1, ...ctxArr.bool.must, 2, ...ctxArr.bool.must_not, 3, ...ctxArr.bool.filter] },
ctxArr
)
);
test(
`mixed clause obj`,
check(
{ arr: ['%dashboard_context-must_clause%', 1, '%dashboard_context-must_not_clause%', 2] },
{ arr: [ctxObj.bool.must, 1, ctxObj.bool.must_not, 2] },
{
arr: [
'%dashboard_context-must_clause%',
1,
'%dashboard_context-must_not_clause%',
2,
'%dashboard_context-filter_clause%',
3,
],
},
{ arr: [ctxObj.bool.must, 1, ctxObj.bool.must_not, 2, ctxObj.bool.filter, 3] },
ctxObj
)
);
Expand Down Expand Up @@ -229,6 +251,7 @@ describe(`EsQueryParser.parseEsRequest`, () => {
},
],
must_not: [{ d: 4 }],
filter: [{ f: 6 }],
},
},
},
Expand Down