chore(#9660): update e2e sync function (#9659)

When the app syncs, and gets an update, the notification modal can appear before the sync status is updated to successful, and when it appears, it closes the sidebar menu.
Try to close the modal quickly every time an update is expected and wdio interacts with the menu instead, of waiting for multiple seconds and then retrying. 

#9660

Author: dianabarsan

Diff for: tests/e2e/default/admin/admin-access.wdio-spec.js

@@ -10,8 +10,7 @@ describe('Acessing the admin app', () => {
   const parent = placeFactory.place().build({ _id: 'dist1', type: 'district_hospital' });
 
   afterEach(async () => {
-    await browser.reloadSession();
-    await browser.url('/');
+    await common.reloadSession();
   });
 
   it('should redirect to login when not logged in', async () => {

Diff for: tests/e2e/default/contacts/contact-details.wdio-spec.js

@@ -80,7 +80,6 @@ describe('Contact details page.', () => {
         { roles: settings.roles, permissions: settings.permissions },
         { revert: true, ignoreReload: true }
       );
-
     };
 
     before(async () => {
@@ -91,7 +90,6 @@ describe('Contact details page.', () => {
       await utils.createUsers([user]);
 
       await loginPage.login(user);
-      await commonElements.waitForPageLoaded();
     });
 
     after(async () => {
@@ -124,8 +122,7 @@ describe('Contact details page.', () => {
 
     it('should not show reports when permission is disabled', async () => {
       await updatePermissions(ROLE, [], ['can_view_reports']);
-      await commonElements.sync(true);
-      await browser.refresh();
+      await commonElements.sync({ expectReload: true, reload: true });
       await waitForContactLoaded(true);
 
       expect(await (await contactPage.reportsCardSelectors.rhsReportListElement()).isDisplayed()).to.equal(false);
@@ -135,8 +132,7 @@ describe('Contact details page.', () => {
 
     it('should not show tasks when permission is disabled', async () => {
       await updatePermissions(ROLE, ['can_view_reports'], ['can_view_tasks']);
-      await commonElements.sync(true);
-      await browser.refresh();
+      await commonElements.sync({ reload: true, expectReload: true });
       await waitForContactLoaded(false);
 
       expect(await (await contactPage.reportsCardSelectors.rhsReportListElement()).isDisplayed()).to.equal(true);
@@ -160,7 +156,7 @@ describe('Contact details page.', () => {
       const contactSummaryFile = path.join(__dirname, 'config/contact-summary-error-config.js');
 
       const { contactSummary } = await chtConfUtils.compileNoolsConfig({ contactSummary: contactSummaryFile });
-      await utils.updateSettings({ contact_summary: contactSummary }, true);
+      await utils.updateSettings({ contact_summary: contactSummary }, { ignoreReload: true });
 
       await utils.saveDocs([...places.values(), patient]);
     });

Diff for: tests/e2e/default/contacts/muting-contact-using-form.wdio-spec.js

@@ -68,7 +68,7 @@ describe('Mute/Unmute contacts using a specific form - ', () => {
 
   it('should show a popup when trying to submit a non-unmuting form against a muted contact', async () => {
     await utils.revertSettings(true);
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
     await commonPage.goToPeople(mutePerson._id);
 
     const modalDetails = await contactPage.openFormWithWarning('death_report');

Diff for: tests/e2e/default/contacts/person-under-area.wdio-spec.js

@@ -37,9 +37,7 @@ describe('Create Person Under Area, ', () => {
     await usersAdminPage.inputAddUserFields(username, 'Jack', 'chw', healthCenter2.name, person2.name, password);
     await usersAdminPage.saveUser();
 
-    await browser.reloadSession();
-    await browser.url('/');
-
+    await commonPage.reloadSession();
     await loginPage.login({ username, password });
 
     await commonPage.goToPeople();

Diff for: tests/e2e/default/db/initial-replication.wdio-spec.js

@@ -50,7 +50,7 @@ describe('initial-replication', () => {
     const localAllDocsPreSync = await chtDbUtils.getDocs();
     const docIdsPreSync = dataFactory.ids(localAllDocsPreSync);
 
-    await commonPage.sync(false, 7000);
+    await commonPage.sync();
 
     const localAllDocs = await chtDbUtils.getDocs();
     const localDocIds = dataFactory.ids(localAllDocs);
@@ -122,8 +122,7 @@ describe('initial-replication', () => {
   });
 
   afterEach(async () => {
-    await browser.reloadSession();
-    await browser.url('/');
+    await commonPage.reloadSession();
   });
 
   it('should log user in', async () => {

Diff for: tests/e2e/default/db/ongoing-replication.wdio-spec.js

@@ -42,7 +42,7 @@ describe('ongoing replication', function() {
     const isRevertingSettings = utils.revertSettings(true);
     if (isRevertingSettings) {
       await isRevertingSettings;
-      await commonPage.sync(true, 30000);
+      await commonPage.sync({ expectReload: true, timeout: 30000 });
     }
   });
 
@@ -72,7 +72,7 @@ describe('ongoing replication', function() {
     await saveData(additionalDenied);
 
     await browser.throttle('online');
-    await commonPage.sync(false, 30000);
+    await commonPage.sync({ expectReload: true, timeout: 30000 });
 
     const localDocsPostSync = await chtDbUtils.getDocs();
     const localDocIds = dataFactory.ids(localDocsPostSync);
@@ -132,7 +132,7 @@ describe('ongoing replication', function() {
     await utils.addTranslations('rnd', {});
     await waitForServiceWorker.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
     const [rnd] = await chtDbUtils.getDocs(['messages-rnd']);
     expect(rnd).to.include({
       type: 'translations',
@@ -144,7 +144,7 @@ describe('ongoing replication', function() {
     await utils.saveDoc(rnd);
     await waitForServiceWorker.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
     const [updatedRnd] = await chtDbUtils.getDocs(['messages-rnd']);
     expect(updatedRnd.updated).to.equal(rnd.updated);
   });
@@ -161,7 +161,7 @@ describe('ongoing replication', function() {
     await utils.deleteDocs(docIdsToDelete);
     await waitForServiceWorker.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
     const localDocsPostSync = await chtDbUtils.getDocs();
     const localDocIds = dataFactory.ids(localDocsPostSync);
 
@@ -171,7 +171,7 @@ describe('ongoing replication', function() {
   it('should download settings updates', async () => {
     await commonPage.sync();
     await utils.updateSettings({ test: true }, { ignoreReload: 'api' });
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
     const [settings] = await chtDbUtils.getDocs(['settings']);
     expect(settings.settings.test).to.equal(true);
   });

Diff for: tests/e2e/default/enketo/extension-lib-form.wdio-spec.js

@@ -13,8 +13,7 @@ describe('Extension lib xpath function', () => {
 
     const waitForServiceWorker = await utils.waitForApiLogs(utils.SW_SUCCESSFUL_REGEX);
     await waitForServiceWorker.promise;
-    await browser.reloadSession();
-    await browser.url('/');
+    await commonPage.reloadSession();
   });
 
   it('calculate average', async () => {

Diff for: tests/e2e/default/enketo/undo-death-report.wdio-spec.js

@@ -26,7 +26,7 @@ describe('Submit an undo death report', () => {
     await commonPage.goToPeople(person._id);
     await commonPage.openFastActionReport('death_report');
     await deathReportForm.submitDeathReport();
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
   });
 
   it('should submit an undo death report, ' +
@@ -43,7 +43,7 @@ describe('Submit an undo death report', () => {
     );
     await genericForm.submitForm();
     await commonPage.waitForPageLoaded();
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true });
 
     expect(await (await contactPage.deathCardSelectors.deathCard()).isDisplayed()).to.be.false;
 

Diff for: tests/e2e/default/login/login-logout.wdio-spec.js

@@ -11,8 +11,7 @@ describe('Login page funcionality tests', () => {
   };
 
   afterEach(async () => {
-    await browser.reloadSession();
-    await browser.url('/');
+    await commonPage.reloadSession();
   });
 
   describe('Locale', () => {

Diff for: tests/e2e/default/more-options-menu/offline-user/all-permissions.wdio-spec.js

@@ -128,7 +128,7 @@ describe('More Options Menu - Offline User', () => {
         'can_export_contacts', 'can_export_messages',
         'can_delete_reports', 'can_update_reports'];
       await utils.updatePermissions(offlineUser.roles, [], allPermissions, true);
-      await commonPage.sync(true);
+      await commonPage.sync({ expectReload: true });
     });
 
     after(async () => await utils.revertSettings(true));

Diff for: tests/e2e/default/more-options-menu/offline-user/edit-permission-disabled.wdio-spec.js

@@ -51,9 +51,8 @@ describe('More Options Menu - Offline User - Edit permissions disabled', () => {
     result = await utils.saveDoc(smsReport);
     smsReportId = result.id;
     await utils.createUsers([offlineUser]);
+    await utils.updatePermissions(offlineUser.roles, [], ['can_edit'], true);
     await loginPage.login(offlineUser);
-    await utils.updatePermissions(offlineUser.roles, [], ['can_edit']);
-    await commonPage.closeReloadModal();
   });
 
   after(async () => await utils.revertSettings(true));

Diff for: tests/e2e/default/privacy-policy/privacy-policy.wdio-spec.js

@@ -22,8 +22,7 @@ describe('Privacy policy', () => {
   users.forEach((user) => {
     describe(`for an ${user.isOffline ? 'offline':'online'} user`, () => {
       before(async () => {
-        await browser.reloadSession();
-        await browser.url('/');
+        await commonPage.reloadSession();
         await utils.saveDocs([parent, privacyPolicy]);
         await utils.createUsers([user]);
         await loginPage.login({ username: user.username, password: user.password, privacyPolicy: true });
@@ -51,16 +50,14 @@ describe('Privacy policy', () => {
       });
 
       it('should not show on subsequent login', async () => {
-        await browser.reloadSession();
-        await browser.url('/');
+        await commonPage.reloadSession();
         await loginPage.login({ username: user.username, password: user.password });
         await (await commonPage.tabsSelector.messagesTab()).waitForDisplayed();
         expect(await (await privacyPage.privacyWrapper()).isDisplayed()).to.not.be.true;
       });
 
       it('should show french policy on secondary login', async () => {
-        await browser.reloadSession();
-        await browser.url('/');
+        await commonPage.reloadSession();
         await loginPage.login({ username: user.username, password: user.password, locale: 'fr', privacyPolicy: true });
         await privacyPage.waitAndAcceptPolicy(await privacyPage.privacyWrapper(), frenchTexts);
         expect(await (await commonPage.tabsSelector.messagesTab()).isDisplayed()).to.be.true;
@@ -116,8 +113,7 @@ describe('Privacy policy', () => {
     before(async () => {
       await utils.saveDocs([parent, privacyPolicy]);
       await utils.createUsers([conflictUser]);
-      await browser.reloadSession();
-      await browser.url('/');
+      await commonPage.reloadSession();
       await loginPage.login({ username: conflictUser.username, password: conflictUser.password, privacyPolicy: true });
     });
 

Diff for: tests/e2e/default/purge/purge.wdio-spec.js

@@ -79,8 +79,7 @@ describe('purge', function() {
     await utils.deleteUsers([user]);
     await utils.revertDb([/^form:/], true);
 
-    await browser.reloadSession();
-    await browser.url('/');
+    await commonElements.reloadSession();
   });
 
   it('purging runs on sync', async () => {
@@ -104,7 +103,7 @@ describe('purge', function() {
     await updatePurgeSettings(filterHomeVisitReports, true);
     await runPurging();
 
-    await commonElements.sync(true);
+    await commonElements.sync({ expectReload: true });
 
     allReports = await getAllReports();
     // this only works because the client didn't have to "purge" these docs and the revs didn't have

Diff for: tests/e2e/default/service-worker/service-worker.wdio-spec.js

@@ -67,7 +67,6 @@ describe('Service worker cache', () => {
   const chw = userFactory.build({ place: district._id });
 
   const login = async () => {
-    await browser.throttle('online');
     await loginPage.login(chw);
     await commonPage.waitForPageLoaded();
   };
@@ -78,6 +77,7 @@ describe('Service worker cache', () => {
   };
 
   const loginIfNeeded = async () => {
+    await browser.throttle('online');
     if (!await isLoggedIn()) {
       await login();
     }
@@ -93,6 +93,10 @@ describe('Service worker cache', () => {
     await loginIfNeeded();
   });
 
+  afterEach(async () => {
+    await utils.revertSettings(true);
+  });
+
   after(async () => {
     await utils.deleteUsers([chw]);
     await utils.revertDb([/^form:/], true);
@@ -147,7 +151,7 @@ describe('Service worker cache', () => {
     await utils.saveDoc(branding);
     await waitForLogs.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
     await browser.throttle('offline'); // make sure we load the login page from cache
     await commonPage.logout();
     expect(await browser.getTitle()).to.equal('Not Medic');
@@ -161,7 +165,7 @@ describe('Service worker cache', () => {
     });
     await waitForLogs.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
     await browser.throttle('offline'); // make sure we load the login page from cache
     await commonPage.logout();
 
@@ -172,7 +176,7 @@ describe('Service worker cache', () => {
   it('adding new languages triggers login page refresh', async () => {
     const languageCode = 'ro';
     await utils.enableLanguage(languageCode);
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
 
     const waitForLogs = await utils.waitForApiLogs(utils.SW_SUCCESSFUL_REGEX);
     await utils.addTranslations(languageCode, {
@@ -183,20 +187,18 @@ describe('Service worker cache', () => {
     });
     await waitForLogs.promise;
 
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
     await commonPage.logout();
 
     await loginPage.changeLanguage(languageCode, 'Utilizator');
 
     expect(await (await loginPage.labelForUser()).getText()).to.equal('Utilizator');
     expect(await (await loginPage.loginButton()).getText()).to.equal('Autentificare');
     expect(await (await loginPage.labelForPassword()).getText()).to.equal('Parola');
-
-    await utils.revertSettings(true);
   });
 
   it('other translation updates do not trigger a login page refresh', async () => {
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
 
     const cacheDetails = await getCachedRequests(true);
 
@@ -207,7 +209,7 @@ describe('Service worker cache', () => {
       'some': 'thing',
     });
     await waitForLogs.promise;
-    await commonPage.sync(true);
+    await commonPage.sync({ expectReload: true, serviceWorkerUpdate: true });
 
     const updatedCacheDetails = await getCachedRequests(true);