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

[Home] Adding file upload to add data page #100863

Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ class TutorialDirectoryUi extends React.Component {
constructor(props) {
super(props);

const extraTabs = getServices().addDataService.getAddDataTabs();

this.tabs = [
{
id: ALL_TAB_ID,
Expand Down Expand Up @@ -77,7 +79,13 @@ class TutorialDirectoryUi extends React.Component {
id: 'home.tutorial.tabs.sampleDataTitle',
defaultMessage: 'Sample data',
}),
content: <SampleDataSetCards addBasePath={this.props.addBasePath} />,
},
...extraTabs.map(({ id, name, component: Component }) => ({
id,
name,
content: <Component />,
})),
];

let openTab = ALL_TAB_ID;
Expand Down Expand Up @@ -190,8 +198,9 @@ class TutorialDirectoryUi extends React.Component {
};

renderTabContent = () => {
if (this.state.selectedTabId === SAMPLE_DATA_TAB_ID) {
return <SampleDataSetCards addBasePath={this.props.addBasePath} />;
const tab = this.tabs.find(({ id }) => id === this.state.selectedTabId);
if (tab?.content !== undefined) {
return tab.content;
Copy link
Contributor

Choose a reason for hiding this comment

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

NIT: if (tab?.content)

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated in b532118

}

return (
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/home/public/application/kibana_services.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { UiCounterMetricType } from '@kbn/analytics';
import { TelemetryPluginStart } from '../../../telemetry/public';
import { UrlForwardingStart } from '../../../url_forwarding/public';
import { TutorialService } from '../services/tutorials';
import { AddDataService } from '../services/add_data';
import { FeatureCatalogueRegistry } from '../services/feature_catalogue';
import { EnvironmentService } from '../services/environment';
import { ConfigSchema } from '../../config';
Expand All @@ -44,6 +45,7 @@ export interface HomeKibanaServices {
environmentService: EnvironmentService;
telemetry?: TelemetryPluginStart;
tutorialService: TutorialService;
addDataService: AddDataService;
}

let services: HomeKibanaServices | null = null;
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/home/public/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ import { featureCatalogueRegistryMock } from './services/feature_catalogue/featu
import { environmentServiceMock } from './services/environment/environment.mock';
import { configSchema } from '../config';
import { tutorialServiceMock } from './services/tutorials/tutorial_service.mock';
import { addDataServiceMock } from './services/add_data/add_data_service.mock';

const createSetupContract = () => ({
featureCatalogue: featureCatalogueRegistryMock.createSetup(),
environment: environmentServiceMock.createSetup(),
tutorials: tutorialServiceMock.createSetup(),
addData: addDataServiceMock.createSetup(),
config: configSchema.validate({}),
});

Expand Down
3 changes: 3 additions & 0 deletions src/plugins/home/public/plugin.test.mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@
import { featureCatalogueRegistryMock } from './services/feature_catalogue/feature_catalogue_registry.mock';
import { environmentServiceMock } from './services/environment/environment.mock';
import { tutorialServiceMock } from './services/tutorials/tutorial_service.mock';
import { addDataServiceMock } from './services/add_data/add_data_service.mock';

export const registryMock = featureCatalogueRegistryMock.create();
export const environmentMock = environmentServiceMock.create();
export const tutorialMock = tutorialServiceMock.create();
export const addDataMock = addDataServiceMock.create();
jest.doMock('./services', () => ({
FeatureCatalogueRegistry: jest.fn(() => registryMock),
EnvironmentService: jest.fn(() => environmentMock),
TutorialService: jest.fn(() => tutorialMock),
AddDataService: jest.fn(() => addDataMock),
}));
9 changes: 9 additions & 0 deletions src/plugins/home/public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import {
FeatureCatalogueRegistrySetup,
TutorialService,
TutorialServiceSetup,
AddDataService,
AddDataServiceSetup,
} from './services';
import { ConfigSchema } from '../config';
import { setServices } from './application/kibana_services';
Expand Down Expand Up @@ -56,6 +58,7 @@ export class HomePublicPlugin
private readonly featuresCatalogueRegistry = new FeatureCatalogueRegistry();
private readonly environmentService = new EnvironmentService();
private readonly tutorialService = new TutorialService();
private readonly addDataService = new AddDataService();

constructor(private readonly initializerContext: PluginInitializerContext<ConfigSchema>) {}

Expand Down Expand Up @@ -94,6 +97,7 @@ export class HomePublicPlugin
urlForwarding: urlForwardingStart,
homeConfig: this.initializerContext.config.get(),
tutorialService: this.tutorialService,
addDataService: this.addDataService,
featureCatalogue: this.featuresCatalogueRegistry,
});
coreStart.chrome.docTitle.change(
Expand Down Expand Up @@ -126,6 +130,7 @@ export class HomePublicPlugin
featureCatalogue,
environment: { ...this.environmentService.setup() },
tutorials: { ...this.tutorialService.setup() },
addData: { ...this.addDataService.setup() },
};
}

Expand Down Expand Up @@ -163,9 +168,13 @@ export type EnvironmentSetup = EnvironmentServiceSetup;
/** @public */
export type TutorialSetup = TutorialServiceSetup;

/** @public */
export type AddDataSetup = AddDataServiceSetup;

/** @public */
export interface HomePublicPluginSetup {
tutorials: TutorialServiceSetup;
addData: AddDataServiceSetup;
featureCatalogue: FeatureCatalogueSetup;
/**
* The environment service is only available for a transition period and will
Expand Down
31 changes: 31 additions & 0 deletions src/plugins/home/public/services/add_data/add_data_service.mock.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

import type { PublicMethodsOf } from '@kbn/utility-types';
import { AddDataService, AddDataServiceSetup } from './add_data_service';

const createSetupMock = (): jest.Mocked<AddDataServiceSetup> => {
const setup = {
registerAddDataTab: jest.fn(),
};
return setup;
};

const createMock = (): jest.Mocked<PublicMethodsOf<AddDataService>> => {
const service = {
setup: jest.fn(),
getAddDataTabs: jest.fn(() => []),
};
service.setup.mockImplementation(createSetupMock);
return service;
};

export const addDataServiceMock = {
createSetup: createSetupMock,
create: createMock,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

import React from 'react';
import { AddDataService } from './add_data_service';

describe('AddDataService', () => {
describe('setup', () => {
test('allows multiple register directory header link calls', () => {
const setup = new AddDataService().setup();
expect(() => {
setup.registerAddDataTab({ id: 'abc', name: 'a b c', component: () => <a>123</a> });
setup.registerAddDataTab({ id: 'def', name: 'a b c', component: () => <a>456</a> });
}).not.toThrow();
});

test('throws when same directory header link is registered twice', () => {
const setup = new AddDataService().setup();
expect(() => {
setup.registerAddDataTab({ id: 'abc', name: 'a b c', component: () => <a>123</a> });
setup.registerAddDataTab({ id: 'abc', name: 'a b c', component: () => <a>456</a> });
}).toThrow();
});
});

describe('getDirectoryHeaderLinks', () => {
test('returns empty array', () => {
const service = new AddDataService();
expect(service.getAddDataTabs()).toEqual([]);
});

test('returns last state of register calls', () => {
const service = new AddDataService();
const setup = service.setup();
const links = [
{ id: 'abc', name: 'a b c', component: () => <a>123</a> },
{ id: 'def', name: 'a b c', component: () => <a>456</a> },
];
setup.registerAddDataTab(links[0]);
setup.registerAddDataTab(links[1]);
expect(service.getAddDataTabs()).toEqual(links);
});
});
});
42 changes: 42 additions & 0 deletions src/plugins/home/public/services/add_data/add_data_service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

import React from 'react';

/** @public */
export interface AddDataTab {
id: string;
name: string;
component: React.FC;
}

export class AddDataService {
private addDataTabs: {
[key: string]: AddDataTab;
} = {};
Copy link
Contributor

Choose a reason for hiding this comment

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

NIT: Record<string, AddDataTab>

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated in b532118


public setup() {
return {
/**
* Registers a component that will be rendered as a new tab in the Add data page
*/
registerAddDataTab: (tab: AddDataTab) => {
if (this.addDataTabs[tab.id]) {
throw new Error(`Tab ${tab.id} already exists`);
}
this.addDataTabs[tab.id] = tab;
},
};
}

public getAddDataTabs() {
return Object.values(this.addDataTabs);
}
}

export type AddDataServiceSetup = ReturnType<AddDataService['setup']>;
11 changes: 11 additions & 0 deletions src/plugins/home/public/services/add_data/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

export { AddDataService } from './add_data_service';

export type { AddDataServiceSetup, AddDataTab } from './add_data_service';
3 changes: 3 additions & 0 deletions src/plugins/home/public/services/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ export type {
TutorialDirectoryHeaderLinkComponent,
TutorialModuleNoticeComponent,
} from './tutorials';

export { AddDataService } from './add_data';
export type { AddDataServiceSetup, AddDataTab } from './add_data';
3 changes: 2 additions & 1 deletion x-pack/plugins/file_data_visualizer/kibana.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"embeddable",
"share",
"discover",
"fileUpload"
"fileUpload",
"home"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think home should be an optional dependency here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated in b532118

],
"optionalPlugins": [
"security",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* 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, { FC, useState, useEffect } from 'react';

export const FileDataVisualizerWrapper: FC = () => {
const [FileDataVisualizerComponent, setFileDataVisualizerComponent] = useState<FC<{}> | null>(
null
);

useEffect(() => {
if (FileDataVisualizerComponent === null) {
import('../application/file_datavisualizer').then(({ FileDataVisualizer }) => {
setFileDataVisualizerComponent(FileDataVisualizer);
Copy link
Contributor

Choose a reason for hiding this comment

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

NIT: could use react.lazy instead of a manual effect.

Copy link
Member Author

Choose a reason for hiding this comment

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

good idea, that is much nicer.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated in b532118

});
}
}, [FileDataVisualizerComponent]);

return <>{FileDataVisualizerComponent}</>;
};
15 changes: 10 additions & 5 deletions x-pack/plugins/file_data_visualizer/public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@
* 2.0.
*/

import { CoreStart } from 'kibana/public';
import { CoreSetup, CoreStart } from 'kibana/public';
import type { EmbeddableStart } from '../../../../src/plugins/embeddable/public';
import type { SharePluginStart } from '../../../../src/plugins/share/public';
import { Plugin } from '../../../../src/core/public';

import { setStartServices } from './kibana_services';
import { DataPublicPluginStart } from '../../../../src/plugins/data/public';
import type { DataPublicPluginStart } from '../../../../src/plugins/data/public';
import type { HomePublicPluginSetup } from '../../../../src/plugins/home/public';
import type { FileUploadPluginStart } from '../../file_upload/public';
import type { MapsStartApi } from '../../maps/public';
import type { SecurityPluginSetup } from '../../security/public';
import { getFileDataVisualizerComponent } from './api';
import { getMaxBytesFormatted } from './application/util/get_max_bytes';
import { registerHomeAddData } from './register_home';

// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface FileDataVisualizerSetupDependencies {}
export interface FileDataVisualizerSetupDependencies {
home: HomePublicPluginSetup;
}
export interface FileDataVisualizerStartDependencies {
data: DataPublicPluginStart;
fileUpload: FileUploadPluginStart;
Expand All @@ -40,7 +43,9 @@ export class FileDataVisualizerPlugin
FileDataVisualizerSetupDependencies,
FileDataVisualizerStartDependencies
> {
public setup() {}
public setup(core: CoreSetup, plugins: FileDataVisualizerSetupDependencies) {
registerHomeAddData(plugins.home);
}

public start(core: CoreStart, plugins: FileDataVisualizerStartDependencies) {
setStartServices(core, plugins);
Expand Down
20 changes: 20 additions & 0 deletions x-pack/plugins/file_data_visualizer/public/register_home.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* 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 { i18n } from '@kbn/i18n';
import type { HomePublicPluginSetup } from '../../../../src/plugins/home/public';
import { FileDataVisualizerWrapper } from './lazy_load_bundle/component_wrapper';

export function registerHomeAddData(home: HomePublicPluginSetup) {
home.addData.registerAddDataTab({
id: 'fileDataViz',
name: i18n.translate('xpack.fileDataVisualizer.embeddedTabTitle', {
defaultMessage: 'Upload file',
}),
component: FileDataVisualizerWrapper,
});
}