All files / client/src/views/login loginThunks.ts

78.84% Statements 82/104
55.55% Branches 25/45
100% Functions 17/17
78.84% Lines 82/104

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353                                                            520x 520x 520x 520x 520x         520x 450x 450x 450x       520x     30x 30x   27x 5x   2x   3x               22x   22x       22x                               22x               22x 21x     21x 11x                       520x     417x       417x   417x         7x           6x 6x 6x                     1x           410x   410x       410x   410x                         410x 375x     410x         410x         410x 9x         520x     41x 41x   31x       31x       520x     18x 18x   18x                             18x   18x       18x                               18x               18x 18x       520x 520x 520x 520x     520x 520x 520x     520x     15x 15x   15x 3x   3x                         12x                     12x 12x           520x     27x     27x   24x                     24x                       24x     24x 1x        
import { isDeepEqual } from "remeda";
import { PostEventLogIsSeenRequest } from "shared/types/api/eventLog";
import { exhaustiveSwitchGuard } from "shared/utils/exhaustiveSwitchGuard";
import {
  postKompassiLoginCallback,
  postLogin,
  postSessionRecovery,
  postUpdateUserEmailAddress,
  postVerifyKompassiLogin,
} from "client/services/loginServices";
import { postEventLogItemIsSeen } from "client/services/userServices";
import { BackendErrorType } from "client/types/errorTypes";
import { AppThunk } from "client/types/reduxTypes";
import {
  loadGroupMembers,
  loadProgramItems,
  loadUser,
} from "client/utils/loadData";
import { saveSession } from "client/utils/localStorage";
import { addError, removeError } from "client/views/admin/adminSlice";
import { submitUpdateGroupCodeAsync } from "client/views/group/groupSlice";
import { LoginFormFields } from "client/views/login/components/LocalLoginForm";
import {
  submitFinalizeLoginAsync,
  submitLoginAsync,
  submitUpdateEventLogItemsAsync,
  submitVerifyKompassiLoginAsync,
} from "client/views/login/loginSlice";
import { submitLogout } from "client/views/logout/logoutActions";
 
export enum LoginErrorMessage {
  LOGIN_FAILED = "error.loginFailed",
  LOGIN_DISABLED = "error.loginDisabled",
  INVALID_USER_GROUP = "error.invalidUserGroup",
  UNKNOWN = "error.unknown",
}
 
// Signing back in makes a sign-out notice stale, so clear both rather than
// leaving the bar contradicting the app behind it
const clearSignedOutErrors = (): AppThunk<void> => {
  return (dispatch): void => {
    dispatch(removeError({ errorKey: BackendErrorType.SESSION_EXPIRED }));
    dispatch(removeError({ errorKey: BackendErrorType.LOGIN_DISABLED }));
  };
};
 
export const submitLogin = (
  loginFormFields: LoginFormFields,
): AppThunk<Promise<LoginErrorMessage | undefined>> => {
  return async (dispatch, getState): Promise<LoginErrorMessage | undefined> => {
    const loginResponse = await postLogin(loginFormFields);
 
    if (loginResponse.status === "error") {
      switch (loginResponse.errorId) {
        case "loginFailed":
          return LoginErrorMessage.LOGIN_FAILED;
        case "loginDisabled":
          return LoginErrorMessage.LOGIN_DISABLED;
        case "unknown":
          return LoginErrorMessage.UNKNOWN;
        default:
          return exhaustiveSwitchGuard(loginResponse.errorId);
      }
    }
 
    dispatch(clearSignedOutErrors());
 
    saveSession({
      login: { jwt: loginResponse.jwt },
    });
 
    dispatch(
      submitLoginAsync({
        loggedIn: true,
        username: loginResponse.username,
        jwt: loginResponse.jwt,
        userGroup: loginResponse.userGroup,
        serial: loginResponse.serial,
        eventLogItems: loginResponse.eventLogItems,
        kompassiUsernameAccepted: loginResponse.kompassiUsernameAccepted,
        kompassiId: loginResponse.kompassiId,
        email: loginResponse.email,
        emailNotificationPermitAsked:
          loginResponse.emailNotificationPermitAsked,
      }),
    );
 
    dispatch(
      submitUpdateGroupCodeAsync({
        groupCode: loginResponse.groupCode,
        isGroupCreator: loginResponse.isGroupCreator,
      }),
    );
 
    // TODO: Remove these, backend response should return all required data
    await loadUser();
    await loadGroupMembers();
    // Program items are skipped on startup when the app is closed and the user
    // is logged out; load them now if they weren't already loaded
    if (getState().allProgramItems.programItems.length === 0) {
      await loadProgramItems({ forceUpdate: false });
    }
  };
};
 
enum SubmitSessionRecoveryErrorMessage {
  LOGIN_FAILED = "error.loginFailed",
  LOGIN_DISABLED = "error.loginDisabled",
  SESSION_EXPIRED = "backendError.sessionExpired",
  UNKNOWN = "error.unknown",
}
 
export const submitSessionRecovery = (
  currentJwt: string,
): AppThunk<Promise<SubmitSessionRecoveryErrorMessage | undefined>> => {
  return async (
    dispatch,
    useState,
  ): Promise<SubmitSessionRecoveryErrorMessage | undefined> => {
    const loginResponse = await postSessionRecovery(currentJwt);
 
    if (loginResponse.status === "error") {
      // Logging out drops the stored session and the copy the store read from
      // it at startup. Clearing storage alone would leave that copy behind,
      // and the caller decides whether to recover from it - so recovery would
      // be attempted again on every poll for as long as the tab stayed open
      switch (loginResponse.errorId) {
        // Log out first so the error is raised against the state the reset
        // leaves behind, whatever the reset chooses to preserve
        case "sessionExpired":
        case "loginFailed":
          // Indistinguishable to the user: the stored session no longer works
          dispatch(submitLogout());
          dispatch(addError({ errorKey: BackendErrorType.SESSION_EXPIRED }));
          return loginResponse.errorId === "sessionExpired"
            ? SubmitSessionRecoveryErrorMessage.SESSION_EXPIRED
            : SubmitSessionRecoveryErrorMessage.LOGIN_FAILED;
        case "loginDisabled":
          // A different situation: logging in again won't help
          dispatch(submitLogout());
          dispatch(addError({ errorKey: BackendErrorType.LOGIN_DISABLED }));
          return SubmitSessionRecoveryErrorMessage.LOGIN_DISABLED;
        case "unknown":
          // Could be anything, including never having reached the server, so
          // keep the session for the next poll to try again
          return SubmitSessionRecoveryErrorMessage.UNKNOWN;
        default:
          return exhaustiveSwitchGuard(loginResponse.errorId);
      }
    }
 
    dispatch(clearSignedOutErrors());
 
    saveSession({
      login: { jwt: loginResponse.jwt },
    });
 
    const state = useState();
 
    const updatedLogin = {
      loggedIn: true,
      username: loginResponse.username,
      jwt: loginResponse.jwt,
      userGroup: loginResponse.userGroup,
      serial: loginResponse.serial,
      eventLogItems: loginResponse.eventLogItems,
      kompassiUsernameAccepted: loginResponse.kompassiUsernameAccepted,
      kompassiId: loginResponse.kompassiId,
      email: loginResponse.email,
      emailNotificationPermitAsked: loginResponse.emailNotificationPermitAsked,
    };
 
    if (!isDeepEqual(state.login, updatedLogin)) {
      dispatch(submitLoginAsync(updatedLogin));
    }
 
    const currentGroup = {
      groupCode: state.group.groupCode,
      isGroupCreator: state.group.isGroupCreator,
    };
 
    const updatedGroup = {
      groupCode: loginResponse.groupCode,
      isGroupCreator: loginResponse.isGroupCreator,
    };
 
    if (!isDeepEqual(currentGroup, updatedGroup)) {
      dispatch(submitUpdateGroupCodeAsync(updatedGroup));
    }
  };
};
 
export const submitUpdateEventLogIsSeen = (
  request: PostEventLogIsSeenRequest,
): AppThunk => {
  return async (dispatch): Promise<void> => {
    const response = await postEventLogItemIsSeen(request);
 
    Iif (response.status === "error") {
      return;
    }
 
    dispatch(submitUpdateEventLogItemsAsync(response.eventLogItems));
  };
};
 
export const submitKompassiLogin = (
  code: string,
): AppThunk<Promise<LoginErrorMessage | undefined>> => {
  return async (dispatch): Promise<LoginErrorMessage | undefined> => {
    const loginResponse = await postKompassiLoginCallback(code);
 
    Iif (loginResponse.status === "error") {
      switch (loginResponse.errorId) {
        case "loginFailed":
          return LoginErrorMessage.LOGIN_FAILED;
        case "loginDisabled":
          return LoginErrorMessage.LOGIN_DISABLED;
        case "invalidUserGroup":
          return LoginErrorMessage.INVALID_USER_GROUP;
        case "unknown":
          return LoginErrorMessage.UNKNOWN;
        default:
          return exhaustiveSwitchGuard(loginResponse.errorId);
      }
    }
 
    dispatch(clearSignedOutErrors());
 
    saveSession({
      login: { jwt: loginResponse.jwt },
    });
 
    dispatch(
      submitLoginAsync({
        loggedIn: true,
        username: loginResponse.username,
        jwt: loginResponse.jwt,
        userGroup: loginResponse.userGroup,
        serial: loginResponse.serial,
        eventLogItems: loginResponse.eventLogItems,
        kompassiUsernameAccepted: loginResponse.kompassiUsernameAccepted,
        kompassiId: loginResponse.kompassiId,
        email: loginResponse.email,
        emailNotificationPermitAsked:
          loginResponse.emailNotificationPermitAsked,
      }),
    );
 
    dispatch(
      submitUpdateGroupCodeAsync({
        groupCode: loginResponse.groupCode,
        isGroupCreator: loginResponse.isGroupCreator,
      }),
    );
 
    // TODO: Remove these, backend response should return all required data
    await loadUser();
    await loadGroupMembers();
  };
};
 
export enum KompassiVerifyErrorMessage {
  USERNAME_TAKEN = "error.usernameTaken",
  LOGIN_FAILED = "error.loginFailed",
  UNKNOWN = "error.unknown",
}
 
export enum UpdateUserEmailAddressErrorMessage {
  UNKNOWN = "error.unknown",
  INVALID_EMAIL = "validation.invalidEmail",
}
 
export const submitVerifyKompassiLogin = (
  username: string,
): AppThunk<Promise<KompassiVerifyErrorMessage | undefined>> => {
  return async (dispatch): Promise<KompassiVerifyErrorMessage | undefined> => {
    const response = await postVerifyKompassiLogin(username);
 
    if (response.status === "error") {
      switch (response.errorId) {
        case "usernameNotFree":
          return KompassiVerifyErrorMessage.USERNAME_TAKEN;
        case "loginFailed":
          // The session JWT points to a username that no longer exists, so
          // retrying cannot succeed - log out and let the user log in again
          dispatch(submitLogout());
          return KompassiVerifyErrorMessage.LOGIN_FAILED;
        case "unknown":
          return KompassiVerifyErrorMessage.UNKNOWN;
        default:
          return exhaustiveSwitchGuard(response.errorId);
      }
    }
 
    dispatch(
      submitVerifyKompassiLoginAsync({
        username: response.username,
        kompassiUsernameAccepted: response.kompassiUsernameAccepted,
        jwt: response.jwt,
      }),
    );
 
    // Session recovery failures are otherwise silent (the endpoint gets the
    // suppressed background error handling), so surface them here where the
    // form can show the error
    const recoveryError = await dispatch(submitSessionRecovery(response.jwt));
    Iif (recoveryError) {
      return KompassiVerifyErrorMessage.UNKNOWN;
    }
  };
};
 
export const submitUpdateUserEmailAddress = (
  email: string,
): AppThunk<Promise<UpdateUserEmailAddressErrorMessage | undefined>> => {
  return async (
    dispatch,
  ): Promise<UpdateUserEmailAddressErrorMessage | undefined> => {
    const updateEmailResponse = await postUpdateUserEmailAddress(email);
 
    Iif (updateEmailResponse.status === "error") {
      switch (updateEmailResponse.errorId) {
        case "unknown":
          return UpdateUserEmailAddressErrorMessage.UNKNOWN;
        case "invalidEmail":
          return UpdateUserEmailAddressErrorMessage.INVALID_EMAIL;
        default:
          return exhaustiveSwitchGuard(updateEmailResponse.errorId);
      }
    }
 
    dispatch(
      submitFinalizeLoginAsync({
        email: updateEmailResponse.email,
        emailNotificationPermitAsked:
          updateEmailResponse.emailNotificationPermitAsked,
        jwt: updateEmailResponse.jwt,
      }),
    );
 
    // Session recovery failures are otherwise silent (the endpoint gets the
    // suppressed background error handling), so surface them here where the
    // form can show the error
    const recoveryError = await dispatch(
      submitSessionRecovery(updateEmailResponse.jwt),
    );
    if (recoveryError) {
      return UpdateUserEmailAddressErrorMessage.UNKNOWN;
    }
  };
};