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.

Sign up for GitHub

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

[Search Playground] Change route on selector changed in between search/chat modes #197431

Merged
merged 8 commits into from
Nov 11, 2024
Merged

[Search Playground] Change route on selector changed in between search/chat modes #197431

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
39ccc28
Change route on selector changed in between search/chat modes
efegurkan Oct 23, 2024
efe81c4
Make routing consistent
efegurkan Oct 24, 2024
c89b64d
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Oct 24, 2024
9bae9f7
Merge branch 'main' of github.com:elastic/kibana into route-on-select…
efegurkan Nov 5, 2024
83ce443
Changed PlaygroundPageMode to Union type
efegurkan Nov 6, 2024
510cd92
Revert "Changed PlaygroundPageMode to Union type"
efegurkan Nov 6, 2024
6910980
Reverted to a cleaner workaround
efegurkan Nov 6, 2024
c88bc22
Merge branch 'main' into route-on-selector-change
elasticmachine Nov 11, 2024
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
15 changes: 13 additions & 2 deletions ...s/enterprise_search/public/applications/applications/components/playground/playground.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,22 @@ import { useValues } from 'kea';

import { i18n } from '@kbn/i18n';

import type { PlaygroundPageMode } from '@kbn/search-playground/public';

import { KibanaLogic } from '../../../shared/kibana';

import { SearchPlaygroundPageTemplate } from './page_template';

export const Playground: React.FC = () => {
interface PlaygroundProps {
pageMode?: PageMode;
}

export enum PageMode {
chat = 'chat',
search = 'search',
}

export const Playground: React.FC<PlaygroundProps> = ({ pageMode = PageMode.chat }) => {
const { searchPlayground } = useValues(KibanaLogic);

if (!searchPlayground) {
Expand All @@ -35,7 +46,7 @@ export const Playground: React.FC = () => {
customPageSections
bottomBorder="extended"
>
<searchPlayground.Playground />
<searchPlayground.Playground pageMode={pageMode as unknown as PlaygroundPageMode} />
</SearchPlaygroundPageTemplate>
</searchPlayground.PlaygroundProvider>
);
Expand Down
18 changes: 14 additions & 4 deletions x-pack/plugins/enterprise_search/public/applications/applications/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@ import { Redirect } from 'react-router-dom';
import { Routes, Route } from '@kbn/shared-ux-router';

import { NotFound } from './components/not_found';
import { Playground } from './components/playground/playground';
import { PageMode, Playground } from './components/playground/playground';
import { SearchApplicationsRouter } from './components/search_applications/search_applications_router';
import { PLAYGROUND_PATH, ROOT_PATH, SEARCH_APPLICATIONS_PATH } from './routes';
import {
PLAYGROUND_CHAT_PATH,
PLAYGROUND_PATH,
PLAYGROUND_SEARCH_PATH,
ROOT_PATH,
SEARCH_APPLICATIONS_PATH,
} from './routes';

export const Applications = () => {
return (
Expand All @@ -22,8 +28,12 @@ export const Applications = () => {
<Route path={SEARCH_APPLICATIONS_PATH}>
<SearchApplicationsRouter />
</Route>
<Route path={PLAYGROUND_PATH}>
<Playground />
<Redirect exact from={PLAYGROUND_PATH} to={PLAYGROUND_CHAT_PATH} />
<Route path={PLAYGROUND_CHAT_PATH}>
<Playground pageMode={PageMode.chat} />
</Route>
<Route path={PLAYGROUND_SEARCH_PATH}>
<Playground pageMode={PageMode.search} />
</Route>
<Route>
<NotFound />
Expand Down
4 changes: 3 additions & 1 deletion x-pack/plugins/enterprise_search/public/applications/applications/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ export enum SearchApplicationViewTabs {
export const SEARCH_APPLICATION_CREATION_PATH = `${SEARCH_APPLICATIONS_PATH}/new`;
export const SEARCH_APPLICATION_PATH = `${SEARCH_APPLICATIONS_PATH}/:searchApplicationName`;
export const SEARCH_APPLICATION_TAB_PATH = `${SEARCH_APPLICATION_PATH}/:tabId`;
export const PLAYGROUND_PATH = `${ROOT_PATH}playground`;
export const PLAYGROUND_PATH = `${ROOT_PATH}playground/`;
export const PLAYGROUND_CHAT_PATH = `${PLAYGROUND_PATH}chat`;
export const PLAYGROUND_SEARCH_PATH = `${PLAYGROUND_PATH}search`;

export const SEARCH_APPLICATION_CONNECT_PATH = `${SEARCH_APPLICATION_PATH}/${SearchApplicationViewTabs.CONNECT}/:connectTabId`;
export enum SearchApplicationConnectTabs {
Expand Down
7 changes: 6 additions & 1 deletion x-pack/plugins/search_playground/public/components/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { Chat } from './chat';
import { SearchMode } from './search_mode/search_mode';
import { SearchPlaygroundSetupPage } from './setup_page/search_playground_setup_page';
import { usePageMode } from '../hooks/use_page_mode';
import { useKibana } from '../hooks/use_kibana';

export interface AppProps {
showDocs?: boolean;
Expand All @@ -33,6 +34,7 @@ export const App: React.FC<AppProps> = ({
showDocs = false,
pageMode = PlaygroundPageMode.chat,
}) => {
const { services } = useKibana();
const [selectedMode, setSelectedMode] = useState<ViewMode>(ViewMode.chat);
const { data: connectors } = useLoadConnectors();
const hasSelectedIndices = Boolean(
Expand All @@ -41,7 +43,10 @@ export const App: React.FC<AppProps> = ({
}).length
);
const handleModeChange = (id: ViewMode) => setSelectedMode(id);
const handlePageModeChange = (mode: PlaygroundPageMode) => setSelectedPageMode(mode);
const handlePageModeChange = (mode: PlaygroundPageMode) => {
services.application?.navigateToUrl(`./${mode}`);
Copy link
Contributor

Choose a reason for hiding this comment

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

Wondering if it works in both ES3 and ESS?

Copy link
Contributor

Choose a reason for hiding this comment

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

good catch, I think if we're doing navigateToUrl we'd need to do the full URL and not make it relative.

and if we care doing navigateToUrl do we still need the setSelectedPageMode() call after this?

Copy link
Member Author

Choose a reason for hiding this comment

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

It does work both places, I tried on both.

Only the last paths differ in between ESS and ES3. When it is relative it works for both. Otherwise I would need to do isServerless check and pass full path unless I change some other things completely.

Ideally the routing should be done inside of the plugin completely and ESS wouldn't be able to break it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I will merge it as is for now, and will come back for a refactor to use single router later.

setSelectedPageMode(mode);
};
const {
showSetupPage,
pageMode: selectedPageMode,
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/search_playground/public/components/search_mode/search_mode.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export const SearchMode: React.FC = () => {
name={ChatFormFields.searchQuery}
render={({ field }) => (
<EuiFieldText
data-test-subj="searchPlaygroundSearchModeFieldText"
{...field}
value={searchBarValue}
icon="search"
Expand Down
6 changes: 5 additions & 1 deletion x-pack/plugins/search_playground/public/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,8 @@ export function plugin(initializerContext: PluginInitializerContext) {
return new SearchPlaygroundPlugin(initializerContext);
}

export type { SearchPlaygroundPluginSetup, SearchPlaygroundPluginStart } from './types';
export type {
SearchPlaygroundPluginSetup,
SearchPlaygroundPluginStart,
PlaygroundPageMode,
} from './types';
2 changes: 1 addition & 1 deletion x-pack/plugins/search_playground/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"@kbn/data-views-plugin",
"@kbn/discover-utils",
"@kbn/data-plugin",
"@kbn/search-index-documents"
"@kbn/search-index-documents",
],
"exclude": [
"target/**/*",
Expand Down