mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
Render accordion in integration readme (#223916)
## Summary [Support collapsible section in Integration README](https://github.com/elastic/integration-experience/issues/82) The public Integrations docs page recently added support for collapsible sections (e.g., for field tables and sample events). This PR brings the same functionality to Kibana to reduce scrolling and help users focus on the most relevant information. To display an accordion, the README should include the following markup: ``` <details> <summary>Click to expand</summary> This content is hidden by default. </details> ``` However, we do not want to modify the integration READMEs directly. Doing so would cause these tags to appear as raw HTML in older versions of Kibana Bumping the minimum supported Kibana version for each integration is also not a solution, as it would complicate backports and maintenance. #### Proposed solution Detect in Kibana parts that should be collapsible, like `exported fields` and update the markdown with the necessary markups. Similar to what the `integration-docs` does in https://github.com/elastic/integration-docs/issues/342 #### Dependencies added: - `rehype-raw`: Parse and render HTML inside Markdown. - `rehype-sanitize`: Sanitize potentially unsafe HTML. #### Version pinning for compatibility - `rehype-sanitize@4.0.0`: Uses hast-util-sanitize@3+, which provides a built-in default schema and is compatible with CommonJS environments. - `rehype-raw@5.1.0`: The latest version that supports CommonJS. Later versions are ESM-only. https://github.com/user-attachments/assets/15f0822b-9b36-45e6-a47e-c8fa0dedd4c3 ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
parent
cfeb30662e
commit
869e162812
6 changed files with 220 additions and 16 deletions
|
@ -1327,6 +1327,8 @@
|
|||
"redux-thunk": "^2.4.2",
|
||||
"redux-thunks": "^1.0.0",
|
||||
"reflect-metadata": "^0.2.2",
|
||||
"rehype-raw": "5.1.0",
|
||||
"rehype-sanitize": "4.0.0",
|
||||
"remark-gfm": "1.0.0",
|
||||
"remark-parse-no-trim": "^8.0.4",
|
||||
"remark-stringify": "^8.0.3",
|
||||
|
|
|
@ -756,6 +756,8 @@
|
|||
"js-search",
|
||||
"openpgp",
|
||||
"remark-gfm",
|
||||
"rehype-raw",
|
||||
"rehype-sanitize",
|
||||
"yaml",
|
||||
"@types/js-search"
|
||||
],
|
||||
|
|
|
@ -13,6 +13,8 @@ import {
|
|||
EuiTable,
|
||||
EuiTableRow,
|
||||
EuiTableRowCell,
|
||||
EuiAccordion,
|
||||
EuiSpacer,
|
||||
} from '@elastic/eui';
|
||||
import React from 'react';
|
||||
import type { MutableRefObject } from 'react';
|
||||
|
@ -114,5 +116,38 @@ export const markdownRenderers = (
|
|||
) => {
|
||||
return <img style={{ maxWidth: '100%' }} {...props} alt={props.alt} />;
|
||||
},
|
||||
details: ({ children, node }) => {
|
||||
const [summaryNode, ...bodyNodes] = React.Children.toArray(children).reduce<
|
||||
[React.ReactElement | null, React.ReactNode[]]
|
||||
>(
|
||||
([summary, body], child) => {
|
||||
if (summary === null && React.isValidElement(child) && child.type === 'summary') {
|
||||
return [child, body];
|
||||
}
|
||||
return [summary, [...body, child]];
|
||||
},
|
||||
[null, []]
|
||||
);
|
||||
|
||||
const summaryText = summaryNode
|
||||
? React.Children.toArray(summaryNode.props.children).join('')
|
||||
: '';
|
||||
|
||||
const id = getAnchorId(children[0]?.toString(), node.position?.start.line);
|
||||
|
||||
return (
|
||||
<>
|
||||
<EuiAccordion
|
||||
id={id}
|
||||
buttonContent={summaryText}
|
||||
initialIsOpen={false}
|
||||
data-test-subj="integrationsDocs.accordion"
|
||||
>
|
||||
{bodyNodes}
|
||||
</EuiAccordion>
|
||||
<EuiSpacer size="m" />
|
||||
</>
|
||||
);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
|
|
@ -10,9 +10,10 @@ import React from 'react';
|
|||
import { createIntegrationsTestRendererMock } from '../../../../../../../mock';
|
||||
|
||||
import { Readme } from './readme';
|
||||
import { waitFor } from '@testing-library/dom';
|
||||
|
||||
describe('Readme', () => {
|
||||
function render() {
|
||||
function render(markdown: string | undefined) {
|
||||
const refs = {
|
||||
current: {
|
||||
set: jest.fn(),
|
||||
|
@ -21,20 +22,111 @@ describe('Readme', () => {
|
|||
} as any;
|
||||
const testRenderer = createIntegrationsTestRendererMock();
|
||||
return testRenderer.render(
|
||||
<Readme
|
||||
packageName="test"
|
||||
version="1.0.0"
|
||||
markdown="# Test >"
|
||||
refs={refs}
|
||||
/>
|
||||
<Readme packageName="test" version="1.0.0" markdown={markdown} refs={refs} />
|
||||
);
|
||||
}
|
||||
it('should render img tag with max width', () => {
|
||||
const result = render();
|
||||
|
||||
const img = result.getByAltText('Image');
|
||||
it('should render img tag with max width', async () => {
|
||||
const result = render('# Test >');
|
||||
|
||||
expect(img).toHaveStyle('max-width: 100%');
|
||||
expect(img).toHaveAttribute('src', '/mock/api/fleet/epm/packages/test/1.0.0/img/image.png');
|
||||
await waitFor(() => {
|
||||
const img = result.getByAltText('Image');
|
||||
|
||||
expect(img).toHaveStyle('max-width: 100%');
|
||||
expect(img).toHaveAttribute('src', '/mock/api/fleet/epm/packages/test/1.0.0/img/image.png');
|
||||
});
|
||||
});
|
||||
|
||||
it('should render exported fields as accordions', async () => {
|
||||
const result = render(`
|
||||
# Test Integration
|
||||
|
||||
This is a test integration.
|
||||
|
||||
## Data streams
|
||||
|
||||
### Logs
|
||||
|
||||
This integration collects logs.
|
||||
|
||||
#### Requirements and setup
|
||||
|
||||
Some requirements and setup instructions.
|
||||
|
||||
**Exported fields**
|
||||
|
||||
| Field | Description | Type |
|
||||
|---|---|---|
|
||||
| @timestamp | Event timestamp. | date |
|
||||
| integration.category | The log category name. | keyword |
|
||||
|
||||
### Metrics
|
||||
|
||||
Some metrics information.
|
||||
|
||||
**Exported fields**
|
||||
|
||||
| Field | Description | Type | Unit | Metric Type |
|
||||
|---|---|---|---|---|
|
||||
| @timestamp | Event timestamp. | date | | |
|
||||
| integration.id | Some id | keyword | | |
|
||||
`);
|
||||
|
||||
await waitFor(() => {
|
||||
const accordionSummaries = result.getAllByTestId('integrationsDocs.accordion');
|
||||
expect(accordionSummaries.length).toBe(2);
|
||||
|
||||
const tables = result.container.querySelectorAll('table');
|
||||
expect(tables.length).toBe(2);
|
||||
});
|
||||
});
|
||||
|
||||
it('should render empty markdown', async () => {
|
||||
const result = render('');
|
||||
await waitFor(() => {
|
||||
expect(result.container).not.toBeEmptyDOMElement();
|
||||
});
|
||||
});
|
||||
|
||||
it('should render even if markdown undefined', async () => {
|
||||
const result = render(undefined);
|
||||
await waitFor(() => {
|
||||
const skeletonWrappers = result.getAllByTestId('euiSkeletonLoadingAriaWrapper');
|
||||
expect(skeletonWrappers.length).toBeGreaterThan(0);
|
||||
|
||||
expect(result.container).not.toBeEmptyDOMElement();
|
||||
});
|
||||
});
|
||||
|
||||
it('should render correct if no exported fields found', async () => {
|
||||
const result = render(`
|
||||
# Test Integration
|
||||
|
||||
This is a test integration.
|
||||
|
||||
## Data streams
|
||||
|
||||
### Logs
|
||||
|
||||
This integration collects logs.
|
||||
|
||||
#### Requirements and setup
|
||||
|
||||
Some requirements and setup instructions.
|
||||
`);
|
||||
|
||||
await waitFor(() => {
|
||||
expect(result.container).not.toBeEmptyDOMElement();
|
||||
|
||||
const accordion = result.queryByTestId('integrationsDocs.accordion');
|
||||
expect(accordion).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
it('should remove script tags', async () => {
|
||||
const result = render('<script>alert("This should not run")</script>');
|
||||
await waitFor(() => {
|
||||
expect(result.queryByText('This should not run')).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
@ -6,14 +6,17 @@
|
|||
*/
|
||||
|
||||
import { EuiText, EuiSkeletonText, EuiSpacer } from '@elastic/eui';
|
||||
import React from 'react';
|
||||
import React, { useMemo } from 'react';
|
||||
import type { MutableRefObject } from 'react';
|
||||
import ReactMarkdown from 'react-markdown';
|
||||
import remarkGfm from 'remark-gfm';
|
||||
import rehypeSanitize from 'rehype-sanitize';
|
||||
import rehypeRaw from 'rehype-raw';
|
||||
|
||||
import { useLinks } from '../../../../../hooks';
|
||||
|
||||
import { markdownRenderers } from './markdown_renderers';
|
||||
import MarkdownIt from 'markdown-it';
|
||||
|
||||
export function Readme({
|
||||
packageName,
|
||||
|
@ -38,21 +41,77 @@ export function Readme({
|
|||
[toRelativeImage, packageName, version]
|
||||
);
|
||||
|
||||
const wrapAllExportedFieldsTables = (content: string | undefined): string | undefined => {
|
||||
if (!content) return content;
|
||||
|
||||
const md = new MarkdownIt();
|
||||
const tokens = md.parse(content, {});
|
||||
const lines = content.split('\n');
|
||||
|
||||
const exportedFieldsLines: number[] = lines
|
||||
.map((line, index) => (line.trim() === '**Exported fields**' ? index : -1))
|
||||
.filter((index) => index !== -1);
|
||||
|
||||
if (exportedFieldsLines.length === 0) return content;
|
||||
|
||||
const tableRanges: Array<[number, number]> = tokens
|
||||
.filter((token) => token.type === 'table_open' && token.map)
|
||||
.map((token) => token.map as [number, number]);
|
||||
|
||||
const usedTables = new Set<number>();
|
||||
const insertions: Array<{ summaryLine: number; start: number; end: number }> = [];
|
||||
|
||||
for (const summaryLine of exportedFieldsLines) {
|
||||
// Find the first table that starts after the summary line and hasn't been used yet
|
||||
const table = tableRanges.find(([start], idx) => start > summaryLine && !usedTables.has(idx));
|
||||
if (table) {
|
||||
const [start, end] = table;
|
||||
usedTables.add(tableRanges.indexOf(table));
|
||||
insertions.push({ summaryLine, start, end });
|
||||
}
|
||||
}
|
||||
|
||||
const newLines: string[] = [];
|
||||
let currentLine = 0;
|
||||
|
||||
for (const { summaryLine, start, end } of insertions) {
|
||||
newLines.push(...lines.slice(currentLine, summaryLine));
|
||||
currentLine = summaryLine + 1;
|
||||
|
||||
newLines.push(...lines.slice(currentLine, start));
|
||||
currentLine = start;
|
||||
|
||||
newLines.push('<details><summary>Exported fields</summary>', '');
|
||||
newLines.push(...lines.slice(start, end));
|
||||
newLines.push('', '</details>');
|
||||
|
||||
currentLine = end;
|
||||
}
|
||||
|
||||
newLines.push(...lines.slice(currentLine));
|
||||
|
||||
return newLines.join('\n');
|
||||
};
|
||||
|
||||
const markdownWithCollapsable = useMemo(() => wrapAllExportedFieldsTables(markdown), [markdown]);
|
||||
|
||||
return (
|
||||
<>
|
||||
{markdown !== undefined ? (
|
||||
{markdownWithCollapsable !== undefined ? (
|
||||
<EuiText grow={true}>
|
||||
<ReactMarkdown
|
||||
transformImageUri={handleImageUri}
|
||||
components={markdownRenderers(refs)}
|
||||
rehypePlugins={[rehypeRaw, [rehypeSanitize]]}
|
||||
remarkPlugins={[remarkGfm]}
|
||||
>
|
||||
{markdown}
|
||||
{markdownWithCollapsable}
|
||||
</ReactMarkdown>
|
||||
</EuiText>
|
||||
) : (
|
||||
<EuiText>
|
||||
{/* simulates a long page of text loading */}
|
||||
|
||||
<EuiSkeletonText lines={5} />
|
||||
<EuiSpacer size="m" />
|
||||
<EuiSkeletonText lines={6} />
|
||||
|
|
16
yarn.lock
16
yarn.lock
|
@ -20401,6 +20401,13 @@ hast-util-raw@^6.1.0:
|
|||
xtend "^4.0.0"
|
||||
zwitch "^1.0.0"
|
||||
|
||||
hast-util-sanitize@^3.0.0:
|
||||
version "3.0.2"
|
||||
resolved "https://registry.yarnpkg.com/hast-util-sanitize/-/hast-util-sanitize-3.0.2.tgz#b0b783220af528ba8fe6999f092d138908678520"
|
||||
integrity sha512-+2I0x2ZCAyiZOO/sb4yNLFmdwPBnyJ4PBkVTUMKMqBwYNA+lXSgOmoRXlJFazoyid9QPogRRKgKhVEodv181sA==
|
||||
dependencies:
|
||||
xtend "^4.0.0"
|
||||
|
||||
hast-util-to-html@^7.1.1:
|
||||
version "7.1.1"
|
||||
resolved "https://registry.yarnpkg.com/hast-util-to-html/-/hast-util-to-html-7.1.1.tgz#39818b8bbfcb8eaa87846a120b3875487b27d094"
|
||||
|
@ -27903,7 +27910,7 @@ regjsparser@^0.9.1:
|
|||
dependencies:
|
||||
jsesc "~0.5.0"
|
||||
|
||||
rehype-raw@^5.1.0:
|
||||
rehype-raw@5.1.0, rehype-raw@^5.1.0:
|
||||
version "5.1.0"
|
||||
resolved "https://registry.yarnpkg.com/rehype-raw/-/rehype-raw-5.1.0.tgz#66d5e8d7188ada2d31bc137bc19a1000cf2c6b7e"
|
||||
integrity sha512-MDvHAb/5mUnif2R+0IPCYJU8WjHa9UzGtM/F4AVy5GixPlDZ1z3HacYy4xojDU+uBa+0X/3PIfyQI26/2ljJNA==
|
||||
|
@ -27918,6 +27925,13 @@ rehype-react@^6.2.1:
|
|||
"@mapbox/hast-util-table-cell-style" "^0.2.0"
|
||||
hast-to-hyperscript "^9.0.0"
|
||||
|
||||
rehype-sanitize@4.0.0:
|
||||
version "4.0.0"
|
||||
resolved "https://registry.yarnpkg.com/rehype-sanitize/-/rehype-sanitize-4.0.0.tgz#b5241cf66bcedc49cd4e924a5f7a252f00a151ad"
|
||||
integrity sha512-ZCr/iQRr4JeqPjun5i9CHHILVY7i45VnLu1CkkibDrSyFQ7dTLSvw8OIQpHhS4RSh9h/9GidxFw1bRb0LOxIag==
|
||||
dependencies:
|
||||
hast-util-sanitize "^3.0.0"
|
||||
|
||||
rehype-stringify@^8.0.0:
|
||||
version "8.0.0"
|
||||
resolved "https://registry.yarnpkg.com/rehype-stringify/-/rehype-stringify-8.0.0.tgz#9b6afb599bcf3165f10f93fc8548f9a03d2ec2ba"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue