Page MenuHomePhabricator
Create Task
Maniphest T252878

Don't use "wikimedia/jquery" in selenium .eslintrc
Closed, ResolvedPublic
Actions

Description

Although wdio uses $ and $$ this has nothing to do with jquery and the jquery features are mostly not used in the tests. The only way jquery could be used in the tests would by inside of browser.execute() calls but I would not expect that very jquery heavy things are done in there.

So my suggestion is to remove the wikimedia/jquery rule-set from the tests/selenium/.eslintrc.json files and rather add "$": "readonly" and "$$": "readonly".

This would also have the advantage that we do not need to disable the no-jquery/no-global-selector rule in every selenium eslint file. ( Which in theory should not apply anyways since we're not dealing with jquery here :-) )

Details

SubjectRepoBranchLines +/-
build: Update devDependencies and use wikimedia/seleniummediawiki/extensions/Newslettermaster+281 -291
build: Update devDependencies and use wikimedia/seleniummediawiki/extensions/TemplateWizardmaster+466 -373
build: Update devDependencies and use wikimedia/seleniummediawiki/extensions/ProofreadPagemaster+419 -185
Customize query in gerrit

Related Objects

Event Timeline

WMDE-Fisch created this task.May 15 2020, 11:13 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 15 2020, 11:13 AM
WMDE-Fisch added a subscriber: zeljkofilipin.May 15 2020, 11:16 AM
zeljkofilipin added a subscriber: Esanders.May 15 2020, 11:46 AM

@Esanders is doing a lot of eslint clenaup. What do you think?

WMDE-Fisch updated the task description. (Show Details)May 25 2020, 10:44 AM
Esanders added a comment.May 25 2020, 1:21 PM

There are couple of possible solutions:

  1. For the jQuery issue specifically, require that a different alias is used in the client, e.g. jQuery instead of $. The jQuery linting plugin can then be configured to only target jQuery instead of $, by adding "settings": { "no-jquery": { "constructorAliases": ["jQuery"] } } }.
  2. Move all browser code to separate files in a sub-folder that has client-side linting applied, so no client-side code appears in the same file as browser.execute. This is more appropriate a lot of code is being executed in the client, and is the technique I used for VE's screenshot tests: https://gerrit.wikimedia.org/r/#/c/mediawiki/extensions/VisualEditor/+/589718/
  3. Create an ESLint pre-processor to lint code inside excute separate. This would be very complicated is probably excessive
  4. Do nothing for smaller snippets of code and turn off client/jQuery linting. The code will still be linted by the common rules. (as suggested in this task description)
Esanders added a comment.EditedMay 25 2020, 1:24 PM

I think this approach (4) is fine for now though. It doesn't appear there are many large selenium tests, or ones using much jQuery.

zeljkofilipin added a project: User-zeljkofilipin.May 25 2020, 1:46 PM
zeljkofilipin moved this task from Backlog 🪒 to Watching 📺 on the User-zeljkofilipin board.
Esanders added a comment.EditedMay 25 2020, 2:32 PM

webdriverio also provide their own recommended config: https://github.com/webdriverio/webdriverio/blob/master/packages/eslint-plugin-wdio/index.js

I've created an upstream task to create a config for this: https://github.com/wikimedia/eslint-config-wikimedia/issues/261

zeljkofilipin added a subscriber: Vidhi-Mody.May 25 2020, 2:41 PM
In T252878#6163115, @Esanders wrote:

webdriverio also provide their own recommended config: https://github.com/webdriverio/webdriverio/blob/master/packages/eslint-plugin-wdio/index.js

I've created an upstream task to create a config for this: https://github.com/wikimedia/eslint-config-wikimedia/issues/261

@Vidhi-Mody you might be interested in this.

zeljkofilipin moved this task from Watching 📺 to Deep work 🌊 on the User-zeljkofilipin board.Jun 18 2020, 3:47 PM
Esanders added a comment.Jun 18 2020, 8:02 PM

wikimedia/selenium in now available and was fixed in core in https://gerrit.wikimedia.org/r/#/c/mediawiki/core/+/596468/

zeljkofilipin moved this task from Deep work 🌊 to Waiting 🏹 on the User-zeljkofilipin board.Jun 19 2020, 9:49 AM

@WMDE-Fisch can this task be resolved?

WMDE-Fisch added a comment.Jun 22 2020, 11:33 AM

Not quite yet :-)

https://codesearch.wmflabs.org/search/?q=%22wikimedia%2Fjquery%22&files=tests%2Fselenium%2F.eslintrc.json

gerritbot added a comment.Jun 22 2020, 11:59 AM

Change 607003 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/ProofreadPage@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607003

gerritbot added a project: Patch-For-Review.Jun 22 2020, 12:00 PM
gerritbot added a comment.Jun 22 2020, 12:22 PM

Change 607005 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/TemplateWizard@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607005

gerritbot added a comment.Jun 22 2020, 12:32 PM

Change 607006 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/Newsletter@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607006

gerritbot added a comment.Jun 22 2020, 7:09 PM

Change 607003 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607003

gerritbot added a comment.Jun 22 2020, 7:14 PM

Change 607005 merged by jenkins-bot:
[mediawiki/extensions/TemplateWizard@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607005

gerritbot added a comment.Jun 22 2020, 7:14 PM

Change 607006 merged by jenkins-bot:
[mediawiki/extensions/Newsletter@master] build: Update devDependencies and use wikimedia/selenium

https://gerrit.wikimedia.org/r/607006

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.38; 2020-06-23).Jun 22 2020, 8:00 PM
zeljkofilipin added a subscriber: jaredblumer.Jun 23 2020, 3:06 PM

@jaredblumer this task is similar to T254495.

zeljkofilipin added a comment.Jul 8 2020, 4:57 PM
In T252878#6244162, @WMDE-Fisch wrote:

Not quite yet :-)

https://codesearch.wmflabs.org/search/?q=%22wikimedia%2Fjquery%22&files=tests%2Fselenium%2F.eslintrc.json

This search no longer returns anything. Time to resolve this task?

WMDE-Fisch closed this task as Resolved.Aug 31 2020, 12:15 PM
WMDE-Fisch claimed this task.
WMDE-Fisch edited projects, added ProofreadPage, MediaWiki-extensions-Newsletter, GrowthExperiments, MediaWiki-extensions-TemplateWizard; removed MW-1.35-notes (1.35.0-wmf.38; 2020-06-23), Patch-For-Review, User-zeljkofilipin.
In T252878#6290362, @zeljkofilipin wrote:
In T252878#6244162, @WMDE-Fisch wrote:

Not quite yet :-)

https://codesearch.wmflabs.org/search/?q=%22wikimedia%2Fjquery%22&files=tests%2Fselenium%2F.eslintrc.json

This search no longer returns anything. Time to resolve this task?

Sounds good!

Restricted Application added a project: Community-Tech. · View Herald TranscriptAug 31 2020, 12:15 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits