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

[Search] [Onboarding] With Data View #193121

Merged
merged 26 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d32d191
WIP
joemcelroy Aug 30, 2024
8e86f71
WIP
joemcelroy Sep 2, 2024
00c213d
WIP
joemcelroy Sep 2, 2024
b477f40
Merge remote-tracking branch 'upstream/main' into connection-details
joemcelroy Sep 3, 2024
efe73d0
Merge remote-tracking branch 'upstream/main' into connection-details
joemcelroy Sep 9, 2024
f7ffbc1
WIP
joemcelroy Sep 9, 2024
47996ce
WIP
joemcelroy Sep 10, 2024
4e65546
WIP
joemcelroy Sep 10, 2024
42172c4
merge main
joemcelroy Sep 10, 2024
b2c1120
add tests + cleanup refactor
joemcelroy Sep 11, 2024
f6d7609
update to initial loading
joemcelroy Sep 11, 2024
d31de6b
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Sep 11, 2024
0b042cc
fix types / eslint issues
joemcelroy Sep 12, 2024
c8cb4ad
Merge branch 'connection-details' of github.com:joemcelroy/kibana int…
joemcelroy Sep 12, 2024
e3f37e8
fix types
joemcelroy Sep 12, 2024
4f59c8e
Merge remote-tracking branch 'upstream/main' into with-data-view
joemcelroy Sep 12, 2024
ad40771
merge
joemcelroy Sep 13, 2024
20b7106
add data view + tests
joemcelroy Sep 13, 2024
629ef95
Merge remote-tracking branch 'upstream/main' into connection-details
joemcelroy Sep 13, 2024
c2b02bb
revert enterprise-search changes
joemcelroy Sep 13, 2024
3b03da7
revert
joemcelroy Sep 13, 2024
92c5730
Merge branch 'connection-details' into with-data-view
joemcelroy Sep 13, 2024
f8830b4
update WIP example
joemcelroy Sep 13, 2024
86d5b88
Merge remote-tracking branch 'upstream/main' into with-data-view
joemcelroy Sep 16, 2024
39eb7e3
update localisation string
joemcelroy Sep 17, 2024
cfac4ee
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Sep 17, 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
18 changes: 2 additions & 16 deletions packages/kbn-search-index-documents/components/document_list.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import { i18n } from '@kbn/i18n';

import { FormattedMessage, FormattedNumber } from '@kbn/i18n-react';

import { resultMetaData } from './result/result_metadata';
import { resultMetaData, resultToField } from './result/result_metadata';

import { Result } from '..';
interface DocumentListProps {
Expand All @@ -55,20 +55,6 @@ export const DocumentList: React.FC<DocumentListProps> = ({
setDocsPerPage,
}) => {
const [isPopoverOpen, setIsPopoverOpen] = useState(false);
const resultToField = (result: SearchHit) => {
if (mappings && result._source && !Array.isArray(result._source)) {
if (typeof result._source === 'object') {
return Object.entries(result._source).map(([key, value]) => {
return {
fieldName: key,
fieldType: mappings[key]?.type ?? 'object',
fieldValue: JSON.stringify(value, null, 2),
};
});
}
}
return [];
};

const getIconType = (size: number) => {
return size === docsPerPage ? 'check' : 'empty';
Expand Down Expand Up @@ -113,7 +99,7 @@ export const DocumentList: React.FC<DocumentListProps> = ({
{docs.map((doc) => {
return (
<React.Fragment key={doc._id}>
<Result fields={resultToField(doc)} metaData={resultMetaData(doc)} />
<Result fields={resultToField(doc, mappings)} metaData={resultMetaData(doc)} />
<EuiSpacer size="s" />
</React.Fragment>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
*/

export { Result } from './result';
export { resultMetaData, resultToField } from './result_metadata';
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

import { SearchHit } from '@elastic/elasticsearch/lib/api/types';
import { MetaDataProps } from './result_types';
import type { MappingProperty, SearchHit } from '@elastic/elasticsearch/lib/api/types';
import type { MetaDataProps } from './result_types';

const TITLE_KEYS = ['title', 'name'];

Expand Down Expand Up @@ -38,3 +38,18 @@ export const resultMetaData = (result: SearchHit): MetaDataProps => ({
id: result._id!,
title: resultTitle(result),
});

export const resultToField = (result: SearchHit, mappings?: Record<string, MappingProperty>) => {
if (mappings && result._source && !Array.isArray(result._source)) {
if (typeof result._source === 'object') {
return Object.entries(result._source).map(([key, value]) => {
return {
fieldName: key,
fieldType: mappings[key]?.type ?? 'object',
fieldValue: JSON.stringify(value, null, 2),
};
});
}
}
return [];
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import React from 'react';

import { EuiPanel } from '@elastic/eui';

export const AddDocumentsCodeExample: React.FC = () => {
return (
<EuiPanel
hasBorder={false}
hasShadow={false}
paddingSize="none"
data-test-subj="SearchIndicesAddDocumentsCode"
>
TODO: WITHOUT DATA TICKET
</EuiPanel>
);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import React from 'react';

import { Result, resultToField, resultMetaData } from '@kbn/search-index-documents';

import { i18n } from '@kbn/i18n';
import {
EuiFlexGroup,
EuiFlexItem,
EuiIcon,
EuiLink,
EuiPanel,
EuiProgress,
EuiSpacer,
} from '@elastic/eui';
import { useIndexDocumentSearch } from '../../hooks/api/use_document_search';
import { useIndexMapping } from '../../hooks/api/use_index_mappings';
import { useKibana } from '../../hooks/use_kibana';
import { AddDocumentsCodeExample } from './add_documents_code_example';

interface IndexDocumentsProps {
indexName: string;
}

interface RecentDocsActionMessageProps {
indexName: string;
}

const DEFAULT_PAGE_SIZE = 50;

const RecentDocsActionMessage: React.FC<RecentDocsActionMessageProps> = ({ indexName }) => {
const {
services: { share },
} = useKibana();

const discoverLocator = share.url.locators.get('DISCOVER_APP_LOCATOR');

const onClick = async () => {
await discoverLocator?.navigate({ dataViewSpec: { title: indexName } });
};

return (
<EuiPanel hasBorder={false} hasShadow={false} color="subdued" borderRadius="none">
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiIcon type="calendar" />
</EuiFlexItem>
<EuiFlexItem>
<p>
{i18n.translate('xpack.searchIndices.indexDocuments.recentDocsActionMessage', {
defaultMessage:
'You are viewing the {pageSize} most recently ingested documents in this index. To see all documents, view in',
values: {
pageSize: DEFAULT_PAGE_SIZE,
},
})}{' '}
<EuiLink onClick={onClick}>
{i18n.translate('xpack.searchIndices.indexDocuments.recentDocsActionMessageLink', {
defaultMessage: 'Discover.',
})}
</EuiLink>
</p>
</EuiFlexItem>
</EuiFlexGroup>
</EuiPanel>
);
};

export const IndexDocuments: React.FC<IndexDocumentsProps> = ({ indexName }) => {
const { data: indexDocuments, isInitialLoading } = useIndexDocumentSearch(indexName, {
pageSize: DEFAULT_PAGE_SIZE,
pageIndex: 0,
});

const { data: mappingData } = useIndexMapping(indexName);

const docs = indexDocuments?.results?.data ?? [];
const mappingProperties = mappingData?.mappings?.properties ?? {};

return (
<EuiPanel hasBorder={false} hasShadow={false} paddingSize="none">
<EuiSpacer />
<EuiFlexGroup direction="column">
<EuiFlexItem>
{isInitialLoading && <EuiProgress size="xs" color="primary" />}
{docs.length === 0 && <AddDocumentsCodeExample />}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{docs.length === 0 && <AddDocumentsCodeExample />}
{!isInitialLoading && docs.length === 0 && <AddDocumentsCodeExample />}

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll adjust this in my PR for no data

{docs.length > 0 && (
<>
<RecentDocsActionMessage indexName={indexName} />
<EuiSpacer size="m" />
{docs.map((doc) => {
return (
<React.Fragment key={doc._id}>
<Result
fields={resultToField(doc, mappingProperties)}
metaData={resultMetaData(doc)}
/>
<EuiSpacer size="s" />
</React.Fragment>
);
})}
</>
)}
</EuiFlexItem>
</EuiFlexGroup>
</EuiPanel>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

import {
EuiPageSection,
EuiSpacer,
EuiButton,
EuiPageTemplate,
EuiFlexItem,
EuiTabbedContent,
EuiFlexGroup,
EuiPopover,
EuiButtonIcon,
Expand All @@ -30,6 +30,7 @@ import { useKibana } from '../../hooks/use_kibana';
import { ConnectionDetails } from '../connection_details/connection_details';
import { QuickStats } from '../quick_stats/quick_stats';
import { useIndexMapping } from '../../hooks/api/use_index_mappings';
import { IndexDocuments } from '../index_documents/index_documents';
import { DeleteIndexModal } from './delete_index_modal';
import { IndexloadingError } from './details_page_loading_error';

Expand Down Expand Up @@ -157,31 +158,47 @@ export const SearchIndexDetailsPage = () => {
</EuiFlexGroup>,
]}
/>
<EuiSpacer size="l" />

{isShowingDeleteModal && (
<DeleteIndexModal
onCancel={() => setShowDeleteIndexModal(!isShowingDeleteModal)}
indexName={indexName}
navigateToIndexListPage={navigateToIndexListPage}
/>
)}
<EuiPageTemplate.Section grow={false}>
<EuiFlexGroup>
<EuiFlexGroup direction="column">
<EuiFlexItem>
<ConnectionDetails />
<EuiFlexGroup>
<EuiFlexItem>
<ConnectionDetails />
</EuiFlexItem>
<EuiFlexItem>{/* TODO: API KEY */}</EuiFlexItem>
</EuiFlexGroup>
</EuiFlexItem>
<EuiFlexItem>
<EuiFlexGroup>
<QuickStats index={index} mappings={mappings} />
</EuiFlexGroup>
</EuiFlexItem>
<EuiFlexItem>
<EuiFlexItem>
<EuiTabbedContent
tabs={[
{
id: 'data',
name: i18n.translate('xpack.searchIndices.documentsTabLabel', {
defaultMessage: 'Data',
}),
content: <IndexDocuments indexName={indexName} />,
},
]}
/>
</EuiFlexItem>
</EuiFlexItem>
<EuiFlexItem>{/* TODO: API KEY */}</EuiFlexItem>
</EuiFlexGroup>

<EuiSpacer size="l" />

<EuiFlexGroup>
<QuickStats index={index} mappings={mappings} />
</EuiFlexGroup>
</EuiPageTemplate.Section>
</>
)}
{isShowingDeleteModal && (
<DeleteIndexModal
onCancel={() => setShowDeleteIndexModal(!isShowingDeleteModal)}
indexName={indexName}
navigateToIndexListPage={navigateToIndexListPage}
/>
)}
{embeddableConsole}
</EuiPageTemplate>
);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { Pagination } from '@elastic/eui';
import { SearchHit } from '@kbn/es-types';
import { pageToPagination, Paginate } from '@kbn/search-index-documents';
import { useQuery } from '@tanstack/react-query';
import { useKibana } from '../use_kibana';

interface IndexDocuments {
meta: Pagination;
results: Paginate<SearchHit>;
}
const DEFAULT_PAGINATION = {
from: 0,
has_more_hits_than_total: false,
size: 10,
total: 0,
};
const pollingInterval = 5 * 1000;
export const useIndexDocumentSearch = (
indexName: string,
pagination: Omit<Pagination, 'totalItemCount'>,
searchQuery?: string
) => {
const {
services: { http },
} = useKibana();
const response = useQuery({
queryKey: ['fetchIndexDocuments', pagination, searchQuery],
refetchInterval: pollingInterval,
refetchIntervalInBackground: true,
refetchOnWindowFocus: 'always',
queryFn: async () =>
http.post<IndexDocuments>(`/internal/serverless_search/indices/${indexName}/search`, {
body: JSON.stringify({
searchQuery,
}),
query: {
page: pagination.pageIndex,
size: pagination.pageSize,
},
}),
});
return {
...response,
meta: pageToPagination(response?.data?.results?._meta?.page ?? DEFAULT_PAGINATION),
};
};
2 changes: 2 additions & 0 deletions x-pack/plugins/search_indices/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
"@kbn/index-management-shared-types",
"@kbn/try-in-console",
"@kbn/cloud-plugin",
"@kbn/search-index-documents",
"@kbn/es-types",
],
"exclude": [
"target/**/*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ export function SvlSearchIndexDetailPageProvider({ getService }: FtrProviderCont
await testSubjects.missingOrFail('setupAISearchButton', { timeout: 2000 });
},

async expectAddDocumentCodeExamples() {
await testSubjects.existOrFail('SearchIndicesAddDocumentsCode', { timeout: 2000 });
},

async expectHasIndexDocuments() {
await retry.try(async () => {
await testSubjects.existOrFail('search-index-documents-result', { timeout: 2000 });
});
},

async expectMoreOptionsActionButtonExists() {
await testSubjects.existOrFail('moreOptionsActionButton');
},
Expand Down
Loading