Edgewall Software
Modify

Opened 8 years ago

Last modified 18 months ago

#3914 new enhancement

ticket change notification should contain diff'ed text, not old and new

Reported by: ThurnerRupert Owned by: cboos
Priority: normal Milestone: next-major-releases
Component: notification Version: 0.10
Severity: normal Keywords: notification email
Cc: mho2@…, leho@…
Release Notes:
API Changes:

Description

it would be beneficial, if the notification mail on a ticket change containes a diff'ed output instead of the old and new text. especially when a description is long and just a little thing changed its quite a challenge to find out what changed.

Attachments (1)

unify-desc-changes.patch (1.8 KB) - added by Dave Gray <trac@…> 4 years ago.
patch from #8862 updated to display entire context and hide header

Download all attachments as: .zip

Change History (15)

comment:1 follow-ups: Changed 8 years ago by cboos

What about the diff with the full context?

comment:2 in reply to: ↑ 1 Changed 7 years ago by anonymous

Replying to cboos:

What about the diff with the full context?

would be even better :)

comment:3 Changed 7 years ago by cboos

  • Milestone set to 0.11
  • Owner changed from jonas to cboos

comment:4 in reply to: ↑ 1 ; follow-up: Changed 7 years ago by mgood

Replying to cboos:

What about the diff with the full context?

Be sure to take into account the line wrapping. Descriptions will probably have long lines that get wrapped for the email, so they'll need diffed after wrapping so the diff doesn't get screwed up.

comment:5 in reply to: ↑ 4 ; follow-up: Changed 7 years ago by eblot

Replying to mgood:

Be sure to take into account the line wrapping. Descriptions will probably have long lines that get wrapped for the email, so they'll need diffed after wrapping so the diff doesn't get screwed up.

Base64 encoding can avoid this issue (as the base64 stream encode the line feed as any other characters). Other encoding schemes (such as QP) are subject to this issue.

Another solution is to make diff'ed text appear as attached files, not inlined within the notification text. Attaching documents to notification would require some careful rework, as previous attempts to use multipart email messages have led to unexpected difficulties.

Anyway, IMHO such a feature could be a candidate for 0.12 rather than 0.11

comment:6 in reply to: ↑ 5 ; follow-up: Changed 7 years ago by mgood

Replying to eblot:

Replying to mgood:

Be sure to take into account the line wrapping. Descriptions will probably have long lines that get wrapped for the email, so they'll need diffed after wrapping so the diff doesn't get screwed up.

Base64 encoding can avoid this issue (as the base64 stream encode the line feed as any other characters). Other encoding schemes (such as QP) are subject to this issue.

No, that's not really what I meant. I'm not sure I understand why the encoding would affect the display. What I mean is that for email display you'll want to wrap the lines in the description so they don't run off the screen. Doing this after doing the diff will produce incorrect diffs like:

- this is the old
description getting
wrapped
+ this is the new
description also
being wrapped

Which would be better displayed as:

- this is the old
- description getting
- wrapped
+ this is the new
+ description also
+ being wrapped

comment:7 in reply to: ↑ 6 Changed 7 years ago by eblot

Replying to mgood:

No, that's not really what I meant. I'm not sure I understand why the encoding would affect the display.

Oh ok, I got it.
About the encoding: email data line should be limited to 76 characters (according to RFC822), so Trac needs to introduce line breaks before sending the email. However with Base64, the original line breaks do not matter, as they never appear in the data sent over SMTP: MIME/Base64 adds its own line breaks that are unrelated with the encoded line breaks.

Nevertheless, I did not though about email display on the MUA, so you can forget about my comment, even though we might need to introduce multipart MIME message at some point.

comment:8 Changed 7 years ago by cboos

  • Component changed from general to ticket system
  • Keywords notification email added
  • Milestone changed from 0.11 to 0.12

Probably 0.12.

comment:9 Changed 6 years ago by osimons

#6664 is working to make a diff available for the web ui. I have noted the question of email diffs on that ticket.

comment:10 Changed 5 years ago by cboos

  • Cc mho2@… added

#8503 was closed as duplicate.

comment:11 Changed 4 years ago by cboos

#8862 was closed as duplicate. If the patch is resubmitted here with the requested changes, we can move that ticket to 0.12.

Changed 4 years ago by Dave Gray <trac@…>

patch from #8862 updated to display entire context and hide header

comment:12 Changed 4 years ago by Dave Gray <trac@…>

patch from #8862 has been updated and is attached

comment:13 Changed 4 years ago by lkraav <leho@…>

  • Cc leho@… added

i was about to file an enhancement bug regarding missing diff links in ticket description change rss feed.

searched through tickets with "ticket description diff", found this and am now wondering if this ticket applies to my question as well?

comment:14 Changed 18 months ago by psuter

  • Component changed from ticket system to notification

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as new The owner will remain cboos.
as The resolution will be set. Next status will be 'closed'.
The owner will be changed from cboos to anonymous. Next status will be 'assigned'.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.