947615 - Event description shows escaped comma and line breaks

Status: RESOLVED FIXED

(Calendar :: ICAL.js Integration, defect)

Description

[Patrick Cloke [:clokep]]

Attachment: unescaped-tooltip.png

This has been happening for a little while now, but I couldn't find a bug filed on it. I have a CalDAV calendar set up with Google Calendar on trunk Thunderbird and Lightning. When I create an event with a description, the description comes back with commas escaped (as \,) and line breaks as \n. See the attached screenshot of a tooltip. (Note that the commas in the Location field are also escaped.)

This is exhibited for both events created in Google Calendar itself and in Lightning. But viewing these events in Google Calendar doesn't show any issues.

Comment 1

[[:MakeMyDay]]

On a CalDAV calendar it is not just the tooltip but also the information in event dialog which is displayed in that way, while this does not happen for local calendars. Additionally, e-mail invitation are also displayed with the escaped characters.

This happens only, if ical.js is enabled - with libical, everything is displayed as expected. So, it seems to be an ical.js issue.

Comment 2

[Philipp Kewisch [:Fallen][☁️📆]]

Attachment: WiP - v1

Confirmed and issue found. Since at the time I didn't exactly remember what valueAsIcalString does I just implemented the value property and forwarded the other one. Here is what is supposed to happen:

* get value gives you the unescaped string
* get valueAsIcalString gives you the escaped string

The setters behave the same way, which I have not fixed yet. See the failing test case. MakeMyDay, any chance you can pick up on this?

Comment 3

[[:MakeMyDay]]

Yes, I'll take this.

Comment 4

[[:MakeMyDay]]

Attachment: FixIcaljsCharacterEscaping-V2.diff

Updated patch based on your one. Setters are added. Text is not displayed escaped anymore and tests passed on try-comm-central.

Comment 5

[Patrick Cloke [:clokep]]

https://hg.mozilla.org/comm-central/rev/98ee5d8c976a

Comment 6

[Philipp Kewisch [:Fallen][☁️📆]]

Geoff, check out this bug regarding your comment in IRC. There needs to be a difference between value and valueAsIcalString. I never really know which is which though and why we really need them both.