1766228 - Add an ESLint rule to ensure that member property accesses of Services are valid

Status: RESOLVED FIXED

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

Description

[Mark Banner (:standard8) (afk until 21st July)]

I believe we occasionally have issues where code is broken because of incorrect use of Services. member property accesses.

We also have several existing in-tree at the moment.

As our ESLint plugin already knows about what services are available on Services, it is reasonably simple to add a rule to check that these are correct. Whilst it is not really the responsibility of ESLint, it is the best tool that we have at the moment.

Comment 1

[Mark Banner (:standard8) (afk until 21st July)]

Attachment: Bug 1766228 - Add some more interface types to components that are included in services. r?kmag

Comment 2

[Mark Banner (:standard8) (afk until 21st July)]

Attachment: Bug 1766228 - Replace manual Services.cookiemgr definition with Services.cookies in netwerk cookies tests. r?baku

This makes the tests consistent with the rest of the code, and avoids errors from the new ESLint valid-services rule.

Depends on D149389

Comment 3

[Mark Banner (:standard8) (afk until 21st July)]

Attachment: Bug 1766228 - Replace manual definition of Services.cookiesvc with Services.cookies. r?baku

This makes the tests consistent with the rest of the code, and avoids errors from the new ESLint valid-services rule.

Depends on D149390

Comment 4

[Mark Banner (:standard8) (afk until 21st July)]

Attachment: Bug 1766228 - Add nsICookieService as an acceptable interface for Services.cookies. r?kmag

Depends on D149391

Comment 5

[Mark Banner (:standard8) (afk until 21st July)]

Attachment: Bug 1766228 - Add an ESLint rule to ensure that member property accesses of Services are valid. r?Gijs

Depends on D149392

Comment 6

[Mark Banner (:standard8) (afk until 21st July)]

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

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2c7ef1ad380a
Add some more interface types to components that are included in services. r=kmag
https://hg.mozilla.org/integration/autoland/rev/76a32127865d
Replace manual Services.cookiemgr definition with Services.cookies in netwerk cookies tests. r=necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/cbba28151712
Replace manual definition of Services.cookiesvc with Services.cookies. r=necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/01642c97e7a5
Add nsICookieService as an acceptable interface for Services.cookies. r=kmag
https://hg.mozilla.org/integration/autoland/rev/5ff1634cfe18
Add an ESLint rule to ensure that member property accesses of Services are valid. r=Gijs

Comment 8

[Norisz Fay [:noriszfay]]

Backed out for causing lint failures on test_restrequest.js

Backout link

Push with failures

Failure log

Failure line(s): TEST-UNEXPECTED-ERROR | /builds/worker/checkouts/gecko/services/common/tests/unit/test_restrequest.js:851:3 | 'Services' is not defined. (no-undef)

There are also some xpcshell failures caused by this push as seen here . Failure log xpcshell

Comment 9

[Mark Banner (:standard8) (afk until 21st July)]

Ah, this conflicted with bug 1773609 which landed a few hours before this. I'll fix.

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6e8dfdb7a82d
Add some more interface types to components that are included in services. r=kmag
https://hg.mozilla.org/integration/autoland/rev/4ba8be002536
Replace manual Services.cookiemgr definition with Services.cookies in netwerk cookies tests. r=necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/3240fa10558b
Replace manual definition of Services.cookiesvc with Services.cookies. r=necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/91253ef3da4f
Add nsICookieService as an acceptable interface for Services.cookies. r=kmag
https://hg.mozilla.org/integration/autoland/rev/29d19ae2936c
Add an ESLint rule to ensure that member property accesses of Services are valid. r=Gijs

Comment 11

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/6e8dfdb7a82d
https://hg.mozilla.org/mozilla-central/rev/4ba8be002536
https://hg.mozilla.org/mozilla-central/rev/3240fa10558b
https://hg.mozilla.org/mozilla-central/rev/91253ef3da4f
https://hg.mozilla.org/mozilla-central/rev/29d19ae2936c