Edgewall Software
Modify

Opened 13 years ago

Last modified 3 months ago

#3914 new enhancement

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

Reported by: ThurnerRupert Owned by:
Priority: normal Milestone: next-dev-1.5.x
Component: notification Version: 0.10
Severity: normal Keywords: notification email
Cc: mho2@…, leho@… Branch:
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@…> 10 years ago.
patch from #8862 updated to display entire context and hide header

Download all attachments as: .zip

Change History (23)

comment:1 by Christian Boos, 13 years ago

What about the diff with the full context?

in reply to:  1 comment:2 by anonymous, 13 years ago

Replying to cboos:

What about the diff with the full context?

would be even better :)

comment:3 by Christian Boos, 13 years ago

Milestone: 0.11
Owner: changed from Jonas Borgström to Christian Boos

in reply to:  1 ; comment:4 by Matthew Good, 13 years ago

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.

in reply to:  4 ; comment:5 by Emmanuel Blot, 13 years ago

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

in reply to:  5 ; comment:6 by Matthew Good, 13 years ago

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

in reply to:  6 comment:7 by Emmanuel Blot, 13 years ago

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 by Christian Boos, 13 years ago

Component: generalticket system
Keywords: notification email added
Milestone: 0.110.12

Probably 0.12.

comment:9 by osimons, 12 years ago

#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 by Christian Boos, 10 years ago

Cc: mho2@… added

#8503 was closed as duplicate.

comment:11 by Christian Boos, 10 years ago

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

by Dave Gray <trac@…>, 10 years ago

Attachment: unify-desc-changes.patch added

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

comment:12 by Dave Gray <trac@…>, 10 years ago

patch from #8862 has been updated and is attached

comment:13 by lkraav <leho@…>, 10 years ago

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 by Peter Suter, 7 years ago

Component: ticket systemnotification

comment:15 by Ryan J Ollos, 5 years ago

Owner: Christian Boos removed

comment:16 by Ryan J Ollos, 21 months ago

#13001 closed as a duplicate.

comment:17 by Ryan J Ollos, 20 months ago

Milestone: next-major-releases1.3.3

Let's consider for 1.4.

comment:18 by Ryan J Ollos, 20 months ago

Milestone: 1.3.31.3.4

comment:19 by Ryan J Ollos, 15 months ago

Milestone: 1.3.41.3.5

comment:20 by Ryan J Ollos, 5 months ago

Milestone: 1.3.51.3.6

comment:21 by Ryan J Ollos, 4 months ago

Milestone: 1.3.61.5.1

comment:22 by Ryan J Ollos, 3 months ago

Milestone: 1.5.1next-dev-1.5.x

Modify Ticket

Change Properties
Set your email in Preferences
Action
as new The ticket will remain with no owner.
The ticket will be disowned. Next status will be 'new'.
as The resolution will be set. Next status will be 'closed'.
The owner will be changed from (none) to anonymous. Next status will be 'assigned'.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.