elastic/elasticsearch

Add a checkCancelled public method to ContextIndexSearcher

Open

#121,349 建立於 2025年1月30日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Java (76,700 star) (25,882 fork)batch import
:Search Foundations/Search>enhancementTeam:Search Foundationshelp wanted

描述

Description

The ContextIndexSearcher has some API to deal with cancelled tasks, see for example hasCancellations() below. Acting on cancelled tasks can be useful in ValueFetchers (which can be implemented by plugins via custom runtime fields), where resources can be released in such a case. Although the method hasCancellations() is public and accessible to plugins, there is however no access point to its counterpart checkCancelled() (see below): that method would be needed to check if the search's task got cancelled (and act upon it).

  • Would it be possible to add a public access method to checkCancelled(), in order to allow plugins to handle cancellations in custom runtime fields ?
  • Related question: are IndexSearchers used in Elasticsearch all ContextIndexSearcher instances ?

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/search/internal/ContextIndexSearcher.java#L193

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/index/mapper/MappedFieldType.java#L118

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/search/internal/ContextIndexSearcher.java#L594

貢獻者指南

技術棧
java
領域
backend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaElasticsearch search internals
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Examine ContextIndexSearcher.java (lines 193 and 594) to understand the existing private checkCancelled method and its relationship to hasCancellations. Check the linked MappedFieldType.java to understand how ValueFetchers use cancellation. Review comments in the issue #121349 for maintainer feedback on whether all IndexSearcher instances are ContextIndexSearcher, and whether a public method is acceptable. The change may involve adding a simple public wrapper that delegates to the private checkCancelled, following existing patterns.