From 2e3c2b90ca7bda42ce948856f63a6b76dee663d7 Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Tue, 4 Mar 2025 06:56:47 +1100
Subject: [PATCH] [8.x] [ES|QL] Makes the clear control button optional
 (#212848) (#212967)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[ES|QL] Makes the clear control button optional
(#212848)](https://github.com/elastic/kibana/pull/212848)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Stratoula
Kalafateli","email":"efstratia.kalafateli@elastic.co"},"sourceCommit":{"committedDate":"2025-03-03T18:03:57Z","message":"[ES|QL]
Makes the clear control button optional (#212848)\n\n##
Summary\n\nCloses
https://github.com/elastic/kibana/issues/212605\n\nHere we are removing
the clear button from the ES|QL control as clearing\nwill result in
wrong charts. I also considered the reset but when there\nis no changes
should be hidden or disabled. This seems to me as a\nsmaller change and
taken under consideration that dashboard already\nallows resetting I
think it is ok to remove it.\n\nWe can always reconsider if any user
complains.\n\nAlthough by removing the clearSelections from the control
config removes\nthe button the `DefaultControlApi ` was marking it as
required. So I had\nto tweak a bit the
types.","sha":"f6978eaf7b511791039210dd9643b68ae3b6b242","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:ES|QL","Team:ESQL","backport:version","v9.1.0","v8.19.0"],"title":"[ES|QL]
Makes the clear control button
optional","number":212848,"url":"https://github.com/elastic/kibana/pull/212848","mergeCommit":{"message":"[ES|QL]
Makes the clear control button optional (#212848)\n\n##
Summary\n\nCloses
https://github.com/elastic/kibana/issues/212605\n\nHere we are removing
the clear button from the ES|QL control as clearing\nwill result in
wrong charts. I also considered the reset but when there\nis no changes
should be hidden or disabled. This seems to me as a\nsmaller change and
taken under consideration that dashboard already\nallows resetting I
think it is ok to remove it.\n\nWe can always reconsider if any user
complains.\n\nAlthough by removing the clearSelections from the control
config removes\nthe button the `DefaultControlApi ` was marking it as
required. So I had\nto tweak a bit the
types.","sha":"f6978eaf7b511791039210dd9643b68ae3b6b242"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212848","number":212848,"mergeCommit":{"message":"[ES|QL]
Makes the clear control button optional (#212848)\n\n##
Summary\n\nCloses
https://github.com/elastic/kibana/issues/212605\n\nHere we are removing
the clear button from the ES|QL control as clearing\nwill result in
wrong charts. I also considered the reset but when there\nis no changes
should be hidden or disabled. This seems to me as a\nsmaller change and
taken under consideration that dashboard already\nallows resetting I
think it is ok to remove it.\n\nWe can always reconsider if any user
complains.\n\nAlthough by removing the clearSelections from the control
config removes\nthe button the `DefaultControlApi ` was marking it as
required. So I had\nto tweak a bit the
types.","sha":"f6978eaf7b511791039210dd9643b68ae3b6b242"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
---
 .../app/control_group_renderer_examples/search_example.tsx     | 2 +-
 .../public/controls/esql_control/get_esql_control_factory.tsx  | 3 ---
 src/platform/plugins/shared/controls/public/controls/types.ts  | 2 +-
 3 files changed, 2 insertions(+), 5 deletions(-)

diff --git a/examples/controls_example/public/app/control_group_renderer_examples/search_example.tsx b/examples/controls_example/public/app/control_group_renderer_examples/search_example.tsx
index 651377e7393ba..7c40bfd4a424b 100644
--- a/examples/controls_example/public/app/control_group_renderer_examples/search_example.tsx
+++ b/examples/controls_example/public/app/control_group_renderer_examples/search_example.tsx
@@ -180,7 +180,7 @@ export const SearchExample = ({ data, dataView, navigation }: Props) => {
           onClick={() => {
             if (controlGroupAPI) {
               Object.values(controlGroupAPI.children$.getValue()).forEach((controlApi) => {
-                (controlApi as DefaultControlApi)?.clearSelections();
+                (controlApi as DefaultControlApi)?.clearSelections?.();
               });
             }
           }}
diff --git a/src/platform/plugins/shared/controls/public/controls/esql_control/get_esql_control_factory.tsx b/src/platform/plugins/shared/controls/public/controls/esql_control/get_esql_control_factory.tsx
index f7a599e22cca0..8cc864f1d37fc 100644
--- a/src/platform/plugins/shared/controls/public/controls/esql_control/get_esql_control_factory.tsx
+++ b/src/platform/plugins/shared/controls/public/controls/esql_control/get_esql_control_factory.tsx
@@ -96,9 +96,6 @@ export const getESQLControlFactory = (): ControlFactory<ESQLControlState, ESQLCo
               references: [],
             };
           },
-          clearSelections: () => {
-            // do nothing, not allowed for now;
-          },
         },
         {
           ...defaultControl.comparators,
diff --git a/src/platform/plugins/shared/controls/public/controls/types.ts b/src/platform/plugins/shared/controls/public/controls/types.ts
index a998ea4d54c75..d2fd714d9587a 100644
--- a/src/platform/plugins/shared/controls/public/controls/types.ts
+++ b/src/platform/plugins/shared/controls/public/controls/types.ts
@@ -36,7 +36,7 @@ export type DefaultControlApi = PublishesDataLoading &
   PublishesBlockingError &
   PublishesUnsavedChanges &
   Partial<PublishesTitle & PublishesDisabledActionIds & HasCustomPrepend> &
-  CanClearSelections &
+  Partial<CanClearSelections> &
   HasType &
   HasUniqueId &
   HasSerializableState<DefaultControlState> &