Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Painless] Replace hard-coded links #60603

Merged
merged 4 commits into from
Mar 20, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { HttpSetup } from 'kibana/public';
import React, { useState, useEffect, FunctionComponent } from 'react';
import { EuiFlexGroup, EuiFlexItem, EuiTitle } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
Expand All @@ -18,15 +17,11 @@ import { Editor } from './editor';
import { RequestFlyout } from './request_flyout';
import { useAppContext } from '../context';

interface Props {
http: HttpSetup;
}

export const Main: FunctionComponent<Props> = ({ http }) => {
const { state, updateState } = useAppContext();
export const Main: FunctionComponent = () => {
const { state, updateState, services, links } = useAppContext();

const [isRequestFlyoutOpen, setRequestFlyoutOpen] = useState(false);
const { inProgress, response, submit } = useSubmitCode(http);
const { inProgress, response, submit } = useSubmitCode(services.http);

// Live-update the output and persist state as the user changes it.
useEffect(() => {
Expand Down Expand Up @@ -61,6 +56,7 @@ export const Main: FunctionComponent<Props> = ({ http }) => {
</EuiFlexGroup>

<MainControls
links={links}
isLoading={inProgress}
toggleRequestFlyout={toggleRequestFlyout}
isRequestFlyoutOpen={isRequestFlyoutOpen}
Expand All @@ -69,6 +65,7 @@ export const Main: FunctionComponent<Props> = ({ http }) => {

{isRequestFlyoutOpen && (
<RequestFlyout
links={links}
onClose={() => setRequestFlyoutOpen(false)}
requestBody={formatRequestPayload(state, PayloadFormat.PRETTY)}
response={response ? formatJson(response.result || response.error) : ''}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,24 @@ import {
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';

import { Links } from '../../links';

interface Props {
toggleRequestFlyout: () => void;
isRequestFlyoutOpen: boolean;
isLoading: boolean;
reset: () => void;
links: Links;
}

export function MainControls({ toggleRequestFlyout, isRequestFlyoutOpen, reset }: Props) {
export function MainControls({ toggleRequestFlyout, isRequestFlyoutOpen, reset, links }: Props) {
const [isHelpOpen, setIsHelpOpen] = useState(false);

const items = [
<EuiContextMenuItem
key="walkthrough"
icon="popout"
href="https://www.elastic.co/guide/en/elasticsearch/painless/7.5/painless-walkthrough.html"
href={links.painlessWalkthrough}
target="_blank"
onClick={() => setIsHelpOpen(false)}
>
Expand All @@ -41,7 +44,7 @@ export function MainControls({ toggleRequestFlyout, isRequestFlyoutOpen, reset }
<EuiContextMenuItem
key="api"
icon="popout"
href="https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-api-reference.html"
href={links.painlessAPIReference}
target="_blank"
onClick={() => setIsHelpOpen(false)}
>
Expand All @@ -53,7 +56,7 @@ export function MainControls({ toggleRequestFlyout, isRequestFlyoutOpen, reset }
<EuiContextMenuItem
key="languageSpec"
icon="popout"
href="https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-lang-spec.html"
href={links.painlessLangSpec}
target="_blank"
onClick={() => setIsHelpOpen(false)}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { painlessContextOptions } from '../../common/constants';
import { useAppContext } from '../../context';

export const ContextTab: FunctionComponent = () => {
const { state, updateState } = useAppContext();
const { state, updateState, links } = useAppContext();
const { context, document, index, query } = state;

return (
Expand All @@ -48,10 +48,7 @@ export const ContextTab: FunctionComponent = () => {
}
labelAppend={
<EuiText size="xs">
<EuiLink
href="https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html"
target="_blank"
>
<EuiLink href={links.painlessExecuteAPI} target="_blank">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great point, will update.

{i18n.translate('xpack.painlessLab.contextFieldDocLinkText', {
defaultMessage: 'Context docs',
})}
Expand Down Expand Up @@ -115,10 +112,7 @@ export const ContextTab: FunctionComponent = () => {
}
labelAppend={
<EuiText size="xs">
<EuiLink
href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html"
target="_blank"
>
<EuiLink href={links.esQueryDSL} target="_blank">
{i18n.translate('xpack.painlessLab.queryFieldDocLinkText', {
defaultMessage: 'Query DSL docs',
})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { CodeEditor } from '../../../../../../../src/plugins/kibana_react/public
import { useAppContext } from '../../context';

export const ParametersTab: FunctionComponent = () => {
const { state, updateState } = useAppContext();
const { state, updateState, links } = useAppContext();
return (
<>
<EuiSpacer size="m" />
Expand All @@ -44,10 +44,7 @@ export const ParametersTab: FunctionComponent = () => {
fullWidth
labelAppend={
<EuiText size="xs">
<EuiLink
href="https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting-using.html#prefer-params"
target="_blank"
>
<EuiLink href={links.modulesScriptingPreferParams} target="_blank">
{i18n.translate('xpack.painlessLab.parametersFieldDocLinkText', {
defaultMessage: 'Parameters docs',
})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

import React from 'react';
import React, { FunctionComponent } from 'react';
import {
EuiCodeBlock,
EuiTabbedContent,
Expand All @@ -17,16 +17,21 @@ import {
EuiFlexItem,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { Links } from '../../links';

export function RequestFlyout({
onClose,
requestBody,
response,
}: {
interface Props {
onClose: any;
requestBody: string;
links: Links;
response?: string;
}) {
}

export const RequestFlyout: FunctionComponent<Props> = ({
onClose,
requestBody,
response,
links,
}) => {
return (
<EuiFlyout onClose={onClose} maxWidth={640}>
<EuiFlyoutHeader>
Expand All @@ -48,7 +53,7 @@ export function RequestFlyout({
<EuiButtonEmpty
size="s"
flush="right"
href="https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html"
href={links.painlessExecuteAPI}
target="_blank"
iconType="help"
>
Expand Down Expand Up @@ -90,4 +95,4 @@ export function RequestFlyout({
</EuiFlyoutBody>
</EuiFlyout>
);
}
};
26 changes: 24 additions & 2 deletions x-pack/plugins/painless_lab/public/application/context.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,36 @@
*/

import React, { createContext, ReactNode, useState, useContext } from 'react';
import { HttpSetup } from 'src/core/public';

import { Links } from '../links';

import { initialState, Store } from './store';
import { PAINLESS_LAB_KEY } from './constants';

interface ContextValue {
state: Store;
updateState: (nextState: (s: Store) => Partial<Store>) => void;
services: {
http: HttpSetup;
};
links: Links;
}

const AppContext = createContext<ContextValue>(undefined as any);

export const AppContextProvider = ({ children }: { children: ReactNode }) => {
interface AppContextProviderArgs {
children: ReactNode;
value: {
http: HttpSetup;
links: Links;
};
}

export const AppContextProvider = ({
children,
value: { http, links },
}: AppContextProviderArgs) => {
const [state, setState] = useState<Store>(() => ({
...initialState,
...JSON.parse(localStorage.getItem(PAINLESS_LAB_KEY) || '{}'),
Expand All @@ -32,7 +50,11 @@ export const AppContextProvider = ({ children }: { children: ReactNode }) => {
setState(() => nextState);
};

return <AppContext.Provider value={{ updateState, state }}>{children}</AppContext.Provider>;
return (
<AppContext.Provider value={{ updateState, state, services: { http }, links }}>
{children}
</AppContext.Provider>
);
};

export const useAppContext = () => {
Expand Down
9 changes: 6 additions & 3 deletions x-pack/plugins/painless_lab/public/application/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,21 @@ import { render, unmountComponentAtNode } from 'react-dom';
import { CoreSetup, CoreStart } from 'kibana/public';
import { createKibanaReactContext } from '../../../../../src/plugins/kibana_react/public';

import { Links } from '../links';

import { AppContextProvider } from './context';
import { Main } from './components/main';

interface AppDependencies {
http: CoreSetup['http'];
I18nContext: CoreStart['i18n']['Context'];
uiSettings: CoreSetup['uiSettings'];
links: Links;
}

export function renderApp(
element: HTMLElement | null,
{ http, I18nContext, uiSettings }: AppDependencies
{ http, I18nContext, uiSettings, links }: AppDependencies
) {
if (!element) {
return () => undefined;
Expand All @@ -32,8 +35,8 @@ export function renderApp(
render(
<I18nContext>
<KibanaReactContextProvider>
<AppContextProvider>
<Main http={http} />
<AppContextProvider value={{ http, links }}>
<Main />
</AppContextProvider>
</KibanaReactContextProvider>
</I18nContext>,
Expand Down
19 changes: 19 additions & 0 deletions x-pack/plugins/painless_lab/public/links.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

import { DocLinksStart } from 'src/core/public';

export type Links = ReturnType<typeof getLinks>;

export const getLinks = ({ DOC_LINK_VERSION, ELASTIC_WEBSITE_URL }: DocLinksStart) =>
Object.freeze({
painlessExecuteAPI: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-execute-api.html`,
painlessAPIReference: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-api-reference.html`,
painlessWalkthrough: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-walkthrough.html`,
painlessLangSpec: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-lang-spec.html`,
esQueryDSL: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/query-dsl.html`,
modulesScriptingPreferParams: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/modules-scripting-using.html#prefer-params`,
});
4 changes: 3 additions & 1 deletion x-pack/plugins/painless_lab/public/plugin.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { LICENSE_CHECK_STATE } from '../../licensing/public';
import { PLUGIN } from '../common/constants';
import { PluginDependencies } from './types';
import { registerPainless } from './application/register_painless';
import { getLinks } from './links';

export class PainlessLabUIPlugin implements Plugin<void, void, PluginDependencies> {
constructor(ctx: PluginInitializerContext) {}
Expand Down Expand Up @@ -69,6 +70,7 @@ export class PainlessLabUIPlugin implements Plugin<void, void, PluginDependencie
const {
i18n: { Context: I18nContext },
notifications,
docLinks,
} = core;

registerPainless();
Expand All @@ -87,7 +89,7 @@ export class PainlessLabUIPlugin implements Plugin<void, void, PluginDependencie
}

const { renderApp } = await import('./application');
return renderApp(element, { I18nContext, http, uiSettings });
return renderApp(element, { I18nContext, http, uiSettings, links: getLinks(docLinks) });
},
});
}
Expand Down