diff --git a/.env b/.env index 33da6f0904..893bd7be39 100644 --- a/.env +++ b/.env @@ -13,6 +13,7 @@ ORDER_HISTORY_URL=null REFRESH_ACCESS_TOKEN_ENDPOINT=null SEGMENT_KEY='' SITE_NAME=null +TPA_UNLINKED_ACCOUNT_PROVISION_URL='' INFO_EMAIL='' # ***** Cookies ***** USER_RETENTION_COOKIE_NAME=null diff --git a/README.rst b/README.rst index 52fc2faa29..89d0023923 100644 --- a/README.rst +++ b/README.rst @@ -112,6 +112,10 @@ The authentication micro-frontend also requires the following additional variabl - Name of MFE, this will be used by the API to get runtime configurations for the specific micro frontend. For a frontend repo `frontend-app-appName`, use `appName` as APP_ID. - ``authn`` | ``''`` + * - ``TPA_UNLINKED_ACCOUNT_PROVISION_URL`` + - URL to redirect to when the identity provided by third-party authentication is not yet linked to a platform account. This allows for redirecting to a custom sign-up flow handled by an external service to create the linked account. An empty string (the default) disables this feature. + - ``http://example.com/signup`` | ``''`` + edX-specific Environment Variables ********************************** @@ -187,4 +191,4 @@ Please see `LICENSE { const { formatMessage } = useIntl(); const tpaProvider = props.provider; - const disablePublicAccountCreation = getConfig().ALLOW_PUBLIC_ACCOUNT_CREATION === false; + const hideRegistrationLink = getConfig().ALLOW_PUBLIC_ACCOUNT_CREATION === false + || getConfig().SHOW_REGISTRATION_LINKS === false; const handleSubmit = (e, url) => { e.preventDefault(); @@ -74,7 +75,7 @@ const EnterpriseSSO = (props) => { className="w-100" onClick={(e) => handleClick(e)} > - {disablePublicAccountCreation + {hideRegistrationLink ? formatMessage(messages['enterprisetpa.login.button.text.public.account.creation.disabled']) : formatMessage(messages['enterprisetpa.login.button.text'])} diff --git a/src/config/index.js b/src/config/index.js index 5a9992190d..20992a6537 100644 --- a/src/config/index.js +++ b/src/config/index.js @@ -9,6 +9,7 @@ const configuration = { ENABLE_POST_REGISTRATION_RECOMMENDATIONS: process.env.ENABLE_POST_REGISTRATION_RECOMMENDATIONS || false, MARKETING_EMAILS_OPT_IN: process.env.MARKETING_EMAILS_OPT_IN || '', SHOW_CONFIGURABLE_EDX_FIELDS: process.env.SHOW_CONFIGURABLE_EDX_FIELDS || false, + SHOW_REGISTRATION_LINKS: process.env.SHOW_REGISTRATION_LINKS !== 'false', // Links ACTIVATION_EMAIL_SUPPORT_LINK: process.env.ACTIVATION_EMAIL_SUPPORT_LINK || null, AUTHN_PROGRESSIVE_PROFILING_SUPPORT_LINK: process.env.AUTHN_PROGRESSIVE_PROFILING_SUPPORT_LINK || null, @@ -19,6 +20,7 @@ const configuration = { SEARCH_CATALOG_URL: process.env.SEARCH_CATALOG_URL || null, TOS_AND_HONOR_CODE: process.env.TOS_AND_HONOR_CODE || null, TOS_LINK: process.env.TOS_LINK || null, + TPA_UNLINKED_ACCOUNT_PROVISION_URL: process.env.TPA_UNLINKED_ACCOUNT_PROVISION_URL || null, // Base container images BANNER_IMAGE_LARGE: process.env.BANNER_IMAGE_LARGE || '', BANNER_IMAGE_MEDIUM: process.env.BANNER_IMAGE_MEDIUM || '', diff --git a/src/login/LoginPage.jsx b/src/login/LoginPage.jsx index 52ab010182..8fed63dfda 100644 --- a/src/login/LoginPage.jsx +++ b/src/login/LoginPage.jsx @@ -310,6 +310,18 @@ class LoginPage extends React.Component { } = this.props; const { currentProvider, providers, secondaryProviders } = this.props.thirdPartyAuthContext; + const unlinkedProvisionUrl = getConfig().TPA_UNLINKED_ACCOUNT_PROVISION_URL; + + /** + * When currentProvider exists and we are in a login page, it is + * because the third-party authenticated account is not linked. + * See also ThirdPartyAuthAlert.jsx. + */ + if (currentProvider && unlinkedProvisionUrl) { + window.location.href = unlinkedProvisionUrl; + return null; + } + if (this.tpaHint) { if (thirdPartyAuthApiStatus === PENDING_STATE) { return ; diff --git a/src/login/tests/LoginPage.test.jsx b/src/login/tests/LoginPage.test.jsx index 11753df438..710a74ad46 100644 --- a/src/login/tests/LoginPage.test.jsx +++ b/src/login/tests/LoginPage.test.jsx @@ -4,6 +4,7 @@ import { Provider } from 'react-redux'; import { getConfig, mergeConfig } from '@edx/frontend-platform'; import { sendPageEvent } from '@edx/frontend-platform/analytics'; import { injectIntl, IntlProvider } from '@edx/frontend-platform/i18n'; +import { render } from '@testing-library/react'; import { mount } from 'enzyme'; import { MemoryRouter } from 'react-router-dom'; import renderer from 'react-test-renderer'; @@ -766,4 +767,50 @@ describe('LoginPage', () => { expect(store.dispatch).toHaveBeenCalledWith(loginRemovePasswordResetBanner()); }); + + it('should not redirect to provisioning URL when not configured', () => { + mergeConfig({ + TPA_UNLINKED_ACCOUNT_PROVISION_URL: '', + }); + + store = mockStore({ + ...initialState, + commonComponents: { + ...initialState.commonComponents, + thirdPartyAuthContext: { + ...initialState.commonComponents.thirdPartyAuthContext, + currentProvider: ssoProvider.name, + }, + }, + }); + + delete window.location; + window.location = { href: getConfig().BASE_URL.concat(LOGIN_PAGE) }; + + render(reduxWrapper()); + expect(window.location.href).toEqual(getConfig().BASE_URL.concat(LOGIN_PAGE)); + }); + + it('should redirect to provisioning URL on unlinked third-party auth account', () => { + mergeConfig({ + TPA_UNLINKED_ACCOUNT_PROVISION_URL: 'http://example.com/signup', + }); + + store = mockStore({ + ...initialState, + commonComponents: { + ...initialState.commonComponents, + thirdPartyAuthContext: { + ...initialState.commonComponents.thirdPartyAuthContext, + currentProvider: ssoProvider.name, + }, + }, + }); + + delete window.location; + window.location = { href: getConfig().BASE_URL.concat(LOGIN_PAGE) }; + + render(reduxWrapper()); + expect(window.location.href).toEqual('http://example.com/signup'); + }); }); diff --git a/src/logistration/Logistration.jsx b/src/logistration/Logistration.jsx index 7c6d77ff0b..5091531855 100644 --- a/src/logistration/Logistration.jsx +++ b/src/logistration/Logistration.jsx @@ -39,6 +39,7 @@ const Logistration = (props) => { const [key, setKey] = useState(''); const navigate = useNavigate(); const disablePublicAccountCreation = getConfig().ALLOW_PUBLIC_ACCOUNT_CREATION === false; + const hideRegistrationLink = getConfig().SHOW_REGISTRATION_LINKS === false; useEffect(() => { const authService = getAuthService(); @@ -116,7 +117,7 @@ const Logistration = (props) => { ) - : (!isValidTpaHint() && ( + : (!isValidTpaHint() && !hideRegistrationLink && ( @@ -126,6 +127,11 @@ const Logistration = (props) => { )}
+ {!institutionLogin && !isValidTpaHint() && hideRegistrationLink && ( +

+ {formatMessage(messages[selectedPage === LOGIN_PAGE ? 'logistration.sign.in' : 'logistration.register'])} +

+ )} {selectedPage === LOGIN_PAGE ? : ( diff --git a/src/logistration/Logistration.test.jsx b/src/logistration/Logistration.test.jsx index 886ca53313..b63735f64c 100644 --- a/src/logistration/Logistration.test.jsx +++ b/src/logistration/Logistration.test.jsx @@ -12,7 +12,7 @@ import Logistration from './Logistration'; import { clearThirdPartyAuthContextErrorMessage } from '../common-components/data/actions'; import { RenderInstitutionButton } from '../common-components/InstitutionLogistration'; import { - COMPLETE_STATE, LOGIN_PAGE, + COMPLETE_STATE, LOGIN_PAGE, REGISTER_PAGE, } from '../data/constants'; import { backupRegistrationForm } from '../register/data/actions'; @@ -111,10 +111,31 @@ describe('Logistration', () => { expect(logistration.find('#main-content').find('LoginPage').exists()).toBeTruthy(); }); + it('should render login/register headings when show registration links is disabled', () => { + mergeConfig({ + SHOW_REGISTRATION_LINKS: false, + }); + + let props = { selectedPage: LOGIN_PAGE }; + let logistration = mount(reduxWrapper()); + + // verifying sign in heading + expect(logistration.find('#main-content').find('h3').text()).toEqual('Sign in'); + + // register page is still accessible when SHOW_REGISTRATION_LINKS is false + // but it needs to be accessed directly + props = { selectedPage: REGISTER_PAGE }; + logistration = mount(reduxWrapper()); + + // verifying register heading + expect(logistration.find('#main-content').find('h3').text()).toEqual('Register'); + }); + it('should render only login page when public account creation is disabled', () => { mergeConfig({ ALLOW_PUBLIC_ACCOUNT_CREATION: false, DISABLE_ENTERPRISE_LOGIN: 'true', + SHOW_REGISTRATION_LINKS: 'true', }); store = mockStore({