Make chat exports use ISO 8601/RFC 3339 dates and be more informative #8558

yaya-usman · 2022-05-10T20:17:03Z

Fixes: vector-im/element-web#21812

it also includes the room name in the file export name.

Signed-off-by: Yaya Usman yaya-usman@users.noreply.github.com

Before:

After:

Here's what your changelog entry will look like:

✨ Features

Make chat exports use ISO 8601/RFC 3339 dates and be more informative (#8558). Contributed by @yaya-usman.

turt2live

Thanks for the PR! While I don't think the Product team cares about the date format as much, they might have thoughts on the file naming otherwise (such as the room name being awkward to look at when made filesafe, or the lack of brand variable to denote where the file came from).

Requesting review from the product team to determine if this assumption is true.

turt2live · 2022-05-10T20:18:48Z

src/utils/exportUtils/JSONExport.ts

@@ -108,7 +108,7 @@ export default class JSONExporter extends Exporter {
 this.addFile("export.json", new Blob([text]));
 await this.downloadZIP();
 } else {
- const fileName = `matrix-export-${formatFullDateNoDay(new Date())}.json`;
+ const fileName = `${this.room.name}-${formatFullDateNoDayISO(new Date())}.json`;


applies throughout: what if the room name contains characters that can't be translated into a file name?

ohh i understand, i probably should check the room name first, if it contains characters that can't be used as a filename, then i default to the brand name or so, how about that?

kittykat · 2022-05-12T09:16:56Z

In what cases is "Element - Chat Export - […]" currently being used? Looking at the before screenshot

yaya-usman · 2022-05-12T09:41:37Z

In what cases is "Element - Chat Export - […]" currently being used? Looking at the before screenshot

When a chat is exported as an HTML

kittykat

I think the filename should be "Element-<roomname>-<ISOdate>" in all cases. For example, Element-testroom-2022-05-12T12_00_00.735Z.json

I will leave it to the technical review on what exactly should happen with room names that can't be translated to filenames, but please feel welcome to ask for my input if needed.

yaya-usman · 2022-05-12T11:21:22Z

I think the filename should be "Element-<roomname>-<ISOdate>" in all cases. For example, Element-testroom-2022-05-12T12_00_00.735Z.json

I will leave it to the technical review on what exactly should happen with room names that can't be translated to filenames, but please feel welcome to ask for my input if needed.

Ok thanks, so should i go ahead and implement your suggestion? also concerning the room names that can't be translated to filenames, i already made a suggestion up there like we can check if the room name has some characters that's not acceptable in a filename with regex or so, if it does, we just ignore it and default to the brand name like Element-Chat Export-2022-05-12T12_00_00.735Z.json what do you think?

kittykat · 2022-05-13T08:12:37Z

@yaya-usman Yes, please implement. To confirm, filename should have the following order of preference:

Element-<roomname>-<ISOdate>
If some characters cannot be in the filename, drop those characters and use only ones that can be
If that leaves no <roomname> component, then drop back to Element-chat-export-<ISOdate>

into patch/date_format

yaya-usman · 2022-05-14T00:15:06Z

@kittykat I have made adjustments based on your suggestions. Below images shows the result

tested room names

The following is the resulting filename

It works for all the exports

kittykat

LGTM.

One improvement could be to drop any leading and trailing whitespace in room name when the filename is put together. E.g. Room / / could give a filename of Element-Room-2022-05-18T10_28_10.032Z.zip instead of ``Element-Room -2022-05-18T10_28_10.032Z.zip`.

yaya-usman · 2022-05-18T21:23:58Z

LGTM.

One improvement could be to drop any leading and trailing whitespace in room name when the filename is put together. E.g. Room / / could give a filename of Element-Room-2022-05-18T10_28_10.032Z.zip instead of ``Element-Room -2022-05-18T10_28_10.032Z.zip`.

This means if the room name is say Empty room then the filename should be Element-Emptyroom-2022-05-18T10_28_10.032Z.zip instead of Element-Empty room-2022-05-18T10_28_10.032Z.zip right?

kittykat · 2022-05-19T08:20:29Z

LGTM.
One improvement could be to drop any leading and trailing whitespace in room name when the filename is put together. E.g. Room / / could give a filename of Element-Room-2022-05-18T10_28_10.032Z.zip instead of ``Element-Room -2022-05-18T10_28_10.032Z.zip`.

This means if the room name is say Empty room then the filename should be Element-Emptyroom-2022-05-18T10_28_10.032Z.zip instead of Element-Empty room-2022-05-18T10_28_10.032Z.zip right?
develop

Mid-string spaces would stay where they are so ideally:

Empty room to Element-Empty room-2022-05-18T10_28_10.032Z.zip
Empty room / to Element-Empty room-2022-05-18T10_28_10.032Z.zip as well

If this is not easy, then we can keep it as:

Empty room / to Element-Empty room -2022-05-18T10_28_10.032Z.zip

t3chguy · 2022-05-20T15:29:22Z

This PR contends with #7992

kittykat · 2022-05-20T15:55:46Z

@yaya-usman Sorry to follow up again but because of the conflicting PR, can you please split out changing date format into its own PR and tag me in it for product signoff? We can merge that one as soon as possible, and then figure out how to handle the naming conflicts separately 👍

Thank you!

yaya-usman · 2022-05-21T06:07:56Z

@yaya-usman Sorry to follow up again but because of the conflicting PR, can you please split out changing date format into its own PR and tag me in it for product signoff? We can merge that one as soon as possible, and then figure out how to handle the naming conflicts separately 👍

Thank you!

Sure no problem, Sorry for the late response. I will be back fully when I am done with exams in school next weekend.

kittykat · 2022-07-26T13:17:46Z

@yaya-usman could you please split out this PR into two? We would like to merge the update to the date format on top of #7992 and then review the other changes to naming separately.

yaya-usman · 2022-07-27T07:18:20Z

@yaya-usman could you please split out this PR into two? We would like to merge the update to the date format on top of #7992 and then review the other changes to naming separately.

Sorry for the late response, i thought this PR has been resolved or rather has been fixed by another person, i deleted the branch from my local but i guess i can still get it back. Also how do i split the PR, i don't really understand that part

kittykat · 2022-07-27T10:41:28Z

@yaya-usman could you please split out this PR into two? We would like to merge the update to the date format on top of #7992 and then review the other changes to naming separately.

Sorry for the late response, i thought this PR has been resolved or rather has been fixed by another person, i deleted the branch from my local but i guess i can still get it back. Also how do i split the PR, i don't really understand that part

Here's a guide you could have a look at for splitting a PR and to split a commit, I would use an interactive rebase, edit the commit, then do an interactive add

turt2live · 2022-10-17T23:36:26Z

Thanks for the PR! After asking for things to be split up we talked about it more as a group and came to a slightly different conclusion on the file naming. That conclusion is now documented as #9440 (which includes your other PR in it). Hopefully this means the code lands sooner - apologies for the delay here.

exported chat date iso formatted

245c3bd

yaya-usman requested a review from a team as a code owner May 10, 2022 20:17

github-actions bot added the T-Defect Bugs, crashes, hangs, vulnerabilities, or other reported problems label May 10, 2022

turt2live suggested changes May 10, 2022

View reviewed changes

turt2live requested a review from a team May 10, 2022 20:21

turt2live added T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements and removed T-Defect Bugs, crashes, hangs, vulnerabilities, or other reported problems labels May 10, 2022

turt2live changed the title ~~Fixes the issue "Chat exports should use ISO 8601/RFC 3339 dates and be more informative"~~ Make chat exports use ISO 8601/RFC 3339 dates and be more informative May 10, 2022

github-actions bot deployed to Netlify May 10, 2022 20:29 View deployment

kittykat self-assigned this May 12, 2022

kittykat suggested changes May 12, 2022

View reviewed changes

yaya-usman added 2 commits May 14, 2022 00:13

Merge branch 'develop' of https://github.com/yaya-usman/matrix-react-sdk

a4f861e

into patch/date_format

updated export filename format

a14d636

yaya-usman requested a review from kittykat May 14, 2022 00:15

github-actions bot deployed to Netlify May 14, 2022 00:16 View deployment

Merge branch 'develop' into patch/date_format

37c43c6

github-actions bot deployed to Netlify May 18, 2022 09:06 View deployment

kittykat approved these changes May 18, 2022

View reviewed changes

kittykat requested a review from turt2live May 18, 2022 21:10

Merge branch 'develop' into patch/date_format

f0a287b

github-actions bot deployed to Netlify May 20, 2022 09:22 View deployment

t3chguy mentioned this pull request May 20, 2022

conversation export named after room #7992

Closed

turt2live removed their request for review May 31, 2022 21:48

MadLittleMods added the Z-Community-PR Issue is solved by a community member's PR label Jun 1, 2022

yaya-usman mentioned this pull request Aug 6, 2022

Exported filename ISO date format #9142

Closed

turt2live closed this Oct 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make chat exports use ISO 8601/RFC 3339 dates and be more informative #8558

Make chat exports use ISO 8601/RFC 3339 dates and be more informative #8558

yaya-usman commented May 10, 2022 •

edited by github-actions bot

Loading

turt2live left a comment

turt2live May 10, 2022

yaya-usman May 10, 2022

kittykat commented May 12, 2022

yaya-usman commented May 12, 2022

kittykat left a comment •

edited

Loading

yaya-usman commented May 12, 2022 •

edited

Loading

kittykat commented May 13, 2022

yaya-usman commented May 14, 2022 •

edited

Loading

kittykat left a comment

yaya-usman commented May 18, 2022

kittykat commented May 19, 2022 •

edited

Loading

t3chguy commented May 20, 2022

kittykat commented May 20, 2022

yaya-usman commented May 21, 2022

kittykat commented Jul 26, 2022

yaya-usman commented Jul 27, 2022 •

edited

Loading

kittykat commented Jul 27, 2022

turt2live commented Oct 17, 2022

Make chat exports use ISO 8601/RFC 3339 dates and be more informative #8558

Make chat exports use ISO 8601/RFC 3339 dates and be more informative #8558

Conversation

yaya-usman commented May 10, 2022 • edited by github-actions bot Loading

✨ Features

turt2live left a comment

Choose a reason for hiding this comment

turt2live May 10, 2022

Choose a reason for hiding this comment

yaya-usman May 10, 2022

Choose a reason for hiding this comment

kittykat commented May 12, 2022

yaya-usman commented May 12, 2022

kittykat left a comment • edited Loading

Choose a reason for hiding this comment

yaya-usman commented May 12, 2022 • edited Loading

kittykat commented May 13, 2022

yaya-usman commented May 14, 2022 • edited Loading

kittykat left a comment

Choose a reason for hiding this comment

yaya-usman commented May 18, 2022

kittykat commented May 19, 2022 • edited Loading

t3chguy commented May 20, 2022

kittykat commented May 20, 2022

yaya-usman commented May 21, 2022

kittykat commented Jul 26, 2022

yaya-usman commented Jul 27, 2022 • edited Loading

kittykat commented Jul 27, 2022

turt2live commented Oct 17, 2022

yaya-usman commented May 10, 2022 •

edited by github-actions bot

Loading

kittykat left a comment •

edited

Loading

yaya-usman commented May 12, 2022 •

edited

Loading

yaya-usman commented May 14, 2022 •

edited

Loading

kittykat commented May 19, 2022 •

edited

Loading

yaya-usman commented Jul 27, 2022 •

edited

Loading