Page MenuHomePhabricator

Summary preview is missing when using live diff
Closed, ResolvedPublicBUG REPORT

Description

Steps to replicate the issue (include links if applicable):

  • Enable live preview
  • Start editing a page
  • Enter something in the edit summary textbox
  • Click "Show changes"

What happens?:
There is no "Preview of edit summary" beneath the textbox.

What should have happened instead?:
"Preview of edit summary" appears, as it does when clicking "Show preview".

Event Timeline

Can't reproduce it. Do you have a URL where you experienced this?

@Od1n: Hi, in the future, please use the bug report form (linked from the top of the task creation page) to create a bug report, and fill in the sections in the template, so your bug report is more complete. Thanks.

My mistake: the preview of the edit summary is missing when doing a "Show changes" action. When doing a "Show preview" action, it is present as expected. I have corrected the first message.

I reproduced the issue on frwiki and enwiki right now.

It seems to be a regression from T293930 (see the code changes).

Nardog renamed this task from Summary preview is missing when using the "live preview" feature to Summary preview is missing when using live diff.Jul 1 2023, 5:10 PM
Nardog updated the task description. (Show Details)
Ammarpad subscribed.

This is not a regression, it's intentional change.

My mistake: the preview of the edit summary is missing when doing a "Show changes" action.

"Show changes" is not "Show preview". Edit summary has no 'changes' to show; so it's hidden in that case. To see 'preview', you've to use the preview button

When doing a "Show preview" action, it is present as expected.

Yes. To see 'preview', that's the right button to use.

It's a workflow-breaking UX change. That's a decision to be made in separate task where people can weigh in, not something to sneak in in a totally unrelated patch.

Live diff was a handy feature to preview the summary because it takes longer to parse the source. It should be restored and shouldn't be removed without sufficient consultation.

Besides, the whole point of live preview is to recreate the server-side behavior client-side. If "Show changes" shouldn't have a summary preview, it should be removed from the server side as well (which I'm not saying it should be, obvs).

I really don't see the point of purposedly hiding the preview of the edit summary, where technically nothing prevents us from showing it.

On frwiki I am usually writing detailed edit summaries, thus I am often previewing them. It is more convenient to preview them using "Show changes" than "Show preview":

  • "Show changes" usually produces a much shorter output than "Show preview", so that scrolling down to the editing area is way more convenient.
  • "Show changes" is what I need/use the most, so in one step I can check both the page content and the edit summary.
  • Don't have to remember if "Show changes" or "Show preview" should be used. Both just work.

Also note the API request to parse the edit summary is still made currently…

The comments by Nardog are relevant as well. This regression appears to be more and more frustrating for me… so I am forced to disable live preview for now.

@Ammarpad could you please submit a patch to fix this regression?

Change 935190 had a related patch set uploaded (by Nardog; author: Nardog):

[mediawiki/core@master] LivePreview: Show summary preview in live diff

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

As far as I understand, the whole reason live diff sends a parse request is to retrieve the parsed summary. So after T293930 it was sending it for no reason.

Ammarpad subscribed.

The comments by Nardog are relevant as well. This regression appears to be more and more frustrating for me… so I am forced to disable live preview for now.

@Ammarpad could you please submit a patch to fix this regression?

Sorry, no. It's not a regression to me. Thanks

I understand that if you read it literally, "Show changes" doesn't imply that a preview of edit summary will be shown, but in practice, that's just way more convenient to use, and everyone got used to it over the years. The non-live version of "Show changes" displays a preview of edit summary too.

I'll merge the patch to add it back. I hope that's fine with everyone. The change will be deployed to Wikimedia wikis next week, per the usual schedule.

Change 935190 merged by jenkins-bot:

[mediawiki/core@master] LivePreview: Show summary preview in live diff

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

matmarex assigned this task to Nardog.

Also, when editing a page of the Module: namespace, there is no "Show preview" button. Thus, to be able to preview the edit summary, one had to copy/paste it to another edit page…