Blank realtime preview pane when request times out
Closed, ResolvedPublic3 Estimated Story PointsBUG REPORT
Actions

Assigned To

Authored By

	dom_walden
	Apr 27 2022, 9:07 AM

Description

What is the problem?

In some circumstances, if the reload request times out the realtime preview pane is blank (showing only the manual reload bar, see screenshot).

This appears to happen only if the timeout occurs after I have already successfully reloaded the preview 3 times. (I believe the code has some logic which means it behaves differently after the first 3 reloads, see T304568.) It doesn't happen if your first reload times out.

So, for example, if I have a generally good connection but it drops out for a short period I might experience this bug.

It is recoverable though. If you reload the page again you will see either the normal error message ("Preview not loading") or the preview will display successfully with the manual reload bar appearing (if your connection has returned).

Steps to reproduce problem

Login to beta as a user with RTP enabled
https://en.wikipedia.beta.wmflabs.org/w/index.php?title=Cat&action=edit
Reload the realtime preview 3 or more times
Open the devtools and throttle the connection as much as you can (disconnecting from the internet might work)
- This is easier with Firefox as you can set your connection to "GPRS" which I find does the trick. With Chrome, you have to create a custom profile.
Reload the realtime preview again

Expected behavior: The request times out and you see a nice error message such as in T303383.
Observed behavior: The realtime preview pane is blank.

Environment

Browser: Firefox 91, Chromium 87
Wiki(s): https://en.wikipedia.beta.wmflabs.org and local docker MediaWiki 1.39.0-alpha (1eb3596) 05:55, 27 April 2022.
Editor: WikiEditor 0.5.3 (0e1ca81) 06:08, 27 April 2022.

Screenshots

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Realtime Preview: show and hide preview and error areas appropriately	mediawiki/extensions/WikiEditor	master	+7 -5

Customize query in gerrit

Related Objects

Mentioned Here: T303383: Improve error display
T304568: Manual refresh message in case of slow connection
rEWED0e1ca8124dae: Localisation updates from https://translatewiki.net.
rMW1eb3596ca2c8: Localisation updates from https://translatewiki.net.

Event Timeline

dom_walden created this task.Apr 27 2022, 9:07 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 27 2022, 9:07 AM

dom_walden updated the task description. (Show Details)Apr 27 2022, 9:08 AM

• JMcLeod_WMF set the point value for this task to 3.Apr 27 2022, 11:23 AM

• JMcLeod_WMF moved this task from New & TBD Tickets to Up Next (June 3-21) on the Community-Tech board.

• JMcLeod_WMF moved this task from Up Next (June 3-21) to New & TBD Tickets on the Community-Tech board.

• MusikAnimal removed the point value 3 for this task.Apr 27 2022, 11:25 AM

• JMcLeod_WMF moved this task from New & TBD Tickets to Up Next (June 3-21) on the Community-Tech board.Apr 27 2022, 11:31 AM

• MusikAnimal set the point value for this task to 3.Apr 27 2022, 11:32 AM

• JMcLeod_WMF moved this task from Up Next (June 3-21) to CommTech-Sprint-24 on the Community-Tech board.Apr 27 2022, 11:55 AM

• JMcLeod_WMF edited projects, added Community-Tech (CommTech-Sprint-24); removed Community-Tech.

Samwilson claimed this task.Apr 29 2022, 2:36 AM

Samwilson moved this task from Ready 🎬 to In Development 💻 on the Community-Tech (CommTech-Sprint-24) board.

Another way I have found to reproduce this. If the realtime preview times out the 3rd request of the session. E.g.:

Open an edit session and make sure the preview is closed
Reload the page (the whole page, not just RTP)
When the page loads, throttle your connection so it will time out
Open realtime preview
When you see the timeout message, reload
When you see the message again, reload again
RTP pane is blank

Change 787839 had a related patch set uploaded (by Samwilson; author: Samwilson):

[mediawiki/extensions/WikiEditor@master] Realtime Preview: always re-show preview area

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

gerritbot added a project: Patch-For-Review.Apr 30 2022, 12:29 AM

@dom_walden I'm unable to reproduce this. Is it still an issue?

In T306965#7899002, @dmaza wrote:

@dom_walden I'm unable to reproduce this. Is it still an issue?

I can reproduce it pretty regularly. Perhaps I need to do a video demonstration.

I think I've figured this out. We're hiding the error message whenever entering manual mode, but actually should be doing so only on successful preview. i.e. I'd been thinking that we wouldn't want the error and manual bar to show at the same time, but that's actually valid.

@dmaza I can replicate it by adding the following at the top of ApiParse::execute(), and then reloading the preview three times:

sleep( ( $this->getConfig()->get('WikiEditorRealtimeDisableDuration') + 1000 ) / 1000 );
throw new \Exception( 'testing' );

Samwilson moved this task from In Development 💻 to Review/Feedback 💬 on the Community-Tech (CommTech-Sprint-24) board.May 4 2022, 3:44 AM

HMonroy moved this task from Review/Feedback 💬 to QA 🐛 on the Community-Tech (CommTech-Sprint-24) board.May 6 2022, 12:44 AM

Change 787839 merged by jenkins-bot:

[mediawiki/extensions/WikiEditor@master] Realtime Preview: show and hide preview and error areas appropriately

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.12; 2022-05-16).May 6 2022, 1:01 AM

Maintenance_bot removed a project: Patch-For-Review.May 6 2022, 1:31 AM

I haven't been able to reproduce this bug.

I have been recording the reproduction steps each time I saw this bug over the last 1-2 weeks. I repeated all of those and could not reproduce.

Test environment: https://en.wikipedia.beta.wmflabs.org WikiEditor 0.5.3 (be4ee22) 00:23, 6 May 2022.

Will mark as resolved since not able to reproduce

• JMcLeod_WMF moved this task from Product sign-off 🤘 to Done 🏁 on the Community-Tech (CommTech-Sprint-24) board.May 24 2022, 6:24 PM

Blank realtime preview pane when request times outClosed, ResolvedPublic3 Estimated Story PointsBUG REPORTActions