1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/**
* @fileoverview Reject use of lazy getters for modules that's loaded early in
* the startup process and not necessarily be lazy.
*
* 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";
const helpers = require("../helpers");
function isString(node) {
return node.type === "Literal" && typeof node.value === "string";
}
function isEagerModule(resourceURI) {
return [
"resource://gre/modules/XPCOMUtils",
"resource://gre/modules/AppConstants",
].includes(resourceURI.replace(/(\.jsm|\.jsm\.js|\.js|\.sys\.mjs)$/, ""));
}
function checkEagerModule(context, node, resourceURI) {
if (!isEagerModule(resourceURI)) {
return;
}
context.report({
node,
messageId: "eagerModule",
data: { uri: resourceURI },
});
}
module.exports = {
meta: {
docs: {
url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/rules/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-eager-module-in-lazy-getter.html",
},
messages: {
eagerModule:
'Module "{{uri}}" is known to be loaded early in the startup process, and should be loaded eagerly, instead of defining a lazy getter.',
},
schema: [],
type: "problem",
},
create(context) {
return {
CallExpression(node) {
if (node.callee.type !== "MemberExpression") {
return;
}
let callerSource;
try {
callerSource = helpers.getASTSource(node.callee);
} catch (e) {
return;
}
if (callerSource === "ChromeUtils.defineModuleGetter") {
if (node.arguments.length < 3) {
return;
}
const resourceURINode = node.arguments[2];
if (!isString(resourceURINode)) {
return;
}
checkEagerModule(context, node, resourceURINode.value);
} else if (
callerSource === "XPCOMUtils.defineLazyModuleGetters" ||
callerSource === "ChromeUtils.defineESModuleGetters"
) {
if (node.arguments.length < 2) {
return;
}
const obj = node.arguments[1];
if (obj.type !== "ObjectExpression") {
return;
}
for (let prop of obj.properties) {
if (prop.type !== "Property") {
continue;
}
if (prop.kind !== "init") {
continue;
}
const resourceURINode = prop.value;
if (!isString(resourceURINode)) {
continue;
}
checkEagerModule(context, node, resourceURINode.value);
}
}
},
};
},
};
|
