Skip to content

Honor highlight other matches #299

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

Merged
sandhya-spend merged 2 commits into from
Mar 26, 2026
Merged

Honor highlight other matches #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
050f8f4
Honor highlight other matches
sandhya-spend Mar 26, 2026
b9098a3
Fix code style issues with Prettier
lint-action Mar 26, 2026
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
5 changes: 5 additions & 0 deletions .changeset/es_highlight_exclude.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'contexture-elasticsearch': patch
---

node.exclude is removed from highlighting only when `highlightOtherMatches` is falsy.
40 changes: 21 additions & 19 deletions packages/provider-elasticsearch/src/example-types/results/highlighting/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,25 +197,27 @@ export let getRequestHighlightFields = (schema, node) => {
// TODO: `highlightOtherMatches` is an undocumented configuration value that we
// are currently using to work around performance issues when highlighting
// fields not included in the node.
if (!node.highlight?.highlightOtherMatches && _.isArray(node.include)) {
const include = expandGlobs(schema, node.include)
let subFields = getSchemaSubFields({
fields: _.pick(include, schema.fields),
})
highlightFields = _.pick(
_.uniq([...include, ..._.keys(subFields)]),
highlightFields
)
}
if (_.isArray(node.exclude)) {
const exclude = expandGlobs(schema, node.exclude)
let subFields = getSchemaSubFields({
fields: _.pick(exclude, schema.fields),
})
highlightFields = _.omit(
_.uniq([...exclude, ..._.keys(subFields)]),
highlightFields
)
if (!node.highlight?.highlightOtherMatches) {
if (_.isArray(node.include)) {
const include = expandGlobs(schema, node.include)
let subFields = getSchemaSubFields({
fields: _.pick(include, schema.fields),
})
highlightFields = _.pick(
_.uniq([...include, ..._.keys(subFields)]),
highlightFields
)
}
if (_.isArray(node.exclude)) {
const exclude = expandGlobs(schema, node.exclude)
let subFields = getSchemaSubFields({
fields: _.pick(exclude, schema.fields),
})
highlightFields = _.omit(
_.uniq([...exclude, ..._.keys(subFields)]),
highlightFields
)
}
}

return F.mapValuesIndexed(
Expand Down
9 changes: 7 additions & 2 deletions packages/provider-elasticsearch/src/example-types/results/highlighting/request.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ describe('getRequestHighlightFields()', () => {
'city.street.subfield': {},
})
})
it('should expand exclude, irrespective of highlightOtherMatches', () => {
it('should expand exclude, depending on highlightOtherMatches', () => {
const schema = {
fields: {
state: {
Expand Down Expand Up @@ -530,7 +530,12 @@ describe('getRequestHighlightFields()', () => {
highlight: { highlightOtherMatches: true },
}
const actual1 = getRequestHighlightFields(schema, node1)
expect(actual1).toEqual({ state: {}, 'state.subfield': {} })
expect(actual1).toEqual({
state: {},
'state.subfield': {},
'city.street': {},
'city.street.subfield': {},
})
const node2 = {
exclude: ['city'],
highlight: { highlightOtherMatches: false },
Expand Down