1479515 - Add manually run linter rules for detecting reference of undefined constants in interfaces and accessing valid properties of Services

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P2)

Description

[Mark Banner (:standard8)]

In the dependencies on bug 1479513, you'll see various cases where we do things like:

Ci.nsIFoo.BAR

and BAR is undefined as it isn't in the interface.

Ideally we should have an automated way to catch this. It is probably a job for static analysis.

Comment 1

[Mark Banner (:standard8)]

Attachment: ESLint based interface checks

This is the patch I whipped up for ESLint. The basic idea here is:

1) Find any item which looks like Ci.IFoo.bar
2) Load the interface JSON information from the hard-coded objdir path `objdir-ff-opt/config/makefiles/xpidl/` (if not already loaded)
3) Search through the interfaces for the IFoo definition
4) Search through the interface definition `consts` value for `bar`
5) If `bar` is not found, repeat 3 and 4 for any parents until `nsISupports` is hit.

This isn't really suitable for ESLint in production at the moment as:

- here is the obvious build dependency.
- I'm not convinced this should be ESLint's role, as this is doing more in-depth analysis.

However, maybe there is another way, or this could be hooked up to static analysis of some kind.

Comment 2

[Mark Banner (:standard8)]

In this bug we'll get these landed in a way that they can be run manually from ESLint when you have a full build. Bug 1666491 will deal with the hook-up to automation.

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1479515 - Add an ESLint rule to check for unknown property accesses on Ci. r?Gijs

This is manually run and requires a full build. MOZ_OBJDIR needs to be set to point to the object directory.

Depends on D156421

Comment 4

[Mark Banner (:standard8)]

Attachment: Bug 1479515 - Extend the ESLint rule for checking Ci properties to check for unknown interfaces as well. r?Gijs

Depends on D156424

Comment 5

[Mark Banner (:standard8)]

Attachment: Bug 1479515 - Add an ESLint rule to check for valid property accesses on Services. r?Gijs

This is manually run and requires a full build. MOZ_OBJDIR needs to be set to point to the object directory.

Depends on D156425

Comment 6

[Mark Banner (:standard8)]

I still need to do a lot of tidy up on these patches, the WIP are posting so there's a copy here as well.

Comment 7

[Mark Banner (:standard8)]

Try push: https://treeherder.mozilla.org/jobs?repo=try&revision=89d1d583966ecf7cc834545561b8d5365ecb6d07

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4bc3e077b7a2
Add an ESLint rule to check for unknown property accesses on Ci. r=Gijs
https://hg.mozilla.org/integration/autoland/rev/5086e62b92ed
Extend the ESLint rule for checking Ci properties to check for unknown interfaces as well. r=Gijs,application-update-reviewers,nalexander
https://hg.mozilla.org/integration/autoland/rev/5eb9e59194ee
Add an ESLint rule to check for valid property accesses on Services. r=Gijs

Comment 9

[Cristina Cozmuta (:CrissCozmuta)]

https://hg.mozilla.org/mozilla-central/rev/4bc3e077b7a2
https://hg.mozilla.org/mozilla-central/rev/5086e62b92ed
https://hg.mozilla.org/mozilla-central/rev/5eb9e59194ee