import { render, screen, fireEvent, waitForElementToBeRemoved, } from '@testing-library/react' import userEvent from '@testing-library/user-event' import EmailsSection from '../../../../../../frontend/js/features/settings/components/emails-section' import { expect } from 'chai' import fetchMock from 'fetch-mock' import { UserEmailData } from '../../../../../../types/user-email' import { Affiliation } from '../../../../../../types/affiliation' import withMarkup from '../../../../helpers/with-markup' import getMeta from '@/utils/meta' const userEmailData: UserEmailData & { affiliation: Affiliation } = { affiliation: { cachedConfirmedAt: null, cachedEntitlement: null, cachedLastDayToReconfirm: null, cachedPastReconfirmDate: false, cachedReconfirmedAt: null, department: 'Art History', institution: { commonsAccount: false, writefullCommonsAccount: false, confirmed: true, id: 1, isUniversity: true, maxConfirmationMonths: null, name: 'Overleaf', ssoEnabled: false, ssoBeta: false, }, inReconfirmNotificationPeriod: false, inferred: false, licence: 'pro_plus', pastReconfirmDate: false, portal: { slug: '', templates_count: 1 }, role: 'Reader', }, email: 'baz@overleaf.com', default: false, } const institutionDomainData = [ { university: { id: 1234, ssoEnabled: true, name: 'Auto Complete University', }, hostname: 'autocomplete.edu', confirmed: true, }, ] as const function resetFetchMock() { fetchMock.reset() fetchMock.get('express:/institutions/domains', []) } describe('', function () { beforeEach(function () { Object.assign(getMeta('ol-ExposedSettings'), { hasAffiliationsFeature: true, hasSamlFeature: true, samlInitPath: 'saml/init', }) fetchMock.reset() }) afterEach(function () { resetFetchMock() }) it('renders "add another email" button', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() await screen.findByRole('button', { name: /add another email/i }) }) it('renders input', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() await fetchMock.flush(true) const button = await screen.findByRole('button', { name: /add another email/i, }) fireEvent.click(button) await screen.findByLabelText(/email/i) }) it('renders "Start adding your address" until a valid email is typed', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) fetchMock.get(`/institutions/domains?hostname=email.com&limit=1`, 200) fetchMock.get(`/institutions/domains?hostname=email&limit=1`, 200) render() await fetchMock.flush(true) const button = await screen.findByRole('button', { name: /add another email/i, }) fireEvent.click(button) const input = screen.getByLabelText(/email/i) // initially the text is displayed and the "add email" button disabled screen.getByText('Start by adding your email address.') expect( screen.getByRole('button', { name: /add new email/i, }).disabled ).to.be.true // no changes while writing the email address fireEvent.change(input, { target: { value: 'partial@email' }, }) screen.getByText('Start by adding your email address.') expect( screen.getByRole('button', { name: /add new email/i, }).disabled ).to.be.true // the text is removed when the complete email address is typed, and the "add button" is reenabled fireEvent.change(input, { target: { value: 'valid@email.com' }, }) expect(screen.queryByText('Start by adding your email address.')).to.be.null expect( screen.getByRole('button', { name: /add new email/i, }).disabled ).to.be.false }) it('renders "add new email" button', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) fireEvent.click(button) screen.getByRole('button', { name: /add new email/i }) }) it('prevent users from adding new emails when the limit is reached', async function () { const emails = [] for (let i = 0; i < 10; i++) { emails.push({ email: `bar${i}@overleaf.com` }) } fetchMock.get('/user/emails?ensureAffiliation=true', emails) render() const findByTextWithMarkup = withMarkup(screen.findByText) await findByTextWithMarkup( 'You can have a maximum of 10 email addresses on this account. To add another email address, please delete an existing one.' ) expect(screen.queryByRole('button', { name: /add another email/i })).to.not .exist }) it('adds new email address', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const addAnotherEmailBtn = await screen.findByRole( 'button', { name: /add another email/i } ) await fetchMock.flush(true) resetFetchMock() fetchMock .get('/user/emails?ensureAffiliation=true', [userEmailData]) .post('/user/emails', 200) fireEvent.click(addAnotherEmailBtn) const input = screen.getByLabelText(/email/i) fireEvent.change(input, { target: { value: userEmailData.email }, }) const submitBtn = screen.getByRole('button', { name: /add new email/i, }) expect(submitBtn.disabled).to.be.false fireEvent.click(submitBtn) expect(submitBtn.disabled).to.be.true await waitForElementToBeRemoved(() => screen.getByRole('button', { name: /add new email/i, }) ) screen.getByText(userEmailData.email) }) it('fails to add add new email address', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const addAnotherEmailBtn = await screen.findByRole( 'button', { name: /add another email/i } ) await fetchMock.flush(true) resetFetchMock() fetchMock .get('/user/emails?ensureAffiliation=true', []) .post('/user/emails', 400) fireEvent.click(addAnotherEmailBtn) const input = screen.getByLabelText(/email/i) fireEvent.change(input, { target: { value: userEmailData.email }, }) const submitBtn = screen.getByRole('button', { name: /add new email/i, }) expect(submitBtn.disabled).to.be.false fireEvent.click(submitBtn) expect(submitBtn.disabled).to.be.true await screen.findByText( /Invalid Request. Please correct the data and try again./i ) expect(submitBtn).to.not.be.null expect(submitBtn.disabled).to.be.false }) it('can link email address to an existing SSO institution', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) fetchMock.reset() fetchMock.get('express:/institutions/domains', institutionDomainData) await userEvent.click(button) const input = screen.getByLabelText(/email/i) fireEvent.change(input, { target: { value: 'user@autocomplete.edu' }, }) await screen.findByRole('button', { name: 'Link Accounts and Add Email' }) }) it('adds new email address with existing institution and custom departments', async function () { const country = 'Germany' const customDepartment = 'Custom department' fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) resetFetchMock() await userEvent.click(button) await userEvent.type(screen.getByLabelText(/email/i), userEmailData.email) await userEvent.click(screen.getByRole('button', { name: /let us know/i })) const universityInput = screen.getByRole('textbox', { name: /university/i, }) expect(universityInput.disabled).to.be.true fetchMock.get('/institutions/list?country_code=de', [ { id: userEmailData.affiliation.institution.id, name: userEmailData.affiliation.institution.name, country_code: 'de', departments: [customDepartment], }, ]) // Select the country from dropdown await userEvent.type( screen.getByRole('textbox', { name: /country/i, }), country ) await userEvent.click(screen.getByText(country)) expect(universityInput.disabled).to.be.false await fetchMock.flush(true) resetFetchMock() // Select the university from dropdown await userEvent.click(universityInput) await userEvent.click( await screen.findByText(userEmailData.affiliation.institution.name) ) const roleInput = screen.getByRole('textbox', { name: /role/i }) await userEvent.type(roleInput, userEmailData.affiliation.role!) const departmentInput = screen.getByRole('textbox', { name: /department/i }) await userEvent.click(departmentInput) await userEvent.click(screen.getByText(customDepartment)) const userEmailDataCopy = { ...userEmailData, affiliation: { ...userEmailData.affiliation, department: customDepartment, }, } fetchMock .get('/user/emails?ensureAffiliation=true', [userEmailDataCopy]) .post(/\/user\/emails/, 200) await userEvent.click( screen.getByRole('button', { name: /add new email/i, }) ) const [[, request]] = fetchMock.calls(/\/user\/emails/) expect(JSON.parse(request?.body?.toString() || '{}')).to.deep.include({ email: userEmailData.email, university: { id: userEmailData.affiliation?.institution.id, }, role: userEmailData.affiliation?.role, department: customDepartment, }) screen.getByText(userEmailData.email) screen.getByText(userEmailData.affiliation.institution.name) screen.getByText(userEmailData.affiliation.role!, { exact: false }) screen.getByText(customDepartment, { exact: false }) }) it('autocompletes institution name', async function () { fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) resetFetchMock() fetchMock.get('/institutions/list?country_code=de', [ { id: 1, name: 'University of Bonn', }, { id: 2, name: 'Bochum institute of Science', }, ]) // open "add new email" section and click "let us know" to open the Country/University form await userEvent.click(button) await userEvent.type(screen.getByLabelText(/email/i), userEmailData.email) await userEvent.click(screen.getByRole('button', { name: /let us know/i })) // select a country const countryInput = screen.getByRole('textbox', { name: /country/i, }) await userEvent.click(countryInput) await userEvent.type(countryInput, 'Germ') await userEvent.click(await screen.findByText('Germany')) // match several universities on initial typing const universityInput = screen.getByRole('textbox', { name: /university/i, }) await userEvent.click(universityInput) await userEvent.type(universityInput, 'bo') await screen.findByText('University of Bonn') await screen.findByText('Bochum institute of Science') // match a single university when typing to refine the search await userEvent.type(universityInput, 'nn') await screen.findByText('University of Bonn') expect(screen.queryByText('Bochum institute of Science')).to.be.null }) it('adds new email address without existing institution', async function () { const country = 'Germany' const countryCode = 'de' const newUniversity = 'Abcdef' fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) resetFetchMock() await userEvent.click(button) await userEvent.type(screen.getByLabelText(/email/i), userEmailData.email) await userEvent.click(screen.getByRole('button', { name: /let us know/i })) const universityInput = screen.getByRole('textbox', { name: /university/i, }) expect(universityInput.disabled).to.be.true fetchMock.get(/\/institutions\/list/, [ { id: userEmailData.affiliation.institution.id, name: userEmailData.affiliation.institution.name, country_code: 'de', departments: [], }, ]) // Select the country from dropdown await userEvent.type( screen.getByRole('textbox', { name: /country/i, }), country ) await userEvent.click(screen.getByText(country)) expect(universityInput.disabled).to.be.false await fetchMock.flush(true) resetFetchMock() // Enter the university manually await userEvent.type(universityInput, newUniversity) const roleInput = screen.getByRole('textbox', { name: /role/i }) await userEvent.type(roleInput, userEmailData.affiliation.role!) const departmentInput = screen.getByRole('textbox', { name: /department/i }) await userEvent.type(departmentInput, userEmailData.affiliation.department!) const userEmailDataCopy = { ...userEmailData, affiliation: { ...userEmailData.affiliation, institution: { ...userEmailData.affiliation.institution, name: newUniversity, }, }, } fetchMock .get('/user/emails?ensureAffiliation=true', [userEmailDataCopy]) .post(/\/user\/emails/, 200) await userEvent.click( screen.getByRole('button', { name: /add new email/i, }) ) const [[, request]] = fetchMock.calls(/\/user\/emails/) expect(JSON.parse(request?.body?.toString() || '{}')).to.deep.include({ email: userEmailData.email, university: { name: newUniversity, country_code: countryCode, }, role: userEmailData.affiliation?.role, department: userEmailData.affiliation?.department, }) screen.getByText(userEmailData.email) screen.getByText(newUniversity) screen.getByText(userEmailData.affiliation.role!, { exact: false }) screen.getByText(userEmailData.affiliation.department!, { exact: false }) }) it('shows country, university, role and department fields based on whether `change` was clicked or not', async function () { const institutionDomainDataCopy = [ { ...institutionDomainData[0], university: { ...institutionDomainData[0].university, ssoEnabled: false, }, }, ] const hostnameFirstChar = institutionDomainDataCopy[0].hostname.charAt(0) fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) fetchMock.reset() fetchMock.get( `/institutions/domains?hostname=${hostnameFirstChar}&limit=1`, institutionDomainDataCopy ) await userEvent.click(button) await userEvent.type( screen.getByLabelText(/email/i), `user@${hostnameFirstChar}` ) await userEvent.keyboard('{Tab}') await fetchMock.flush(true) fetchMock.reset() expect( screen.queryByRole('textbox', { name: /country/i, }) ).to.be.null expect( screen.queryByRole('textbox', { name: /university/i, }) ).to.be.null screen.getByRole('textbox', { name: /role/i, }) screen.getByRole('textbox', { name: /department/i, }) await userEvent.click(screen.getByRole('button', { name: /change/i })) screen.getByRole('textbox', { name: /country/i, }) screen.getByRole('textbox', { name: /university/i, }) expect( screen.queryByRole('textbox', { name: /role/i, }) ).to.be.null expect( screen.queryByRole('textbox', { name: /department/i, }) ).to.be.null }) it('displays institution name with change button when autocompleted and adds new record', async function () { const institutionDomainDataCopy = [ { ...institutionDomainData[0], university: { ...institutionDomainData[0].university, ssoEnabled: false, }, }, ] const hostnameFirstChar = institutionDomainDataCopy[0].hostname.charAt(0) fetchMock.get('/user/emails?ensureAffiliation=true', []) render() const button = await screen.findByRole('button', { name: /add another email/i, }) await fetchMock.flush(true) fetchMock.reset() fetchMock.get( `/institutions/domains?hostname=${hostnameFirstChar}&limit=1`, institutionDomainDataCopy ) await userEvent.click(button) await userEvent.type( screen.getByLabelText(/email/i), `user@${hostnameFirstChar}` ) await userEvent.keyboard('{Tab}') await fetchMock.flush(true) fetchMock.reset() screen.getByText(institutionDomainDataCopy[0].university.name) const userEmailDataCopy = { ...userEmailData, affiliation: { ...userEmailData.affiliation, institution: { ...userEmailData.affiliation.institution, name: institutionDomainDataCopy[0].university.name, }, }, } fetchMock .get('/user/emails?ensureAffiliation=true', [userEmailDataCopy]) .post('/user/emails', 200) await userEvent.type( screen.getByRole('textbox', { name: /role/i }), userEmailData.affiliation.role! ) await userEvent.type( screen.getByRole('textbox', { name: /department/i }), userEmailData.affiliation.department! ) await userEvent.click( screen.getByRole('button', { name: /add new email/i, }) ) await fetchMock.flush(true) fetchMock.reset() screen.getByText(userEmailDataCopy.affiliation.institution.name, { exact: false, }) screen.getByText(userEmailDataCopy.affiliation.role!, { exact: false }) screen.getByText(userEmailDataCopy.affiliation.department!, { exact: false, }) }) })