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

Refactor Sample Data Home section which also fixes flaky sample data functional test #21655

Merged
merged 14 commits into from
Aug 27, 2018
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -28,70 +28,40 @@ import {
EuiToolTip,
} from '@elastic/eui';

import {
installSampleDataSet,
uninstallSampleDataSet
} from '../sample_data_sets';
const INSTALLED_STATUS = 'installed';
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess these are returned from the objects in listSampleDataSets? Our folder structure of core plugins makes it difficult to push common consts in an intuitive place (the server side code of this is far away). If we typescripted this and the files in ../sample_data_sets we could at least show that the object being returned has a status and is one of installed or not_installed. Suppose that's fine for this PR but I think it'd be really helpful to understand and follow this code if it was in typescript.

const UNINSTALLED_STATUS = 'not_installed';

export class SampleDataSetCard extends React.Component {

constructor(props) {
super(props);

this.state = {
isProcessingRequest: false,
};
}

startRequest = async () => {
const {
getConfig,
setConfig,
id,
name,
onRequestComplete,
defaultIndex,
clearIndexPatternsCache,
} = this.props;

this.setState({
isProcessingRequest: true,
});

if (this.isInstalled()) {
await uninstallSampleDataSet(id, name, defaultIndex, getConfig, setConfig, clearIndexPatternsCache);
} else {
await installSampleDataSet(id, name, defaultIndex, getConfig, setConfig, clearIndexPatternsCache);
}

onRequestComplete();

this.setState({
isProcessingRequest: false,
});
}

isInstalled = () => {
if (this.props.status === 'installed') {
if (this.props.status === INSTALLED_STATUS) {
return true;
}

return false;
}

install = () => {
this.props.onInstall(this.props.id);
}

uninstall = () => {
this.props.onUninstall(this.props.id);
}

renderBtn = () => {
switch (this.props.status) {
case 'installed':
case INSTALLED_STATUS:
return (
<EuiFlexGroup justifyContent="spaceBetween">
<EuiFlexItem grow={false}>
<EuiButtonEmpty
isLoading={this.state.isProcessingRequest}
onClick={this.startRequest}
isLoading={this.props.isProcessing}
onClick={this.uninstall}
color="danger"
data-test-subj={`removeSampleDataSet${this.props.id}`}
>
{this.state.isProcessingRequest ? 'Removing' : 'Remove'}
{this.props.isProcessing ? 'Removing' : 'Remove'}
</EuiButtonEmpty>
</EuiFlexItem>
<EuiFlexItem grow={false}>
Expand All @@ -105,16 +75,16 @@ export class SampleDataSetCard extends React.Component {
</EuiFlexGroup>
);

case 'not_installed':
case UNINSTALLED_STATUS:
return (
<EuiFlexGroup justifyContent="flexEnd">
<EuiFlexItem grow={false}>
<EuiButton
isLoading={this.state.isProcessingRequest}
onClick={this.startRequest}
isLoading={this.props.isProcessing}
onClick={this.install}
data-test-subj={`addSampleDataSet${this.props.id}`}
>
{this.state.isProcessingRequest ? 'Adding' : 'Add'}
{this.props.isProcessing ? 'Adding' : 'Add'}
</EuiButton>
</EuiFlexItem>
</EuiFlexGroup>
Expand Down Expand Up @@ -162,15 +132,13 @@ SampleDataSetCard.propTypes = {
name: PropTypes.string.isRequired,
launchUrl: PropTypes.string.isRequired,
status: PropTypes.oneOf([
'installed',
'not_installed',
INSTALLED_STATUS,
UNINSTALLED_STATUS,
'unknown',
]).isRequired,
isProcessing: PropTypes.bool.isRequired,
statusMsg: PropTypes.string,
onRequestComplete: PropTypes.func.isRequired,
getConfig: PropTypes.func.isRequired,
setConfig: PropTypes.func.isRequired,
clearIndexPatternsCache: PropTypes.func.isRequired,
defaultIndex: PropTypes.string.isRequired,
previewUrl: PropTypes.string.isRequired,
onInstall: PropTypes.func.isRequired,
onUninstall: PropTypes.func.isRequired,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import React from 'react';
import PropTypes from 'prop-types';
import {
EuiFlexGrid,
EuiFlexItem,
} from '@elastic/eui';

import { SampleDataSetCard } from './sample_data_set_card';

import {
listSampleDataSets,
installSampleDataSet,
uninstallSampleDataSet
} from '../sample_data_sets';

export class SampleDataSetCards extends React.Component {

constructor(props) {
super(props);

this.state = {
sampleDataSets: [],
};
}

componentWillUnmount() {
this._isMounted = false;
}

async componentDidMount() {
this._isMounted = true;

this.loadSampleDataSets();
}

loadSampleDataSets = async () => {
const sampleDataSets = await listSampleDataSets();

if (!this._isMounted) {
return;
}

this.setState({
sampleDataSets: sampleDataSets
.map((sampleDataSet) => {
sampleDataSet.isProcessing = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this is modifying the returned object. When we have typescript, the structure of sampleDataSet will be easy to see, and at that point, I don't think it would make sense to put an isProcessing flag on it just for the purpose of this class. What about a mapping that keeps track of isProcessing for each sample data set by id?

return sampleDataSet;
})
.sort((a, b) => {
return a.name.toLowerCase().localeCompare(b.name.toLowerCase());
}),
});
}

install = async (id) => {
const {
getConfig,
setConfig,
clearIndexPatternsCache,
} = this.props;

const targetSampleDataSet = this.state.sampleDataSets.find((sampleDataSet) => {
return sampleDataSet.id === id;
});
targetSampleDataSet.isProcessing = true;

this.setState({
sampleDataSets: this.state.sampleDataSets.map((sampleDataSet) => {
if (sampleDataSet.id === id) {
return targetSampleDataSet;
}
return sampleDataSet;
}),
});

await installSampleDataSet(id, targetSampleDataSet.name, targetSampleDataSet.defaultIndex,
getConfig, setConfig, clearIndexPatternsCache);
if (!this._isMounted) {
return;
}

this.loadSampleDataSets();
}

uninstall = async (id) => {
const {
getConfig,
setConfig,
clearIndexPatternsCache,
} = this.props;

const targetSampleDataSet = this.state.sampleDataSets.find((sampleDataSet) => {
return sampleDataSet.id === id;
});
targetSampleDataSet.isProcessing = true;

this.setState({
sampleDataSets: this.state.sampleDataSets.map((sampleDataSet) => {
if (sampleDataSet.id === id) {
return targetSampleDataSet;
}
return sampleDataSet;
}),
});

await uninstallSampleDataSet(id, targetSampleDataSet.name, targetSampleDataSet.defaultIndex,
getConfig, setConfig, clearIndexPatternsCache);
if (!this._isMounted) {
return;
}

this.loadSampleDataSets();
}

render() {
return (
<EuiFlexGrid columns={4}>
{
this.state.sampleDataSets.map(sampleDataSet => {
return (
<EuiFlexItem key={sampleDataSet.id}>
<SampleDataSetCard
id={sampleDataSet.id}
description={sampleDataSet.description}
name={sampleDataSet.name}
launchUrl={this.props.addBasePath(`/app/kibana#/dashboard/${sampleDataSet.overviewDashboard}`)}
status={sampleDataSet.status}
isProcessing={sampleDataSet.isProcessing}
statusMsg={sampleDataSet.statusMsg}
previewUrl={this.props.addBasePath(sampleDataSet.previewImagePath)}
onInstall={this.install}
onUninstall={this.uninstall}
/>
</EuiFlexItem>
);
})
}
</EuiFlexGrid>
);
}
}

SampleDataSetCards.propTypes = {
getConfig: PropTypes.func.isRequired,
setConfig: PropTypes.func.isRequired,
clearIndexPatternsCache: PropTypes.func.isRequired,
addBasePath: PropTypes.func.isRequired,
};
Loading