Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 278 insertions, 0 deletions

diff --git a/comm/mail/test/browser/account/browser_accountTelemetry.js b/comm/mail/test/browser/account/browser_accountTelemetry.js
new file mode 100644
index 0000000000..5488eaf9d6
--- /dev/null
+++ b/comm/mail/test/browser/account/browser_accountTelemetry.js
@@ -0,0 +1,278 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+/**
+ * Test telemetry related to account.
+ */
+
+let { FeedUtils } = ChromeUtils.import("resource:///modules/FeedUtils.jsm");
+
+let { IMServices } = ChromeUtils.importESModule(
+  "resource:///modules/IMServices.sys.mjs"
+);
+let { MailServices } = ChromeUtils.import(
+  "resource:///modules/MailServices.jsm"
+);
+let { MailTelemetryForTests } = ChromeUtils.import(
+  "resource:///modules/MailGlue.jsm"
+);
+
+let {
+  add_message_to_folder,
+  create_message,
+  msgGen,
+  get_special_folder,
+  create_folder,
+} = ChromeUtils.import(
+  "resource://testing-common/mozmill/FolderDisplayHelpers.jsm"
+);
+let { PromiseTestUtils } = ChromeUtils.import(
+  "resource://testing-common/mailnews/PromiseTestUtils.jsm"
+);
+let { TelemetryTestUtils } = ChromeUtils.importESModule(
+  "resource://testing-common/TelemetryTestUtils.sys.mjs"
+);
+
+/**
+ * Check that we are counting account types.
+ */
+add_task(async function test_account_types() {
+  // Collect all added accounts to be cleaned up at the end.
+  let addedAccounts = [];
+
+  Services.telemetry.clearScalars();
+
+  const NUM_IMAP = 3;
+  const NUM_RSS = 1;
+  const NUM_IRC = 1;
+
+  // Add incoming servers.
+  let imapServer = MailServices.accounts
+    .createIncomingServer("nobody", "foo.invalid", "imap")
+    .QueryInterface(Ci.nsIImapIncomingServer);
+  let imAccount = IMServices.accounts.createAccount(
+    "telemetry-irc-user",
+    "prpl-irc"
+  );
+  imAccount.autoLogin = false;
+  let ircServer = MailServices.accounts.createIncomingServer(
+    "nobody",
+    "foo.invalid",
+    "im"
+  );
+  ircServer.wrappedJSObject.imAccount = imAccount;
+
+  // Add accounts and assign incoming servers.
+  for (let i = 0; i < NUM_IMAP; i++) {
+    let identity = MailServices.accounts.createIdentity();
+    identity.email = "tinderbox@foo.invalid";
+    let account = MailServices.accounts.createAccount();
+    account.incomingServer = imapServer;
+    account.addIdentity(identity);
+    addedAccounts.push(account);
+  }
+  for (let i = 0; i < NUM_RSS; i++) {
+    let account = FeedUtils.createRssAccount("rss");
+    addedAccounts.push(account);
+  }
+  for (let i = 0; i < NUM_IRC; i++) {
+    let account = MailServices.accounts.createAccount();
+    account.incomingServer = ircServer;
+    addedAccounts.push(account);
+  }
+
+  registerCleanupFunction(() => {
+    for (let account of addedAccounts) {
+      MailServices.accounts.removeAccount(account);
+    }
+  });
+
+  MailTelemetryForTests.reportAccountTypes();
+  let scalars = TelemetryTestUtils.getProcessScalars("parent", true);
+
+  // Check if we count account types correctly.
+  Assert.equal(
+    scalars["tb.account.count"].imap,
+    NUM_IMAP,
+    "IMAP account number must be correct"
+  );
+  Assert.equal(
+    scalars["tb.account.count"].rss,
+    NUM_RSS,
+    "RSS account number must be correct"
+  );
+  Assert.equal(
+    scalars["tb.account.count"].im_irc,
+    NUM_IRC,
+    "IRC account number must be correct"
+  );
+  Assert.equal(
+    scalars["tb.account.count"].none,
+    undefined,
+    "Should not report Local Folders account"
+  );
+});
+
+/**
+ * Check that we are counting account sizes.
+ */
+add_task(async function test_account_sizes() {
+  Services.telemetry.clearScalars();
+
+  const NUM_INBOX = 3;
+  const NUM_OTHER = 2;
+
+  let inbox = await get_special_folder(
+    Ci.nsMsgFolderFlags.Inbox,
+    true,
+    null,
+    false
+  );
+  let other = await create_folder("TestAccountSize");
+  for (let i = 0; i < NUM_INBOX; i++) {
+    await add_message_to_folder(
+      [inbox],
+      msgGen.makeMessage({ body: { body: `test inbox ${i}` } })
+    );
+  }
+  for (let i = 0; i < NUM_OTHER; i++) {
+    await add_message_to_folder(
+      [other],
+      msgGen.makeMessage({ body: { body: `test other ${i}` } })
+    );
+  }
+
+  MailTelemetryForTests.reportAccountSizes();
+  let scalars = TelemetryTestUtils.getProcessScalars("parent", true);
+
+  // Check if we count total messages correctly.
+  Assert.equal(
+    scalars["tb.account.total_messages"].Inbox,
+    NUM_INBOX,
+    "Number of messages in Inbox must be correct"
+  );
+  Assert.equal(
+    scalars["tb.account.total_messages"].Other,
+    NUM_OTHER,
+    "Number of messages in other folders must be correct"
+  );
+  Assert.equal(
+    scalars["tb.account.total_messages"].Total,
+    NUM_INBOX + NUM_OTHER,
+    "Number of messages in all folders must be correct"
+  );
+
+  // The folder sizes on Windows are not exactly the same with Linux/macOS.
+  function checkSize(actual, expected, message) {
+    Assert.ok(Math.abs(actual - expected) < 10, message);
+  }
+  // Check if we count size on disk correctly.
+  checkSize(
+    scalars["tb.account.size_on_disk"].Inbox,
+    873,
+    "Size of Inbox must be correct"
+  );
+  checkSize(
+    scalars["tb.account.size_on_disk"].Other,
+    618,
+    "Size of other folders must be correct"
+  );
+  checkSize(
+    scalars["tb.account.size_on_disk"].Total,
+    873 + 618,
+    "Size of all folders must be correct"
+  );
+});
+
+/**
+ * Verify counting of OAuth2 providers
+ */
+add_task(async function test_account_oauth_providers() {
+  // Collect all added accounts to be cleaned up at the end
+  const addedAccounts = [];
+
+  Services.telemetry.clearScalars();
+
+  const EXPECTED_GOOGLE_COUNT = 2;
+  const EXPECTED_MICROSOFT_COUNT = 1;
+  const EXPECTED_YAHOO_AOL_COUNT = 2;
+  const EXPECTED_OTHER_COUNT = 2;
+
+  const hostnames = [
+    "imap.googlemail.com",
+    "imap.gmail.com",
+    "imap.mail.ru",
+    "imap.yandex.com",
+    "imap.mail.yahoo.com",
+    "imap.aol.com",
+    "outlook.office365.com",
+    "something.totally.unexpected",
+  ];
+
+  function createIncomingImapServer(username, hostname, authMethod) {
+    const incoming = MailServices.accounts.createIncomingServer(
+      username,
+      hostname,
+      "imap"
+    );
+
+    incoming.authMethod = authMethod;
+
+    const account = MailServices.accounts.createAccount();
+    account.incomingServer = incoming;
+
+    const identity = MailServices.accounts.createIdentity();
+    account.addIdentity(identity);
+
+    addedAccounts.push(account);
+  }
+
+  // Add incoming servers
+  let i = 0;
+  const otherAuthMethods = [
+    Ci.nsMsgAuthMethod.none,
+    Ci.nsMsgAuthMethod.passwordCleartext,
+    Ci.nsMsgAuthMethod.passwordEncrypted,
+    Ci.nsMsgAuthMethod.secure,
+  ];
+
+  for (const hostname of hostnames) {
+    // Create one with OAuth2
+    createIncomingImapServer("nobody", hostname, Ci.nsMsgAuthMethod.OAuth2);
+
+    // Create one with an arbitrary method from our list
+    createIncomingImapServer("somebody_else", hostname, otherAuthMethods[i]);
+    i = i + (1 % otherAuthMethods.length);
+  }
+
+  registerCleanupFunction(() => {
+    for (const account of addedAccounts) {
+      MailServices.accounts.removeAccount(account);
+    }
+  });
+
+  MailTelemetryForTests.reportAccountTypes();
+  const scalars = TelemetryTestUtils.getProcessScalars("parent", true);
+
+  // Check if we count account types correctly.
+  Assert.equal(
+    scalars["tb.account.oauth2_provider_count"].google,
+    EXPECTED_GOOGLE_COUNT,
+    "should have expected number of Google accounts"
+  );
+  Assert.equal(
+    scalars["tb.account.oauth2_provider_count"].microsoft,
+    EXPECTED_MICROSOFT_COUNT,
+    "should have expected number of Microsoft accounts"
+  );
+  Assert.equal(
+    scalars["tb.account.oauth2_provider_count"].yahoo_aol,
+    EXPECTED_YAHOO_AOL_COUNT,
+    "should have expected number of Yahoo/AOL accounts"
+  );
+  Assert.equal(
+    scalars["tb.account.oauth2_provider_count"].other,
+    EXPECTED_OTHER_COUNT,
+    "should have expected number of other accounts"
+  );
+});