@openedx/frontend-app-authn 1.0.0-alpha.5 → 1.0.0-alpha.7

package/src/login/data/reducers.js

@@ -1,76 +0,0 @@
-import {
-  BACKUP_LOGIN_DATA,
-  DISMISS_PASSWORD_RESET_BANNER,
-  LOGIN_REQUEST,
-} from './actions';
-import { DEFAULT_STATE, PENDING_STATE } from '../../data/constants';
-import { RESET_PASSWORD } from '../../reset-password';
-
-export const defaultState = {
-  loginErrorCode: '',
-  loginErrorContext: {},
-  loginResult: {},
-  loginFormData: {
-    formFields: {
-      emailOrUsername: '', password: '',
-    },
-    errors: {
-      emailOrUsername: '', password: '',
-    },
-  },
-  shouldBackupState: false,
-  showResetPasswordSuccessBanner: false,
-  submitState: DEFAULT_STATE,
-};
-
-const reducer = (state = defaultState, action = {}) => {
-  switch (action.type) {
-    case BACKUP_LOGIN_DATA.BASE:
-      return {
-        ...state,
-        shouldBackupState: true,
-      };
-    case BACKUP_LOGIN_DATA.BEGIN:
-      return {
-        ...defaultState,
-        loginFormData: { ...action.payload },
-      };
-    case LOGIN_REQUEST.BEGIN:
-      return {
-        ...state,
-        showResetPasswordSuccessBanner: false,
-        submitState: PENDING_STATE,
-      };
-    case LOGIN_REQUEST.SUCCESS:
-      return {
-        ...state,
-        loginResult: action.payload,
-      };
-    case LOGIN_REQUEST.FAILURE: {
-      const { email, loginError, redirectUrl } = action.payload;
-      return {
-        ...state,
-        loginErrorCode: loginError.errorCode,
-        loginErrorContext: { ...loginError.context, email, redirectUrl },
-        submitState: DEFAULT_STATE,
-      };
-    }
-    case RESET_PASSWORD.SUCCESS:
-      return {
-        ...state,
-        showResetPasswordSuccessBanner: true,
-      };
-    case DISMISS_PASSWORD_RESET_BANNER: {
-      return {
-        ...state,
-        showResetPasswordSuccessBanner: false,
-      };
-    }
-    default:
-      return {
-        ...state,
-      };
-  }
-};
-
-export default reducer;

package/src/login/data/sagas.js

@@ -1,45 +0,0 @@
-import { camelCaseObject, logError, logInfo } from '@openedx/frontend-base';
-import { call, put, takeEvery } from 'redux-saga/effects';
-
-import {
-  LOGIN_REQUEST,
-  loginRequestBegin,
-  loginRequestFailure,
-  loginRequestSuccess,
-} from './actions';
-import { FORBIDDEN_REQUEST, INTERNAL_SERVER_ERROR } from './constants';
-import {
-  loginRequest,
-} from './service';
-
-export function* handleLoginRequest(action) {
-  try {
-    yield put(loginRequestBegin());
-
-    const { redirectUrl, success } = yield call(loginRequest, action.payload.creds);
-
-    yield put(loginRequestSuccess(
-      redirectUrl,
-      success,
-    ));
-  } catch (e) {
-    const statusCodes = [400];
-    if (e.response) {
-      const { status } = e.response;
-      if (statusCodes.includes(status)) {
-        yield put(loginRequestFailure(camelCaseObject(e.response.data)));
-        logInfo(e);
-      } else if (status === 403) {
-        yield put(loginRequestFailure({ errorCode: FORBIDDEN_REQUEST }));
-        logInfo(e);
-      } else {
-        yield put(loginRequestFailure({ errorCode: INTERNAL_SERVER_ERROR }));
-        logError(e);
-      }
-    }
-  }
-}
-
-export default function* saga() {
-  yield takeEvery(LOGIN_REQUEST.BASE, handleLoginRequest);
-}

package/src/login/data/service.js

@@ -1,27 +0,0 @@
-import { getAuthenticatedHttpClient, getSiteConfig, getUrlByRouteRole } from '@openedx/frontend-base';
-import * as QueryString from 'query-string';
-
-export async function loginRequest(creds) {
-  const requestConfig = {
-    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-    isPublic: true,
-  };
-
-  const { data } = await getAuthenticatedHttpClient()
-    .post(
-      `${getSiteConfig().lmsBaseUrl}/api/user/v2/account/login_session/`,
-      QueryString.stringify(creds),
-      requestConfig,
-    )
-    .catch((e) => {
-      throw (e);
-    });
-
-  const defaultRedirectUrl = getUrlByRouteRole('org.openedx.frontend.role.dashboard');
-  const redirectUrl = data.redirect_url ?? defaultRedirectUrl;
-
-  return {
-    redirectUrl,
-    success: data.success ?? false,
-  };
-}

package/src/login/data/tests/reducers.test.js

@@ -1,155 +0,0 @@
-import { getSiteConfig } from '@openedx/frontend-base';
-
-import { DEFAULT_REDIRECT_URL, DEFAULT_STATE, PENDING_STATE } from '../../../data/constants';
-import { RESET_PASSWORD } from '../../../reset-password';
-import { BACKUP_LOGIN_DATA, DISMISS_PASSWORD_RESET_BANNER, LOGIN_REQUEST } from '../actions';
-import reducer from '../reducers';
-
-describe('login reducer', () => {
-  const defaultState = {
-    loginErrorCode: '',
-    loginErrorContext: {},
-    loginResult: {},
-    loginFormData: {
-      formFields: {
-        emailOrUsername: '', password: '',
-      },
-      errors: {
-        emailOrUsername: '', password: '',
-      },
-    },
-    shouldBackupState: false,
-    showResetPasswordSuccessBanner: false,
-    submitState: DEFAULT_STATE,
-  };
-
-  it('should update state to show reset password success banner', () => {
-    const action = {
-      type: RESET_PASSWORD.SUCCESS,
-    };
-
-    expect(
-      reducer(defaultState, action),
-    ).toEqual(
-      {
-        ...defaultState,
-        showResetPasswordSuccessBanner: true,
-      },
-    );
-  });
-
-  it('should set the flag which keeps the login form data in redux state', () => {
-    const action = {
-      type: BACKUP_LOGIN_DATA.BASE,
-    };
-
-    expect(
-      reducer(defaultState, action),
-    ).toEqual(
-      {
-        ...defaultState,
-        shouldBackupState: true,
-      },
-    );
-  });
-
-  it('should backup the login form data', () => {
-    const payload = {
-      formFields: {
-        emailOrUsername: 'test@exmaple.com',
-        password: 'test1',
-      },
-      errors: {
-        emailOrUsername: '', password: '',
-      },
-    };
-    const action = {
-      type: BACKUP_LOGIN_DATA.BEGIN,
-      payload,
-    };
-
-    expect(
-      reducer(defaultState, action),
-    ).toEqual(
-      {
-        ...defaultState,
-        loginFormData: payload,
-      },
-    );
-  });
-
-  it('should update state to dismiss reset password banner', () => {
-    const action = {
-      type: DISMISS_PASSWORD_RESET_BANNER,
-    };
-
-    expect(
-      reducer(defaultState, action),
-    ).toEqual(
-      {
-        ...defaultState,
-        showResetPasswordSuccessBanner: false,
-      },
-    );
-  });
-
-  it('should start the login request', () => {
-    const action = {
-      type: LOGIN_REQUEST.BEGIN,
-    };
-
-    expect(reducer(defaultState, action)).toEqual(
-      {
-        ...defaultState,
-        showResetPasswordSuccessBanner: false,
-        submitState: PENDING_STATE,
-      },
-    );
-  });
-
-  it('should set redirect url on login success action', () => {
-    const payload = {
-      redirectUrl: `${getSiteConfig().baseUrl}${DEFAULT_REDIRECT_URL}`,
-      success: true,
-    };
-    const action = {
-      type: LOGIN_REQUEST.SUCCESS,
-      payload,
-    };
-
-    expect(reducer(defaultState, action)).toEqual(
-      {
-        ...defaultState,
-        loginResult: payload,
-      },
-    );
-  });
-
-  it('should set the error data on login request failure', () => {
-    const payload = {
-      loginError: {
-        success: false,
-        value: 'Email or password is incorrect.',
-        errorCode: 'incorrect-email-or-password',
-        context: {
-          failureCount: 0,
-        },
-      },
-      email: 'test@example.com',
-      redirectUrl: '',
-    };
-    const action = {
-      type: LOGIN_REQUEST.FAILURE,
-      payload,
-    };
-
-    expect(reducer(defaultState, action)).toEqual(
-      {
-        ...defaultState,
-        loginErrorCode: payload.loginError.errorCode,
-        loginErrorContext: { ...payload.loginError.context, email: payload.email, redirectUrl: payload.redirectUrl },
-        submitState: DEFAULT_STATE,
-      },
-    );
-  });
-});

package/src/login/data/tests/sagas.test.js

@@ -1,110 +0,0 @@
-import { camelCaseObject } from '@openedx/frontend-base';
-import { runSaga } from 'redux-saga';
-
-import { initializeMockServices } from '../../../setupTest';
-import * as actions from '../actions';
-import { FORBIDDEN_REQUEST, INTERNAL_SERVER_ERROR } from '../constants';
-import { handleLoginRequest } from '../sagas';
-import * as api from '../service';
-
-const { loggingService } = initializeMockServices();
-
-describe('handleLoginRequest', () => {
-  const params = {
-    payload: {
-      loginFormData: {
-        email: 'test@test.com',
-        password: 'test-password',
-      },
-    },
-  };
-
-  const testErrorResponse = async (loginErrorResponse, expectedLogFunc, expectedDispatchers) => {
-    const loginRequest = jest.spyOn(api, 'loginRequest').mockImplementation(() => Promise.reject(loginErrorResponse));
-
-    const dispatched = [];
-    await runSaga(
-      { dispatch: (action) => dispatched.push(action) },
-      handleLoginRequest,
-      params,
-    );
-
-    expect(loginRequest).toHaveBeenCalledTimes(1);
-    expect(expectedLogFunc).toHaveBeenCalled();
-    expect(dispatched).toEqual(expectedDispatchers);
-    loginRequest.mockClear();
-  };
-
-  beforeEach(() => {
-    loggingService.logError.mockReset();
-    loggingService.logInfo.mockReset();
-  });
-
-  it('should call service and dispatch success action', async () => {
-    const data = { redirectUrl: '/dashboard', success: true };
-    const loginRequest = jest.spyOn(api, 'loginRequest')
-      .mockImplementation(() => Promise.resolve(data));
-
-    const dispatched = [];
-    await runSaga(
-      { dispatch: (action) => dispatched.push(action) },
-      handleLoginRequest,
-      params,
-    );
-
-    expect(loginRequest).toHaveBeenCalledTimes(1);
-    expect(dispatched).toEqual([
-      actions.loginRequestBegin(),
-      actions.loginRequestSuccess(data.redirectUrl, data.success),
-    ]);
-    loginRequest.mockClear();
-  });
-
-  it('should call service and dispatch error action', async () => {
-    const loginErrorResponse = {
-      response: {
-        status: 400,
-        data: {
-          login_error: 'something went wrong',
-        },
-      },
-    };
-
-    await testErrorResponse(loginErrorResponse, loggingService.logInfo, [
-      actions.loginRequestBegin(),
-      actions.loginRequestFailure(camelCaseObject(loginErrorResponse.response.data)),
-    ]);
-  });
-
-  it('should handle rate limit error code', async () => {
-    const loginErrorResponse = {
-      response: {
-        status: 403,
-        data: {
-          errorCode: FORBIDDEN_REQUEST,
-        },
-      },
-    };
-
-    await testErrorResponse(loginErrorResponse, loggingService.logInfo, [
-      actions.loginRequestBegin(),
-      actions.loginRequestFailure(loginErrorResponse.response.data),
-    ]);
-  });
-
-  it('should handle 500 error code', async () => {
-    const loginErrorResponse = {
-      response: {
-        status: 500,
-        data: {
-          errorCode: INTERNAL_SERVER_ERROR,
-        },
-      },
-    };
-
-    await testErrorResponse(loginErrorResponse, loggingService.logError, [
-      actions.loginRequestBegin(),
-      actions.loginRequestFailure(loginErrorResponse.response.data),
-    ]);
-  });
-});

package/src/login/index.js

@@ -1,5 +0,0 @@
-export const storeName = 'login';
-
-export { default as LoginPage } from './LoginPage';
-export { default as reducer } from './data/reducers';
-export { default as saga } from './data/sagas';

package/src/login/messages.jsx

@@ -1,211 +0,0 @@
-import { defineMessages } from '@openedx/frontend-base';
-
-const messages = defineMessages({
-  'login.page.title': {
-    id: 'login.page.title',
-    defaultMessage: 'Login | {siteName}',
-    description: 'login page title',
-  },
-  // Login labels
-  'login.user.identity.label': {
-    id: 'login.user.identity.label',
-    defaultMessage: 'Username or email',
-    description: 'Label for user identity field to enter either username or email to login',
-  },
-  'login.password.label': {
-    id: 'login.password.label',
-    defaultMessage: 'Password',
-    description: 'Label for password field',
-  },
-  'sign.in.button': {
-    id: 'sign.in.button',
-    defaultMessage: 'Sign in',
-    description: 'Sign in button label that appears on login page',
-  },
-  'forgot.password': {
-    id: 'forgot.password',
-    defaultMessage: 'Forgot password',
-    description: 'Button text for forgot password',
-  },
-  'institution.login.button': {
-    id: 'institution.login.button',
-    defaultMessage: 'Institution/campus credentials',
-    description: 'shows institutions list',
-  },
-  'institution.login.page.title': {
-    id: 'institution.login.page.title',
-    defaultMessage: 'Sign in with institution/campus credentials',
-    description: 'Heading of institution page',
-  },
-  'institution.login.page.sub.heading': {
-    id: 'institution.login.page.sub.heading',
-    defaultMessage: 'Choose your institution from the list below',
-    description: 'Heading of the institutions list',
-  },
-  'non.compliant.password.title': {
-    id: 'non.compliant.password.title',
-    defaultMessage: 'We recently changed our password requirements',
-    description: 'A title that appears in bold before error message for non-compliant password',
-  },
-  'non.compliant.password.message': {
-    id: 'non.compliant.password.message',
-    defaultMessage: 'Your current password does not meet the new security requirements. '
-                    + 'We just sent a password-reset message to the email address associated with this account. '
-                    + 'Thank you for helping us keep your data safe.',
-    description: 'Error message for non-compliant password',
-  },
-  'account.locked.out.message.1': {
-    id: 'account.locked.out.message.1',
-    defaultMessage: 'To protect your account, it\'s been temporarily locked. Try again in 30 minutes.',
-    description: 'Part of message for when user account has been locked out after multiple failed login attempts',
-  },
-  'username.or.email.format.validation.less.chars.message': {
-    id: 'username.or.email.format.validation.less.chars.message',
-    defaultMessage: 'Username or email must have at least 2 characters.',
-    description: 'Validation message that appears when username or email address is less than 2 characters',
-  },
-  'email.validation.message': {
-    id: 'email.validation.message',
-    defaultMessage: 'Enter your username or email',
-    description: 'Validation message that appears when email is empty',
-  },
-  'password.validation.message': {
-    id: 'password.validation.message',
-    defaultMessage: 'Enter your password',
-    description: 'Validation message that appears when password is empty',
-  },
-  // Account Activation Strings
-  'account.activation.success.message.title': {
-    id: 'account.activation.success.message.title',
-    defaultMessage: 'Success! You have activated your account.',
-    description: 'Account Activation success message title',
-  },
-  'account.activation.success.message': {
-    id: 'account.activation.success.message',
-    defaultMessage: 'You will now receive email updates and alerts from us related to the courses you are enrolled in. Sign in to continue.',
-    description: 'Message show to learners when their account has been activated successfully',
-  },
-  'account.activation.info.message': {
-    id: 'account.activation.info.message',
-    defaultMessage: 'This account has already been activated.',
-    description: 'Message shown when learner account has already been activated',
-  },
-  'account.activation.error.message.title': {
-    id: 'account.activation.error.message.title',
-    defaultMessage: 'Your account could not be activated',
-    description: 'Account Activation error message title',
-  },
-  'account.activation.support.link': {
-    id: 'account.activation.support.link',
-    defaultMessage: 'contact support',
-    description: 'Link text used in account activation error message to go to learner help center',
-  },
-  // Email Confirmation Strings
-  'account.confirmation.success.message.title': {
-    id: 'account.confirmation.success.message.title',
-    defaultMessage: 'Success! You have confirmed your email.',
-    description: 'Account verification success message title',
-  },
-  'account.confirmation.success.message': {
-    id: 'account.confirmation.success.message',
-    defaultMessage: 'Sign in to continue.',
-    description: 'Message show to learners when their account has been activated successfully',
-  },
-  'account.confirmation.info.message': {
-    id: 'account.confirmation.info.message',
-    defaultMessage: 'This email has already been confirmed.',
-    description: 'Message shown when learner account has already been verified',
-  },
-  'account.confirmation.error.message.title': {
-    id: 'account.confirmation.error.message.title',
-    defaultMessage: 'Your email could not be confirmed',
-    description: 'Account verification error message title',
-  },
-  'tpa.account.link': {
-    id: 'tpa.account.link',
-    defaultMessage: '{provider} account',
-    description: 'Link text error message used to go to SSO when staff user try to login through password.',
-  },
-  'internal.server.error.message': {
-    id: 'internal.server.error.message',
-    defaultMessage: 'An error has occurred. Try refreshing the page, or check your internet connection.',
-    description: 'Error message that appears when server responds with 500 error code',
-  },
-  'login.rate.limit.reached.message': {
-    id: 'login.rate.limit.reached.message',
-    defaultMessage: 'Too many failed login attempts. Try again later.',
-    description: 'Error message that appears when an anonymous user has made too many failed login attempts',
-  },
-  'login.failure.header.title': {
-    id: 'login.failure.header.title',
-    defaultMessage: 'We couldn\'t sign you in.',
-    description: 'Login failure header message.',
-  },
-  'contact.support.link': {
-    id: 'contact.support.link',
-    defaultMessage: 'contact {platformName} support',
-    description: 'Link text used in inactive user error message to go to learner help center',
-  },
-  'login.incorrect.credentials.error': {
-    id: 'login.incorrect.credentials.error',
-    defaultMessage: 'The username, email, or password you entered is incorrect. Please try again.',
-    description: 'Error message for incorrect email or password',
-  },
-  'login.form.invalid.error.message': {
-    id: 'login.form.invalid.error.message',
-    defaultMessage: 'Please fill in the fields below.',
-    description: 'Login form empty input user message',
-  },
-  'login.incorrect.credentials.error.reset.link.text': {
-    id: 'login.incorrect.credentials.error.reset.link.text',
-    defaultMessage: 'reset your password',
-    description: 'Reset password link text for incorrect email or password credentials',
-  },
-  'login.incorrect.credentials.error.before.account.blocked.text': {
-    id: 'login.incorrect.credentials.error.before.account.blocked.text',
-    defaultMessage: 'click here to reset it.',
-    description: 'Reset password link text for incorrect email or password credentials before blocking account',
-  },
-  // Vulnerable password change prompt
-  'password.security.nudge.title': {
-    id: 'password.security.nudge.title',
-    defaultMessage: 'Password security',
-    description: 'Title for prompt that nudges user to change their vulnerable password',
-  },
-  'password.security.block.title': {
-    id: 'password.security.block.title',
-    defaultMessage: 'Password change required',
-    description: 'Title for prompt that asks user to change their vulnerable password',
-  },
-  'password.security.nudge.body': {
-    id: 'password.security.nudge.body',
-    defaultMessage: 'Our system detected that your password is vulnerable. '
-                    + 'We recommend you change it so that your account stays secure.',
-    description: 'Message copy for prompt that nudges user to change their vulnerable password',
-  },
-  'password.security.block.body': {
-    id: 'password.security.block.body',
-    defaultMessage: 'Our system detected that your password is vulnerable. '
-                    + 'Change your password so that your account stays secure.',
-    description: 'Message copy for prompt that asks user to change their vulnerable password',
-  },
-  'password.security.close.button': {
-    id: 'password.security.close.button',
-    defaultMessage: 'Close',
-    description: 'Button to close popup',
-  },
-  'password.security.redirect.to.reset.password.button': {
-    id: 'password.security.redirect.to.reset.password.button',
-    defaultMessage: 'Reset your password',
-    description: 'Button to redirect users to Reset Password page',
-  },
-  'login.tpa.authentication.failure': {
-    id: 'login.tpa.authentication.failure',
-    defaultMessage: 'We are sorry, you are not authorized to access {platform_name} via this channel. '
-        + 'Please contact your learning administrator or manager in order to access {platform_name}.'
-        + '{lineBreak}{lineBreak}Error Details:{lineBreak}{errorMessage}',
-    description: 'Error message third party authentication pipeline fails',
-  },
-});
-
-export default messages;