2022-11-02 09:41:30 -04:00
import { click , visit } from "@ember/test-helpers" ;
import {
acceptance ,
exists ,
visible ,
} from "discourse/tests/helpers/qunit-helpers" ;
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 07:21:02 -05:00
import { skip } from "qunit" ;
2022-11-02 09:41:30 -04:00
acceptance ( "Discourse Chat - Chat live pane collapse" , function ( needs ) {
needs . user ( {
username : "eviltrout" ,
id : 1 ,
can _chat : true ,
has _chat _enabled : true ,
} ) ;
needs . settings ( {
chat _enabled : true ,
} ) ;
needs . pretender ( ( server , helper ) => {
server . get ( "/chat/:chatChannelId/messages.json" , ( ) =>
helper . response ( {
meta : {
can _chat : true ,
user _silenced : false ,
} ,
chat _messages : [
{
id : 1 ,
message : "https://www.youtube.com/watch?v=aOWkVdU4NH0" ,
cooked :
'<div class="onebox lazyYT lazyYT-container" data-youtube-id="aOWkVdU4NH0" data-youtube-title="Picnic with my cat (shaved ice & lemonade)" data-parameters="feature=oembed&wmode=opaque"> <a href="https://www.youtube.com/watch?v=aOWkVdU4NH0" target="_blank" rel="nofollow ugc noopener"> <img class="ytp-thumbnail-image" src="/images/discourse-logo-sketch.png" title="Picnic with my cat (shaved ice & lemonade)"></a></div>' ,
excerpt :
'<a href="https://www.youtube.com/watch?v=aOWkVdU4NH0">[Picnic with my cat (shaved ice & lemonade…</a>' ,
created _at : "2021-07-20T08:14:16.950Z" ,
flag _count : 0 ,
user : {
avatar _template :
"/letter_avatar_proxy/v4/letter/t/a9a28c/{size}.png" ,
id : 1 ,
name : "Tomtom" ,
username : "tomtom" ,
} ,
} ,
{
id : 2 ,
message : "" ,
cooked : "" ,
excerpt : "" ,
uploads : [
{
id : 4 ,
url : "/images/avatar.png" ,
original _filename : "tomtom.jpeg" ,
filesize : 93815 ,
width : 480 ,
height : 640 ,
thumbnail _width : 375 ,
thumbnail _height : 500 ,
extension : "jpeg" ,
retain _hours : null ,
human _filesize : "91.6 KB" ,
} ,
] ,
user : {
avatar _template :
"/letter_avatar_proxy/v4/letter/t/a9a28c/{size}.png" ,
id : 1 ,
name : "Tomtom" ,
username : "tomtom" ,
} ,
} ,
] ,
} )
) ;
server . get ( "/chat/chat_channels.json" , ( ) =>
helper . response ( {
public _channels : [ ] ,
direct _message _channels : [ ] ,
2022-12-01 19:57:53 -05:00
message _bus _last _ids : {
channel _metadata : 0 ,
channel _edits : 0 ,
channel _status : 0 ,
new _channel : 0 ,
user _tracking _state : 0 ,
} ,
2022-11-02 09:41:30 -04:00
} )
) ;
server . get ( "/chat/chat_channels/:chatChannelId" , ( ) =>
helper . response ( { id : 1 , title : "something" } )
) ;
server . post ( "/uploads/lookup-urls" , ( ) =>
helper . response ( [
200 ,
{ "Content-Type" : "application/json" } ,
[
{
url : "/images/avatar.png" ,
} ,
] ,
] )
) ;
} ) ;
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 07:21:02 -05:00
skip ( "can collapse and expand youtube chat" , async function ( assert ) {
2022-11-02 09:41:30 -04:00
const youtubeContainer = ".chat-message-container[data-id='1'] .lazyYT" ;
const expandImage =
".chat-message-container[data-id='1'] .chat-message-collapser-closed" ;
const collapseImage =
".chat-message-container[data-id='1'] .chat-message-collapser-opened" ;
2023-01-27 07:58:12 -05:00
await visit ( "/chat/c/cat/1" ) ;
2022-11-02 09:41:30 -04:00
assert . ok ( visible ( youtubeContainer ) ) ;
assert . ok ( visible ( collapseImage ) , "the open arrow is shown" ) ;
assert . notOk ( exists ( expandImage ) , "the close arrow is hidden" ) ;
await click ( collapseImage ) ;
assert . notOk ( visible ( youtubeContainer ) ) ;
assert . ok ( visible ( expandImage ) , "the close arrow is shown" ) ;
assert . notOk ( exists ( collapseImage ) , "the open arrow is hidden" ) ;
await click ( expandImage ) ;
assert . ok ( visible ( youtubeContainer ) ) ;
assert . ok ( visible ( collapseImage ) , "the open arrow is shown again" ) ;
assert . notOk ( exists ( expandImage ) , "the close arrow is hidden again" ) ;
} ) ;
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 07:21:02 -05:00
skip ( "lightbox shows up before and after expand and collapse" , async function ( assert ) {
2022-11-02 09:41:30 -04:00
const lightboxImage = ".mfp-img" ;
const image = ".chat-message-container[data-id='2'] .chat-img-upload" ;
const expandImage =
".chat-message-container[data-id='2'] .chat-message-collapser-closed" ;
const collapseImage =
".chat-message-container[data-id='2'] .chat-message-collapser-opened" ;
2023-01-27 07:58:12 -05:00
await visit ( "/chat/c/cat/1" ) ;
2022-11-02 09:41:30 -04:00
await click ( image ) ;
assert . ok (
exists ( document . querySelector ( lightboxImage ) ) ,
"can see lightbox"
) ;
await click ( document . querySelector ( ".mfp-container" ) ) ;
await click ( collapseImage ) ;
await click ( expandImage ) ;
await click ( image ) ;
assert . ok (
exists ( document . querySelector ( lightboxImage ) ) ,
"can see lightbox after collapse expand"
) ;
await click ( document . querySelector ( ".mfp-container" ) ) ;
} ) ;
} ) ;