/* Any copyright is dedicated to the Public Domain. http://creativecommons.org/publicdomain/zero/1.0/ */ "use strict"; add_task(function setup() { // gSync.init() is called in a requestIdleCallback. Force its initialization. gSync.init(); }); add_task(async function test_ui_state_notification_calls_updateAllUI() { let called = false; let updateAllUI = gSync.updateAllUI; gSync.updateAllUI = () => { called = true; }; Services.obs.notifyObservers(null, UIState.ON_UPDATE); ok(called); gSync.updateAllUI = updateAllUI; }); add_task(async function test_ui_state_signedin() { const msBadgeEnabled = Services.prefs.getBoolPref( "browser.messaging-system.fxatoolbarbadge.enabled" ); const relativeDateAnchor = new Date(); let state = { status: UIState.STATUS_SIGNED_IN, email: "foo@bar.com", displayName: "Foo Bar", avatarURL: "https://foo.bar", lastSync: new Date(), syncing: false, }; const origRelativeTimeFormat = gSync.relativeTimeFormat; gSync.relativeTimeFormat = { formatBestUnit(date) { return origRelativeTimeFormat.formatBestUnit(date, { now: relativeDateAnchor, }); }, }; gSync.updateAllUI(state); let lastSyncTooltip = gSync.formatLastSyncDate(new Date(state.lastSync)); checkPanelUIStatusBar({ label: "Foo Bar", fxastatus: "signedin", syncing: false, syncNowTooltip: lastSyncTooltip, }); checkRemoteTabsPanel("PanelUI-remotetabs-main", false); checkMenuBarItem("sync-syncnowitem"); checkFxaToolbarButtonPanel("PanelUI-fxa-menu"); if (msBadgeEnabled) { await checkFxABadged(); } else { checkFxAAvatar("signedin"); } gSync.relativeTimeFormat = origRelativeTimeFormat; }); add_task(async function test_ui_state_syncing() { let state = { status: UIState.STATUS_SIGNED_IN, email: "foo@bar.com", displayName: "Foo Bar", avatarURL: "https://foo.bar", lastSync: new Date(), syncing: true, }; gSync.updateAllUI(state); checkSyncNowButton("PanelUI-remotetabs-syncnow", true); // Be good citizens and remove the "syncing" state. gSync.updateAllUI({ status: UIState.STATUS_SIGNED_IN, email: "foo@bar.com", lastSync: new Date(), syncing: false, }); // Because we switch from syncing to non-syncing, and there's a timeout involved. await promiseObserver("test:browser-sync:activity-stop"); }); add_task(async function test_ui_state_unconfigured() { const msBadgeEnabled = Services.prefs.getBoolPref( "browser.messaging-system.fxatoolbarbadge.enabled" ); let state = { status: UIState.STATUS_NOT_CONFIGURED, }; gSync.updateAllUI(state); let signedOffLabel = gSync.appMenuStatus.getAttribute("defaultlabel"); checkPanelUIStatusBar({ label: signedOffLabel, }); checkRemoteTabsPanel("PanelUI-remotetabs-setupsync"); checkMenuBarItem("sync-setup"); checkFxaToolbarButtonPanel("PanelUI-fxa-signin"); if (msBadgeEnabled) { await checkFxABadged(); } else { checkFxAAvatar("not_configured"); } }); add_task(async function test_ui_state_unverified() { let state = { status: UIState.STATUS_NOT_VERIFIED, email: "foo@bar.com", lastSync: new Date(), syncing: false, }; gSync.updateAllUI(state); let expectedLabel = gSync.appMenuStatus.getAttribute("unverifiedlabel"); let tooltipText = gSync.fxaStrings.formatStringFromName("verifyDescription", [ state.email, ]); checkPanelUIStatusBar({ label: expectedLabel, tooltip: tooltipText, fxastatus: "unverified", syncing: false, syncNowTooltip: tooltipText, }); checkRemoteTabsPanel("PanelUI-remotetabs-unverified", false); checkMenuBarItem("sync-unverifieditem"); checkFxaToolbarButtonPanel("PanelUI-fxa-unverified"); checkFxAAvatar("unverified"); }); add_task(async function test_ui_state_loginFailed() { let state = { status: UIState.STATUS_LOGIN_FAILED, email: "foo@bar.com", }; gSync.updateAllUI(state); let expectedLabel = gSync.appMenuStatus.getAttribute("errorlabel"); let tooltipText = gSync.fxaStrings.formatStringFromName( "reconnectDescription", [state.email] ); checkPanelUIStatusBar({ label: expectedLabel, tooltip: tooltipText, fxastatus: "login-failed", syncing: false, syncNowTooltip: tooltipText, }); checkRemoteTabsPanel("PanelUI-remotetabs-reauthsync", false); checkMenuBarItem("sync-reauthitem"); checkFxaToolbarButtonPanel("PanelUI-fxa-unverified"); checkFxAAvatar("unverified"); }); function checkPanelUIStatusBar({ label, tooltip, fxastatus, syncing, syncNowTooltip, }) { let labelNode = document.getElementById("appMenu-fxa-label"); let statusNode = document.getElementById("appMenu-fxa-status"); is(labelNode.getAttribute("label"), label, "fxa label has the right value"); if (statusNode.getAttribute("tooltiptext")) { is( statusNode.getAttribute("tooltiptext"), tooltip, "fxa tooltip has the right value" ); } if (fxastatus) { is( statusNode.getAttribute("fxastatus"), fxastatus, "fxa fxastatus has the right value" ); } else { ok(!statusNode.hasAttribute("fxastatus"), "fxastatus is unset"); } } function checkRemoteTabsPanel(expectedShownItemId, syncing, syncNowTooltip) { checkItemsVisibilities( [ "PanelUI-remotetabs-main", "PanelUI-remotetabs-setupsync", "PanelUI-remotetabs-reauthsync", "PanelUI-remotetabs-unverified", ], expectedShownItemId ); if (syncing != undefined && syncNowTooltip != undefined) { checkSyncNowButton("PanelUI-remotetabs-syncnow", syncing, syncNowTooltip); } } function checkMenuBarItem(expectedShownItemId) { checkItemsVisibilities( [ "sync-setup", "sync-syncnowitem", "sync-reauthitem", "sync-unverifieditem", ], expectedShownItemId ); } function checkSyncNowButton(buttonId, syncing, tooltip = null) { const remoteTabsButton = document.getElementById(buttonId); is( remoteTabsButton.getAttribute("syncstatus"), syncing ? "active" : "", "button active has the right value" ); if (tooltip) { is( remoteTabsButton.getAttribute("tooltiptext"), tooltip, "button tooltiptext is set to the right value" ); } if (buttonId.endsWith("-fxa-icon")) { return; } is( remoteTabsButton.hasAttribute("disabled"), syncing, "disabled has the right value" ); if (syncing) { is( remoteTabsButton.getAttribute("label"), gSync.syncStrings.GetStringFromName("syncingtabs.label"), "label is set to the right value" ); } else { is( remoteTabsButton.getAttribute("label"), gSync.syncStrings.GetStringFromName("syncnow.label"), "label is set to the right value" ); } } async function checkFxaToolbarButtonPanel(expectedShownItemId) { let panel = document.getElementById("PanelUI-fxa"); let promisePanelOpen = BrowserTestUtils.waitForEvent(panel, "ViewShown"); document.getElementById("PanelUI-fxa-menu").click(); await promisePanelOpen; checkItemsDisplayed( ["PanelUI-fxa-signin", "PanelUI-fxa-unverified", "PanelUI-fxa-menu"], expectedShownItemId ); } async function checkFxABadged() { const button = document.getElementById("fxa-toolbar-menu-button"); await BrowserTestUtils.waitForCondition(() => { return button.querySelector("label.feature-callout"); }); const badge = button.querySelector("label.feature-callout"); ok(badge, "expected feature-callout style badge"); ok(BrowserTestUtils.is_visible(badge), "expected the badge to be visible"); } // fxaStatus is one of 'not_configured', 'unverified', or 'signedin'. function checkFxAAvatar(fxaStatus) { const avatarContainers = [ document.getElementById("appMenu-fxa-avatar"), document.getElementById("fxa-avatar-image"), ]; for (const avatar of avatarContainers) { const avatarURL = getComputedStyle(avatar).listStyleImage; const expected = { not_configured: 'url("chrome://browser/skin/fxa/avatar-empty-badged.svg")', unverified: 'url("chrome://browser/skin/fxa/avatar-confirm.svg")', signedin: 'url("chrome://browser/skin/fxa/avatar.svg")', }; ok( avatarURL == expected[fxaStatus], `expected avatar URL to be ${expected[fxaStatus]}, got ${avatarURL}` ); } } // Only one item displayed at a time. function checkItemsDisplayed(itemsIds, expectedShownItemId) { for (let id of itemsIds) { if (id == expectedShownItemId) { ok( BrowserTestUtils.is_visible(document.getElementById(id)), `view ${id} should be visible` ); } else { ok( BrowserTestUtils.is_hidden(document.getElementById(id)), `view ${id} should be hidden` ); } } } // Only one item visible at a time. function checkItemsVisibilities(itemsIds, expectedShownItemId) { for (let id of itemsIds) { if (id == expectedShownItemId) { ok( !document.getElementById(id).hidden, "menuitem " + id + " should be visible" ); } else { ok( document.getElementById(id).hidden, "menuitem " + id + " should be hidden" ); } } } function promiseObserver(topic) { return new Promise(resolve => { let obs = (aSubject, aTopic, aData) => { Services.obs.removeObserver(obs, aTopic); resolve(aSubject); }; Services.obs.addObserver(obs, topic); }); }