From 6bf0a5cb5034a7e684dcc3500e841785237ce2dd Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 7 Apr 2024 19:32:43 +0200
Subject: Adding upstream version 1:115.7.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../lib/rules/use-chromeutils-generateqi.js        | 105 +++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-chromeutils-generateqi.js

(limited to 'tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-chromeutils-generateqi.js')

diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-chromeutils-generateqi.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-chromeutils-generateqi.js
new file mode 100644
index 0000000000..5b8b58855d
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-chromeutils-generateqi.js
@@ -0,0 +1,105 @@
+/**
+ * @fileoverview Reject use of XPCOMUtils.generateQI and JS-implemented
+ *               QueryInterface methods in favor of ChromeUtils.
+ *
+ * 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/.
+ */
+
+"use strict";
+
+function isIdentifier(node, id) {
+  return node && node.type === "Identifier" && node.name === id;
+}
+
+function isMemberExpression(node, object, member) {
+  return (
+    node.type === "MemberExpression" &&
+    isIdentifier(node.object, object) &&
+    isIdentifier(node.property, member)
+  );
+}
+
+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 funcToGenerateQI(context, node) {
+  const sourceCode = context.getSourceCode();
+  const text = sourceCode.getText(node);
+
+  let interfaces = [];
+  let match;
+  let re = /\bCi\.([a-zA-Z0-9]+)\b|\b(nsI[A-Z][a-zA-Z0-9]+)\b/g;
+  while ((match = re.exec(text))) {
+    interfaces.push(match[1] || match[2]);
+  }
+
+  let ifaces = interfaces
+    .filter(iface => iface != "nsISupports")
+    .map(iface => JSON.stringify(iface))
+    .join(", ");
+
+  return `ChromeUtils.generateQI([${ifaces}])`;
+}
+
+module.exports = {
+  meta: {
+    docs: {
+      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/use-chromeutils-generateqi.html",
+    },
+    fixable: "code",
+    schema: [],
+    type: "suggestion",
+  },
+
+  create(context) {
+    return {
+      CallExpression(node) {
+        let { callee } = node;
+        if (isMemberExpression(callee, "XPCOMUtils", "generateQI")) {
+          context.report({
+            node,
+            message: MSG_NO_XPCOMUTILS_GENERATEQI,
+            fix(fixer) {
+              return fixer.replaceText(callee, "ChromeUtils.generateQI");
+            },
+          });
+        }
+      },
+
+      "AssignmentExpression > MemberExpression[property.name='QueryInterface']":
+        function (node) {
+          const { right } = node.parent;
+          if (right.type === "FunctionExpression") {
+            context.report({
+              node: node.parent,
+              message: MSG_NO_JS_QUERY_INTERFACE,
+              fix(fixer) {
+                return fixer.replaceText(
+                  right,
+                  funcToGenerateQI(context, right)
+                );
+              },
+            });
+          }
+        },
+
+      "Property[key.name='QueryInterface'][value.type='FunctionExpression']":
+        function (node) {
+          context.report({
+            node,
+            message: MSG_NO_JS_QUERY_INTERFACE,
+            fix(fixer) {
+              let generateQI = funcToGenerateQI(context, node.value);
+              return fixer.replaceText(node, `QueryInterface: ${generateQI}`);
+            },
+          });
+        },
+    };
+  },
+};
-- 
cgit v1.2.3