• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

mendersoftware / gui / 1273353274

30 Apr 2024 12:32PM UTC coverage: 83.381%. First build
1273353274

Pull #4378

gitlab-ci

aleksandrychev
test: fixed allows role creation for static groups e2e test

Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
Pull Request #4378: feat: added two-step login for enterprise users

4462 of 6369 branches covered (70.06%)

25 of 32 new or added lines in 5 files covered. (78.13%)

8464 of 10151 relevant lines covered (83.38%)

140.59 hits per line

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

88.48
/src/js/actions/userActions.js
1
'use strict';
2

3
// Copyright 2019 Northern.tech AS
4
//
5
//    Licensed under the Apache License, Version 2.0 (the "License");
6
//    you may not use this file except in compliance with the License.
7
//    You may obtain a copy of the License at
8
//
9
//        http://www.apache.org/licenses/LICENSE-2.0
10
//
11
//    Unless required by applicable law or agreed to in writing, software
12
//    distributed under the License is distributed on an "AS IS" BASIS,
13
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
//    See the License for the specific language governing permissions and
15
//    limitations under the License.
16
import hashString from 'md5';
17
import Cookies from 'universal-cookie';
18

19
import GeneralApi, { apiRoot } from '../api/general-api';
20
import UsersApi from '../api/users-api';
21
import { cleanUp, maxSessionAge, setSessionInfo } from '../auth';
22
import { HELPTOOLTIPS } from '../components/helptips/helptooltips';
23
import { getSsoStartUrlById } from '../components/settings/organization/ssoconfig.js';
24
import * as AppConstants from '../constants/appConstants';
25
import { APPLICATION_JSON_CONTENT_TYPE, APPLICATION_JWT_CONTENT_TYPE } from '../constants/appConstants';
26
import { ALL_RELEASES } from '../constants/releaseConstants.js';
27
import * as UserConstants from '../constants/userConstants';
28
import { duplicateFilter, extractErrorMessage, isEmpty, preformatWithRequestID } from '../helpers';
29
import { getCurrentUser, getOnboardingState, getTooltipsState, getUserSettings as getUserSettingsSelector } from '../selectors';
30
import { clearAllRetryTimers } from '../utils/retrytimer';
31
import { commonErrorFallback, commonErrorHandler, initializeAppData, setOfflineThreshold, setSnackbar } from './appActions';
32

33
const cookies = new Cookies();
184✔
34
const {
35
  defaultPermissionSets,
36
  emptyRole,
37
  emptyUiPermissions,
38
  itemUiPermissionsReducer,
39
  OWN_USER_ID,
40
  PermissionTypes,
41
  rolesById: defaultRolesById,
42
  scopedPermissionAreas,
43
  twoFAStates,
44
  uiPermissionsByArea,
45
  uiPermissionsById,
46
  useradmApiUrl,
47
  useradmApiUrlv2
48
} = UserConstants;
184✔
49

50
const handleLoginError =
51
  (err, { token2fa: has2FA, password }) =>
184✔
52
  dispatch => {
1✔
53
    const errorText = extractErrorMessage(err);
1✔
54
    const is2FABackend = errorText.includes('2fa');
1✔
55
    if (is2FABackend && !has2FA) {
1!
56
      return Promise.reject({ error: '2fa code missing' });
1✔
57
    }
NEW
58
    if (password === undefined) {
×
59
      // Enterprise supports two-steps login. On the first step you can enter only email
60
      // and in case of SSO set up you will receive a redirect URL
61
      // otherwise you will receive 401 status code and password field will be shown.
NEW
62
      return Promise.reject();
×
63
    }
NEW
64
    const twoFAError = is2FABackend ? ' and verification code' : '';
×
NEW
65
    const errorMessage = `There was a problem logging in. Please check your email${
×
66
      twoFAError ? ',' : ' and'
×
67
    } password${twoFAError}. If you still have problems, contact an administrator.`;
NEW
68
    return Promise.reject(dispatch(setSnackbar(preformatWithRequestID(err.response, errorMessage), null, 'Copy to clipboard')));
×
69
  };
70

71
/*
72
  User management
73
*/
74
export const loginUser = (userData, stayLoggedIn) => dispatch =>
184✔
75
  UsersApi.postLogin(`${useradmApiUrl}/auth/login`, { ...userData, no_expiry: stayLoggedIn })
5✔
76
    .catch(err => {
77
      cleanUp();
1✔
78
      return Promise.resolve(dispatch(handleLoginError(err, userData)));
1✔
79
    })
80
    .then(({ text: response, contentType }) => {
81
      // If the content type is application/json then backend returned SSO configuration.
82
      // user should be redirected to the start sso url to finish login process.
83
      if (contentType === APPLICATION_JSON_CONTENT_TYPE) {
4✔
84
        const { id } = response[0];
1✔
85
        const ssoLoginUrl = getSsoStartUrlById(id);
1✔
86
        window.location.replace(ssoLoginUrl);
1✔
87
        return;
1✔
88
      }
89

90
      const token = response;
3✔
91
      if (contentType !== APPLICATION_JWT_CONTENT_TYPE || !token) {
3!
92
        return;
×
93
      }
94
      // save token to local storage & set maxAge if noexpiry checkbox not checked
95
      let now = new Date();
3✔
96
      now.setSeconds(now.getSeconds() + maxSessionAge);
3✔
97
      const expiresAt = stayLoggedIn ? undefined : now.toISOString();
3!
98
      setSessionInfo({ token, expiresAt });
3✔
99
      cookies.remove('JWT', { path: '/' });
3✔
100
      return dispatch(getUser(OWN_USER_ID))
3✔
101
        .catch(e => {
102
          cleanUp();
1✔
103
          return Promise.reject(dispatch(setSnackbar(extractErrorMessage(e))));
1✔
104
        })
105
        .then(() => {
106
          window.sessionStorage.removeItem('pendings-redirect');
2✔
107
          if (window.location.pathname !== '/ui/') {
2!
108
            window.location.replace('/ui/');
2✔
109
          }
110
          return Promise.all([dispatch({ type: UserConstants.SUCCESSFULLY_LOGGED_IN, value: { expiresAt, token } })]);
2✔
111
        });
112
    });
113

114
export const logoutUser = () => (dispatch, getState) => {
184✔
115
  if (Object.keys(getState().app.uploadsById).length) {
8!
116
    return Promise.reject();
×
117
  }
118
  return GeneralApi.post(`${useradmApiUrl}/auth/logout`).finally(() => {
8✔
119
    cleanUp();
8✔
120
    clearAllRetryTimers(setSnackbar);
8✔
121
    return Promise.resolve(dispatch({ type: UserConstants.USER_LOGOUT }));
8✔
122
  });
123
};
124

125
export const passwordResetStart = email => dispatch =>
184✔
126
  GeneralApi.post(`${useradmApiUrl}/auth/password-reset/start`, { email }).catch(err =>
2✔
127
    commonErrorHandler(err, `The password reset request cannot be processed:`, dispatch, undefined, true)
×
128
  );
129

130
export const passwordResetComplete = (secretHash, newPassword) => dispatch =>
184✔
131
  GeneralApi.post(`${useradmApiUrl}/auth/password-reset/complete`, { secret_hash: secretHash, password: newPassword }).catch((err = {}) => {
2!
132
    const { error, response = {} } = err;
×
133
    let errorMsg = '';
×
134
    if (response.status == 400) {
×
135
      errorMsg = 'the link you are using expired or the request is not valid, please try again.';
×
136
    } else {
137
      errorMsg = error;
×
138
    }
139
    dispatch(setSnackbar('The password reset request cannot be processed: ' + errorMsg));
×
140
    return Promise.reject(err);
×
141
  });
142

143
export const verifyEmailStart = () => (dispatch, getState) =>
184✔
144
  GeneralApi.post(`${useradmApiUrl}/auth/verify-email/start`, { email: getCurrentUser(getState()).email })
1✔
145
    .catch(err => commonErrorHandler(err, 'An error occured starting the email verification process:', dispatch))
×
146
    .finally(() => Promise.resolve(dispatch(getUser(OWN_USER_ID))));
1✔
147

148
export const setAccountActivationCode = code => dispatch => Promise.resolve(dispatch({ type: UserConstants.RECEIVED_ACTIVATION_CODE, code }));
184✔
149

150
export const verifyEmailComplete = secret => dispatch =>
184✔
151
  GeneralApi.post(`${useradmApiUrl}/auth/verify-email/complete`, { secret_hash: secret })
2✔
152
    .catch(err => commonErrorHandler(err, 'An error occured completing the email verification process:', dispatch))
1✔
153
    .finally(() => Promise.resolve(dispatch(getUser(OWN_USER_ID))));
2✔
154

155
export const verify2FA = tfaData => dispatch =>
184✔
156
  UsersApi.putVerifyTFA(`${useradmApiUrl}/2faverify`, tfaData)
2✔
157
    .then(() => Promise.resolve(dispatch(getUser(OWN_USER_ID))))
2✔
158
    .catch(err =>
159
      commonErrorHandler(err, 'An error occured validating the verification code: failed to verify token, please try again.', dispatch, undefined, true)
×
160
    );
161

162
export const getUserList = () => dispatch =>
184✔
163
  GeneralApi.get(`${useradmApiUrl}/users`)
18✔
164
    .then(res => {
165
      const users = res.data.reduce((accu, item) => {
18✔
166
        accu[item.id] = item;
36✔
167
        return accu;
36✔
168
      }, {});
169
      return dispatch({ type: UserConstants.RECEIVED_USER_LIST, users });
18✔
170
    })
171
    .catch(err => commonErrorHandler(err, `Users couldn't be loaded.`, dispatch, commonErrorFallback));
×
172

173
export const getUser = id => dispatch =>
184✔
174
  GeneralApi.get(`${useradmApiUrl}/users/${id}`).then(({ data: user }) =>
14✔
175
    Promise.all([
13✔
176
      dispatch({ type: UserConstants.RECEIVED_USER, user }),
177
      dispatch(setHideAnnouncement(false, user.id)),
178
      dispatch(updateUserColumnSettings(undefined, user.id)),
179
      user
180
    ])
181
  );
182

183
export const initializeSelf = () => dispatch => dispatch(getUser(UserConstants.OWN_USER_ID)).then(() => dispatch(initializeAppData()));
184✔
184

185
export const updateUserColumnSettings = (columns, currentUserId) => (dispatch, getState) => {
184✔
186
  const userId = currentUserId ?? getCurrentUser(getState()).id;
16✔
187
  const storageKey = `${userId}-column-widths`;
16✔
188
  let customColumns = [];
16✔
189
  if (!columns) {
16✔
190
    try {
14✔
191
      customColumns = JSON.parse(window.localStorage.getItem(storageKey)) || customColumns;
14!
192
    } catch {
193
      // most likely the column info doesn't exist yet or is lost - continue
194
    }
195
  } else {
196
    customColumns = columns;
2✔
197
  }
198
  window.localStorage.setItem(storageKey, JSON.stringify(customColumns));
16✔
199
  return Promise.resolve(dispatch({ type: UserConstants.SET_CUSTOM_COLUMNS, value: customColumns }));
16✔
200
};
201

202
const actions = {
184✔
203
  create: {
204
    successMessage: 'The user was created successfully.',
205
    errorMessage: 'creating'
206
  },
207
  edit: {
208
    successMessage: 'The user has been updated.',
209
    errorMessage: 'editing'
210
  },
211
  remove: {
212
    successMessage: 'The user was removed from the system.',
213
    errorMessage: 'removing'
214
  }
215
};
216

217
const userActionErrorHandler = (err, type, dispatch) => commonErrorHandler(err, `There was an error ${actions[type].errorMessage} the user.`, dispatch);
184✔
218

219
export const createUser = userData => dispatch =>
184✔
220
  GeneralApi.post(`${useradmApiUrl}/users`, userData)
3✔
221
    .then(() =>
222
      Promise.all([
3✔
223
        dispatch({ type: UserConstants.CREATED_USER, user: userData }),
224
        dispatch(getUserList()),
225
        dispatch(setSnackbar(actions.create.successMessage))
226
      ])
227
    )
228
    .catch(err => userActionErrorHandler(err, 'create', dispatch));
×
229

230
export const removeUser = userId => dispatch =>
184✔
231
  GeneralApi.delete(`${useradmApiUrl}/users/${userId}`)
1✔
232
    .then(() =>
233
      Promise.all([dispatch({ type: UserConstants.REMOVED_USER, userId }), dispatch(getUserList()), dispatch(setSnackbar(actions.remove.successMessage))])
1✔
234
    )
235
    .catch(err => userActionErrorHandler(err, 'remove', dispatch));
×
236

237
export const editUser = (userId, userData) => (dispatch, getState) => {
184✔
238
  return GeneralApi.put(`${useradmApiUrl}/users/${userId}`, userData).then(() =>
3✔
239
    Promise.all([
1✔
240
      dispatch({ type: UserConstants.UPDATED_USER, userId: userId === UserConstants.OWN_USER_ID ? getState().users.currentUser : userId, user: userData }),
1!
241
      dispatch(setSnackbar(actions.edit.successMessage))
242
    ])
243
  );
244
};
245

246
export const enableUser2fa =
247
  (userId = OWN_USER_ID) =>
184✔
248
  dispatch =>
2✔
249
    GeneralApi.post(`${useradmApiUrl}/users/${userId}/2fa/enable`)
2✔
250
      .catch(err => commonErrorHandler(err, `There was an error enabling Two Factor authentication for the user.`, dispatch))
×
251
      .then(() => Promise.resolve(dispatch(getUser(userId))));
2✔
252

253
export const disableUser2fa =
254
  (userId = OWN_USER_ID) =>
184!
255
  dispatch =>
1✔
256
    GeneralApi.post(`${useradmApiUrl}/users/${userId}/2fa/disable`)
1✔
257
      .catch(err => commonErrorHandler(err, `There was an error disabling Two Factor authentication for the user.`, dispatch))
×
258
      .then(() => Promise.resolve(dispatch(getUser(userId))));
1✔
259

260
/* RBAC related things follow:  */
261

262
const mergePermissions = (existingPermissions = { ...emptyUiPermissions }, addedPermissions) =>
184!
263
  Object.entries(existingPermissions).reduce(
1,518✔
264
    (accu, [key, value]) => {
265
      let values;
266
      if (!accu[key]) {
2,857✔
267
        accu[key] = value;
327✔
268
        return accu;
327✔
269
      }
270
      if (Array.isArray(value)) {
2,530✔
271
        values = [...value, ...accu[key]].filter(duplicateFilter);
1,554✔
272
      } else {
273
        values = mergePermissions(accu[key], { ...value });
976✔
274
      }
275
      accu[key] = values;
2,530✔
276
      return accu;
2,530✔
277
    },
278
    { ...addedPermissions }
279
  );
280

281
const mapHttpPermission = permission =>
184✔
282
  Object.entries(uiPermissionsByArea).reduce(
126✔
283
    (accu, [area, definition]) => {
284
      const endpointMatches = definition.endpoints.filter(
630✔
285
        endpoint => endpoint.path.test(permission.value) && (endpoint.types.includes(permission.type) || permission.type === PermissionTypes.Any)
1,638✔
286
      );
287
      if (permission.value === PermissionTypes.Any || (permission.value.includes(apiRoot) && endpointMatches.length)) {
630✔
288
        const endpointUiPermission = endpointMatches.reduce((endpointAccu, endpoint) => [...endpointAccu, ...endpoint.uiPermissions], []);
189✔
289
        const collector = (endpointUiPermission || definition.uiPermissions)
99!
290
          .reduce((permissionsAccu, uiPermission) => {
291
            if (permission.type === PermissionTypes.Any || (!endpointMatches.length && uiPermission.verbs.some(verb => verb === permission.type))) {
207!
292
              permissionsAccu.push(uiPermission.value);
207✔
293
            }
294
            return permissionsAccu;
207✔
295
          }, [])
296
          .filter(duplicateFilter);
297
        if (Array.isArray(accu[area])) {
99✔
298
          accu[area] = [...accu[area], ...collector].filter(duplicateFilter);
54✔
299
        } else {
300
          accu[area] = mergePermissions(accu[area], { [scopedPermissionAreas[area].excessiveAccessSelector]: collector });
45✔
301
        }
302
      }
303
      return accu;
630✔
304
    },
305
    { ...emptyUiPermissions }
306
  );
307

308
const permissionActionTypes = {
184✔
309
  any: mapHttpPermission,
310
  CREATE_DEPLOYMENT: permission =>
311
    permission.type === PermissionTypes.DeviceGroup
9!
312
      ? {
313
          deployments: [uiPermissionsById.deploy.value],
314
          groups: { [permission.value]: [uiPermissionsById.deploy.value] }
315
        }
316
      : {},
317
  http: mapHttpPermission,
318
  REMOTE_TERMINAL: permission =>
319
    permission.type === PermissionTypes.DeviceGroup
×
320
      ? {
321
          groups: { [permission.value]: [uiPermissionsById.connect.value] }
322
        }
323
      : {},
324
  VIEW_DEVICE: permission =>
325
    permission.type === PermissionTypes.DeviceGroup
9!
326
      ? {
327
          groups: { [permission.value]: [uiPermissionsById.read.value] }
328
        }
329
      : {}
330
};
331

332
const combinePermissions = (existingPermissions, additionalPermissions = {}) =>
184!
333
  Object.entries(additionalPermissions).reduce((accu, [name, permissions]) => {
86✔
334
    let maybeExistingPermissions = accu[name] || [];
86✔
335
    accu[name] = [...permissions, ...maybeExistingPermissions].filter(duplicateFilter);
86✔
336
    return accu;
86✔
337
  }, existingPermissions);
338

339
const tryParseCustomPermission = permission => {
184✔
340
  const uiPermissions = permissionActionTypes[permission.action](permission.object);
144✔
341
  const result = mergePermissions({ ...emptyUiPermissions }, uiPermissions);
144✔
342
  return { isCustom: true, permission, result };
144✔
343
};
344

345
const customPermissionHandler = (accu, permission) => {
184✔
346
  let processor = tryParseCustomPermission(permission);
144✔
347
  return {
144✔
348
    ...accu,
349
    isCustom: accu.isCustom || processor.isCustom,
171✔
350
    uiPermissions: mergePermissions(accu.uiPermissions, processor.result)
351
  };
352
};
353

354
const mapPermissionSet = (permissionSetName, names, scope, existingGroupsPermissions = {}) => {
184✔
355
  const permission = Object.values(uiPermissionsById).find(permission => permission.permissionSets[scope] === permissionSetName).value;
267✔
356
  const scopedPermissions = names.reduce((accu, name) => combinePermissions(accu, { [name]: [permission] }), existingGroupsPermissions);
86✔
357
  return Object.entries(scopedPermissions).reduce((accu, [key, permissions]) => ({ ...accu, [key]: deriveImpliedAreaPermissions(scope, permissions) }), {});
86✔
358
};
359

360
const isEmptyPermissionSet = permissionSet =>
184✔
361
  !Object.values(permissionSet).reduce((accu, permissions) => {
135✔
362
    if (Array.isArray(permissions)) {
675✔
363
      return accu || !!permissions.length;
405✔
364
    }
365
    return accu || !isEmpty(permissions);
270✔
366
  }, false);
367

368
const parseRolePermissions = ({ permission_sets_with_scope = [], permissions = [] }, permissionSets) => {
184✔
369
  const preliminaryResult = permission_sets_with_scope.reduce(
63✔
370
    (accu, permissionSet) => {
371
      let processor = permissionSets[permissionSet.name];
171✔
372
      if (!processor) {
171!
373
        return accu;
×
374
      }
375
      const scope = Object.keys(scopedPermissionAreas).find(scope => uiPermissionsByArea[scope].scope === permissionSet.scope?.type);
306✔
376
      if (scope) {
171✔
377
        const result = mapPermissionSet(permissionSet.name, permissionSet.scope.value, scope, accu.uiPermissions[scope]);
36✔
378
        return { ...accu, uiPermissions: { ...accu.uiPermissions, [scope]: result } };
36✔
379
      } else if (isEmptyPermissionSet(processor.result)) {
135!
380
        return processor.permissions.reduce(customPermissionHandler, accu);
×
381
      }
382
      return {
135✔
383
        ...accu,
384
        isCustom: accu.isCustom || processor.isCustom,
270✔
385
        uiPermissions: mergePermissions(accu.uiPermissions, processor.result)
386
      };
387
    },
388
    { isCustom: false, uiPermissions: { ...emptyUiPermissions, groups: {}, releases: {} } }
389
  );
390
  return permissions.reduce(customPermissionHandler, preliminaryResult);
63✔
391
};
392

393
export const normalizeRbacRoles = (roles, rolesById, permissionSets) =>
184✔
394
  roles.reduce(
10✔
395
    (accu, role) => {
396
      let normalizedPermissions;
397
      let isCustom = false;
120✔
398
      if (rolesById[role.name]) {
120✔
399
        normalizedPermissions = {
57✔
400
          ...rolesById[role.name].uiPermissions,
401
          groups: { ...rolesById[role.name].uiPermissions.groups },
402
          releases: { ...rolesById[role.name].uiPermissions.releases }
403
        };
404
      } else {
405
        const result = parseRolePermissions(role, permissionSets);
63✔
406
        normalizedPermissions = result.uiPermissions;
63✔
407
        isCustom = result.isCustom;
63✔
408
      }
409

410
      const roleState = accu[role.name] ?? { ...emptyRole };
120✔
411
      accu[role.name] = {
120✔
412
        ...roleState,
413
        ...role,
414
        description: roleState.description ? roleState.description : role.description,
120✔
415
        editable: !defaultRolesById[role.name] && !isCustom && (typeof roleState.editable !== 'undefined' ? roleState.editable : true),
276✔
416
        isCustom,
417
        name: roleState.name ? roleState.name : role.name,
120✔
418
        uiPermissions: normalizedPermissions
419
      };
420
      return accu;
120✔
421
    },
422
    { ...rolesById }
423
  );
424

425
export const mapUserRolesToUiPermissions = (userRoles, roles) =>
184✔
426
  userRoles.reduce(
89✔
427
    (accu, roleId) => {
428
      if (!(roleId && roles[roleId])) {
74!
429
        return accu;
×
430
      }
431
      return mergePermissions(accu, roles[roleId].uiPermissions);
74✔
432
    },
433
    { ...emptyUiPermissions }
434
  );
435

436
export const getPermissionSets = () => (dispatch, getState) =>
184✔
437
  GeneralApi.get(`${useradmApiUrlv2}/permission_sets?per_page=500`)
10✔
438
    .then(({ data }) => {
439
      const permissionSets = data.reduce(
10✔
440
        (accu, permissionSet) => {
441
          const permissionSetState = accu[permissionSet.name] ?? {};
140✔
442
          let permissionSetObject = { ...permissionSetState, ...permissionSet };
140✔
443
          permissionSetObject.result = Object.values(uiPermissionsById).reduce(
140✔
444
            (accu, item) =>
445
              Object.entries(item.permissionSets).reduce((collector, [area, permissionSet]) => {
840✔
446
                if (scopedPermissionAreas[area]) {
1,680✔
447
                  return collector;
1,120✔
448
                }
449
                if (permissionSet === permissionSetObject.name) {
560✔
450
                  collector[area] = [...collector[area], item.value].filter(duplicateFilter);
40✔
451
                }
452
                return collector;
560✔
453
              }, accu),
454
            { ...emptyUiPermissions, ...(permissionSetObject.result ?? {}) }
149✔
455
          );
456
          const scopes = Object.values(scopedPermissionAreas).reduce((accu, { key, scopeType }) => {
140✔
457
            if (permissionSetObject.supported_scope_types?.includes(key) || permissionSetObject.supported_scope_types?.includes(scopeType)) {
280✔
458
              accu.push(key);
50✔
459
            }
460
            return accu;
280✔
461
          }, []);
462
          permissionSetObject = scopes.reduce((accu, scope) => {
140✔
463
            accu.result[scope] = mapPermissionSet(permissionSetObject.name, [scopedPermissionAreas[scope].excessiveAccessSelector], scope);
50✔
464
            return accu;
50✔
465
          }, permissionSetObject);
466
          accu[permissionSet.name] = permissionSetObject;
140✔
467
          return accu;
140✔
468
        },
469
        { ...getState().users.permissionSetsById }
470
      );
471
      return Promise.all([dispatch({ type: UserConstants.RECEIVED_PERMISSION_SETS, value: permissionSets }), permissionSets]);
10✔
472
    })
473
    .catch(() => console.log('Permission set retrieval failed - likely accessing a non-RBAC backend'));
×
474

475
export const getRoles = () => (dispatch, getState) =>
184✔
476
  Promise.all([GeneralApi.get(`${useradmApiUrlv2}/roles?per_page=500`), dispatch(getPermissionSets())])
10✔
477
    .then(results => {
478
      if (!results) {
10!
479
        return Promise.resolve();
×
480
      }
481
      const [{ data: roles }, permissionSetTasks] = results;
10✔
482
      const rolesById = normalizeRbacRoles(roles, getState().users.rolesById, permissionSetTasks[permissionSetTasks.length - 1]);
10✔
483
      return Promise.resolve(dispatch({ type: UserConstants.RECEIVED_ROLES, value: rolesById }));
10✔
484
    })
485
    .catch(() => console.log('Role retrieval failed - likely accessing a non-RBAC backend'));
×
486

487
const deriveImpliedAreaPermissions = (area, areaPermissions, skipPermissions = []) => {
184✔
488
  const highestAreaPermissionLevelSelected = areaPermissions.reduce(
94✔
489
    (highest, current) => (uiPermissionsById[current].permissionLevel > highest ? uiPermissionsById[current].permissionLevel : highest),
99✔
490
    1
491
  );
492
  return uiPermissionsByArea[area].uiPermissions.reduce((permissions, current) => {
94✔
493
    if ((current.permissionLevel < highestAreaPermissionLevelSelected || areaPermissions.includes(current.value)) && !skipPermissions.includes(current.value)) {
459✔
494
      permissions.push(current.value);
160✔
495
    }
496
    return permissions;
459✔
497
  }, []);
498
};
499

500
/**
501
 * transforms [{ group: "groupName",  uiPermissions: ["read", "manage", "connect"] }, ...] to
502
 * [{ name: "ReadDevices", scope: { type: "DeviceGroups", value: ["groupName", ...] } }, ...]
503
 */
504
const transformAreaRoleDataToScopedPermissionsSets = (area, areaPermissions, excessiveAccessSelector) => {
184✔
505
  const permissionSetObject = areaPermissions.reduce((accu, { item, uiPermissions }) => {
4✔
506
    // if permission area is release and item is release tag (not all releases) then exclude upload permission as it cannot be applied to tags
507
    const skipPermissions = scopedPermissionAreas.releases.key === area && item !== ALL_RELEASES ? [uiPermissionsById.upload.value] : [];
6✔
508
    const impliedPermissions = deriveImpliedAreaPermissions(area, uiPermissions, skipPermissions);
6✔
509
    accu = impliedPermissions.reduce((itemPermissionAccu, impliedPermission) => {
6✔
510
      const permissionSetState = itemPermissionAccu[uiPermissionsById[impliedPermission].permissionSets[area]] ?? {
7✔
511
        type: uiPermissionsByArea[area].scope,
512
        value: []
513
      };
514
      itemPermissionAccu[uiPermissionsById[impliedPermission].permissionSets[area]] = {
7✔
515
        ...permissionSetState,
516
        value: [...permissionSetState.value, item]
517
      };
518
      return itemPermissionAccu;
7✔
519
    }, accu);
520
    return accu;
6✔
521
  }, {});
522
  return Object.entries(permissionSetObject).map(([name, { value, ...scope }]) => {
4✔
523
    if (value.includes(excessiveAccessSelector)) {
7✔
524
      return { name };
3✔
525
    }
526
    return { name, scope: { ...scope, value: value.filter(duplicateFilter) } };
4✔
527
  });
528
};
529

530
const transformRoleDataToRole = (roleData, roleState = {}) => {
184✔
531
  const role = { ...roleState, ...roleData };
3✔
532
  const { description = '', name, uiPermissions = emptyUiPermissions } = role;
3!
533
  const { maybeUiPermissions, remainderKeys } = Object.entries(emptyUiPermissions).reduce(
3✔
534
    (accu, [key, emptyPermissions]) => {
535
      if (!scopedPermissionAreas[key]) {
15✔
536
        accu.remainderKeys.push(key);
9✔
537
      } else if (uiPermissions[key]) {
6✔
538
        accu.maybeUiPermissions[key] = uiPermissions[key].reduce(itemUiPermissionsReducer, emptyPermissions);
4✔
539
      }
540
      return accu;
15✔
541
    },
542
    { maybeUiPermissions: {}, remainderKeys: [] }
543
  );
544
  const { permissionSetsWithScope, roleUiPermissions } = remainderKeys.reduce(
3✔
545
    (accu, area) => {
546
      const areaPermissions = role.uiPermissions[area];
9✔
547
      if (!Array.isArray(areaPermissions)) {
9✔
548
        return accu;
7✔
549
      }
550
      const impliedPermissions = deriveImpliedAreaPermissions(area, areaPermissions);
2✔
551
      accu.roleUiPermissions[area] = impliedPermissions;
2✔
552
      const mappedPermissions = impliedPermissions.map(uiPermission => ({ name: uiPermissionsById[uiPermission].permissionSets[area] }));
2✔
553
      accu.permissionSetsWithScope.push(...mappedPermissions);
2✔
554
      return accu;
2✔
555
    },
556
    { permissionSetsWithScope: [{ name: defaultPermissionSets.Basic.name }], roleUiPermissions: {} }
557
  );
558
  const scopedPermissionSets = Object.values(scopedPermissionAreas).reduce((accu, { key, excessiveAccessSelector }) => {
3✔
559
    if (!uiPermissions[key]) {
6✔
560
      return accu;
2✔
561
    }
562
    accu.push(...transformAreaRoleDataToScopedPermissionsSets(key, uiPermissions[key], excessiveAccessSelector));
4✔
563
    return accu;
4✔
564
  }, []);
565
  return {
3✔
566
    permissionSetsWithScope: [...permissionSetsWithScope, ...scopedPermissionSets],
567
    role: {
568
      ...emptyRole,
569
      name,
570
      description: description ? description : roleState.description,
3!
571
      uiPermissions: {
572
        ...emptyUiPermissions,
573
        ...roleUiPermissions,
574
        ...maybeUiPermissions
575
      }
576
    }
577
  };
578
};
579

580
const roleActions = {
184✔
581
  create: {
582
    successMessage: 'The role was created successfully.',
583
    errorMessage: 'creating'
584
  },
585
  edit: {
586
    successMessage: 'The role has been updated.',
587
    errorMessage: 'editing'
588
  },
589
  remove: {
590
    successMessage: 'The role was deleted successfully.',
591
    errorMessage: 'removing'
592
  }
593
};
594

595
const roleActionErrorHandler = (err, type, dispatch) => commonErrorHandler(err, `There was an error ${roleActions[type].errorMessage} the role.`, dispatch);
184✔
596

597
export const createRole = roleData => dispatch => {
184✔
598
  const { permissionSetsWithScope, role } = transformRoleDataToRole(roleData);
1✔
599
  return GeneralApi.post(`${useradmApiUrlv2}/roles`, {
1✔
600
    name: role.name,
601
    description: role.description,
602
    permission_sets_with_scope: permissionSetsWithScope
603
  })
604
    .then(() =>
605
      Promise.all([
1✔
606
        dispatch({ type: UserConstants.CREATED_ROLE, role, roleId: role.name }),
607
        dispatch(getRoles()),
608
        dispatch(setSnackbar(roleActions.create.successMessage))
609
      ])
610
    )
611
    .catch(err => roleActionErrorHandler(err, 'create', dispatch));
×
612
};
613

614
export const editRole = roleData => (dispatch, getState) => {
184✔
615
  const { permissionSetsWithScope, role } = transformRoleDataToRole(roleData, getState().users.rolesById[roleData.name]);
2✔
616
  return GeneralApi.put(`${useradmApiUrlv2}/roles/${role.name}`, {
2✔
617
    description: role.description,
618
    name: role.name,
619
    permission_sets_with_scope: permissionSetsWithScope
620
  })
621
    .then(() =>
622
      Promise.all([
2✔
623
        dispatch({ type: UserConstants.UPDATED_ROLE, role, roleId: role.name }),
624
        dispatch(getRoles()),
625
        dispatch(setSnackbar(roleActions.edit.successMessage))
626
      ])
627
    )
628
    .catch(err => roleActionErrorHandler(err, 'edit', dispatch));
×
629
};
630

631
export const removeRole = roleId => (dispatch, getState) =>
184✔
632
  GeneralApi.delete(`${useradmApiUrlv2}/roles/${roleId}`)
2✔
633
    .then(() => {
634
      // eslint-disable-next-line no-unused-vars
635
      const { [roleId]: toBeRemoved, ...rolesById } = getState().users.rolesById;
2✔
636
      return Promise.all([
2✔
637
        dispatch({ type: UserConstants.REMOVED_ROLE, value: rolesById }),
638
        dispatch(getRoles()),
639
        dispatch(setSnackbar(roleActions.remove.successMessage))
640
      ]);
641
    })
642
    .catch(err => roleActionErrorHandler(err, 'remove', dispatch));
×
643

644
/*
645
  Global settings
646
*/
647
export const getGlobalSettings = () => dispatch =>
184✔
648
  GeneralApi.get(`${useradmApiUrl}/settings`).then(({ data: settings, headers: { etag } }) => {
14✔
649
    window.sessionStorage.setItem(UserConstants.settingsKeys.initialized, true);
14✔
650
    return Promise.all([dispatch({ type: UserConstants.SET_GLOBAL_SETTINGS, settings }), dispatch(setOfflineThreshold()), etag]);
14✔
651
  });
652

653
export const saveGlobalSettings =
654
  (settings, beOptimistic = false, notify = false) =>
184✔
655
  (dispatch, getState) => {
10✔
656
    if (!window.sessionStorage.getItem(UserConstants.settingsKeys.initialized) && !beOptimistic) {
10!
657
      return;
×
658
    }
659
    return Promise.resolve(dispatch(getGlobalSettings())).then(result => {
10✔
660
      let updatedSettings = { ...getState().users.globalSettings, ...settings };
10✔
661
      if (getCurrentUser(getState()).verified) {
10✔
662
        updatedSettings['2fa'] = twoFAStates.enabled;
9✔
663
      } else {
664
        delete updatedSettings['2fa'];
1✔
665
      }
666
      let tasks = [dispatch({ type: UserConstants.SET_GLOBAL_SETTINGS, settings: updatedSettings })];
10✔
667
      const headers = result[result.length - 1] ? { 'If-Match': result[result.length - 1] } : {};
10!
668
      return GeneralApi.post(`${useradmApiUrl}/settings`, updatedSettings, { headers })
10✔
669
        .then(() => {
670
          if (notify) {
10✔
671
            tasks.push(dispatch(setSnackbar('Settings saved successfully')));
1✔
672
          }
673
          return Promise.all(tasks);
10✔
674
        })
675
        .catch(err => {
676
          if (beOptimistic) {
×
677
            return Promise.all([tasks]);
×
678
          }
679
          console.log(err);
×
680
          return commonErrorHandler(err, `The settings couldn't be saved.`, dispatch);
×
681
        });
682
    });
683
  };
684

685
export const getUserSettings = () => dispatch =>
184✔
686
  GeneralApi.get(`${useradmApiUrl}/settings/me`).then(({ data: settings, headers: { etag } }) => {
58✔
687
    window.sessionStorage.setItem(UserConstants.settingsKeys.initialized, true);
58✔
688
    return Promise.all([dispatch({ type: UserConstants.SET_USER_SETTINGS, settings }), etag]);
58✔
689
  });
690

691
export const saveUserSettings =
692
  (settings = { onboarding: {} }) =>
184✔
693
  (dispatch, getState) => {
54✔
694
    if (!getState().users.currentUser) {
54!
695
      return Promise.resolve();
×
696
    }
697
    return Promise.resolve(dispatch(getUserSettings())).then(result => {
54✔
698
      const userSettings = getUserSettingsSelector(getState());
54✔
699
      const onboardingState = getOnboardingState(getState());
54✔
700
      const tooltipState = getTooltipsState(getState());
54✔
701
      const updatedSettings = {
54✔
702
        ...userSettings,
703
        ...settings,
704
        onboarding: {
705
          ...onboardingState,
706
          ...settings.onboarding
707
        },
708
        tooltips: tooltipState
709
      };
710
      const headers = result[result.length - 1] ? { 'If-Match': result[result.length - 1] } : {};
54!
711
      return Promise.all([
54✔
712
        Promise.resolve(dispatch({ type: UserConstants.SET_USER_SETTINGS, settings: updatedSettings })),
713
        GeneralApi.post(`${useradmApiUrl}/settings/me`, updatedSettings, { headers })
714
      ]).catch(() => dispatch({ type: UserConstants.SET_USER_SETTINGS, settings: userSettings }));
×
715
    });
716
  };
717

718
export const get2FAQRCode = () => dispatch =>
184✔
719
  GeneralApi.get(`${useradmApiUrl}/2faqr`).then(res => dispatch({ type: UserConstants.RECEIVED_QR_CODE, value: res.data.qr }));
2✔
720

721
/*
722
  Onboarding
723
*/
724
export const setShowConnectingDialog = show => dispatch => dispatch({ type: UserConstants.SET_SHOW_CONNECT_DEVICE, show: Boolean(show) });
184✔
725

726
export const setHideAnnouncement = (shouldHide, userId) => (dispatch, getState) => {
184✔
727
  const currentUserId = userId || getCurrentUser(getState()).id;
14✔
728
  const hash = getState().app.hostedAnnouncement ? hashString(getState().app.hostedAnnouncement) : '';
14✔
729
  const announceCookie = cookies.get(`${currentUserId}${hash}`);
14✔
730
  if (shouldHide || (hash.length && typeof announceCookie !== 'undefined')) {
14!
731
    cookies.set(`${currentUserId}${hash}`, true, { maxAge: 604800 });
1✔
732
    return Promise.resolve(dispatch({ type: AppConstants.SET_ANNOUNCEMENT, announcement: undefined }));
1✔
733
  }
734
  return Promise.resolve();
13✔
735
};
736

737
export const getTokens = () => (dispatch, getState) =>
184✔
738
  GeneralApi.get(`${useradmApiUrl}/settings/tokens`).then(({ data: tokens }) => {
15✔
739
    const user = getCurrentUser(getState());
15✔
740
    const updatedUser = {
15✔
741
      ...user,
742
      tokens
743
    };
744
    return Promise.resolve(dispatch({ type: UserConstants.UPDATED_USER, user: updatedUser, userId: user.id }));
15✔
745
  });
746

747
const ONE_YEAR = 31536000;
184✔
748

749
export const generateToken =
750
  ({ expiresIn = ONE_YEAR, name }) =>
184✔
751
  dispatch =>
5✔
752
    GeneralApi.post(`${useradmApiUrl}/settings/tokens`, { name, expires_in: expiresIn })
5✔
753
      .then(({ data: token }) => Promise.all([dispatch(getTokens()), token]))
5✔
754
      .catch(err => commonErrorHandler(err, 'There was an error creating the token:', dispatch));
×
755

756
export const revokeToken = token => dispatch =>
184✔
757
  GeneralApi.delete(`${useradmApiUrl}/settings/tokens/${token.id}`).then(() => Promise.resolve(dispatch(getTokens())));
1✔
758

759
export const setTooltipReadState =
760
  (id, readState = UserConstants.READ_STATES.read, persist) =>
184!
761
  dispatch =>
1✔
762
    Promise.resolve(dispatch({ type: UserConstants.SET_TOOLTIP_STATE, id, value: { readState } })).then(() => {
1✔
763
      if (persist) {
1!
764
        return Promise.resolve(dispatch(saveUserSettings()));
1✔
765
      }
766
      return Promise.resolve();
×
767
    });
768

769
export const setAllTooltipsReadState =
770
  (readState = UserConstants.READ_STATES.read) =>
184!
771
  dispatch => {
1✔
772
    const updatedTips = Object.keys(HELPTOOLTIPS).reduce((accu, id) => ({ ...accu, [id]: { readState } }), {});
28✔
773
    return Promise.resolve(dispatch({ type: UserConstants.SET_TOOLTIPS_STATE, value: updatedTips })).then(() => dispatch(saveUserSettings()));
1✔
774
  };
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc