963002358

pending completion

Build # 963002358

Build Type

Pull #3870

gitlab-ci

Committed by

mzedel

Commit Message

chore: cleaned up left over onboarding tooltips & aligned with updated design

Signed-off-by: Manuel Zedel <manuel.zedel@northern.tech>

Pull Request Pull Request #3870: MEN-5413

Run Details

4348 of 6319 branches covered (68.81%)

95 of 122 new or added lines in 24 files covered. (77.87%)

1734 existing lines in 160 files now uncovered.

8174 of 9951 relevant lines covered (82.14%)

178.12 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.81

/src/js/components/deployments/deployments.js

// Copyright 2015 Northern.tech AS
//
//    Licensed 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.

/* eslint-disable react-hooks/exhaustive-deps */
import React, { useCallback, useEffect, useRef, useState } from 'react';
import { useDispatch, useSelector } from 'react-redux';
import { Link, useNavigate } from 'react-router-dom';

import { Button, Tab, Tabs } from '@mui/material';

import { setSnackbar } from '../../actions/appActions';
import { abortDeployment, setDeploymentsState } from '../../actions/deploymentActions';
import { getDynamicGroups, getGroups } from '../../actions/deviceActions';
import { advanceOnboarding } from '../../actions/onboardingActions';
import { DEPLOYMENT_ROUTES, DEPLOYMENT_STATES, listDefaultsByState } from '../../constants/deploymentConstants';
import { ALL_DEVICES } from '../../constants/deviceConstants';
import { onboardingSteps } from '../../constants/onboardingConstants';
import { getISOStringBoundaries } from '../../helpers';
import { getDevicesById, getGroupsByIdWithoutUngrouped, getIsEnterprise, getOnboardingState, getReleasesById, getUserCapabilities } from '../../selectors';
import { useLocationParams } from '../../utils/liststatehook';
import { getOnboardingComponentFor } from '../../utils/onboardingmanager';
import useWindowSize from '../../utils/resizehook';
import CreateDeployment from './createdeployment';
import Progress from './inprogressdeployments';
import Past from './pastdeployments';
import Report from './report';
import Scheduled from './scheduleddeployments';

const routes = {
  [DEPLOYMENT_ROUTES.active.key]: {
    ...DEPLOYMENT_ROUTES.active,
    component: Progress
  },
  [DEPLOYMENT_ROUTES.scheduled.key]: {
    ...DEPLOYMENT_ROUTES.scheduled,
    component: Scheduled
  },
  [DEPLOYMENT_ROUTES.finished.key]: {
    ...DEPLOYMENT_ROUTES.finished,
    component: Past
  }
};

export const defaultRefreshDeploymentsLength = 30000;

export const Deployments = () => {
  const groupsById = useSelector(getGroupsByIdWithoutUngrouped);
  const devicesById = useSelector(getDevicesById);
  const isEnterprise = useSelector(getIsEnterprise);
  const onboardingState = useSelector(getOnboardingState);
  const pastCount = useSelector(state => state.deployments.byStatus.finished.total);
  const releases = useSelector(getReleasesById);
  const selectionState = useSelector(state => state.deployments.selectionState);
  const userCapabilities = useSelector(getUserCapabilities);
  const dispatch = useDispatch();

  const [deploymentObject, setDeploymentObject] = useState({});
  // eslint-disable-next-line no-unused-vars
  const size = useWindowSize();
  const tabsRef = useRef();
  const isInitialized = useRef(false);
  const navigate = useNavigate();
  const { reportType, showCreationDialog: createDialog, showReportDialog: reportDialog, state } = selectionState.general;
  const { canDeploy, canReadReleases } = userCapabilities;

  const [date] = useState(getISOStringBoundaries(new Date()));
  const { start: today, end: tonight } = date;

  const [locationParams, setLocationParams] = useLocationParams('deployments', { today, tonight, defaults: listDefaultsByState });

  useEffect(() => {
    if (!isInitialized.current) {
      return;
    }
    setLocationParams({ deploymentObject, pageState: selectionState });
  }, [
    JSON.stringify(deploymentObject),
    selectionState.selectedId,
    selectionState.general.state,
    selectionState.general.showCreationDialog,
    selectionState.general.showReportDialog,
    selectionState.general.reportType,
    selectionState[DEPLOYMENT_STATES.finished].endDate,
    selectionState[DEPLOYMENT_STATES.finished].search,
    selectionState[DEPLOYMENT_STATES.finished].startDate,
    selectionState[DEPLOYMENT_STATES.finished].page,
    selectionState[DEPLOYMENT_STATES.finished].perPage,
    selectionState[DEPLOYMENT_STATES.finished].type,
    selectionState[DEPLOYMENT_STATES.inprogress].page,
    selectionState[DEPLOYMENT_STATES.inprogress].perPage,
    selectionState[DEPLOYMENT_STATES.pending].page,
    selectionState[DEPLOYMENT_STATES.pending].perPage,
    setLocationParams
  ]);

  useEffect(() => {
    dispatch(getGroups());
    if (isEnterprise) {
      dispatch(getDynamicGroups());
    }
    const { deploymentObject = {}, id: selectedId = [], ...remainder } = locationParams;
    const { devices: selectedDevices = [], release: releaseName } = deploymentObject;
    const release = releaseName ? { ...(releases[releaseName] ?? { Name: releaseName }) } : undefined;
    const devices = selectedDevices.length ? selectedDevices.map(device => ({ ...device, ...devicesById[device.id] })) : [];
    setDeploymentObject({ devices, release, releaseSelectionLocked: !!release });
    dispatch(setDeploymentsState({ selectedId: selectedId[0], ...remainder }));
    isInitialized.current = true;
  }, [dispatch, isEnterprise]);

  const retryDeployment = (deployment, deploymentDeviceIds) => {
    const { artifact_name, name, update_control_map = {} } = deployment;
    const release = releases[artifact_name];
    const enterpriseSettings = isEnterprise
      ? {
          phases: [{ batch_size: 100, start_ts: undefined, delay: 0 }],
          update_control_map: { states: update_control_map.states || {} }
        }
      : {};
    const targetDevicesConfig = name === ALL_DEVICES || groupsById[name] ? { group: name } : { devices: [devicesById[name]] };
    const deploymentObject = {
      deploymentDeviceIds,
      release,
      deploymentDeviceCount: deploymentDeviceIds.length,
      ...targetDevicesConfig,
      ...enterpriseSettings
    };
    setDeploymentObject(deploymentObject);
    dispatch(setDeploymentsState({ general: { showCreationDialog: true, showReportDialog: false } }));
  };

  const onScheduleSubmit = () => {
    dispatch(setDeploymentsState({ general: { showCreationDialog: false, showReportDialog: false } }));
    setDeploymentObject({});
    // successfully retrieved new deployment
    if (routes.active.key !== state) {
      navigate(routes.active.route);
      changeTab(undefined, routes.active.key);
    }
  };

  const onAbortDeployment = id =>
    dispatch(abortDeployment(id)).then(() => {
      dispatch(setDeploymentsState({ general: { showCreationDialog: false, showReportDialog: false } }));
      return Promise.resolve();
    });

  const changeTab = (_, tabIndex) => {
    dispatch(setDeploymentsState({ general: { state: tabIndex } }));
    dispatch(setSnackbar(''));
    if (pastCount && !onboardingState.complete) {
      dispatch(advanceOnboarding(onboardingSteps.DEPLOYMENTS_PAST));
    }
  };

  const showReport = (reportType, selectedId) => {
    if (!onboardingState.complete) {
      dispatch(advanceOnboarding(onboardingSteps.DEPLOYMENTS_INPROGRESS));
    }
    dispatch(setDeploymentsState({ general: { reportType, showCreationDialog: false, showReportDialog: true }, selectedId }));
  };

  const closeReport = () => dispatch(setDeploymentsState({ general: { reportType: undefined, showReportDialog: false }, selectedId: undefined }));

  const onCreationDismiss = () => {
    dispatch(setDeploymentsState({ general: { showCreationDialog: false } }));
    setDeploymentObject({});
  };

  const onCreationShow = () => dispatch(setDeploymentsState({ general: { showCreationDialog: true } }));

  const setDeploymentSettings = useCallback(change => setDeploymentObject(current => ({ ...current, ...change })), []);

  let onboardingComponent = null;
  // the pastCount prop is needed to trigger the rerender as the change in past deployments would otherwise not be noticed on this view
  if (pastCount && tabsRef.current && !reportDialog) {
    const tabs = tabsRef.current.getElementsByClassName('MuiTab-root');
    const finishedTab = tabs[tabs.length - 1];
    onboardingComponent = getOnboardingComponentFor(onboardingSteps.DEPLOYMENTS_PAST, onboardingState, {
      anchor: {
        left: tabsRef.current.offsetLeft + tabsRef.current.offsetWidth - finishedTab.offsetWidth / 2,
        top: tabsRef.current.parentElement.offsetTop + finishedTab.offsetHeight
      }
    });
  }

  const ComponentToShow = routes[state].component;
  return (
    <>
      <div className="margin-left-small margin-top" style={{ maxWidth: '80vw' }}>
        <div className="flexbox space-between">
          <Tabs value={state} onChange={changeTab} ref={tabsRef}>
            {Object.values(routes).map(route => (
              <Tab component={Link} key={route.route} label={route.title} to={route.route} value={route.key} />
            ))}
          </Tabs>
          {canDeploy && canReadReleases && (
            <Button color="secondary" variant="contained" onClick={onCreationShow} style={{ height: '100%' }}>
              Create a deployment
            </Button>
          )}
        </div>
        <ComponentToShow abort={onAbortDeployment} createClick={onCreationShow} openReport={showReport} isShowingDetails={reportDialog} />
      </div>
      <Report abort={onAbortDeployment} onClose={closeReport} open={reportDialog} retry={retryDeployment} type={reportType} />
      <CreateDeployment
        open={createDialog}
        onDismiss={onCreationDismiss}
        deploymentObject={deploymentObject}
        onScheduleSubmit={onScheduleSubmit}
        setDeploymentSettings={setDeploymentSettings}
      />
      {!reportDialog && onboardingComponent}
    </>
  );
};

export default Deployments;

1	// Copyright 2015 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14
15	/* eslint-disable react-hooks/exhaustive-deps */
16	import React, { useCallback, useEffect, useRef, useState } from 'react';
17	import { useDispatch, useSelector } from 'react-redux';
18	import { Link, useNavigate } from 'react-router-dom';
19
20	import { Button, Tab, Tabs } from '@mui/material';
21
22	import { setSnackbar } from '../../actions/appActions';
23	import { abortDeployment, setDeploymentsState } from '../../actions/deploymentActions';
24	import { getDynamicGroups, getGroups } from '../../actions/deviceActions';
25	import { advanceOnboarding } from '../../actions/onboardingActions';
26	import { DEPLOYMENT_ROUTES, DEPLOYMENT_STATES, listDefaultsByState } from '../../constants/deploymentConstants';
27	import { ALL_DEVICES } from '../../constants/deviceConstants';
28	import { onboardingSteps } from '../../constants/onboardingConstants';
29	import { getISOStringBoundaries } from '../../helpers';
30	import { getDevicesById, getGroupsByIdWithoutUngrouped, getIsEnterprise, getOnboardingState, getReleasesById, getUserCapabilities } from '../../selectors';
31	import { useLocationParams } from '../../utils/liststatehook';
32	import { getOnboardingComponentFor } from '../../utils/onboardingmanager';
33	import useWindowSize from '../../utils/resizehook';
34	import CreateDeployment from './createdeployment';
35	import Progress from './inprogressdeployments';
36	import Past from './pastdeployments';
37	import Report from './report';
38	import Scheduled from './scheduleddeployments';
39
40	const routes = {	7✔
41	[DEPLOYMENT_ROUTES.active.key]: {
42	...DEPLOYMENT_ROUTES.active,
43	component: Progress
44	},
45	[DEPLOYMENT_ROUTES.scheduled.key]: {
46	...DEPLOYMENT_ROUTES.scheduled,
47	component: Scheduled
48	},
49	[DEPLOYMENT_ROUTES.finished.key]: {
50	...DEPLOYMENT_ROUTES.finished,
51	component: Past
52	}
53	};
54
55	export const defaultRefreshDeploymentsLength = 30000;	7✔
56
57	export const Deployments = () => {	7✔
58	const groupsById = useSelector(getGroupsByIdWithoutUngrouped);	226✔
59	const devicesById = useSelector(getDevicesById);	225✔
60	const isEnterprise = useSelector(getIsEnterprise);	225✔
61	const onboardingState = useSelector(getOnboardingState);	225✔
62	const pastCount = useSelector(state => state.deployments.byStatus.finished.total);	527✔
63	const releases = useSelector(getReleasesById);	225✔
64	const selectionState = useSelector(state => state.deployments.selectionState);	527✔
65	const userCapabilities = useSelector(getUserCapabilities);	225✔
66	const dispatch = useDispatch();	225✔
67
68	const [deploymentObject, setDeploymentObject] = useState({});	225✔
69	// eslint-disable-next-line no-unused-vars
70	const size = useWindowSize();	225✔
71	const tabsRef = useRef();	225✔
72	const isInitialized = useRef(false);	225✔
73	const navigate = useNavigate();	225✔
74	const { reportType, showCreationDialog: createDialog, showReportDialog: reportDialog, state } = selectionState.general;	225✔
75	const { canDeploy, canReadReleases } = userCapabilities;	225✔
76
77	const [date] = useState(getISOStringBoundaries(new Date()));	225✔
78	const { start: today, end: tonight } = date;	225✔
79
80	const [locationParams, setLocationParams] = useLocationParams('deployments', { today, tonight, defaults: listDefaultsByState });	225✔
81
82	useEffect(() => {	225✔
83	if (!isInitialized.current) {	74✔
84	return;	5✔
85	}
86	setLocationParams({ deploymentObject, pageState: selectionState });	69✔
87	}, [
88	JSON.stringify(deploymentObject),
89	selectionState.selectedId,
90	selectionState.general.state,
91	selectionState.general.showCreationDialog,
92	selectionState.general.showReportDialog,
93	selectionState.general.reportType,
94	selectionState[DEPLOYMENT_STATES.finished].endDate,
95	selectionState[DEPLOYMENT_STATES.finished].search,
96	selectionState[DEPLOYMENT_STATES.finished].startDate,
97	selectionState[DEPLOYMENT_STATES.finished].page,
98	selectionState[DEPLOYMENT_STATES.finished].perPage,
99	selectionState[DEPLOYMENT_STATES.finished].type,
100	selectionState[DEPLOYMENT_STATES.inprogress].page,
101	selectionState[DEPLOYMENT_STATES.inprogress].perPage,
102	selectionState[DEPLOYMENT_STATES.pending].page,
103	selectionState[DEPLOYMENT_STATES.pending].perPage,
104	setLocationParams
105	]);
106
107	useEffect(() => {	225✔
108	dispatch(getGroups());	5✔
109	if (isEnterprise) {	5✔
110	dispatch(getDynamicGroups());	2✔
111	}
112	const { deploymentObject = {}, id: selectedId = [], ...remainder } = locationParams;	5!
113	const { devices: selectedDevices = [], release: releaseName } = deploymentObject;	5✔
114	const release = releaseName ? { ...(releases[releaseName] ?? { Name: releaseName }) } : undefined;	5!
115	const devices = selectedDevices.length ? selectedDevices.map(device => ({ ...device, ...devicesById[device.id] })) : [];	5!
116	setDeploymentObject({ devices, release, releaseSelectionLocked: !!release });	5✔
117	dispatch(setDeploymentsState({ selectedId: selectedId[0], ...remainder }));	5✔
118	isInitialized.current = true;	5✔
119	}, [dispatch, isEnterprise]);
120
121	const retryDeployment = (deployment, deploymentDeviceIds) => {	225✔
UNCOV 122	const { artifact_name, name, update_control_map = {} } = deployment;	×
UNCOV 123	const release = releases[artifact_name];	×
UNCOV 124	const enterpriseSettings = isEnterprise	×
125	? {
126	phases: [{ batch_size: 100, start_ts: undefined, delay: 0 }],
127	update_control_map: { states: update_control_map.states \|\| {} }	×
128	}
129	: {};
UNCOV 130	const targetDevicesConfig = name === ALL_DEVICES \|\| groupsById[name] ? { group: name } : { devices: [devicesById[name]] };	×
UNCOV 131	const deploymentObject = {	×
132	deploymentDeviceIds,
133	release,
134	deploymentDeviceCount: deploymentDeviceIds.length,
135	...targetDevicesConfig,
136	...enterpriseSettings
137	};
UNCOV 138	setDeploymentObject(deploymentObject);	×
UNCOV 139	dispatch(setDeploymentsState({ general: { showCreationDialog: true, showReportDialog: false } }));	×
140	};
141
142	const onScheduleSubmit = () => {	225✔
143	dispatch(setDeploymentsState({ general: { showCreationDialog: false, showReportDialog: false } }));	2✔
144	setDeploymentObject({});	2✔
145	// successfully retrieved new deployment
146	if (routes.active.key !== state) {	2✔
147	navigate(routes.active.route);	1✔
148	changeTab(undefined, routes.active.key);	1✔
149	}
150	};
151
152	const onAbortDeployment = id =>	225✔
UNCOV 153	dispatch(abortDeployment(id)).then(() => {	×
UNCOV 154	dispatch(setDeploymentsState({ general: { showCreationDialog: false, showReportDialog: false } }));	×
UNCOV 155	return Promise.resolve();	×
156	});
157
158	const changeTab = (_, tabIndex) => {	225✔
159	dispatch(setDeploymentsState({ general: { state: tabIndex } }));	5✔
160	dispatch(setSnackbar(''));	5✔
161	if (pastCount && !onboardingState.complete) {	5✔
162	dispatch(advanceOnboarding(onboardingSteps.DEPLOYMENTS_PAST));	1✔
163	}
164	};
165
166	const showReport = (reportType, selectedId) => {	225✔
167	if (!onboardingState.complete) {	1!
168	dispatch(advanceOnboarding(onboardingSteps.DEPLOYMENTS_INPROGRESS));	1✔
169	}
170	dispatch(setDeploymentsState({ general: { reportType, showCreationDialog: false, showReportDialog: true }, selectedId }));	1✔
171	};
172
173	const closeReport = () => dispatch(setDeploymentsState({ general: { reportType: undefined, showReportDialog: false }, selectedId: undefined }));	225✔
174
175	const onCreationDismiss = () => {	225✔
176	dispatch(setDeploymentsState({ general: { showCreationDialog: false } }));	1✔
177	setDeploymentObject({});	1✔
178	};
179
180	const onCreationShow = () => dispatch(setDeploymentsState({ general: { showCreationDialog: true } }));	225✔
181
182	const setDeploymentSettings = useCallback(change => setDeploymentObject(current => ({ ...current, ...change })), []);	225✔
183
184	let onboardingComponent = null;	225✔
185	// the pastCount prop is needed to trigger the rerender as the change in past deployments would otherwise not be noticed on this view
186	if (pastCount && tabsRef.current && !reportDialog) {	225✔
187	const tabs = tabsRef.current.getElementsByClassName('MuiTab-root');	180✔
188	const finishedTab = tabs[tabs.length - 1];	180✔
189	onboardingComponent = getOnboardingComponentFor(onboardingSteps.DEPLOYMENTS_PAST, onboardingState, {	180✔
190	anchor: {
191	left: tabsRef.current.offsetLeft + tabsRef.current.offsetWidth - finishedTab.offsetWidth / 2,
192	top: tabsRef.current.parentElement.offsetTop + finishedTab.offsetHeight
193	}
194	});
195	}
196
197	const ComponentToShow = routes[state].component;	225✔
198	return (	225✔
199	<>
200	<div className="margin-left-small margin-top" style={{ maxWidth: '80vw' }}>
201	<div className="flexbox space-between">
202	<Tabs value={state} onChange={changeTab} ref={tabsRef}>
203	{Object.values(routes).map(route => (
204	<Tab component={Link} key={route.route} label={route.title} to={route.route} value={route.key} />	675✔
205	))}
206	</Tabs>
207	{canDeploy && canReadReleases && (	675✔
208	<Button color="secondary" variant="contained" onClick={onCreationShow} style={{ height: '100%' }}>
209	Create a deployment
210	</Button>
211	)}
212	</div>
213	<ComponentToShow abort={onAbortDeployment} createClick={onCreationShow} openReport={showReport} isShowingDetails={reportDialog} />
214	</div>
215	<Report abort={onAbortDeployment} onClose={closeReport} open={reportDialog} retry={retryDeployment} type={reportType} />
216	<CreateDeployment
217	open={createDialog}
218	onDismiss={onCreationDismiss}
219	deploymentObject={deploymentObject}
220	onScheduleSubmit={onScheduleSubmit}
221	setDeploymentSettings={setDeploymentSettings}
222	/>
223	{!reportDialog && onboardingComponent}	447✔
224	</>
225	);
226	};
227
228	export default Deployments;

mendersoftware / gui / 963002358

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous