Stream Readability

[srenault-meeds]

Rationale

More knowledge is shared in the stream, more it can be difficult to know what is useful for me as a user. Indeed:

1. Posts that I have already read are still displayed in their whole content
2. Comment with links can be really noisy for eyes (link length + link embedded thumbnail) and it is not useful for any reader.

1. Functional Requirements

Top User Stories

1. Read/unread activity display

Current As a user, when new activity is posted

• OR when a new comment is added to an activity I have commented
• OR... Then the unread activities red dot is displayed as currently. Once read, the red dot disappears

New display / UX

• Case 1: New unread activity I have not read the activity. Red dot is displayed AND until I reload the page, the activity is fully displayed

• Case 2: Activity is read I have read the activity. Red dot has disappearred. It is no more considered as an unread activity. Considering the activity is longer than 5 lines When going back to the stream Then this activity is collapsed to see only the first 4 lines AND I can click to a see more to see the whole activity

• Case 3: Unread activity "again" - Edit case I have read the activity. But since the last time I saw it, it is back to unread status. Indeed, the activity has been edited Then in addition to the red dot, the activity is fully displayed so I can acknowledge it has been edited

• Case 4: Unread activity "again" - like case My activity has been liked. It is back to unread status Then the activity remains collapsed if longer than 5 lines

• Case 5: Unread activity "again" - comment case / comment edition case My activity has been commented Then the activity remains collapsed if longer than 5 lines AND the most two recent comments are listed below

• Case 6: Unread activity "again" - reply to a comment, like to a comment My comment has been replied or liked Then the activity remains collapsed if longer than 5 lines AND the related comment is displayed below (max the two most recent)

• Case 7: Read activity (activity, comment, etc.) The activity is read and no activity is identified there (no like, no edit, no comment, no reply) Then:

  1. Activity is collapsed if longer than 5 lines
  2. Comment are collapsed A "View all comments" is proposed below the activity to display all comments in the drawer

2. Links readability / posting

Current As a user, when adding multiple links to a post Then only the first is embedded And both links are fully displayed

New display / UX

• Case 1: When adding only one link, then don't display it As an embedded display is proposed

• Case 2: When adding more than one link, Then display all links and keep the fact the first is embedded

• Case 3: When posting links longer than 75 char., Then display an ellipsis

3. Links readability / commenting Current As a user, when adding links in a comment Then links can be embedded And links are fully displayed

New display / UX When adding links to a comment Then:

• No embedded display anymore except video links
• Only first 75 char. are displayed

5. Links display When adding links Then an icon before the link is added so we can quickly see what this is about
   • internal links
   • external links
   • if not know, a link icon is displayed

Impacts

Gamification

NA

Notifications

NA

Analytics

NA

Unified Search

NA

2. Technical Requirements

Expected Volume & Performance

Security

Extensibility

Configurability

Upgradability

Existing Features

Feature Flags

Other Non Functional Requirements

3. Impacts

Documentation

Training

4. Software Architecture

Services & processing

Neither Rest nor WebSockets APIs will be added here.

The existing webSocket ActivityStreamWebSocketService will be used to broadcast activities events . Thus we need to subscribe to the Channel “/eXo/Application/ActivityStream” and listen to the following activities and comments actions:

• updateActivity
• likeActivity
• createComment
• updateComment
• likeComment

To check the read/unread activity, we will adopt the same approach as the unread badge display. Therefore, we will utilize the activity.metadata.unread object to determine whether the activity should be displayed in its full or collapsed form.

If the activity is fully displayed, we need to reload the page in order to collapse the activity content.

We Have to add a new param collapsed (default = true) to the activity content extension to enable the display of full or collapsed activity content.

[srenault-meeds]

To check @margondicco thanks

[margondicco]

Go Fonc (+ we should keep embeded video in comment)

[srenault-meeds]

Ok. Thanks (added the embedded video case)

[SaraBoutej]

Ready for tech review by DAO Members (eXo: @rdenarie )

[rdenarie]

ok for me

[SaraBoutej]

MIP ready for review by the DAO members (cc @rdenarie ). Acc up

[margondicco]

Hello thank you @SaraBoutej . Tested and validated

cc @srenault-meeds

[rdenarie]

Ok for me, you can proceed to merge