corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

Bug 1460092: Add ESLint rule to enforce use of ChromeUtils.generateQI. r=Gijs

Browse Source 
Also fixes existing code which fails the rule.

MozReview-Commit-ID: CkLFgsspGMU
This commit is contained in:
Kris Maglione
2018-05-08 18:36:22 -07:00
parent f45e53c27b
commit c03fa450d6
84 changed files with 328 additions and 564 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
tools/lint/eslint/eslint-plugin-mozilla/tests/use-chromeutils-generateqi.js Normal file
View File

@@ -0,0 +1,77 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
var rule = require("../lib/rules/use-chromeutils-generateqi");
var RuleTester = require("eslint/lib/testers/rule-tester");
const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
// ------------------------------------------------------------------------------
// Tests
// ------------------------------------------------------------------------------
function callError(message) {
return [{message, type: "CallExpression"}];
}
function error(message, type) {
return [{message, type}];
}
const MSG_NO_JS_QUERY_INTERFACE = (
"Please use ChromeUtils.generateQI rather than manually creating " +
"JavaScript QueryInterface functions");
const MSG_NO_XPCOMUTILS_GENERATEQI = (
"Please use ChromeUtils.generateQI instead of XPCOMUtils.generateQI");
function QueryInterface(iid) {
/* globals nsIFlug */
if (iid.equals(Ci.nsISupports) ||
iid.equals(Ci.nsIMeh) ||
iid.equals(nsIFlug) ||
iid.equals(Ci.amIFoo)) {
return this;
}
throw Cr.NS_ERROR_NO_INTERFACE;
}
ruleTester.run("use-chromeutils-generateqi", rule, {
valid: [
`X.prototype.QueryInterface = ChromeUtils.generateQI(["nsIMeh"]);`,
`X.prototype = { QueryInterface: ChromeUtils.generateQI(["nsIMeh"]) }`
],
invalid: [
{
code: `X.prototype.QueryInterface = XPCOMUtils.generateQI(["nsIMeh"]);`,
output: `X.prototype.QueryInterface = ChromeUtils.generateQI(["nsIMeh"]);`,
errors: callError(MSG_NO_XPCOMUTILS_GENERATEQI)
},
{
code: `X.prototype = { QueryInterface: XPCOMUtils.generateQI(["nsIMeh"]) };`,
output: `X.prototype = { QueryInterface: ChromeUtils.generateQI(["nsIMeh"]) };`,
errors: callError(MSG_NO_XPCOMUTILS_GENERATEQI)
},
{
code: `X.prototype = { QueryInterface: ${QueryInterface} };`,
output: `X.prototype = { QueryInterface: ChromeUtils.generateQI(["nsIMeh", "nsIFlug", "amIFoo"]) };`,
errors: error(MSG_NO_JS_QUERY_INTERFACE, "Property")
},
{
code: `X.prototype = { ${String(QueryInterface).replace(/^function /, "")} };`,
output: `X.prototype = { QueryInterface: ChromeUtils.generateQI(["nsIMeh", "nsIFlug", "amIFoo"]) };`,
errors: error(MSG_NO_JS_QUERY_INTERFACE, "Property")
},
{
code: `X.prototype.QueryInterface = ${QueryInterface};`,
output: `X.prototype.QueryInterface = ChromeUtils.generateQI(["nsIMeh", "nsIFlug", "amIFoo"]);`,
errors: error(MSG_NO_JS_QUERY_INTERFACE, "AssignmentExpression")
}
]
});