Last modified: 2009-10-11 18:11:09 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T22601, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 20601 - Do not put "diff generator" comments into feeds
Do not put "diff generator" comments into feeds
Status: RESOLVED FIXED
Product: MediaWiki
Classification: Unclassified
Recent changes (Other open bugs)
1.16.x
All All
: Normal normal (vote)
: ---
Assigned To: Nobody - You can work on this!
http://article.gmane.org/gmane.emacs....
:
Depends on: 21053
Blocks: feeds
  Show dependency treegraph
 
Reported: 2009-09-11 19:18 UTC by Dan Jacobson
Modified: 2009-10-11 18:11 UTC (History)
2 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments
turn off damaging debugging comments in production environment (1001 bytes, patch)
2009-09-13 01:03 UTC, Dan Jacobson
Details

Description Dan Jacobson 2009-09-11 19:18:16 UTC
Gentlemen, please do not put
"<!-- diff generator: internal 2009-09-07 20:40:16 -->"
comments into feeds!

Many RSS readers make a checksum, and this changing item
causes articles to appear new each time!

No other feed providers do this.
Comment 1 Chad H. 2009-09-11 21:43:37 UTC
Lowering severity.
Comment 2 Dan Jacobson 2009-09-13 01:03:55 UTC
Created attachment 6546 [details]
turn off damaging debugging comments in production environment

You don't understand how serious the problem is.
For rapidly changing wikis, users won't notice the problem.
But for small wikis, you will be doubling the users RSS stored articles each
time he browses... and he will wonder why they have reappeared again as
new.

Let's see the difference in the same HTTP GET of
index.php?title=Special:RecentChanges&feed=rss
before and after doing
TRUNCATE TABLE objectcache:
>@@ -24 +24 @@
>-		<lastBuildDate>Sun, 13 Sep 2009 00:09:25 GMT</lastBuildDate>
>+		<lastBuildDate>Sun, 13 Sep 2009 00:12:10 GMT</lastBuildDate>
>@@ -87 +87 @@
>-&lt;!-- diff generator: internal 2009-09-13 00:09:26 --&gt;
>+&lt;!-- diff generator: internal 2009-09-13 00:12:10 --&gt;
Well, we see the lastBuildDate holds the same information, so the
attached patch to remove the superfluous diff generator comment will not
remove any information, and at the same time not confuse RSS readers
into thinking the article has changed!

The better maintained a wiki is (the more often it is updated), the more
frustrated the user becomes, as each update truncates the objectcache,
causing the comments you are putting into the bodies to change.

Keep your debugging comments off in production environments please.
Comment 3 Chad H. 2009-09-14 02:13:37 UTC
Removing patch keyword, not a desirable solution.
Comment 4 Dan Jacobson 2009-09-14 19:00:15 UTC
And furthermore:
"But I'm only putting comments into an XML feed." No you are not.
Comments look like <!-- ... -->, not encoded.

"But I provide a Last-modified HTTP header." Yes, however all it takes
is for one item in the feed to change, and then we get all the items
which contain diffs change. Caching 101... the basics, don't spoil it.

Comment 5 Tim Starling 2009-09-16 03:48:53 UTC
Committed similar solution in r56406.
Comment 6 Dan Jacobson 2009-09-17 00:35:54 UTC
Thanks. Discussion logged in http://news.gmane.org/group/gmane.org.wikimedia.mediawiki/thread=32143 .

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links