137 lines
4.4 KiB
JavaScript
137 lines
4.4 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
const Ci = Components.interfaces;
|
|
const Cu = Components.utils;
|
|
const PREF_DEPRECATION_WARNINGS = "devtools.errorconsole.deprecation_warnings";
|
|
|
|
Cu.import("resource://gre/modules/Services.jsm", this);
|
|
Cu.import("resource://gre/modules/Deprecated.jsm", this);
|
|
|
|
// Using this named functions to test deprecation and the properly logged
|
|
// callstacks.
|
|
function basicDeprecatedFunction () {
|
|
Deprecated.warning("this method is deprecated.", "http://example.com");
|
|
return true;
|
|
}
|
|
|
|
function deprecationFunctionBogusCallstack () {
|
|
Deprecated.warning("this method is deprecated.", "http://example.com", {
|
|
caller: {}
|
|
});
|
|
return true;
|
|
}
|
|
|
|
function deprecationFunctionCustomCallstack () {
|
|
// Get the nsIStackFrame that will contain the name of this function.
|
|
function getStack () {
|
|
return Components.stack;
|
|
}
|
|
Deprecated.warning("this method is deprecated.", "http://example.com",
|
|
getStack());
|
|
return true;
|
|
}
|
|
|
|
let tests = [
|
|
// Test deprecation warning without passing the callstack.
|
|
{
|
|
deprecatedFunction: basicDeprecatedFunction,
|
|
expectedObservation: function (aMessage) {
|
|
testAMessage(aMessage);
|
|
ok(aMessage.errorMessage.indexOf("basicDeprecatedFunction") > 0,
|
|
"Callstack is correctly logged.");
|
|
}
|
|
},
|
|
// Test a reported error when URL to documentation is not passed.
|
|
{
|
|
deprecatedFunction: function () {
|
|
Deprecated.warning("this method is deprecated.");
|
|
return true;
|
|
},
|
|
expectedObservation: function (aMessage) {
|
|
ok(aMessage.errorMessage.indexOf("must provide a URL") > 0,
|
|
"Deprecation warning logged an empty URL argument.");
|
|
}
|
|
},
|
|
// Test deprecation with a bogus callstack passed as an argument (it will be
|
|
// replaced with the current call stack).
|
|
{
|
|
deprecatedFunction: deprecationFunctionBogusCallstack,
|
|
expectedObservation: function (aMessage) {
|
|
testAMessage(aMessage);
|
|
ok(aMessage.errorMessage.indexOf("deprecationFunctionBogusCallstack") > 0,
|
|
"Callstack is correctly logged.");
|
|
}
|
|
},
|
|
// When pref is unset Deprecated.warning should not log anything.
|
|
{
|
|
deprecatedFunction: basicDeprecatedFunction,
|
|
expectedObservation: function (aMessage) {
|
|
// Nothing should be logged when pref is false.
|
|
ok(false, "Deprecated warning should not log anything when pref is unset.");
|
|
},
|
|
// Set pref to false.
|
|
logWarnings: false
|
|
},
|
|
// Test deprecation with a valid custom callstack passed as an argument.
|
|
{
|
|
deprecatedFunction: deprecationFunctionCustomCallstack,
|
|
expectedObservation: function (aMessage) {
|
|
testAMessage(aMessage);
|
|
ok(aMessage.errorMessage.indexOf("deprecationFunctionCustomCallstack") > 0,
|
|
"Callstack is correctly logged.");
|
|
finish();
|
|
},
|
|
// Set pref to true.
|
|
logWarnings: true
|
|
}];
|
|
|
|
function test() {
|
|
waitForExplicitFinish();
|
|
|
|
// Check if Deprecated is loaded.
|
|
ok(Deprecated, "Deprecated object exists");
|
|
|
|
// Run all test cases.
|
|
tests.forEach(testDeprecated);
|
|
}
|
|
|
|
// Test Consle Message attributes.
|
|
function testAMessage (aMessage) {
|
|
ok(aMessage.errorMessage.indexOf("DEPRECATION WARNING: " +
|
|
"this method is deprecated.") === 0,
|
|
"Deprecation is correctly logged.");
|
|
ok(aMessage.errorMessage.indexOf("http://example.com") > 0,
|
|
"URL is correctly logged.");
|
|
}
|
|
|
|
function testDeprecated (test) {
|
|
// Deprecation warnings will be logged only when the preference is set.
|
|
if (typeof test.logWarnings !== "undefined") {
|
|
Services.prefs.setBoolPref(PREF_DEPRECATION_WARNINGS, test.logWarnings);
|
|
}
|
|
|
|
// Create a console listener.
|
|
let consoleListener = {
|
|
observe: function (aMessage) {
|
|
// Ignore unexpected messages.
|
|
if (!(aMessage instanceof Ci.nsIScriptError)) {
|
|
return;
|
|
}
|
|
if (aMessage.errorMessage.indexOf("DEPRECATION WARNING: ") < 0 &&
|
|
aMessage.errorMessage.indexOf("must provide a URL") < 0) {
|
|
return;
|
|
}
|
|
ok(aMessage instanceof Ci.nsIScriptError,
|
|
"Deprecation log message is an instance of type nsIScriptError.");
|
|
test.expectedObservation(aMessage);
|
|
}
|
|
};
|
|
// Register a listener that contains the tests.
|
|
Services.console.registerListener(consoleListener);
|
|
// Run the deprecated function.
|
|
test.deprecatedFunction();
|
|
// Unregister a listener.
|
|
Services.console.unregisterListener(consoleListener);
|
|
} |