Support the query parameter in requests to Painless

elastic · Mar 17, 2020 · a592009 · a592009
1 parent 6b3b777
commit a592009
Show file tree

Hide file tree

Showing 8 changed files with 154 additions and 72 deletions.
diff --git a/x-pack/plugins/painless_lab/public/application/common/types.ts b/x-pack/plugins/painless_lab/public/application/common/types.ts
@@ -13,6 +13,7 @@ export interface RequestPayloadConfig {
   parameters?: string;
   index?: string;
   document?: string;
+  query?: string;
 }
 
 export enum PayloadFormat {

diff --git a/x-pack/plugins/painless_lab/public/application/components/main.tsx b/x-pack/plugins/painless_lab/public/application/components/main.tsx
@@ -30,14 +30,15 @@ export function Main({ http }: Props) {
     parameters: '',
     index: '',
     document: '',
+    query: '',
     ...JSON.parse(localStorage.getItem(PAINLESS_LAB_KEY) || '{}'),
   }));
 
   const [isRequestFlyoutOpen, setRequestFlyoutOpen] = useState(false);
   const { inProgress, response, submit } = useSubmitCode(http);
 
   // Live-update the output and persist state as the user changes it.
-  const { code, context, parameters, index, document } = state;
+  const { code, context, parameters, index, document, query } = state;
   useEffect(() => {
     submit(state);
     localStorage.setItem(PAINLESS_LAB_KEY, JSON.stringify(state));
@@ -63,13 +64,17 @@ export function Main({ http }: Props) {
     setState({ ...state, document: newDocument });
   };
 
+  const onQueryChange = (newQuery: string) => {
+    setState({ ...state, query: newQuery });
+  };
+
   const toggleRequestFlyout = () => {
     setRequestFlyoutOpen(!isRequestFlyoutOpen);
   };
 
   return (
-    <>
-      <EuiFlexGroup gutterSize="s">
+    <div className="painlessLabMainContainer">
+      <EuiFlexGroup className="painlessLabPanelsContainer" responsive={false} gutterSize="none">
         <EuiFlexItem>
           <EuiTitle className="euiScreenReaderOnly">
             <h1>
@@ -90,10 +95,12 @@ export function Main({ http }: Props) {
             parameters={parameters}
             index={index}
             document={document}
+            query={query}
             onContextChange={onContextChange}
             onParametersChange={onParametersChange}
             onIndexChange={onIndexChange}
             onDocumentChange={onDocumentChange}
+            onQueryChange={onQueryChange}
           />
         </EuiFlexItem>
       </EuiFlexGroup>
@@ -108,13 +115,10 @@ export function Main({ http }: Props) {
       {isRequestFlyoutOpen && (
         <RequestFlyout
           onClose={() => setRequestFlyoutOpen(false)}
-          requestBody={formatRequestPayload(
-            { code, context, document, index, parameters },
-            PayloadFormat.PRETTY
-          )}
+          requestBody={formatRequestPayload(state, PayloadFormat.PRETTY)}
           response={response ? formatJson(response.result || response.error) : ''}
         />
       )}
-    </>
+    </div>
   );
 }
diff --git a/x-pack/plugins/painless_lab/public/application/components/main_controls.tsx b/x-pack/plugins/painless_lab/public/application/components/main_controls.tsx
@@ -77,58 +77,54 @@ export function MainControls({ toggleRequestFlyout, isRequestFlyoutOpen, reset }
   ];
 
   return (
-    <>
-      <div className="painlessLabBottomBarPlaceholder" />
-
-      <EuiBottomBar paddingSize="s">
-        <EuiFlexGroup gutterSize="s" justifyContent="spaceBetween">
-          <EuiFlexItem grow={false}>
-            <EuiFlexGroup gutterSize="s" justifyContent="flexStart">
-              <EuiFlexItem grow={false}>
-                <EuiPopover
-                  id="painlessLabHelpContextMenu"
-                  button={
-                    <EuiButtonEmpty
-                      size="s"
-                      iconType="help"
-                      iconSide="left"
-                      color="ghost"
-                      onClick={() => setIsHelpOpen(!isHelpOpen)}
-                    >
-                      {i18n.translate('xpack.painlessLab.helpButtonLabel', {
-                        defaultMessage: 'Help',
-                      })}
-                    </EuiButtonEmpty>
-                  }
-                  isOpen={isHelpOpen}
-                  closePopover={() => setIsHelpOpen(false)}
-                  panelPaddingSize="none"
-                  withTitle
-                  anchorPosition="upRight"
-                >
-                  <EuiContextMenuPanel items={items} />
-                </EuiPopover>
-              </EuiFlexItem>
-            </EuiFlexGroup>
-          </EuiFlexItem>
-          <EuiFlexItem grow={false}>
-            <EuiButtonEmpty
-              size="s"
-              color="ghost"
-              onClick={toggleRequestFlyout}
-              data-test-subj="btnViewRequest"
-            >
-              {isRequestFlyoutOpen
-                ? i18n.translate('xpack.painlessLab.hideRequestButtonLabel', {
-                    defaultMessage: 'Hide API request',
-                  })
-                : i18n.translate('xpack.painlessLab.showRequestButtonLabel', {
-                    defaultMessage: 'Show API request',
-                  })}
-            </EuiButtonEmpty>
-          </EuiFlexItem>
-        </EuiFlexGroup>
-      </EuiBottomBar>
-    </>
+    <EuiBottomBar paddingSize="s">
+      <EuiFlexGroup gutterSize="s" justifyContent="spaceBetween">
+        <EuiFlexItem grow={false}>
+          <EuiFlexGroup gutterSize="s" justifyContent="flexStart">
+            <EuiFlexItem grow={false}>
+              <EuiPopover
+                id="painlessLabHelpContextMenu"
+                button={
+                  <EuiButtonEmpty
+                    size="s"
+                    iconType="help"
+                    iconSide="left"
+                    color="ghost"
+                    onClick={() => setIsHelpOpen(!isHelpOpen)}
+                  >
+                    {i18n.translate('xpack.painlessLab.helpButtonLabel', {
+                      defaultMessage: 'Help',
+                    })}
+                  </EuiButtonEmpty>
+                }
+                isOpen={isHelpOpen}
+                closePopover={() => setIsHelpOpen(false)}
+                panelPaddingSize="none"
+                withTitle
+                anchorPosition="upRight"
+              >
+                <EuiContextMenuPanel items={items} />
+              </EuiPopover>
+            </EuiFlexItem>
+          </EuiFlexGroup>
+        </EuiFlexItem>
+        <EuiFlexItem grow={false}>
+          <EuiButtonEmpty
+            size="s"
+            color="ghost"
+            onClick={toggleRequestFlyout}
+            data-test-subj="btnViewRequest"
+          >
+            {isRequestFlyoutOpen
+              ? i18n.translate('xpack.painlessLab.hideRequestButtonLabel', {
+                  defaultMessage: 'Hide API request',
+                })
+              : i18n.translate('xpack.painlessLab.showRequestButtonLabel', {
+                  defaultMessage: 'Show API request',
+                })}
+          </EuiButtonEmpty>
+        </EuiFlexItem>
+      </EuiFlexGroup>
+    </EuiBottomBar>
   );
 }
diff --git a/x-pack/plugins/painless_lab/public/application/components/output_pane/context_tab.tsx b/x-pack/plugins/painless_lab/public/application/components/output_pane/context_tab.tsx
@@ -26,18 +26,22 @@ interface Props {
   context: any;
   index: string;
   document: string;
+  query: string;
   onContextChange: (context: string) => void;
   onIndexChange: (index: string) => void;
   onDocumentChange: (document: string) => void;
+  onQueryChange: (query: string) => void;
 }
 
 export const ContextTab = ({
   context,
   index,
   document,
+  query,
   onContextChange,
   onIndexChange,
   onDocumentChange,
+  onQueryChange,
 }: Props) => (
   <>
     <EuiSpacer size="m" />
@@ -100,6 +104,56 @@ export const ContextTab = ({
         <EuiFieldText fullWidth value={index || ''} onChange={e => onIndexChange(e.target.value)} />
       </EuiFormRow>
     )}
+    {/* Query DSL Code Editor */}
+    {'score'.indexOf(context) !== -1 && (
+      <EuiFormRow
+        label={
+          <EuiToolTip
+            content={i18n.translate('xpack.painlessLab.queryFieldLabel', {
+              defaultMessage:
+                'Use query to specify that that _score will be used to calculate score.',
+            })}
+          >
+            <span>
+              <FormattedMessage id="xpack.painlessLab.indexFieldLabel" defaultMessage="Query" />{' '}
+              <EuiIcon type="questionInCircle" color="subdued" />
+            </span>
+          </EuiToolTip>
+        }
+        labelAppend={
+          <EuiText size="xs">
+            <EuiLink
+              href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html"
+              target="_blank"
+            >
+              {i18n.translate('xpack.painlessLab.queryFieldDocLinkText', {
+                defaultMessage: 'Query DSL docs',
+              })}
+            </EuiLink>
+          </EuiText>
+        }
+        fullWidth
+      >
+        <EuiPanel paddingSize="s">
+          <CodeEditor
+            languageId="json"
+            height={150}
+            value={query}
+            onChange={onQueryChange}
+            options={{
+              fontSize: 12,
+              minimap: {
+                enabled: false,
+              },
+              scrollBeyondLastLine: false,
+              wordWrap: 'on',
+              wrappingIndent: 'indent',
+              automaticLayout: true,
+            }}
+          />
+        </EuiPanel>
+      </EuiFormRow>
+    )}
     {['filter', 'score'].indexOf(context) !== -1 && (
       <EuiFormRow
         label={

diff --git a/x-pack/plugins/painless_lab/public/application/components/output_pane/output_pane.tsx b/x-pack/plugins/painless_lab/public/application/components/output_pane/output_pane.tsx
@@ -27,10 +27,12 @@ interface Props {
   parameters: string;
   index: string;
   document: string;
+  query: string;
   onContextChange: (change: string) => void;
   onParametersChange: (change: string) => void;
   onIndexChange: (change: string) => void;
   onDocumentChange: (change: string) => void;
+  onQueryChange: (change: string) => void;
 }
 
 export function OutputPane({
@@ -40,10 +42,12 @@ export function OutputPane({
   parameters,
   index,
   document,
+  query,
   onContextChange,
   onParametersChange,
   onIndexChange,
   onDocumentChange,
+  onQueryChange,
 }: Props) {
   const outputTabLabel = (
     <EuiFlexGroup gutterSize="s" alignItems="center">
@@ -96,9 +100,11 @@ export function OutputPane({
                 context={context}
                 index={index}
                 document={document}
+                query={query}
                 onContextChange={onContextChange}
                 onIndexChange={onIndexChange}
                 onDocumentChange={onDocumentChange}
+                onQueryChange={onQueryChange}
               />
             ),
           },

diff --git a/x-pack/plugins/painless_lab/public/application/lib/format.ts b/x-pack/plugins/painless_lab/public/application/lib/format.ts
@@ -16,30 +16,33 @@ function prettifyPayload(payload = '', indentationLevel = 0) {
  * e.g. 1.0, is preserved instead of being coerced to an integer, e.g. 1.
  */
 export function formatRequestPayload(
-  { code, context, parameters, index, document }: RequestPayloadConfig,
+  { code, context, parameters, index, document, query }: RequestPayloadConfig,
   format: PayloadFormat = PayloadFormat.UGLY
 ): string {
   const isAdvancedContext = context === 'filter' || context === 'score';
 
-  let formattedCode;
-  let formattedParameters;
-  let formattedContext;
-  let formattedIndex;
-  let formattedDocument;
+  let formattedCode: string | undefined;
+  let formattedParameters: string | undefined;
+  let formattedContext: string | undefined;
+  let formattedIndex: string | undefined;
+  let formattedDocument: string | undefined;
+  let formattedQuery: string | undefined;
 
   if (format === PayloadFormat.UGLY) {
     formattedCode = JSON.stringify(code);
     formattedParameters = parameters;
     formattedContext = context;
     formattedIndex = index;
     formattedDocument = document;
+    formattedQuery = query;
   } else {
     // Triple quote the code because it's multiline.
     formattedCode = `"""${prettifyPayload(code, 4)}"""`;
     formattedParameters = prettifyPayload(parameters, 4);
     formattedContext = prettifyPayload(context, 6);
     formattedIndex = prettifyPayload(index);
     formattedDocument = prettifyPayload(document, 4);
+    formattedQuery = prettifyPayload(query, 4);
   }
 
   const requestPayload = `{
@@ -56,7 +59,12 @@ export function formatRequestPayload(
   "context": "${formattedContext}",
   "context_setup": {
     "index": "${formattedIndex}",
-    "document": ${formattedDocument}
+    "document": ${formattedDocument}${
+          query && context === 'score'
+            ? `,
+    "query": ${formattedQuery}`
+            : ''
+        }
   }`
       : ``
   }

diff --git a/x-pack/plugins/painless_lab/public/index.scss b/x-pack/plugins/painless_lab/public/index.scss
@@ -1 +1 @@
-@import 'styles/index'
+@import 'styles/index';
diff --git a/x-pack/plugins/painless_lab/public/styles/_index.scss b/x-pack/plugins/painless_lab/public/styles/_index.scss
@@ -1,10 +1,13 @@
+@import '@elastic/eui/src/components/header/variables';
 
 /**
- * 1. This is a very brittle way of preventing the editor and other content from disappearing
- *    behind the bottom bar.
+ * This is a very brittle way of preventing the editor and other content from disappearing
+ * behind the bottom bar.
  */
+$bottomBarHeight:  calc(#{$euiSize} * 3);
+
 .painlessLabBottomBarPlaceholder {
-  height: $euiSize * 3; /* [1] */
+  height: $bottomBarHeight
 }
 
 .painlessLabRightPane {
@@ -23,9 +26,19 @@
 
   [role="tabpanel"] {
     height: 100%;
+    overflow-y: auto;
   }
 }
 
 .painlessLab__betaLabelContainer {
   line-height: 0;
 }
+
+.painlessLabMainContainer {
+  height: calc(100vh - calc(#{$euiHeaderChildSize} * 2) - #{$bottomBarHeight});
+}
+
+.painlessLabPanelsContainer {
+  // The panels container should adopt the height of the main container
+  height: 100%;
+}