From 690bd06a48d62d1ef227bc7740a4838af4b2b002 Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Fri, 22 Nov 2024 03:03:39 +1100
Subject: [PATCH] [8.x] [Session management] update cleanup to allow partial
 search results for PIT query (#200912) (#201205)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Session management] update cleanup to allow partial search results
for PIT query (#200912)](https://github.com/elastic/kibana/pull/200912)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"Sid","email":"siddharthmantri1@gmail.com"},"sourceCommit":{"committedDate":"2024-11-21T14:14:54Z","message":"[Session
management] update cleanup to allow partial search results for PIT query
(#200912)\n\nCloses
https://github.com/elastic/kibana/issues/200008\r\n\r\n##
Summary\r\nThis PR updates the session cleanup task to allow partial
results in the\r\npoint in time query used to delete any invalid
sessions.\r\n\r\n\r\n### Notes\r\nUsing a [recently introduced option
by\r\nES](https://github.com/elastic/elasticsearch/pull/111516), the
session\r\ncleanup now allows the PIT to run over partial results. This
should\r\nreduce the noise we see around session_cleanup errors in our
logs.\r\n\r\n\r\n### Release notes\r\nFixes error with opening point in
time query for session deletion by now\r\naccounting for partial
results.\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies following
conditions. \r\n\r\nReviewers should verify this PR satisfies this list
as well.\r\n\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"8f12714219ca4b4c8e58678d42e9978c3defa40b","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:fix","Team:Security","v9.0.0","Feature:Security/Session
Management","backport:prev-major"],"title":"[Session management] update
cleanup to allow partial search results for PIT
query","number":200912,"url":"https://github.com/elastic/kibana/pull/200912","mergeCommit":{"message":"[Session
management] update cleanup to allow partial search results for PIT query
(#200912)\n\nCloses
https://github.com/elastic/kibana/issues/200008\r\n\r\n##
Summary\r\nThis PR updates the session cleanup task to allow partial
results in the\r\npoint in time query used to delete any invalid
sessions.\r\n\r\n\r\n### Notes\r\nUsing a [recently introduced option
by\r\nES](https://github.com/elastic/elasticsearch/pull/111516), the
session\r\ncleanup now allows the PIT to run over partial results. This
should\r\nreduce the noise we see around session_cleanup errors in our
logs.\r\n\r\n\r\n### Release notes\r\nFixes error with opening point in
time query for session deletion by now\r\naccounting for partial
results.\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies following
conditions. \r\n\r\nReviewers should verify this PR satisfies this list
as well.\r\n\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"8f12714219ca4b4c8e58678d42e9978c3defa40b"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/200912","number":200912,"mergeCommit":{"message":"[Session
management] update cleanup to allow partial search results for PIT query
(#200912)\n\nCloses
https://github.com/elastic/kibana/issues/200008\r\n\r\n##
Summary\r\nThis PR updates the session cleanup task to allow partial
results in the\r\npoint in time query used to delete any invalid
sessions.\r\n\r\n\r\n### Notes\r\nUsing a [recently introduced option
by\r\nES](https://github.com/elastic/elasticsearch/pull/111516), the
session\r\ncleanup now allows the PIT to run over partial results. This
should\r\nreduce the noise we see around session_cleanup errors in our
logs.\r\n\r\n\r\n### Release notes\r\nFixes error with opening point in
time query for session deletion by now\r\naccounting for partial
results.\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies following
conditions. \r\n\r\nReviewers should verify this PR satisfies this list
as well.\r\n\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"8f12714219ca4b4c8e58678d42e9978c3defa40b"}}]}]
BACKPORT-->

Co-authored-by: Sid <siddharthmantri1@gmail.com>
---
 .../security/server/session_management/session_index.test.ts | 5 +++++
 .../security/server/session_management/session_index.ts      | 1 +
 2 files changed, 6 insertions(+)

diff --git a/x-pack/plugins/security/server/session_management/session_index.test.ts b/x-pack/plugins/security/server/session_management/session_index.test.ts
index e1890273469ed..04991f4aeefd6 100644
--- a/x-pack/plugins/security/server/session_management/session_index.test.ts
+++ b/x-pack/plugins/security/server/session_management/session_index.test.ts
@@ -473,6 +473,7 @@ describe('Session index', () => {
       expect(mockElasticsearchClient.search).toHaveBeenCalledTimes(1);
       expect(mockElasticsearchClient.search).toHaveBeenCalledWith({
         _source_includes: 'usernameHash,provider',
+        allow_partial_search_results: true,
         sort: '_shard_doc',
         track_total_hits: false,
         search_after: undefined,
@@ -555,6 +556,7 @@ describe('Session index', () => {
       expect(mockElasticsearchClient.search).toHaveBeenCalledTimes(1);
       expect(mockElasticsearchClient.search).toHaveBeenCalledWith({
         _source_includes: 'usernameHash,provider',
+        allow_partial_search_results: true,
         sort: '_shard_doc',
         track_total_hits: false,
         search_after: undefined,
@@ -649,6 +651,7 @@ describe('Session index', () => {
       expect(mockElasticsearchClient.search).toHaveBeenCalledTimes(1);
       expect(mockElasticsearchClient.search).toHaveBeenCalledWith({
         _source_includes: 'usernameHash,provider',
+        allow_partial_search_results: true,
         sort: '_shard_doc',
         track_total_hits: false,
         search_after: undefined,
@@ -737,6 +740,7 @@ describe('Session index', () => {
       expect(mockElasticsearchClient.search).toHaveBeenCalledTimes(1);
       expect(mockElasticsearchClient.search).toHaveBeenCalledWith({
         _source_includes: 'usernameHash,provider',
+        allow_partial_search_results: true,
         sort: '_shard_doc',
         track_total_hits: false,
         search_after: undefined,
@@ -850,6 +854,7 @@ describe('Session index', () => {
       expect(mockElasticsearchClient.search).toHaveBeenCalledTimes(1);
       expect(mockElasticsearchClient.search).toHaveBeenCalledWith({
         _source_includes: 'usernameHash,provider',
+        allow_partial_search_results: true,
         sort: '_shard_doc',
         track_total_hits: false,
         search_after: undefined,
diff --git a/x-pack/plugins/security/server/session_management/session_index.ts b/x-pack/plugins/security/server/session_management/session_index.ts
index 9f11e9224243c..9166ec9deb91f 100644
--- a/x-pack/plugins/security/server/session_management/session_index.ts
+++ b/x-pack/plugins/security/server/session_management/session_index.ts
@@ -857,6 +857,7 @@ export class SessionIndex {
           size: SESSION_INDEX_CLEANUP_BATCH_SIZE,
           sort: '_shard_doc',
           track_total_hits: false, // for performance
+          allow_partial_search_results: true,
         });
         const { hits } = searchResponse.hits;
         if (hits.length > 0) {