-
Notifications
You must be signed in to change notification settings - Fork 884
/
visualize_listing.tsx
241 lines (226 loc) · 8.2 KB
/
visualize_listing.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Any modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
/*
* 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 './visualize_listing.scss';
import React, { useCallback, useRef, useMemo, useEffect } from 'react';
import { i18n } from '@osd/i18n';
import { useUnmount, useMount } from 'react-use';
import { useLocation } from 'react-router-dom';
import {
useOpenSearchDashboards,
TableListView,
} from '../../../../opensearch_dashboards_react/public';
import { VISUALIZE_ENABLE_LABS_SETTING } from '../../../../visualizations/public';
import { VisualizeServices } from '../types';
import { VisualizeConstants } from '../visualize_constants';
import { getTableColumns, getNoItemsMessage } from '../utils';
import { getUiActions } from '../../services';
import { SAVED_OBJECT_DELETE_TRIGGER } from '../../../../saved_objects_management/public';
import { HeaderVariant } from '../../../../../core/public/index';
import { constructVisBuilderPath } from '../utils/construct_vis_builder_path';
export const VisualizeListing = () => {
const {
services: {
application,
chrome,
history,
savedVisualizations,
toastNotifications,
visualizations,
savedObjects,
savedObjectsPublic,
uiSettings,
visualizeCapabilities,
navigation,
},
} = useOpenSearchDashboards<VisualizeServices>();
const { pathname } = useLocation();
const closeNewVisModal = useRef(() => {});
const listingLimit = savedObjectsPublic.settings.getListingLimit();
const showUpdatedUx = uiSettings?.get('home:useNewHomePage');
const { HeaderControl } = navigation.ui;
const { setAppRightControls } = application;
useEffect(() => {
if (pathname === '/new') {
// In case the user navigated to the page via the /visualize/new URL we start the dialog immediately
closeNewVisModal.current = visualizations.showNewVisModal({
onClose: () => {
// In case the user came via a URL to this page, change the URL to the regular landing page URL after closing the modal
history.push(VisualizeConstants.LANDING_PAGE_PATH);
},
});
} else {
// close modal window if exists
closeNewVisModal.current();
}
}, [history, pathname, visualizations]);
useMount(() => {
if (showUpdatedUx) {
chrome.setBreadcrumbs([
{
text: i18n.translate('visualize.listingBreadcrumbsTitle', {
defaultMessage: 'Visualizations',
}),
},
]);
} else {
chrome.setBreadcrumbs([
{
text: i18n.translate('visualize.legacy.listingBreadcrumbsTitle', {
defaultMessage: 'Visualize',
}),
},
]);
}
chrome.docTitle.change(
i18n.translate('visualize.listingPageTitle', { defaultMessage: 'Visualize' })
);
});
useUnmount(() => closeNewVisModal.current());
const createNewVis = useCallback(() => {
closeNewVisModal.current = visualizations.showNewVisModal();
}, [visualizations]);
const editItem = useCallback(
({ editUrl, editApp }) => {
if (editApp) {
application.navigateToApp(editApp, { path: editUrl });
return;
}
// for visualizations the edit and view URLs are the same
history.push(editUrl);
},
[application, history]
);
const { services: visualizeServices } = useOpenSearchDashboards<VisualizeServices>();
// This function takes a legacy visualization item as input and constructs the appropriate path.
// It then navigates to the VisBuilder app with the constructed path to migrate the legacy visualization.
const visbuilderEditItem = useCallback(
async (item) => {
const path = await constructVisBuilderPath(item, visualizeServices);
application.navigateToApp('vis-builder', { path });
},
[visualizeServices, application]
);
const noItemsFragment = useMemo(() => getNoItemsMessage(createNewVis), [createNewVis]);
const tableColumns = useMemo(() => getTableColumns(application, history, uiSettings), [
application,
history,
uiSettings,
]);
const fetchItems = useCallback(
(filter) => {
const isLabsEnabled = uiSettings.get(VISUALIZE_ENABLE_LABS_SETTING);
return savedVisualizations
.findListItems(filter, listingLimit)
.then(({ total, hits }: { total: number; hits: object[] }) => ({
total,
hits: hits.filter(
(result: any) =>
isLabsEnabled ||
(result.type?.stage !== 'experimental' && result.stage !== 'experimental')
),
}));
},
[listingLimit, savedVisualizations, uiSettings]
);
const deleteItems = useCallback(
async (selectedItems: object[]) => {
const uiActions = getUiActions();
await Promise.all(
selectedItems.map((item: any) =>
savedObjects.client
.delete(item.savedObjectType, item.id)
.then(() => {
/**
* TODO: this should be automatically handled by the saved objects plugin. Tracking issue:
* https://github.com/opensearch-project/OpenSearch-Dashboards/issues/4499
*/
uiActions
.getTrigger(SAVED_OBJECT_DELETE_TRIGGER)
.exec({ type: item.savedObjectType, savedObjectId: item.id });
})
.catch((error) => {
toastNotifications.addError(error, {
title: i18n.translate('visualize.visualizeListingDeleteErrorTitle', {
defaultMessage: 'Error deleting visualization',
}),
});
})
)
);
},
[savedObjects.client, toastNotifications]
);
return (
<>
{showUpdatedUx && (
<HeaderControl
setMountPoint={setAppRightControls}
controls={[
{
id: 'visualize.createVisualization',
label: 'Create visualization',
testId: 'createVisualizationButton',
run: createNewVis,
fill: true,
iconType: 'plus',
controlType: 'button',
},
]}
/>
)}
<TableListView
headingId="visualizeListingHeading"
// we allow users to create visualizations even if they can't save them
// for data exploration purposes
createItem={createNewVis}
findItems={fetchItems}
deleteItems={visualizeCapabilities.delete ? deleteItems : undefined}
editItem={visualizeCapabilities.save ? editItem : undefined}
visbuilderEditItem={visbuilderEditItem}
tableColumns={tableColumns}
listingLimit={listingLimit}
initialPageSize={savedObjectsPublic.settings.getPerPage()}
initialFilter={''}
noItemsFragment={noItemsFragment}
entityName={i18n.translate('visualize.listing.table.entityName', {
defaultMessage: 'visualization',
})}
entityNamePlural={i18n.translate('visualize.listing.table.entityNamePlural', {
defaultMessage: 'visualizations',
})}
tableListTitle={i18n.translate('visualize.listing.table.listTitle', {
defaultMessage: 'Visualizations',
})}
toastNotifications={toastNotifications}
showUpdatedUx={showUpdatedUx}
paddingSize={showUpdatedUx ? 'm' : 'l'}
/>
</>
);
};