Make MoreMenu gadget more future proof #26
Conversation
|
(Full disclosure: final code untested as I couldn't work out how to get it running locally) |
There was a problem hiding this comment.
Of course, the issue is not just with MoreMenu, but until we have official mw.addPortlet support this is better than nothing. Thank you so much for taking the time to write this! I will test it soon.
Full disclosure: final code untested as I couldn't work out how to get it running locally
I have updated the README with instructions. It's pretty easy to set up, and you can even test on a local MW install if you want.
dist/MoreMenu.js
Outdated
| } else { | ||
| // Throwing an error will notify Wikimedia developers that they | ||
| // broke this script by showing up in our error logs. | ||
| throw new Error('MoreMenu: p-cactions is not in DOM. Expection with Vector maintaining team not met.'); |
There was a problem hiding this comment.
Clever! So this will show in logstash?
Also, typo: expection
There was a problem hiding this comment.
Yep!
This is a good idea for any popular and maintained script as it will show up in https://grafana.wikimedia.org/d/000000566/overview?orgId=1&viewPanel=16 which will block the train if we go into red zone. It should also show up on the beta cluster if you have a script to update it there, which gives a small chance that any issue will be picked up before the train begins to roll out.
It's also a nice way to setup an informal but enforceable contract with us :)
|
Thanks for updating README. Run out of time today, but can take a look tomorrow and give the readme a spin. |
|
Amended and tested: |
Clone an existing menu to work out the menu structure.
| // broke this script by showing up in our error logs. | ||
|
|
||
|
|
||
| throw new Error('MoreMenu: p-cactions is not in DOM. Expection with Vector maintaining team not met.'); |
There was a problem hiding this comment.
There's a typo at "Expection". Also I can't figure out the meaning of the second sentence. Consider re-wording.
| } | ||
| // Throwing an error will notify Wikimedia developers that they | ||
| // broke this script by showing up in our error logs. | ||
| throw new Error('MoreMenu: p-cactions is not in DOM. Expection with Vector maintaining team not met.'); |
|
I had another idea of how we might approach this here - https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/878212 I quite like this idea as it allows skins to reimplement the |
|
@MusikAnimal looks like this broke again: https://phabricator.wikimedia.org/T337893 I'm still out on vacation, but perhaps we could work together on the core code to find a more long term solution here. |
|
Almost 2 years since this PR was opened! I think now that we're using I want to thank you @jdlrobson for going out of your way to create this PR, and for all of your efforts to mitigate conflicts with scripts/gadgets as Vector 2022 evolved. |
Clone an existing menu to work out the menu structure. (Follow up to #25#issuecomment-1064558959 )
@MusikAnimal what do you think about this patch? While it won't prevent breakage, I think it will reduce the breakage. It will also throw an error when action needs to be taken, so when it does break we'll know right away (hopefully via an email alert).