notifications.test.tsx 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112
  1. import { expect } from 'chai'
  2. import sinon from 'sinon'
  3. import {
  4. fireEvent,
  5. render,
  6. screen,
  7. waitForElementToBeRemoved,
  8. } from '@testing-library/react'
  9. import fetchMock from 'fetch-mock'
  10. import { merge, cloneDeep } from 'lodash'
  11. import {
  12. professionalUserData,
  13. unconfirmedUserData,
  14. untrustedUserData,
  15. unconfirmedCommonsUserData,
  16. confirmedUserData,
  17. } from '../../settings/fixtures/test-user-email-data'
  18. import {
  19. notificationDropboxDuplicateProjectNames,
  20. notificationGroupInviteDefault,
  21. notificationIPMatchedAffiliation,
  22. notificationProjectInvite,
  23. notificationTPDSFileLimit,
  24. notificationsInstitution,
  25. } from '../fixtures/notifications-data'
  26. import Common from '../../../../../frontend/js/features/project-list/components/notifications/groups/common'
  27. import Institution from '../../../../../frontend/js/features/project-list/components/notifications/groups/institution'
  28. import ConfirmEmail, {
  29. getEmailDeletionDate,
  30. } from '../../../../../frontend/js/features/project-list/components/notifications/groups/confirm-email'
  31. import ReconfirmationInfo from '../../../../../frontend/js/features/project-list/components/notifications/groups/affiliation/reconfirmation-info'
  32. import { ProjectListProvider } from '../../../../../frontend/js/features/project-list/context/project-list-context'
  33. import { SplitTestProvider } from '@/shared/context/split-test-context'
  34. import {
  35. Notification,
  36. Institution as InstitutionType,
  37. } from '../../../../../types/project/dashboard/notification'
  38. import { DeepPartial } from '../../../../../types/utils'
  39. import { Project } from '../../../../../types/project/dashboard/api'
  40. import GroupsAndEnterpriseBanner from '../../../../../frontend/js/features/project-list/components/notifications/groups-and-enterprise-banner'
  41. import GroupSsoSetupSuccess from '../../../../../frontend/js/features/project-list/components/notifications/groups/group-sso-setup-success'
  42. import localStorage from '@/infrastructure/local-storage'
  43. import { location } from '@/shared/components/location'
  44. import {
  45. commonsSubscription,
  46. freeSubscription,
  47. groupSubscription,
  48. individualSubscription,
  49. } from '../fixtures/user-subscriptions'
  50. import getMeta from '@/utils/meta'
  51. const renderWithinProjectListProvider = (
  52. Component: React.ComponentType<React.PropsWithChildren>
  53. ) => {
  54. render(<Component />, {
  55. wrapper: ({ children }) => (
  56. <ProjectListProvider>
  57. <SplitTestProvider>
  58. <ul className="list-unstyled">{children}</ul>
  59. </SplitTestProvider>
  60. </ProjectListProvider>
  61. ),
  62. })
  63. }
  64. describe('<UserNotifications />', function () {
  65. const exposedSettings = {
  66. samlInitPath: '/fakeSaml/',
  67. appName: 'Overleaf',
  68. }
  69. beforeEach(function () {
  70. fetchMock.removeRoutes().clearHistory()
  71. // at least one project is required to show some notifications
  72. const projects = [{}] as Project[]
  73. fetchMock.post(/\/api\/project/, {
  74. status: 200,
  75. body: {
  76. projects,
  77. totalSize: projects.length,
  78. },
  79. })
  80. })
  81. afterEach(function () {
  82. fetchMock.removeRoutes().clearHistory()
  83. })
  84. describe('<Common>', function () {
  85. beforeEach(function () {
  86. window.metaAttributesCache.set('ol-user', {})
  87. Object.assign(getMeta('ol-ExposedSettings'), exposedSettings)
  88. })
  89. afterEach(function () {
  90. fetchMock.removeRoutes().clearHistory()
  91. })
  92. it('accepts project invite', async function () {
  93. const reconfiguredNotification: DeepPartial<Notification> = {
  94. _id: 1,
  95. templateKey: 'notification_project_invite',
  96. }
  97. window.metaAttributesCache.set('ol-notifications', [
  98. merge(cloneDeep(notificationProjectInvite), reconfiguredNotification),
  99. ])
  100. renderWithinProjectListProvider(Common)
  101. await fetchMock.callHistory.flush(true)
  102. const deleteMock = fetchMock.delete(
  103. `/notifications/${reconfiguredNotification._id}`,
  104. 200
  105. )
  106. const acceptMock = fetchMock.post(
  107. `/project/${notificationProjectInvite.messageOpts.projectId}/invite/token/${notificationProjectInvite.messageOpts.token}/accept`,
  108. 200
  109. )
  110. screen.getByRole('alert')
  111. screen.getByText(/would like you to join/i)
  112. const joinBtn = screen.getByRole('button', {
  113. name: /join project/i,
  114. }) as HTMLButtonElement
  115. expect(joinBtn.disabled).to.be.false
  116. fireEvent.click(joinBtn)
  117. expect(joinBtn.disabled).to.be.true
  118. await waitForElementToBeRemoved(() =>
  119. screen.getByRole('button', { name: /joining/i })
  120. )
  121. expect(acceptMock.callHistory.called()).to.be.true
  122. await screen.findByText(/joined/i)
  123. expect(screen.queryByRole('button', { name: /join project/i })).to.be.null
  124. const openProject = screen.getByRole('link', { name: /open project/i })
  125. expect(openProject.getAttribute('href')).to.equal(
  126. `/project/${notificationProjectInvite.messageOpts.projectId}`
  127. )
  128. const closeBtn = screen.getByRole('button', { name: /close/i })
  129. fireEvent.click(closeBtn)
  130. expect(deleteMock.callHistory.called()).to.be.true
  131. expect(screen.queryByRole('alert')).to.be.null
  132. })
  133. it('fails to accept project invite', async function () {
  134. const reconfiguredNotification: DeepPartial<Notification> = {
  135. _id: 1,
  136. templateKey: 'notification_project_invite',
  137. }
  138. window.metaAttributesCache.set('ol-notifications', [
  139. merge(cloneDeep(notificationProjectInvite), reconfiguredNotification),
  140. ])
  141. renderWithinProjectListProvider(Common)
  142. await fetchMock.callHistory.flush(true)
  143. fetchMock.post(
  144. `/project/${notificationProjectInvite.messageOpts.projectId}/invite/token/${notificationProjectInvite.messageOpts.token}/accept`,
  145. 500
  146. )
  147. screen.getByRole('alert')
  148. screen.getByText(/would like you to join/i)
  149. const joinBtn = screen.getByRole('button', {
  150. name: /join project/i,
  151. }) as HTMLButtonElement
  152. fireEvent.click(joinBtn)
  153. await waitForElementToBeRemoved(() =>
  154. screen.getByRole('button', { name: /joining/i })
  155. )
  156. expect(fetchMock.callHistory.called()).to.be.true
  157. screen.getByRole('button', { name: /join project/i })
  158. expect(screen.queryByRole('button', { name: /open project/i })).to.be.null
  159. })
  160. it('shows WFH2020', async function () {
  161. const reconfiguredNotification: DeepPartial<Notification> = {
  162. _id: 1,
  163. templateKey: 'wfh_2020_upgrade_offer',
  164. }
  165. window.metaAttributesCache.set('ol-notifications', [
  166. merge(reconfiguredNotification),
  167. ])
  168. renderWithinProjectListProvider(Common)
  169. await fetchMock.callHistory.flush(true)
  170. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  171. screen.getByRole('alert')
  172. screen.getByText(/your free WFH2020 upgrade came to an end on/i)
  173. const viewLink = screen.getByRole('link', { name: /view/i })
  174. expect(viewLink.getAttribute('href')).to.equal(
  175. 'https://www.overleaf.com/events/wfh2020'
  176. )
  177. const closeBtn = screen.getByRole('button', { name: /close/i })
  178. fireEvent.click(closeBtn)
  179. expect(fetchMock.callHistory.called()).to.be.true
  180. expect(screen.queryByRole('alert')).to.be.null
  181. })
  182. it('shows IP matched affiliation with SSO enabled', async function () {
  183. const reconfiguredNotification: DeepPartial<Notification> = {
  184. _id: 1,
  185. templateKey: 'notification_ip_matched_affiliation',
  186. messageOpts: { ssoEnabled: true },
  187. }
  188. window.metaAttributesCache.set('ol-notifications', [
  189. merge(
  190. cloneDeep(notificationIPMatchedAffiliation),
  191. reconfiguredNotification
  192. ),
  193. ])
  194. renderWithinProjectListProvider(Common)
  195. await fetchMock.callHistory.flush(true)
  196. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  197. screen.getByRole('alert')
  198. screen.getByText(/it looks like you’re at/i)
  199. screen.getByText(/you can now log in through your institution/i)
  200. screen.getByText(
  201. /link an institutional email address to your account to get started/i
  202. )
  203. const findOutMore = screen.getByRole('link', { name: /find out more/i })
  204. expect(findOutMore.getAttribute('href')).to.equal(
  205. 'https://www.overleaf.com/learn/how-to/Institutional_Login'
  206. )
  207. const linkAccount = screen.getByRole('link', { name: /link account/i })
  208. expect(linkAccount.getAttribute('href')).to.equal(
  209. `${exposedSettings.samlInitPath}?university_id=${notificationIPMatchedAffiliation.messageOpts.institutionId}&auto=/project`
  210. )
  211. const closeBtn = screen.getByRole('button', { name: /close/i })
  212. fireEvent.click(closeBtn)
  213. expect(fetchMock.callHistory.called()).to.be.true
  214. expect(screen.queryByRole('alert')).to.be.null
  215. })
  216. it('shows IP matched affiliation with SSO disabled', async function () {
  217. const reconfiguredNotification: DeepPartial<Notification> = {
  218. _id: 1,
  219. templateKey: 'notification_ip_matched_affiliation',
  220. messageOpts: { ssoEnabled: false },
  221. }
  222. window.metaAttributesCache.set('ol-notifications', [
  223. merge(
  224. cloneDeep(notificationIPMatchedAffiliation),
  225. reconfiguredNotification
  226. ),
  227. ])
  228. renderWithinProjectListProvider(Common)
  229. await fetchMock.callHistory.flush(true)
  230. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  231. screen.getByRole('alert')
  232. screen.getByText(/it looks like you’re at/i)
  233. screen.getByText(/did you know that/i)
  234. screen.getByText(
  235. /add an institutional email address to claim your features/i
  236. )
  237. const addAffiliation = screen.getByRole('link', {
  238. name: /add affiliation/i,
  239. })
  240. expect(addAffiliation.getAttribute('href')).to.equal(`/user/settings`)
  241. const closeBtn = screen.getByRole('button', { name: /close/i })
  242. fireEvent.click(closeBtn)
  243. expect(fetchMock.callHistory.called()).to.be.true
  244. expect(screen.queryByRole('alert')).to.be.null
  245. })
  246. it('shows tpds file limit', async function () {
  247. const reconfiguredNotification: DeepPartial<Notification> = {
  248. templateKey: 'notification_tpds_file_limit',
  249. }
  250. window.metaAttributesCache.set('ol-notifications', [
  251. merge(cloneDeep(notificationTPDSFileLimit), reconfiguredNotification),
  252. ])
  253. renderWithinProjectListProvider(Common)
  254. await fetchMock.callHistory.flush(true)
  255. screen.getByRole('alert')
  256. screen.getByText(/file limit/i)
  257. screen.getByText(/You can't add more files to the project or sync it/i)
  258. const accountSettings = screen.getByRole('link', {
  259. name: /Open project/i,
  260. })
  261. expect(accountSettings.getAttribute('href')).to.equal('/project/123')
  262. const closeBtn = screen.getByRole('button', { name: /close/i })
  263. fireEvent.click(closeBtn)
  264. expect(screen.queryByRole('alert')).to.be.null
  265. })
  266. it('shows dropbox duplicate project names warning', async function () {
  267. const reconfiguredNotification: DeepPartial<Notification> = {
  268. _id: 1,
  269. templateKey: 'notification_dropbox_duplicate_project_names',
  270. }
  271. window.metaAttributesCache.set('ol-notifications', [
  272. merge(
  273. cloneDeep(notificationDropboxDuplicateProjectNames),
  274. reconfiguredNotification
  275. ),
  276. ])
  277. renderWithinProjectListProvider(Common)
  278. await fetchMock.callHistory.flush(true)
  279. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  280. screen.getByRole('alert')
  281. screen.getByText(/you have more than one project called/i)
  282. screen.getByText(/make your project names unique/i)
  283. const learnMore = screen.getByRole('link', { name: /learn more/i })
  284. expect(learnMore.getAttribute('href')).to.equal(
  285. '/learn/how-to/Dropbox_Synchronization#Troubleshooting'
  286. )
  287. const closeBtn = screen.getByRole('button', { name: /close/i })
  288. fireEvent.click(closeBtn)
  289. expect(fetchMock.callHistory.called()).to.be.true
  290. expect(screen.queryByRole('alert')).to.be.null
  291. })
  292. it('shows dropbox unlinked tue to lapsed reconfirmation', async function () {
  293. const reconfiguredNotification: DeepPartial<Notification> = {
  294. _id: 1,
  295. templateKey:
  296. 'notification_dropbox_unlinked_due_to_lapsed_reconfirmation',
  297. }
  298. window.metaAttributesCache.set('ol-notifications', [
  299. merge(
  300. cloneDeep(notificationDropboxDuplicateProjectNames),
  301. reconfiguredNotification
  302. ),
  303. ])
  304. renderWithinProjectListProvider(Common)
  305. await fetchMock.callHistory.flush(true)
  306. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  307. screen.getByRole('alert')
  308. screen.getByText(/your Dropbox account has been unlinked/i)
  309. screen.getByText(
  310. /confirm you are still at the institution and on their license, or upgrade your account in order to relink your dropbox account/i
  311. )
  312. const learnMore = screen.getByRole('link', { name: /learn more/i })
  313. expect(learnMore.getAttribute('href')).to.equal(
  314. '/learn/how-to/Institutional_Email_Reconfirmation'
  315. )
  316. const closeBtn = screen.getByRole('button', { name: /close/i })
  317. fireEvent.click(closeBtn)
  318. expect(fetchMock.callHistory.called()).to.be.true
  319. expect(screen.queryByRole('alert')).to.be.null
  320. })
  321. it('shows non specific notification', async function () {
  322. const reconfiguredNotification: DeepPartial<Notification> = {
  323. _id: 1,
  324. html: 'unspecific message',
  325. }
  326. window.metaAttributesCache.set('ol-notifications', [
  327. reconfiguredNotification,
  328. ])
  329. renderWithinProjectListProvider(Common)
  330. await fetchMock.callHistory.flush(true)
  331. fetchMock.delete(`/notifications/${reconfiguredNotification._id}`, 200)
  332. screen.getByRole('alert')
  333. screen.getByText(reconfiguredNotification.html!)
  334. const closeBtn = screen.getByRole('button', { name: /close/i })
  335. fireEvent.click(closeBtn)
  336. expect(fetchMock.callHistory.called()).to.be.true
  337. expect(screen.queryByRole('alert')).to.be.null
  338. })
  339. describe('<GroupInvitation />', function () {
  340. describe('without existing personal subscription', function () {
  341. it('shows group invitation notification for user without personal subscription', async function () {
  342. const notificationGroupInvite: DeepPartial<Notification> = {
  343. _id: 1,
  344. templateKey: 'notification_group_invitation',
  345. }
  346. window.metaAttributesCache.set('ol-notifications', [
  347. merge(
  348. cloneDeep(notificationGroupInviteDefault),
  349. notificationGroupInvite
  350. ),
  351. ])
  352. renderWithinProjectListProvider(Common)
  353. await fetchMock.callHistory.flush(true)
  354. fetchMock.delete(`/notifications/${notificationGroupInvite._id}`, 200)
  355. screen.getByRole('alert')
  356. screen.getByText('inviter@overleaf.com')
  357. screen.getByText(
  358. /has invited you to join a group subscription on Overleaf/
  359. )
  360. screen.getByRole('button', { name: 'Join now' })
  361. screen.getByRole('button', { name: /close/i })
  362. })
  363. describe('with existing personal subscription', function () {
  364. it('shows group invitation notification for user with personal subscription', async function () {
  365. const notificationGroupInvite: DeepPartial<Notification> = {
  366. _id: 1,
  367. templateKey: 'notification_group_invitation',
  368. }
  369. window.metaAttributesCache.set('ol-notifications', [
  370. merge(
  371. cloneDeep(notificationGroupInviteDefault),
  372. notificationGroupInvite
  373. ),
  374. ])
  375. window.metaAttributesCache.set(
  376. 'ol-hasIndividualPaidSubscription',
  377. true
  378. )
  379. renderWithinProjectListProvider(Common)
  380. await fetchMock.callHistory.flush(true)
  381. fetchMock.delete(
  382. `/notifications/${notificationGroupInvite._id}`,
  383. 200
  384. )
  385. screen.getByRole('alert')
  386. screen.getByText(
  387. /inviter@overleaf.com has invited you to join a group Overleaf subscription. If you join this group, you may not need your individual subscription. Would you like to cancel it/
  388. )
  389. screen.getByRole('button', { name: 'Not now' })
  390. screen.getByRole('button', { name: 'Cancel my subscription' })
  391. })
  392. })
  393. })
  394. })
  395. })
  396. describe('<Institution>', function () {
  397. beforeEach(function () {
  398. Object.assign(getMeta('ol-ExposedSettings'), exposedSettings)
  399. fetchMock.removeRoutes().clearHistory()
  400. })
  401. afterEach(function () {
  402. fetchMock.removeRoutes().clearHistory()
  403. })
  404. it('shows sso available', function () {
  405. const institution: DeepPartial<InstitutionType> = {
  406. templateKey: 'notification_institution_sso_available',
  407. }
  408. window.metaAttributesCache.set('ol-notificationsInstitution', [
  409. { ...notificationsInstitution, ...institution },
  410. ])
  411. render(<Institution />)
  412. screen.getByRole('alert')
  413. screen.getByText(/you can now link/i)
  414. screen.getByText(/doing this will allow you to log in/i)
  415. const learnMore = screen.getByRole('link', { name: /learn more/i })
  416. expect(learnMore.getAttribute('href')).to.equal(
  417. '/learn/how-to/Institutional_Login'
  418. )
  419. const action = screen.getByRole('link', { name: /link account/i })
  420. expect(action.getAttribute('href')).to.equal(
  421. `${exposedSettings.samlInitPath}?university_id=${notificationsInstitution.institutionId}&auto=/project&email=${notificationsInstitution.email}`
  422. )
  423. })
  424. it('shows sso linked', function () {
  425. const institution: DeepPartial<InstitutionType> = {
  426. _id: 1,
  427. templateKey: 'notification_institution_sso_linked',
  428. }
  429. window.metaAttributesCache.set('ol-notificationsInstitution', [
  430. { ...notificationsInstitution, ...institution },
  431. ])
  432. render(<Institution />)
  433. fetchMock.delete(`/notifications/${institution._id}`, 200)
  434. const notificationEl = screen.getByRole('alert')
  435. expect(notificationEl.textContent).to.match(
  436. new RegExp(
  437. `your Overleaf account on ${notificationsInstitution.email} ` +
  438. `has been linked to your ${notificationsInstitution.institutionName} ` +
  439. `institutional account.`,
  440. 'i'
  441. )
  442. )
  443. const closeBtn = screen.getByRole('button', { name: /close/i })
  444. fireEvent.click(closeBtn)
  445. expect(fetchMock.callHistory.called()).to.be.true
  446. expect(screen.queryByRole('alert')).to.be.null
  447. })
  448. it('shows sso linked to group with domain capture enabled', function () {
  449. const institution: DeepPartial<InstitutionType> = {
  450. _id: 1,
  451. templateKey: 'notification_group_sso_linked',
  452. }
  453. window.metaAttributesCache.set('ol-notificationsInstitution', [
  454. { ...notificationsInstitution, ...institution },
  455. ])
  456. render(<Institution />)
  457. fetchMock.delete(`/notifications/${institution._id}`, 200)
  458. const notificationEl = screen.getByRole('alert')
  459. expect(notificationEl.textContent).to.match(
  460. new RegExp(
  461. `your Overleaf account on ${notificationsInstitution.email} ` +
  462. `has been linked to your ${notificationsInstitution.institutionName} ` +
  463. `account.`,
  464. 'i'
  465. )
  466. )
  467. const closeBtn = screen.getByRole('button', { name: /close/i })
  468. fireEvent.click(closeBtn)
  469. expect(fetchMock.callHistory.called()).to.be.true
  470. expect(screen.queryByRole('alert')).to.be.null
  471. })
  472. it('shows sso non canonical', function () {
  473. const institution: DeepPartial<InstitutionType> = {
  474. _id: 1,
  475. templateKey: 'notification_institution_sso_non_canonical',
  476. }
  477. window.metaAttributesCache.set('ol-notificationsInstitution', [
  478. { ...notificationsInstitution, ...institution },
  479. ])
  480. render(<Institution />)
  481. fetchMock.delete(`/notifications/${institution._id}`, 200)
  482. screen.getByRole('alert')
  483. screen.getByText(/you’ve tried to log in with/i)
  484. screen.getByText(
  485. /in order to match your institutional metadata, your account is associated with/i
  486. )
  487. const closeBtn = screen.getByRole('button', { name: /close/i })
  488. fireEvent.click(closeBtn)
  489. expect(fetchMock.callHistory.called()).to.be.true
  490. expect(screen.queryByRole('alert')).to.be.null
  491. })
  492. it('shows sso already registered', function () {
  493. const institution: DeepPartial<InstitutionType> = {
  494. _id: 1,
  495. templateKey: 'notification_institution_sso_already_registered',
  496. }
  497. window.metaAttributesCache.set('ol-notificationsInstitution', [
  498. { ...notificationsInstitution, ...institution },
  499. ])
  500. render(<Institution />)
  501. fetchMock.delete(`/notifications/${institution._id}`, 200)
  502. screen.getByRole('alert')
  503. screen.getByText(/which is already registered with/i)
  504. const action = screen.getByRole('link', { name: /find out more/i })
  505. expect(action.getAttribute('href')).to.equal(
  506. '/learn/how-to/Institutional_Login'
  507. )
  508. const closeBtn = screen.getByRole('button', { name: /close/i })
  509. fireEvent.click(closeBtn)
  510. expect(fetchMock.callHistory.called()).to.be.true
  511. expect(screen.queryByRole('alert')).to.be.null
  512. })
  513. it('shows sso error', function () {
  514. const institution: DeepPartial<InstitutionType> = {
  515. templateKey: 'notification_institution_sso_error',
  516. error: {
  517. message: 'fake message',
  518. tryAgain: true,
  519. },
  520. }
  521. window.metaAttributesCache.set('ol-notificationsInstitution', [
  522. { ...notificationsInstitution, ...institution },
  523. ])
  524. render(<Institution />)
  525. screen.getByRole('alert')
  526. screen.getByText(/something went wrong/i)
  527. screen.getByText(institution.error!.message!)
  528. screen.getByText(/please try again/i)
  529. const closeBtn = screen.getByRole('button', { name: /close/i })
  530. fireEvent.click(closeBtn)
  531. expect(screen.queryByRole('alert')).to.be.null
  532. })
  533. })
  534. describe('getEmailDeletionDate', function () {
  535. beforeEach(async function () {
  536. window.metaAttributesCache.set('ol-userEmails', [
  537. confirmedUserData,
  538. untrustedUserData,
  539. ])
  540. this.clock = sinon.useFakeTimers(new Date('2025-07-01').getTime())
  541. })
  542. afterEach(function () {
  543. this.clock.restore()
  544. })
  545. it('returns deletion date for unconfirmed email within notification window', function () {
  546. window.metaAttributesCache.set('ol-userEmails', [unconfirmedUserData])
  547. const signUpDate = '2022-01-01' // Before cutoff '2025-03-03'
  548. const emailDeletionDate = getEmailDeletionDate(
  549. unconfirmedUserData,
  550. signUpDate
  551. )
  552. const dateOptions: Intl.DateTimeFormatOptions = {
  553. month: 'long',
  554. day: 'numeric',
  555. year: 'numeric',
  556. }
  557. expect(emailDeletionDate).to.equal(
  558. new Date('2025-09-03').toLocaleDateString(undefined, dateOptions)
  559. )
  560. })
  561. it('returns false for primary email', function () {
  562. const primaryUserData = { ...unconfirmedUserData, default: true }
  563. const signUpDate = '2022-01-01'
  564. const emailDeletionDate = getEmailDeletionDate(
  565. primaryUserData,
  566. signUpDate
  567. )
  568. expect(emailDeletionDate).to.be.false
  569. })
  570. it('returns false for already confirmed email', function () {
  571. window.metaAttributesCache.set('ol-userEmails', [confirmedUserData])
  572. const signUpDate = '2022-01-01'
  573. const emailDeletionDate = getEmailDeletionDate(
  574. confirmedUserData,
  575. signUpDate
  576. )
  577. expect(emailDeletionDate).to.be.false
  578. })
  579. })
  580. describe('<ConfirmEmail/>', function () {
  581. beforeEach(async function () {
  582. Object.assign(getMeta('ol-ExposedSettings'), {
  583. emailConfirmationDisabled: false,
  584. })
  585. window.metaAttributesCache.set('ol-userEmails', [
  586. confirmedUserData,
  587. untrustedUserData,
  588. ])
  589. window.metaAttributesCache.set(
  590. 'ol-usersBestSubscription',
  591. freeSubscription
  592. )
  593. window.metaAttributesCache.set('ol-user', {
  594. signUpDate: new Date('2024-01-01').toISOString(),
  595. })
  596. })
  597. afterEach(function () {
  598. fetchMock.removeRoutes().clearHistory()
  599. })
  600. function testUnconfirmedNotification(
  601. userEmails: any[],
  602. isPrimary: boolean
  603. ) {
  604. it(`sends unconfirmed notification email successfully when email is ${isPrimary ? 'primary' : 'secondary'}`, async function () {
  605. window.metaAttributesCache.set('ol-userEmails', userEmails)
  606. renderWithinProjectListProvider(ConfirmEmail)
  607. await fetchMock.callHistory.flush(true)
  608. fetchMock.post('/user/emails/send-confirmation-code', 200)
  609. const email = userEmails[0].email
  610. const alert = await screen.findByRole('alert')
  611. if (isPrimary) {
  612. expect(alert.textContent).to.contain(
  613. `Please confirm your primary email address ${email}. To edit it, go to `
  614. )
  615. } else {
  616. expect(alert.textContent).to.contain(
  617. `Please confirm your secondary email address ${email}. To edit it, go to `
  618. )
  619. }
  620. expect(
  621. screen
  622. .getByRole('button', { name: 'Send confirmation code' })
  623. .classList.contains('button-loading')
  624. ).to.be.false
  625. expect(screen.queryByRole('dialog')).to.be.null
  626. const sendCodeButton = await screen.findByRole('button', {
  627. name: 'Send confirmation code',
  628. })
  629. fireEvent.click(sendCodeButton)
  630. await screen.findByRole('dialog')
  631. expect(fetchMock.callHistory.called()).to.be.true
  632. })
  633. }
  634. testUnconfirmedNotification(
  635. [{ email: 'baz@overleaf.com', default: true }],
  636. true
  637. )
  638. testUnconfirmedNotification(
  639. [{ email: 'baz@overleaf.com', default: false }],
  640. false
  641. )
  642. it('sends untrusted notification email successfully', async function () {
  643. window.metaAttributesCache.set('ol-userEmails', [untrustedUserData])
  644. renderWithinProjectListProvider(ConfirmEmail)
  645. await fetchMock.callHistory.flush(true)
  646. fetchMock.post('/user/emails/send-confirmation-code', 200)
  647. const email = untrustedUserData.email
  648. const alert = await screen.findByRole('alert')
  649. expect(alert.textContent).to.contain(
  650. `To enhance the security of your Overleaf account, please reconfirm your secondary email address ${email}.`
  651. )
  652. const resendButton = screen.getByRole('button', {
  653. name: 'Send confirmation code',
  654. })
  655. fireEvent.click(resendButton)
  656. await screen.findByRole('dialog')
  657. expect(fetchMock.callHistory.called()).to.be.true
  658. })
  659. it('fails to send', async function () {
  660. window.metaAttributesCache.set('ol-userEmails', [unconfirmedUserData])
  661. renderWithinProjectListProvider(ConfirmEmail)
  662. await fetchMock.callHistory.flush(true)
  663. fetchMock.post('/user/emails/send-confirmation-code', 500)
  664. const resendButtons = await screen.findAllByRole('button', {
  665. name: 'Send confirmation code',
  666. })
  667. const resendButton = resendButtons[0]
  668. fireEvent.click(resendButton)
  669. await screen.findByRole('dialog')
  670. expect(fetchMock.callHistory.called()).to.be.true
  671. screen.getByText(/something went wrong/i)
  672. })
  673. for (const subscription of [freeSubscription, individualSubscription]) {
  674. it(`shows commons notification for commons account when user is on ${subscription.type} plan`, async function () {
  675. window.metaAttributesCache.set('ol-userEmails', [
  676. unconfirmedCommonsUserData,
  677. ])
  678. window.metaAttributesCache.set('ol-usersBestSubscription', subscription)
  679. renderWithinProjectListProvider(ConfirmEmail)
  680. await fetchMock.callHistory.flush(true)
  681. const alert = await screen.findByRole('alert')
  682. const email = unconfirmedCommonsUserData.email
  683. expect(alert.textContent).to.contain(
  684. 'You are one step away from accessing Overleaf Professional features'
  685. )
  686. expect(alert.textContent).to.contain(
  687. `Overleaf has an Overleaf subscription. Click the confirmation link sent to ${email} to upgrade to Overleaf Professional`
  688. )
  689. })
  690. }
  691. for (const subscription of [groupSubscription, commonsSubscription]) {
  692. it(`shows default notification for commons account when user is on ${subscription.type} plan`, async function () {
  693. window.metaAttributesCache.set('ol-userEmails', [
  694. unconfirmedCommonsUserData,
  695. ])
  696. window.metaAttributesCache.set('ol-usersBestSubscription', subscription)
  697. renderWithinProjectListProvider(ConfirmEmail)
  698. await fetchMock.callHistory.flush(true)
  699. const alert = await screen.findByRole('alert')
  700. const email = unconfirmedCommonsUserData.email
  701. const isPrimary = unconfirmedCommonsUserData.default
  702. if (isPrimary) {
  703. expect(alert.textContent).to.contain(
  704. `Please confirm your primary email address ${email}.`
  705. )
  706. } else {
  707. expect(alert.textContent).to.contain(
  708. `Please confirm your secondary email address ${email}.`
  709. )
  710. }
  711. })
  712. }
  713. })
  714. describe('<Affiliation/>', function () {
  715. beforeEach(function () {
  716. Object.assign(getMeta('ol-ExposedSettings'), exposedSettings)
  717. this.locationWrapperSandbox = sinon.createSandbox()
  718. this.locationWrapperStub = this.locationWrapperSandbox.stub(location)
  719. fetchMock.removeRoutes().clearHistory()
  720. })
  721. afterEach(function () {
  722. this.locationWrapperSandbox.restore()
  723. fetchMock.removeRoutes().clearHistory()
  724. })
  725. it('shows reconfirm message with SSO disabled', async function () {
  726. window.metaAttributesCache.set('ol-allInReconfirmNotificationPeriods', [
  727. { ...professionalUserData, samlProviderId: 'Saml Provider' },
  728. ])
  729. render(<ReconfirmationInfo />)
  730. screen.getByRole('alert')
  731. screen.getByText(
  732. /take a moment to confirm your institutional email address/i
  733. )
  734. const removeLink = screen.getByRole('link', { name: /remove it/i })
  735. expect(removeLink.getAttribute('href')).to.equal(
  736. `/user/settings?remove=${professionalUserData.email}`
  737. )
  738. const learnMore = screen.getByRole('link', { name: /learn more/i })
  739. expect(learnMore.getAttribute('href')).to.equal(
  740. '/learn/how-to/Institutional_Email_Reconfirmation'
  741. )
  742. const sendReconfirmationMock = fetchMock.post(
  743. '/user/emails/send-confirmation-code',
  744. 200
  745. )
  746. fireEvent.click(
  747. screen.getByRole('button', { name: 'Send confirmation code' })
  748. )
  749. await waitForElementToBeRemoved(() => screen.getByText(/sending/i))
  750. // Sometimes we need to wait for useWaitForI18n to be ready
  751. await screen.findByText(
  752. /Enter the 6-digit code sent to foo@overleaf.com/i
  753. )
  754. expect(sendReconfirmationMock.callHistory.called()).to.be.true
  755. fireEvent.click(
  756. screen.getByRole('button', { name: /resend confirmation code/i })
  757. )
  758. await waitForElementToBeRemoved(() =>
  759. screen.getByText('Resending confirmation code')
  760. )
  761. expect(sendReconfirmationMock.callHistory.calls()).to.have.lengthOf(2)
  762. })
  763. it('shows reconfirm message with SSO enabled', async function () {
  764. window.metaAttributesCache.set('ol-allInReconfirmNotificationPeriods', [
  765. merge(cloneDeep(professionalUserData), {
  766. affiliation: { institution: { ssoEnabled: true } },
  767. }),
  768. ])
  769. render(<ReconfirmationInfo />)
  770. fireEvent.click(
  771. screen.getByRole('button', { name: /confirm affiliation/i })
  772. )
  773. sinon.assert.calledOnce(this.locationWrapperStub.assign)
  774. sinon.assert.calledWithMatch(
  775. this.locationWrapperStub.assign,
  776. `${exposedSettings.samlInitPath}?university_id=${professionalUserData.affiliation.institution.id}&reconfirm=/project`
  777. )
  778. })
  779. it('shows success reconfirmation message', function () {
  780. window.metaAttributesCache.set('ol-userEmails', [
  781. { ...professionalUserData, samlProviderId: 'Saml Provider' },
  782. ])
  783. window.metaAttributesCache.set('ol-reconfirmedViaSAML', 'Saml Provider')
  784. const { rerender } = render(<ReconfirmationInfo />)
  785. screen.getByRole('alert')
  786. screen.getByText(professionalUserData.affiliation!.institution!.name!)
  787. screen.getByText(/affiliation is confirmed/i)
  788. window.metaAttributesCache.set('ol-reconfirmedViaSAML', '')
  789. rerender(<ReconfirmationInfo />)
  790. expect(screen.queryByRole('alert')).to.be.null
  791. })
  792. })
  793. describe('<GroupsAndEnterpriseBanner />', function () {
  794. beforeEach(function () {
  795. localStorage.clear()
  796. fetchMock.removeRoutes().clearHistory()
  797. // at least one project is required to show some notifications
  798. const projects = [{}] as Project[]
  799. fetchMock.post(/\/api\/project/, {
  800. status: 200,
  801. body: {
  802. projects,
  803. totalSize: projects.length,
  804. },
  805. })
  806. window.metaAttributesCache.set(
  807. 'ol-groupsAndEnterpriseBannerVariant',
  808. 'on-premise'
  809. )
  810. window.metaAttributesCache.set('ol-inactiveTutorials', '[]')
  811. })
  812. afterEach(function () {
  813. fetchMock.removeRoutes().clearHistory()
  814. })
  815. it('does not show the banner for users that are in group or are affiliated', async function () {
  816. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', false)
  817. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  818. await fetchMock.callHistory.flush(true)
  819. expect(screen.queryByRole('link', { name: 'Contact sales' })).to.be.null
  820. })
  821. it('shows the banner for users that have dismissed the previous banners', async function () {
  822. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', true)
  823. localStorage.setItem('has_dismissed_groups_and_enterprise_banner', true)
  824. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  825. await fetchMock.callHistory.flush(true)
  826. await screen.findByRole('link', { name: 'Contact sales' })
  827. })
  828. it('does not show the banner for users that have dismissed the banner within the last 30 days and before server-side state', async function () {
  829. const dismissed = new Date()
  830. dismissed.setDate(dismissed.getDate() - 29) // 29 days
  831. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', true)
  832. localStorage.setItem(
  833. 'has_dismissed_groups_and_enterprise_banner',
  834. dismissed
  835. )
  836. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  837. await fetchMock.callHistory.flush(true)
  838. expect(screen.queryByRole('link', { name: 'Contact sales' })).to.be.null
  839. })
  840. it('shows the banner for users who have not dismissed the repeat appearance', async function () {
  841. window.metaAttributesCache.set(
  842. 'ol-inactiveTutorials',
  843. '["groups-enterprise-banner"]'
  844. )
  845. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', true)
  846. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  847. await fetchMock.callHistory.flush(true)
  848. expect(screen.queryByRole('link', { name: 'Contact sales' })).to.be.null
  849. })
  850. it('does not show the banner for users with both inactive tutorials', async function () {
  851. window.metaAttributesCache.set(
  852. 'ol-inactiveTutorials',
  853. '["groups-enterprise-banner", "groups-enterprise-banner-repeat"]'
  854. )
  855. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', true)
  856. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  857. await fetchMock.callHistory.flush(true)
  858. expect(screen.queryByRole('link', { name: 'Contact sales' })).to.be.null
  859. })
  860. describe('users that are not in group and are not affiliated', function () {
  861. beforeEach(function () {
  862. localStorage.clear()
  863. fetchMock.removeRoutes().clearHistory()
  864. // at least one project is required to show some notifications
  865. const projects = [{}] as Project[]
  866. fetchMock.post(/\/api\/project/, {
  867. status: 200,
  868. body: {
  869. projects,
  870. totalSize: projects.length,
  871. },
  872. })
  873. window.metaAttributesCache.set('ol-showGroupsAndEnterpriseBanner', true)
  874. })
  875. afterEach(function () {
  876. fetchMock.removeRoutes().clearHistory()
  877. })
  878. after(function () {
  879. localStorage.clear()
  880. })
  881. it('will show the correct text for the `on-premise` variant', async function () {
  882. window.metaAttributesCache.set(
  883. 'ol-groupsAndEnterpriseBannerVariant',
  884. 'on-premise'
  885. )
  886. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  887. await fetchMock.callHistory.flush(true)
  888. await screen.findByText(
  889. 'Overleaf On-Premises: Does your company want to keep its data within its firewall? Overleaf offers Server Pro, an on-premises solution for companies. Get in touch to learn more.'
  890. )
  891. const link = screen.getByRole('link', { name: 'Contact sales' })
  892. expect(link.getAttribute('href')).to.equal(`/for/contact-sales-2`)
  893. })
  894. it('will show the correct text for the `FOMO` variant', async function () {
  895. window.metaAttributesCache.set(
  896. 'ol-groupsAndEnterpriseBannerVariant',
  897. 'FOMO'
  898. )
  899. renderWithinProjectListProvider(GroupsAndEnterpriseBanner)
  900. await fetchMock.callHistory.flush(true)
  901. await screen.findByText(
  902. 'Why do Fortune 500 companies and top research institutions trust Overleaf to streamline their collaboration? Get in touch to learn more.'
  903. )
  904. const link = screen.getByRole('link', { name: 'Contact sales' })
  905. expect(link.getAttribute('href')).to.equal(`/for/contact-sales-4`)
  906. })
  907. })
  908. })
  909. describe('GroupSsoSetupSuccess', function () {
  910. it('shows group SSO linked notification', function () {
  911. window.metaAttributesCache.set('ol-groupSsoSetupSuccess', true)
  912. renderWithinProjectListProvider(GroupSsoSetupSuccess)
  913. screen.getByText('Success! Single sign-on is all set up for you.')
  914. })
  915. it('does not show group SSO linked notification', function () {
  916. window.metaAttributesCache.set('ol-groupSsoSetupSuccess', false)
  917. renderWithinProjectListProvider(GroupSsoSetupSuccess)
  918. expect(
  919. screen.queryByText('Success! Single sign-on is all set up for you.')
  920. ).to.be.null
  921. })
  922. it('shows group SSO linked notification when joining via domain capture', function () {
  923. const groupName = 'Group Name'
  924. window.metaAttributesCache.set('ol-groupSsoSetupSuccess', true)
  925. window.metaAttributesCache.set('ol-viaDomainCapture', true)
  926. window.metaAttributesCache.set('ol-joinedGroupName', groupName)
  927. renderWithinProjectListProvider(GroupSsoSetupSuccess)
  928. const alert = screen.getByRole('alert')
  929. expect(alert.textContent).to.contain(
  930. `You’ve joined the ${groupName} group. SSO is enabled.`
  931. )
  932. })
  933. })
  934. })