20251: Fix flaky collection file browser by using race-free state update callback
[arvados-workbench2.git] / src / views / workbench / workbench.tsx
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 import React from 'react';
6 import { StyleRulesCallback, WithStyles, withStyles } from '@material-ui/core/styles';
7 import { Route, Switch } from "react-router";
8 import { ProjectPanel } from "views/project-panel/project-panel";
9 import { DetailsPanel } from 'views-components/details-panel/details-panel';
10 import { ArvadosTheme } from 'common/custom-theme';
11 import { ContextMenu } from "views-components/context-menu/context-menu";
12 import { FavoritePanel } from "../favorite-panel/favorite-panel";
13 import { TokenDialog } from 'views-components/token-dialog/token-dialog';
14 import { RichTextEditorDialog } from 'views-components/rich-text-editor-dialog/rich-text-editor-dialog';
15 import { Snackbar } from 'views-components/snackbar/snackbar';
16 import { CollectionPanel } from '../collection-panel/collection-panel';
17 import { RenameFileDialog } from 'views-components/rename-file-dialog/rename-file-dialog';
18 import { FileRemoveDialog } from 'views-components/file-remove-dialog/file-remove-dialog';
19 import { MultipleFilesRemoveDialog } from 'views-components/file-remove-dialog/multiple-files-remove-dialog';
20 import { Routes } from 'routes/routes';
21 import { SidePanel } from 'views-components/side-panel/side-panel';
22 import { ProcessPanel } from 'views/process-panel/process-panel';
23 import { ChangeWorkflowDialog } from 'views-components/run-process-dialog/change-workflow-dialog';
24 import { CreateProjectDialog } from 'views-components/dialog-forms/create-project-dialog';
25 import { CreateCollectionDialog } from 'views-components/dialog-forms/create-collection-dialog';
26 import { CopyCollectionDialog } from 'views-components/dialog-forms/copy-collection-dialog';
27 import { CopyProcessDialog } from 'views-components/dialog-forms/copy-process-dialog';
28 import { UpdateCollectionDialog } from 'views-components/dialog-forms/update-collection-dialog';
29 import { UpdateProcessDialog } from 'views-components/dialog-forms/update-process-dialog';
30 import { UpdateProjectDialog } from 'views-components/dialog-forms/update-project-dialog';
31 import { MoveProcessDialog } from 'views-components/dialog-forms/move-process-dialog';
32 import { MoveProjectDialog } from 'views-components/dialog-forms/move-project-dialog';
33 import { MoveCollectionDialog } from 'views-components/dialog-forms/move-collection-dialog';
34 import { FilesUploadCollectionDialog } from 'views-components/dialog-forms/files-upload-collection-dialog';
35 import { PartialCopyCollectionDialog } from 'views-components/dialog-forms/partial-copy-collection-dialog';
36 import { RemoveProcessDialog } from 'views-components/process-remove-dialog/process-remove-dialog';
37 import { MainContentBar } from 'views-components/main-content-bar/main-content-bar';
38 import { Grid } from '@material-ui/core';
39 import { TrashPanel } from "views/trash-panel/trash-panel";
40 import { SharedWithMePanel } from 'views/shared-with-me-panel/shared-with-me-panel';
41 import { RunProcessPanel } from 'views/run-process-panel/run-process-panel';
42 import SplitterLayout from 'react-splitter-layout';
43 import { WorkflowPanel } from 'views/workflow-panel/workflow-panel';
44 import { SearchResultsPanel } from 'views/search-results-panel/search-results-panel';
45 import { SshKeyPanel } from 'views/ssh-key-panel/ssh-key-panel';
46 import { SshKeyAdminPanel } from 'views/ssh-key-panel/ssh-key-admin-panel';
47 import { SiteManagerPanel } from "views/site-manager-panel/site-manager-panel";
48 import { UserProfilePanel } from 'views/user-profile-panel/user-profile-panel';
49 import { SharingDialog } from 'views-components/sharing-dialog/sharing-dialog';
50 import { NotFoundDialog } from 'views-components/not-found-dialog/not-found-dialog';
51 import { AdvancedTabDialog } from 'views-components/advanced-tab-dialog/advanced-tab-dialog';
52 import { ProcessInputDialog } from 'views-components/process-input-dialog/process-input-dialog';
53 import { VirtualMachineUserPanel } from 'views/virtual-machine-panel/virtual-machine-user-panel';
54 import { VirtualMachineAdminPanel } from 'views/virtual-machine-panel/virtual-machine-admin-panel';
55 import { RepositoriesPanel } from 'views/repositories-panel/repositories-panel';
56 import { KeepServicePanel } from 'views/keep-service-panel/keep-service-panel';
57 import { ApiClientAuthorizationPanel } from 'views/api-client-authorization-panel/api-client-authorization-panel';
58 import { LinkPanel } from 'views/link-panel/link-panel';
59 import { RepositoriesSampleGitDialog } from 'views-components/repositories-sample-git-dialog/repositories-sample-git-dialog';
60 import { RepositoryAttributesDialog } from 'views-components/repository-attributes-dialog/repository-attributes-dialog';
61 import { CreateRepositoryDialog } from 'views-components/dialog-forms/create-repository-dialog';
62 import { RemoveRepositoryDialog } from 'views-components/repository-remove-dialog/repository-remove-dialog';
63 import { CreateSshKeyDialog } from 'views-components/dialog-forms/create-ssh-key-dialog';
64 import { PublicKeyDialog } from 'views-components/ssh-keys-dialog/public-key-dialog';
65 import { RemoveApiClientAuthorizationDialog } from 'views-components/api-client-authorizations-dialog/remove-dialog';
66 import { RemoveKeepServiceDialog } from 'views-components/keep-services-dialog/remove-dialog';
67 import { RemoveLinkDialog } from 'views-components/links-dialog/remove-dialog';
68 import { RemoveSshKeyDialog } from 'views-components/ssh-keys-dialog/remove-dialog';
69 import { VirtualMachineAttributesDialog } from 'views-components/virtual-machines-dialog/attributes-dialog';
70 import { RemoveVirtualMachineDialog } from 'views-components/virtual-machines-dialog/remove-dialog';
71 import { RemoveVirtualMachineLoginDialog } from 'views-components/virtual-machines-dialog/remove-login-dialog';
72 import { VirtualMachineAddLoginDialog } from 'views-components/virtual-machines-dialog/add-login-dialog';
73 import { AttributesApiClientAuthorizationDialog } from 'views-components/api-client-authorizations-dialog/attributes-dialog';
74 import { AttributesKeepServiceDialog } from 'views-components/keep-services-dialog/attributes-dialog';
75 import { AttributesLinkDialog } from 'views-components/links-dialog/attributes-dialog';
76 import { AttributesSshKeyDialog } from 'views-components/ssh-keys-dialog/attributes-dialog';
77 import { UserPanel } from 'views/user-panel/user-panel';
78 import { UserAttributesDialog } from 'views-components/user-dialog/attributes-dialog';
79 import { CreateUserDialog } from 'views-components/dialog-forms/create-user-dialog';
80 import { HelpApiClientAuthorizationDialog } from 'views-components/api-client-authorizations-dialog/help-dialog';
81 import { DeactivateDialog } from 'views-components/user-dialog/deactivate-dialog';
82 import { ActivateDialog } from 'views-components/user-dialog/activate-dialog';
83 import { SetupDialog } from 'views-components/user-dialog/setup-dialog';
84 import { GroupsPanel } from 'views/groups-panel/groups-panel';
85 import { RemoveGroupDialog } from 'views-components/groups-dialog/remove-dialog';
86 import { GroupAttributesDialog } from 'views-components/groups-dialog/attributes-dialog';
87 import { GroupDetailsPanel } from 'views/group-details-panel/group-details-panel';
88 import { RemoveGroupMemberDialog } from 'views-components/groups-dialog/member-remove-dialog';
89 import { GroupMemberAttributesDialog } from 'views-components/groups-dialog/member-attributes-dialog';
90 import { PartialCopyToCollectionDialog } from 'views-components/dialog-forms/partial-copy-to-collection-dialog';
91 import { PublicFavoritePanel } from 'views/public-favorites-panel/public-favorites-panel';
92 import { LinkAccountPanel } from 'views/link-account-panel/link-account-panel';
93 import { FedLogin } from './fed-login';
94 import { CollectionsContentAddressPanel } from 'views/collection-content-address-panel/collection-content-address-panel';
95 import { AllProcessesPanel } from '../all-processes-panel/all-processes-panel';
96 import { NotFoundPanel } from '../not-found-panel/not-found-panel';
97 import { AutoLogout } from 'views-components/auto-logout/auto-logout';
98 import { RestoreCollectionVersionDialog } from 'views-components/collections-dialog/restore-version-dialog';
99 import { WebDavS3InfoDialog } from 'views-components/webdav-s3-dialog/webdav-s3-dialog';
100 import { pluginConfig } from 'plugins';
101 import { ElementListReducer } from 'common/plugintypes';
102 import { COLLAPSE_ICON_SIZE } from 'views-components/side-panel-toggle/side-panel-toggle'
103 import { Banner } from 'views-components/baner/banner';
104
105 type CssRules = 'root' | 'container' | 'splitter' | 'asidePanel' | 'contentWrapper' | 'content';
106
107 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
108     root: {
109         paddingTop: theme.spacing.unit * 7,
110         background: theme.palette.background.default
111     },
112     container: {
113         position: 'relative'
114     },
115     splitter: {
116         '& > .layout-splitter': {
117             width: '2px',
118         },
119         '& > .layout-splitter-disabled': {
120             pointerEvents: 'none',
121             cursor: 'pointer'
122         }
123     },
124     asidePanel: {
125         paddingTop: theme.spacing.unit,
126         height: '100%'
127     },
128     contentWrapper: {
129         paddingTop: theme.spacing.unit,
130         minWidth: 0
131     },
132     content: {
133         minWidth: 0,
134         paddingLeft: theme.spacing.unit * 3,
135         paddingRight: theme.spacing.unit * 3,
136         // Reserve vertical space for app bar + MainContentBar
137         minHeight: `calc(100vh - ${theme.spacing.unit * 16}px)`,
138         display: 'flex',
139     }
140 });
141
142 interface WorkbenchDataProps {
143     isUserActive: boolean;
144     isNotLinking: boolean;
145     sessionIdleTimeout: number;
146     sidePanelIsCollapsed: boolean;
147 }
148
149 type WorkbenchPanelProps = WithStyles<CssRules> & WorkbenchDataProps;
150
151 const defaultSplitterSize = 90;
152
153 const getSplitterInitialSize = () => {
154     const splitterSize = localStorage.getItem('splitterSize');
155     return splitterSize ? Number(splitterSize) : defaultSplitterSize;
156 };
157
158 const saveSplitterSize = (size: number) => localStorage.setItem('splitterSize', size.toString());
159
160 let routes = <>
161     <Route path={Routes.PROJECTS} component={ProjectPanel} />
162     <Route path={Routes.COLLECTIONS} component={CollectionPanel} />
163     <Route path={Routes.FAVORITES} component={FavoritePanel} />
164     <Route path={Routes.ALL_PROCESSES} component={AllProcessesPanel} />
165     <Route path={Routes.PROCESSES} component={ProcessPanel} />
166     <Route path={Routes.TRASH} component={TrashPanel} />
167     <Route path={Routes.SHARED_WITH_ME} component={SharedWithMePanel} />
168     <Route path={Routes.RUN_PROCESS} component={RunProcessPanel} />
169     <Route path={Routes.WORKFLOWS} component={WorkflowPanel} />
170     <Route path={Routes.SEARCH_RESULTS} component={SearchResultsPanel} />
171     <Route path={Routes.VIRTUAL_MACHINES_USER} component={VirtualMachineUserPanel} />
172     <Route path={Routes.VIRTUAL_MACHINES_ADMIN} component={VirtualMachineAdminPanel} />
173     <Route path={Routes.REPOSITORIES} component={RepositoriesPanel} />
174     <Route path={Routes.SSH_KEYS_USER} component={SshKeyPanel} />
175     <Route path={Routes.SSH_KEYS_ADMIN} component={SshKeyAdminPanel} />
176     <Route path={Routes.SITE_MANAGER} component={SiteManagerPanel} />
177     <Route path={Routes.KEEP_SERVICES} component={KeepServicePanel} />
178     <Route path={Routes.USERS} component={UserPanel} />
179     <Route path={Routes.API_CLIENT_AUTHORIZATIONS} component={ApiClientAuthorizationPanel} />
180     <Route path={Routes.MY_ACCOUNT} component={UserProfilePanel} />
181     <Route path={Routes.USER_PROFILE} component={UserProfilePanel} />
182     <Route path={Routes.GROUPS} component={GroupsPanel} />
183     <Route path={Routes.GROUP_DETAILS} component={GroupDetailsPanel} />
184     <Route path={Routes.LINKS} component={LinkPanel} />
185     <Route path={Routes.PUBLIC_FAVORITES} component={PublicFavoritePanel} />
186     <Route path={Routes.LINK_ACCOUNT} component={LinkAccountPanel} />
187     <Route path={Routes.COLLECTIONS_CONTENT_ADDRESS} component={CollectionsContentAddressPanel} />
188 </>;
189
190 const reduceRoutesFn: (a: React.ReactElement[],
191     b: ElementListReducer) => React.ReactElement[] = (a, b) => b(a);
192
193 routes = React.createElement(React.Fragment, null, pluginConfig.centerPanelList.reduce(reduceRoutesFn, React.Children.toArray(routes.props.children)));
194
195 const applyCollapsedState = (isCollapsed) => {
196     const rightPanel: Element = document.getElementsByClassName('layout-pane')[1]
197     const totalWidth: number = document.getElementsByClassName('splitter-layout')[0]?.clientWidth
198     const rightPanelExpandedWidth = ((totalWidth-COLLAPSE_ICON_SIZE)) / (totalWidth/100) 
199     if(rightPanel) {
200         rightPanel.setAttribute('style', `width: ${isCollapsed ? rightPanelExpandedWidth : getSplitterInitialSize()}%`)
201     }
202     const splitter = document.getElementsByClassName('layout-splitter')[0]
203     isCollapsed ? splitter?.classList.add('layout-splitter-disabled') : splitter?.classList.remove('layout-splitter-disabled')
204     
205 }
206
207 export const WorkbenchPanel =
208     withStyles(styles)((props: WorkbenchPanelProps) =>{
209
210         //panel size will not scale automatically on window resize, so we do it manually
211         window.addEventListener('resize', ()=>applyCollapsedState(props.sidePanelIsCollapsed))
212         applyCollapsedState(props.sidePanelIsCollapsed)
213         
214         return <Grid container item xs className={props.classes.root}>
215             {props.sessionIdleTimeout > 0 && <AutoLogout />}
216             <Grid container item xs className={props.classes.container}>
217                 <SplitterLayout customClassName={props.classes.splitter} percentage={true}
218                     primaryIndex={0} primaryMinSize={10}
219                     secondaryInitialSize={getSplitterInitialSize()} secondaryMinSize={40}
220                     onSecondaryPaneSizeChange={saveSplitterSize}>
221                     {props.isUserActive && props.isNotLinking && <Grid container item xs component='aside' direction='column' className={props.classes.asidePanel}>
222                         <SidePanel />
223                     </Grid>}
224                     <Grid container item xs component="main" direction="column" className={props.classes.contentWrapper}>
225                         <Grid item xs>
226                             {props.isNotLinking && <MainContentBar />}
227                         </Grid>
228                         <Grid item xs className={props.classes.content}>
229                             <Switch>
230                                 {routes.props.children}
231                                 <Route path={Routes.NO_MATCH} component={NotFoundPanel} />
232                             </Switch>
233                         </Grid>
234                     </Grid>
235                 </SplitterLayout>
236             </Grid>
237             <Grid item>
238                 <DetailsPanel />
239             </Grid>
240             <AdvancedTabDialog />
241             <AttributesApiClientAuthorizationDialog />
242             <AttributesKeepServiceDialog />
243             <AttributesLinkDialog />
244             <AttributesSshKeyDialog />
245             <ChangeWorkflowDialog />
246             <ContextMenu />
247             <CopyCollectionDialog />
248             <CopyProcessDialog />
249             <CreateCollectionDialog />
250             <CreateProjectDialog />
251             <CreateRepositoryDialog />
252             <CreateSshKeyDialog />
253             <CreateUserDialog />
254             <TokenDialog />
255             <FileRemoveDialog />
256             <FilesUploadCollectionDialog />
257             <GroupAttributesDialog />
258             <GroupMemberAttributesDialog />
259             <HelpApiClientAuthorizationDialog />
260             <MoveCollectionDialog />
261             <MoveProcessDialog />
262             <MoveProjectDialog />
263             <MultipleFilesRemoveDialog />
264             <PublicKeyDialog />
265             <PartialCopyCollectionDialog />
266             <PartialCopyToCollectionDialog />
267             <ProcessInputDialog />
268             <RestoreCollectionVersionDialog />
269             <RemoveApiClientAuthorizationDialog />
270             <RemoveGroupDialog />
271             <RemoveGroupMemberDialog />
272             <RemoveKeepServiceDialog />
273             <RemoveLinkDialog />
274             <RemoveProcessDialog />
275             <RemoveRepositoryDialog />
276             <RemoveSshKeyDialog />
277             <RemoveVirtualMachineDialog />
278             <RemoveVirtualMachineLoginDialog />
279             <VirtualMachineAddLoginDialog />
280             <RenameFileDialog />
281             <RepositoryAttributesDialog />
282             <RepositoriesSampleGitDialog />
283             <RichTextEditorDialog />
284             <SharingDialog />
285             <NotFoundDialog />
286             <Snackbar />
287             <UpdateCollectionDialog />
288             <UpdateProcessDialog />
289             <UpdateProjectDialog />
290             <UserAttributesDialog />
291             <DeactivateDialog />
292             <ActivateDialog />
293             <SetupDialog />
294             <VirtualMachineAttributesDialog />
295             <FedLogin />
296             <WebDavS3InfoDialog />
297             <Banner />
298             {React.createElement(React.Fragment, null, pluginConfig.dialogs)}
299         </Grid>}
300     );