From 11fa7c697e364aeb08c4c343f2bd9b52851b18ec Mon Sep 17 00:00:00 2001
From: Ryan McKinley <ryantxu@gmail.com>
Date: Thu, 4 Feb 2021 12:23:05 -0800
Subject: [PATCH] Transformers: add search to transform selection (#30854)

---
 .../src/selectors/components.ts               |   1 +
 .../TransformationsEditor.test.tsx            |   4 +-
 .../TransformationsEditor.tsx                 | 194 ++++++++++++------
 3 files changed, 132 insertions(+), 67 deletions(-)

diff --git a/packages/grafana-e2e-selectors/src/selectors/components.ts b/packages/grafana-e2e-selectors/src/selectors/components.ts
index a8bc8ba9234..a261cc18ea9 100644
--- a/packages/grafana-e2e-selectors/src/selectors/components.ts
+++ b/packages/grafana-e2e-selectors/src/selectors/components.ts
@@ -122,6 +122,7 @@ export const Components = {
       modeLabel: 'Transform mode label',
       calculationsLabel: 'Transform calculations label',
     },
+    searchInput: 'search transformations',
   },
   PageToolbar: {
     container: () => '.page-toolbar',
diff --git a/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.test.tsx b/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.test.tsx
index 4d1920eed50..5269a9a6d37 100644
--- a/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.test.tsx
+++ b/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.test.tsx
@@ -51,8 +51,8 @@ describe('TransformationsEditor', () => {
       const addTransformationButton = screen.getByText(buttonLabel);
       userEvent.click(addTransformationButton);
 
-      const picker = screen.getByLabelText(selectors.components.ValuePicker.select(buttonLabel));
-      expect(picker).toBeDefined();
+      const search = screen.getByLabelText(selectors.components.Transforms.searchInput);
+      expect(search).toBeDefined();
     });
   });
 
diff --git a/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.tsx b/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.tsx
index 191b42b6596..c1324bed2ed 100644
--- a/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.tsx
+++ b/public/app/features/dashboard/components/TransformationsEditor/TransformationsEditor.tsx
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { ChangeEvent } from 'react';
 import {
   Alert,
   Button,
@@ -8,9 +8,10 @@ import {
   Themeable,
   DismissableFeatureInfoBox,
   useTheme,
-  ValuePicker,
   VerticalGroup,
   withTheme,
+  Input,
+  IconButton,
 } from '@grafana/ui';
 import {
   DataFrame,
@@ -40,6 +41,8 @@ interface TransformationsEditorProps extends Themeable {
 interface State {
   data: DataFrame[];
   transformations: TransformationsEditorTransformation[];
+  search: string;
+  showPicker?: boolean;
 }
 
 class UnThemedTransformationsEditor extends React.PureComponent<TransformationsEditorProps, State> {
@@ -56,9 +59,34 @@ class UnThemedTransformationsEditor extends React.PureComponent<TransformationsE
         id: ids[i],
       })),
       data: [],
+      search: '',
     };
   }
 
+  onSearchChange = (event: ChangeEvent<HTMLInputElement>) => {
+    this.setState({ search: event.target.value });
+  };
+
+  onSearchKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => {
+    if (event.key === 'Enter') {
+      const { search } = this.state;
+      if (search) {
+        const lower = search.toLowerCase();
+        const filtered = standardTransformersRegistry.list().filter((t) => {
+          const txt = (t.name + t.description).toLowerCase();
+          return txt.indexOf(lower) >= 0;
+        });
+        if (filtered.length > 0) {
+          this.onTransformationAdd({ value: filtered[0].id });
+        }
+      }
+    } else if (event.keyCode === 27) {
+      // Escape key
+      this.setState({ search: '', showPicker: false });
+      event.stopPropagation(); // don't exit the editor
+    }
+  };
+
   buildTransformationIds(transformations: DataTransformerConfig[]) {
     const transformationCounters: Record<string, number> = {};
     const transformationIds: string[] = [];
@@ -113,6 +141,7 @@ class UnThemedTransformationsEditor extends React.PureComponent<TransformationsE
     const { transformations } = this.state;
 
     const nextId = this.getTransformationNextId(selectable.value!);
+    this.setState({ search: '', showPicker: false });
     this.onChange([
       ...transformations,
       {
@@ -139,33 +168,6 @@ class UnThemedTransformationsEditor extends React.PureComponent<TransformationsE
     this.onChange(next);
   };
 
-  renderTransformationSelector = () => {
-    const availableTransformers = standardTransformersRegistry.list().map((t) => {
-      return {
-        value: t.transformation.id,
-        label: t.name,
-        description: t.description,
-      };
-    });
-
-    return (
-      <div
-        className={css`
-          max-width: 66%;
-        `}
-      >
-        <ValuePicker
-          size="md"
-          variant="secondary"
-          label="Add transformation"
-          options={availableTransformers}
-          onChange={this.onTransformationAdd}
-          isFullWidth={false}
-        />
-      </div>
-    );
-  };
-
   onDragEnd = (result: DropResult) => {
     const { transformations } = this.state;
 
@@ -208,43 +210,106 @@ class UnThemedTransformationsEditor extends React.PureComponent<TransformationsE
     );
   };
 
-  renderNoAddedTransformsState() {
+  renderTransformsPicker() {
+    const { transformations, search } = this.state;
+    let suffix: React.ReactNode = null;
+    let xforms = standardTransformersRegistry.list();
+    if (search) {
+      const lower = search.toLowerCase();
+      const filtered = xforms.filter((t) => {
+        const txt = (t.name + t.description).toLowerCase();
+        return txt.indexOf(lower) >= 0;
+      });
+      suffix = (
+        <>
+          {filtered.length} / {xforms.length} &nbsp;&nbsp;
+          <IconButton
+            name="times"
+            surface="header"
+            onClick={() => {
+              this.setState({ search: '' });
+            }}
+          />
+        </>
+      );
+
+      xforms = filtered;
+    }
+
+    const noTransforms = !transformations?.length;
+    const showPicker = noTransforms || this.state.showPicker;
+    if (!suffix && showPicker && !noTransforms) {
+      suffix = (
+        <IconButton
+          name="times"
+          surface="header"
+          onClick={() => {
+            this.setState({ showPicker: false });
+          }}
+        />
+      );
+    }
+
     return (
       <>
-        <Container grow={1}>
-          <DismissableFeatureInfoBox
-            title="Transformations"
-            className={css`
-              margin-bottom: ${this.props.theme.spacing.lg};
-            `}
-            persistenceId="transformationsFeaturesInfoBox"
-            url={getDocsLink(DocsId.Transformations)}
+        {noTransforms && (
+          <Container grow={1}>
+            <DismissableFeatureInfoBox
+              title="Transformations"
+              className={css`
+                margin-bottom: ${this.props.theme.spacing.lg};
+              `}
+              persistenceId="transformationsFeaturesInfoBox"
+              url={getDocsLink(DocsId.Transformations)}
+            >
+              <p>
+                Transformations allow you to join, calculate, re-order, hide and rename your query results before being
+                visualized. <br />
+                Many transforms are not suitable if you&apos;re using the Graph visualization as it currently only
+                supports time series. <br />
+                It can help to switch to Table visualization to understand what a transformation is doing. <br />
+              </p>
+            </DismissableFeatureInfoBox>
+          </Container>
+        )}
+        {showPicker ? (
+          <VerticalGroup>
+            <Input
+              aria-label={selectors.components.Transforms.searchInput}
+              value={search ?? ''}
+              autoFocus={!noTransforms}
+              placeholder="Add transformation"
+              onChange={this.onSearchChange}
+              onKeyDown={this.onSearchKeyDown}
+              suffix={suffix}
+            />
+
+            {xforms.map((t) => {
+              return (
+                <TransformationCard
+                  key={t.name}
+                  title={t.name}
+                  description={t.description}
+                  actions={<Button>Select</Button>}
+                  ariaLabel={selectors.components.TransformTab.newTransform(t.name)}
+                  onClick={() => {
+                    this.onTransformationAdd({ value: t.id });
+                  }}
+                />
+              );
+            })}
+          </VerticalGroup>
+        ) : (
+          <Button
+            icon="plus"
+            variant="secondary"
+            onClick={() => {
+              this.setState({ showPicker: true });
+            }}
           >
-            <p>
-              Transformations allow you to join, calculate, re-order, hide and rename your query results before being
-              visualized. <br />
-              Many transforms are not suitable if you&apos;re using the Graph visualization as it currently only
-              supports time series. <br />
-              It can help to switch to Table visualization to understand what a transformation is doing. <br />
-            </p>
-          </DismissableFeatureInfoBox>
-        </Container>
-        <VerticalGroup>
-          {standardTransformersRegistry.list().map((t) => {
-            return (
-              <TransformationCard
-                key={t.name}
-                title={t.name}
-                description={t.description}
-                actions={<Button>Select</Button>}
-                ariaLabel={selectors.components.TransformTab.newTransform(t.name)}
-                onClick={() => {
-                  this.onTransformationAdd({ value: t.id });
-                }}
-              />
-            );
-          })}
-        </VerticalGroup>
+            Add transformation
+          </Button>
+        )}
       </>
     );
   }
@@ -271,9 +336,8 @@ class UnThemedTransformationsEditor extends React.PureComponent<TransformationsE
                 title="Transformations can't be used on a panel with alerts"
               />
             ) : null}
-            {!hasTransforms && this.renderNoAddedTransformsState()}
             {hasTransforms && this.renderTransformationEditors()}
-            {hasTransforms && this.renderTransformationSelector()}
+            {this.renderTransformsPicker()}
           </div>
         </Container>
       </CustomScrollbar>