Page MenuHomePhabricator
Create Task
Maniphest T265096

Tag errors where a banner is being displayed
Closed, ResolvedPublic
Actions

Description

There have been a few errors relating to banners recently that have been extremely hard to debug (T264786, T264952)
The error client could provide a clue to a banner being the cause by adding the value of mw.centralNotice.isBannerShown()

Note it's possible we could even log the name of the banner mw.centralNotice.getDataProperty( 'banner' ); but that warrants further investigation and the boolean should be sufficient enough for now.

The tag will also allow us to create a fundraising banner dashboard for catching and addressing these errors as banners are enabled.

Details

SubjectRepoBranchLines +/-
Tag errors when a banner is displayedmediawiki/extensions/WikimediaEventsmaster+5 -1
Tag errors when a banner is displayedmediawiki/extensions/WikimediaEventsmaster+6 -1
clientError: Adds new fields and updates behavior.mediawiki/extensions/WikimediaEventsmaster+55 -16
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.Oct 8 2020, 10:38 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 8 2020, 10:38 PM
gerritbot added a comment.Oct 8 2020, 10:40 PM

Change 633034 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/extensions/WikimediaEvents@master] Tag errors when a banner is displayed

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

gerritbot added a project: Patch-For-Review.Oct 8 2020, 10:40 PM
Pcoombe awarded a token.Oct 9 2020, 3:58 PM
Jdlrobson mentioned this in T265131: Kibana: Sort normalized messages by how many users they affect.Oct 9 2020, 6:03 PM
Jdlrobson triaged this task as High priority.Oct 13 2020, 5:25 PM

(blocker for rolling out to enwiki)

• jbolorinos-ctr awarded a token.Oct 13 2020, 5:45 PM
• jbolorinos-ctr subscribed.
gerritbot added a comment.Oct 15 2020, 6:15 PM

Change 634295 had a related patch set uploaded (by Jdlrobson; owner: Jason Linehan):
[mediawiki/extensions/WikimediaEvents@master] clientError: Adds 'is_user_logged_in' and 'is_banner_shown' fields

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

gerritbot added a comment.Oct 15 2020, 6:15 PM

Change 633034 abandoned by Jdlrobson:
[mediawiki/extensions/WikimediaEvents@master] Tag errors when a banner is displayed

Reason:
Since a schema change is required this is being done as part of https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikimediaEvents/ /634295

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

Jdlrobson added a parent task: T255585: [EPIC] Extend client-side error logging coverage to include English Wikipedia.Oct 21 2020, 5:31 PM
Jdlrobson mentioned this in T265401: Uncaught TypeError: event.target.getAttribute is not a function .Oct 23 2020, 9:10 PM
Jdlrobson moved this task from Backlog to In progress on the DoNotUse---Instrument-ClientError board.Jan 26 2021, 6:05 PM
Pcoombe subscribed.Sep 1 2022, 3:20 PM

Hi @Jdlrobson, not sure what the status of this is. Is it still something that you're working on?

gerritbot added a comment.Sep 1 2022, 6:48 PM

Change 634295 abandoned by Jdlrobson:

[mediawiki/extensions/WikimediaEvents@master] clientError: Adds new fields and updates behavior.

Reason:

No longer being worked on

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

Jdlrobson added a comment.Sep 1 2022, 6:51 PM

It's been causing less problems so I haven't thought too much of this and haven't been working on it.

The more important underlying issue here is making sure banners work cross browser without errors and when they do, we know banners cause them. Thinking about this through a more modern lens, one solution to this would be to make sure that all banner code is not run in global scope (at least for new campaigns). Would that be possible? If so perhaps we can decline this in favor of doing that?

e.g.
Right now we do:

<banner code>

Instead we'd do:

( function runCentralNoticeBanner() {
   <banner code>
} () )

That would make sure any error in the banner code has runCentralNoticeBanner in the stack trace.

Maintenance_bot removed a project: Patch-For-Review.Sep 1 2022, 7:30 PM
Tgr added a subtask: T316992: ClientError fieldname 'tags' is conflicting.Sep 4 2022, 2:50 AM
gerritbot added a comment.Sep 4 2022, 6:12 AM

Change 829300 had a related patch set uploaded (by Gergő Tisza; author: Gergő Tisza):

[mediawiki/extensions/WikimediaEvents@master] Tag errors when a banner is displayed

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

gerritbot added a project: Patch-For-Review.Sep 4 2022, 6:12 AM
gerritbot added a comment.Sep 26 2022, 10:36 AM

Change 829300 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Tag errors when a banner is displayed

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.3; 2022-09-26).Sep 26 2022, 11:00 AM
Maintenance_bot removed a project: Patch-For-Review.Sep 26 2022, 11:31 AM
Pcoombe mentioned this in T319498: Uncaught TypeError: mw.centralNotice.isBannerShown is not a function.Oct 10 2022, 6:19 PM
Aklapper edited projects, added Instrument-ClientError; removed DoNotUse---Instrument-ClientError.Nov 24 2022, 1:55 PM
Tgr closed this task as Resolved.Jan 30 2023, 5:16 AM
Tgr claimed this task.
Tgr mentioned this in T165686: Spike: CentralNotice: How can we better monitor/provide tools/collaborate to prevent errors in banners?.
Tgr subscribed.

Nothing left here to do, I think.

Tgr added a comment.Jan 30 2023, 5:19 AM

Except that per T319498: Uncaught TypeError: mw.centralNotice.isBannerShown is not a function it is somewhat broken, but let's follow up on that there.

Tgr closed subtask T316992: ClientError fieldname 'tags' is conflicting as Resolved.Jan 30 2023, 5:19 AM
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