fune/browser/components/urlbar/tests/unit/test_providersManager.js
Drew Willcoxon f0b51d5d79 Bug 1691855 - Fix intermittent TV failure in browser/components/urlbar/tests/unit/test_resultBuckets.js. r=mak
The problem is that the test creates and registers many providers but never
unregisters them. Usually that's not a problem since test providers have random
names and test query contexts are created with the `providers` option. But
sometimes two different providers end up with the same name because
`Math.random() * 100000` ends up being the same. Therefore a context can end up
with two (duplicate) providers when there should be only one, which means
`context.results` ends up with two copies of each result.

This patch makes several changes:

* test_resultBuckets.js now unregisters providers.
* Stop using `Math.random()` as the basis for making random test provider
  names. Instead, use UUIDs.
* Add a `registerCleanupFunction` in head.js for unregistering test providers
  (even though that wouldn't have fixed this bug).
* Make `registerBasicTestProvider` return the provider instead of its name so
  that the provider can be passed to
  `UrlbarProvidersManager.unregisterProvider()`.

Differential Revision: https://phabricator.services.mozilla.com/D104929
2021-02-12 16:23:52 +00:00

74 lines
2 KiB
JavaScript

/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
add_task(async function test_providers() {
Assert.throws(
() => UrlbarProvidersManager.registerProvider(),
/invalid provider/,
"Should throw with no arguments"
);
Assert.throws(
() => UrlbarProvidersManager.registerProvider({}),
/invalid provider/,
"Should throw with empty object"
);
Assert.throws(
() =>
UrlbarProvidersManager.registerProvider({
name: "",
}),
/invalid provider/,
"Should throw with empty name"
);
Assert.throws(
() =>
UrlbarProvidersManager.registerProvider({
name: "test",
startQuery: "no",
}),
/invalid provider/,
"Should throw with invalid startQuery"
);
Assert.throws(
() =>
UrlbarProvidersManager.registerProvider({
name: "test",
startQuery: () => {},
cancelQuery: "no",
}),
/invalid provider/,
"Should throw with invalid cancelQuery"
);
let match = new UrlbarResult(
UrlbarUtils.RESULT_TYPE.TAB_SWITCH,
UrlbarUtils.RESULT_SOURCE.TABS,
{ url: "http://mozilla.org/foo/" }
);
let provider = registerBasicTestProvider([match]);
let context = createContext(undefined, { providers: [provider.name] });
let controller = UrlbarTestUtils.newMockController();
let resultsPromise = promiseControllerNotification(
controller,
"onQueryResults"
);
await UrlbarProvidersManager.startQuery(context, controller);
// Sanity check that this doesn't throw. It should be a no-op since we await
// for startQuery.
UrlbarProvidersManager.cancelQuery(context);
let params = await resultsPromise;
Assert.deepEqual(params[0].results, [match]);
});
add_task(async function test_criticalSection() {
// Just a sanity check, this shouldn't throw.
await UrlbarProvidersManager.runInCriticalSection(async () => {
let db = await PlacesUtils.promiseLargeCacheDBConnection();
await db.execute(`PRAGMA page_cache`);
});
});