-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
[Lens] Implement deep linking and embedding #84416
Changes from 12 commits
e9a70a9
ba48fdc
dffdd6d
9345fca
a86082e
06ac9dd
e8d6df9
e2a9e9b
793f8ed
0f32e4b
f9bbdb2
8ae66be
0d4b99e
cf1fd9f
d9397ec
8b02b39
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"rules": { | ||
"@typescript-eslint/consistent-type-definitions": 0 | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Embedded Lens examples | ||
|
||
To run this example plugin, use the command `yarn start --run-examples`. | ||
|
||
TODO |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"id": "embeddedLensExample", | ||
"version": "0.0.1", | ||
"kibanaVersion": "kibana", | ||
"configPath": ["embedded_lens_example"], | ||
"server": false, | ||
"ui": true, | ||
"requiredPlugins": [ | ||
"lens", | ||
"data", | ||
"developerExamples" | ||
], | ||
"optionalPlugins": [], | ||
"requiredBundles": [] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"name": "embedded_lens_example", | ||
"version": "1.0.0", | ||
"main": "target/examples/embedded_lens_example", | ||
"kibana": { | ||
"version": "kibana", | ||
"templateVersion": "1.0.0" | ||
}, | ||
"license": "Apache-2.0", | ||
"scripts": { | ||
"kbn": "node ../../../scripts/kbn.js", | ||
"build": "rm -rf './target' && ../../../node_modules/.bin/tsc" | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
/* | ||
* 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 React, { useState } from 'react'; | ||
import { | ||
EuiButton, | ||
EuiPage, | ||
EuiPageBody, | ||
EuiPageContent, | ||
EuiPageContentBody, | ||
EuiPageHeader, | ||
EuiPageHeaderSection, | ||
EuiTitle, | ||
} from '@elastic/eui'; | ||
import { CoreStart } from 'kibana/public'; | ||
import { TypedLensByValueInput } from '../../../plugins/lens/public'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we expecting that other plugins will start depending on Lens in the plugin system? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, exactly - as they are creating Lens-specific configuration, this seems like a good way to represent it on the type level |
||
import { StartDependencies } from './plugin'; | ||
|
||
// Generate a Lens state based on some app-specific input parameters. | ||
// `TypedLensByValueInput` can be used for type-safety - it uses the same interfaces as Lens-internal code. | ||
function getLensAttributes( | ||
defaultIndex: string, | ||
color: string | ||
): TypedLensByValueInput['attributes'] { | ||
return { | ||
visualizationType: 'lnsXY', | ||
title: '', | ||
references: [ | ||
{ | ||
id: defaultIndex, | ||
name: 'indexpattern-datasource-current-indexpattern', | ||
type: 'index-pattern', | ||
}, | ||
{ | ||
id: defaultIndex, | ||
name: 'indexpattern-datasource-layer-layer1', | ||
type: 'index-pattern', | ||
}, | ||
], | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm a bit worried about the references parameter of our saved object. Seems easy for an app to provide the wrong information. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I thought about a builder function of some sort abstracting away these things, but didn't want to overdo it for the first experimental release. Do you have something simple in mind we could add here? IMHO we can wait for consumers to see in which direction we should drive this API. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was also expecting some kind of builder, but I agree that we should iterate on it. For now I'm assuming that users will copy+paste the JSON from a saved object. |
||
state: { | ||
datasourceStates: { | ||
indexpattern: { | ||
layers: { | ||
layer1: { | ||
columnOrder: ['col1', 'col2'], | ||
columns: { | ||
col2: { | ||
dataType: 'number', | ||
isBucketed: false, | ||
label: 'Count of records', | ||
operationType: 'count', | ||
scale: 'ratio', | ||
sourceField: 'Records', | ||
}, | ||
col1: { | ||
dataType: 'date', | ||
isBucketed: true, | ||
label: '@timestamp', | ||
operationType: 'date_histogram', | ||
params: { interval: 'auto' }, | ||
scale: 'interval', | ||
sourceField: '@timestamp', | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
filters: [], | ||
query: { language: 'kuery', query: '' }, | ||
visualization: { | ||
axisTitlesVisibilitySettings: { x: true, yLeft: true, yRight: true }, | ||
fittingFunction: 'None', | ||
gridlinesVisibilitySettings: { x: true, yLeft: true, yRight: true }, | ||
layers: [ | ||
{ | ||
accessors: ['col2'], | ||
layerId: 'layer1', | ||
seriesType: 'bar_stacked', | ||
xAccessor: 'col1', | ||
yConfig: [{ forAccessor: 'col2', color }], | ||
}, | ||
], | ||
legend: { isVisible: true, position: 'right' }, | ||
preferredSeriesType: 'bar_stacked', | ||
tickLabelsVisibilitySettings: { x: true, yLeft: true, yRight: true }, | ||
valueLabels: 'hide', | ||
}, | ||
}, | ||
}; | ||
} | ||
|
||
export const App = (props: { core: CoreStart; plugins: StartDependencies }) => { | ||
const [color, setColor] = useState('green'); | ||
const LensComponent = props.plugins.lens.EmbeddableComponent; | ||
return ( | ||
<EuiPage> | ||
<EuiPageBody style={{ maxWidth: 1200, margin: '0 auto' }}> | ||
<EuiPageHeader> | ||
<EuiPageHeaderSection> | ||
<EuiTitle size="l"> | ||
<h1>Embedded Lens vis</h1> | ||
</EuiTitle> | ||
</EuiPageHeaderSection> | ||
</EuiPageHeader> | ||
<EuiPageContent> | ||
<EuiPageContentBody style={{ maxWidth: 800, margin: '0 auto' }}> | ||
<EuiButton | ||
onClick={() => { | ||
// eslint-disable-next-line no-bitwise | ||
const newColor = '#' + ((Math.random() * 0xffffff) << 0).toString(16); | ||
setColor(newColor); | ||
}} | ||
> | ||
Change color | ||
</EuiButton> | ||
<EuiButton | ||
onClick={() => { | ||
props.plugins.lens.navigateToPrefilledEditor({ | ||
id: '', | ||
timeRange: { | ||
from: 'now-5d', | ||
to: 'now', | ||
}, | ||
attributes: getLensAttributes(props.core.uiSettings.get('defaultIndex'), color), | ||
}); | ||
// eslint-disable-next-line no-bitwise | ||
const newColor = '#' + ((Math.random() * 0xffffff) << 0).toString(16); | ||
setColor(newColor); | ||
}} | ||
> | ||
Edit | ||
</EuiButton> | ||
<LensComponent | ||
id="" | ||
style={{ height: 500 }} | ||
timeRange={{ | ||
from: 'now-5d', | ||
to: 'now', | ||
}} | ||
attributes={getLensAttributes(props.core.uiSettings.get('defaultIndex'), color)} | ||
/> | ||
</EuiPageContentBody> | ||
</EuiPageContent> | ||
</EuiPageBody> | ||
</EuiPage> | ||
); | ||
}; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/* | ||
* 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 { EmbeddedLensExamplePlugin } from './plugin'; | ||
|
||
export const plugin = () => new EmbeddedLensExamplePlugin(); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
/* | ||
* 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 * as React from 'react'; | ||
import { render, unmountComponentAtNode } from 'react-dom'; | ||
import { CoreSetup, AppMountParameters } from 'kibana/public'; | ||
import { StartDependencies } from './plugin'; | ||
|
||
export const mount = (coreSetup: CoreSetup<StartDependencies>) => async ({ | ||
element, | ||
}: AppMountParameters) => { | ||
const [core, plugins] = await coreSetup.getStartServices(); | ||
const { App } = await import('./app'); | ||
|
||
const deps = { | ||
core, | ||
plugins, | ||
}; | ||
const reactElement = <App {...deps} />; | ||
render(reactElement, element); | ||
return () => unmountComponentAtNode(element); | ||
}; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/* | ||
* 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 { Plugin, CoreSetup, AppNavLinkStatus } from '../../../../src/core/public'; | ||
import { DataPublicPluginStart } from '../../../../src/plugins/data/public'; | ||
import { LensPublicStart } from '../../../plugins/lens/public'; | ||
import { DeveloperExamplesSetup } from '../../../../examples/developer_examples/public'; | ||
import { mount } from './mount'; | ||
|
||
export interface SetupDependencies { | ||
developerExamples: DeveloperExamplesSetup; | ||
} | ||
|
||
export interface StartDependencies { | ||
data: DataPublicPluginStart; | ||
lens: LensPublicStart; | ||
} | ||
|
||
export class EmbeddedLensExamplePlugin | ||
implements Plugin<void, void, SetupDependencies, StartDependencies> { | ||
public setup(core: CoreSetup<StartDependencies>, { developerExamples }: SetupDependencies) { | ||
core.application.register({ | ||
id: 'embedded_lens_example', | ||
title: 'Embedded Lens example', | ||
navLinkStatus: AppNavLinkStatus.hidden, | ||
mount: mount(core), | ||
}); | ||
|
||
developerExamples.register({ | ||
appId: 'embedded_lens_example', | ||
title: 'Embedded Lens', | ||
description: 'Examples of how to use Lens in other apps.', | ||
links: [ | ||
{ | ||
label: 'README', | ||
href: | ||
'https://github.com/elastic/kibana/tree/master/x-pack/examples/embedded_lens_example', | ||
iconType: 'logoGithub', | ||
size: 's', | ||
target: '_blank', | ||
}, | ||
], | ||
}); | ||
} | ||
|
||
public start() {} | ||
|
||
public stop() {} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"extends": "../../../tsconfig.base.json", | ||
"compilerOptions": { | ||
"outDir": "./target", | ||
"skipLibCheck": true | ||
}, | ||
"include": [ | ||
"index.ts", | ||
"public/**/*.ts", | ||
"public/**/*.tsx", | ||
"server/**/*.ts", | ||
"../../typings/**/*" | ||
], | ||
"exclude": [], | ||
"references": [ | ||
{ "path": "../../../src/core/tsconfig.json" }, | ||
{ "path": "../../../src/plugins/kibana_utils/tsconfig.json" }, | ||
{ "path": "../../../src/plugins/kibana_react/tsconfig.json" }, | ||
{ "path": "../../../src/plugins/share/tsconfig.json" } | ||
] | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @flash1293! For this example plugin, can we add a dependency on
features
to illustrate that you'll need to grant access to thelens
saved object type in order to properly embed when security is enabled?I'm happy to help draft this change if you'd like help with it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@legrego Happy to include this - but I'm not sure how it should look like.
This example is not working with saved objects directly, but it does link into the Lens editor. So I guess the right integration would be to check whether there there are at least visualize read permissions via ui capabilities and otherwise disable the button, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, so this doesn't allow you to view existing visualizations, or save new ones? If that's the case, then you shouldn't need any capabilities checks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed offline, I will introduce a third method on the contract which can be used by consumers to determine whether it's possible to link to Lens or not.