1
0
Fork 0
firefox/toolkit/components/telemetry/tests/unit/test_TelemetryControllerShutdown.js
Daniel Baumann 5e9a113729
Adding upstream version 140.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-25 09:37:52 +02:00

90 lines
3.1 KiB
JavaScript

/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
// Test that TelemetryController sends close to shutdown don't lead
// to AsyncShutdown timeouts.
"use strict";
const { TelemetryController } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetryController.sys.mjs"
);
const { TelemetrySend } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetrySend.sys.mjs"
);
const { AsyncShutdown } = ChromeUtils.importESModule(
"resource://gre/modules/AsyncShutdown.sys.mjs"
);
function contentHandler(metadata, response) {
dump("contentHandler called for path: " + metadata._path + "\n");
// We intentionally don't finish writing the response here to let the
// client time out.
response.processAsync();
response.setHeader("Content-Type", "text/plain");
}
add_task(async function test_setup() {
// Addon manager needs a profile directory
do_get_profile();
await loadAddonManager(
"xpcshell@tests.mozilla.org",
"XPCShell",
"1",
"1.9.2"
);
finishAddonManagerStartup();
// Make sure any pending XPIDatabase.saveChanges deferred tasks
// are finalized, needed to prevent intermittent failure when the test
// exits quickly and the saveChanges deferred tasks may end up
// executing too late, and AddonTestUtils.promiseShutdownManager
// will rethrow that error here:
// https://searchfox.org/mozilla-central/rev/60108fa975/toolkit/mozapps/extensions/internal/AddonTestUtils.sys.mjs#968
await AddonTestUtils.getXPIExports().XPIDatabase.finalize();
fakeIntlReady();
// Make sure we don't generate unexpected pings due to pref changes.
await setEmptyPrefWatchlist();
Services.prefs.setBoolPref(TelemetryUtils.Preferences.FhrUploadEnabled, true);
});
/**
* Ensures that TelemetryController does not hang processing shutdown
* phases. Assumes that Telemetry shutdown routines do not take longer than
* CRASH_TIMEOUT_MS to complete.
*/
add_task(async function test_sendTelemetryShutsDownWithinReasonableTimeout() {
const CRASH_TIMEOUT_MS = 10 * 1000;
// Enable testing mode for AsyncShutdown, otherwise some testing-only functionality
// is not available.
Services.prefs.setBoolPref("toolkit.asyncshutdown.testing", true);
// Reducing the max delay for waitiing on phases to complete from 1 minute
// (standard) to 20 seconds to avoid blocking the tests in case of misbehavior.
Services.prefs.setIntPref(
"toolkit.asyncshutdown.crash_timeout",
CRASH_TIMEOUT_MS
);
let httpServer = new HttpServer();
httpServer.registerPrefixHandler("/", contentHandler);
httpServer.start(-1);
await TelemetryController.testSetup();
TelemetrySend.setServer(
"http://localhost:" + httpServer.identity.primaryPort
);
let submissionPromise = TelemetryController.submitExternalPing(
"test-ping-type",
{}
);
// Trigger the AsyncShutdown phase TelemetryController hangs off.
AsyncShutdown.profileBeforeChange._trigger();
AsyncShutdown.sendTelemetry._trigger();
// Now wait for the ping submission.
await submissionPromise;
// If we get here, we didn't time out in the shutdown routines.
Assert.ok(true, "Didn't time out on shutdown.");
});