chat_session_start_spec.rb 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. require 'rails_helper'
  2. RSpec.describe Sessions::Event::ChatSessionStart do
  3. let(:client_id) { rand(123_456_789) }
  4. let(:chat) { Chat.first }
  5. let(:chat_session) do
  6. Sessions.create('customer_session_id', { 'id' => customer.id }, {})
  7. Sessions.queue('customer_session_id')
  8. Chat::Session.create(
  9. chat_id: chat.id,
  10. user_id: nil,
  11. preferences: { participants: ['customer_session_id'] },
  12. state: 'waiting',
  13. )
  14. end
  15. let!(:agent) do
  16. agent = create(:agent, preferences: { chat: { active: { chat.id.to_s => 'on' } } })
  17. file = File.open('test/data/image/1000x1000.png', 'rb')
  18. contents = file.read
  19. avatar = Avatar.add(
  20. object: 'User',
  21. o_id: agent.id,
  22. default: true,
  23. resize: {
  24. content: contents,
  25. mime_type: 'image/jpg',
  26. },
  27. source: 'web',
  28. deletable: true,
  29. updated_by_id: 1,
  30. created_by_id: 1,
  31. )
  32. Avatar.set_default('User', agent.id, avatar.id)
  33. agent.image = avatar.store_hash
  34. agent.save!
  35. agent
  36. end
  37. let!(:customer) { create(:customer) }
  38. let(:subject_as_agent) do
  39. Sessions.create(client_id, { 'id' => agent.id }, {})
  40. Sessions.queue(client_id)
  41. described_class.new(
  42. payload: { 'data' => chat_session.session_id },
  43. user_id: agent.id,
  44. client_id: client_id,
  45. clients: {},
  46. session: { 'id' => agent.id },
  47. )
  48. end
  49. let(:chat_message_history) do
  50. Chat::Message.create!(
  51. chat_session_id: chat_session.id,
  52. content: 'some message',
  53. )
  54. end
  55. before do
  56. Setting.set('chat', true)
  57. end
  58. context 'when starting a chat session as customer' do
  59. let(:subject_as_customer) do
  60. Sessions.create(client_id, { 'id' => customer.id }, {})
  61. Sessions.queue(client_id)
  62. described_class.new(
  63. payload: { 'data' => chat_session.session_id },
  64. user_id: customer.id,
  65. client_id: client_id,
  66. clients: {},
  67. session: { 'id' => customer.id },
  68. )
  69. end
  70. context 'without chat.agent permissions' do
  71. it 'send out no_permission event to user' do
  72. expect(subject_as_customer.run).to eq(nil)
  73. messages = Sessions.queue(client_id)
  74. expect(messages.count).to eq(1)
  75. expect(messages).to eq([
  76. { 'event' => 'chat_error',
  77. 'data' => {
  78. 'state' => 'no_permission'
  79. } }
  80. ])
  81. end
  82. end
  83. end
  84. context 'when starting a chat session with invalid chat_session_id' do
  85. let(:subject_with_invalid_session_id) do
  86. described_class.new(
  87. payload: { 'data' => 'not_existing_chat_session_id' },
  88. user_id: agent.id,
  89. client_id: client_id,
  90. clients: {},
  91. session: { 'id' => agent.id },
  92. )
  93. end
  94. it 'return failed message' do
  95. expect(subject_with_invalid_session_id.run).to eq(
  96. event: 'chat_session_start',
  97. data: {
  98. state: 'failed',
  99. message: 'No session available.',
  100. },
  101. )
  102. end
  103. end
  104. context 'when starting a chat session as agent' do
  105. it 'send out chat_session_start to customer and agent' do
  106. expect(subject_as_agent.run).to eq(nil)
  107. messages_to_customer = Sessions.queue('customer_session_id')
  108. expect(messages_to_customer.count).to eq(1)
  109. expect(messages_to_customer[0]).to eq(
  110. 'event' => 'chat_session_start',
  111. 'data' => {
  112. 'state' => 'ok',
  113. 'agent' => {
  114. 'name' => agent.fullname,
  115. 'avatar' => 'http://zammad.example.com/api/v1/users/image/4cbd23059d5eb008f28a0f8bfbc723be',
  116. },
  117. 'chat_id' => chat.id,
  118. 'session_id' => chat_session.session_id,
  119. },
  120. )
  121. messages_to_agent = Sessions.queue(client_id)
  122. expect(messages_to_agent.count).to eq(1)
  123. expect(messages_to_agent[0]).to include(
  124. 'event' => 'chat_session_start',
  125. 'data' => hash_including(
  126. 'session' => hash_including(
  127. 'user_id' => agent.id,
  128. 'state' => 'running',
  129. 'preferences' => hash_including(
  130. 'participants' => ['customer_session_id', client_id]
  131. ),
  132. 'id' => chat_session.id,
  133. 'chat_id' => chat_session.chat_id,
  134. 'session_id' => chat_session.session_id,
  135. 'name' => nil,
  136. )
  137. )
  138. )
  139. end
  140. end
  141. context 'when starting a chat session as agent with alternative_name and no avatar_state' do
  142. it 'send out chat_session_start to customer (with prepared agent information) and agent' do
  143. agent.preferences[:chat] ||= {}
  144. agent.preferences[:chat][:alternative_name] = 'some name'
  145. agent.preferences[:chat][:avatar_state] = 'disabled'
  146. agent.save!
  147. expect(subject_as_agent.run).to eq(nil)
  148. messages_to_customer = Sessions.queue('customer_session_id')
  149. expect(messages_to_customer.count).to eq(1)
  150. expect(messages_to_customer[0]).to eq(
  151. 'event' => 'chat_session_start',
  152. 'data' => {
  153. 'state' => 'ok',
  154. 'agent' => {
  155. 'name' => 'some name',
  156. 'avatar' => nil,
  157. },
  158. 'chat_id' => chat.id,
  159. 'session_id' => chat_session.session_id,
  160. },
  161. )
  162. messages_to_agent = Sessions.queue(client_id)
  163. expect(messages_to_agent.count).to eq(1)
  164. expect(messages_to_agent[0]).to include(
  165. 'event' => 'chat_session_start',
  166. 'data' => hash_including(
  167. 'session' => hash_including(
  168. 'user_id' => agent.id,
  169. 'state' => 'running',
  170. 'preferences' => hash_including(
  171. 'participants' => ['customer_session_id', client_id]
  172. ),
  173. 'id' => chat_session.id,
  174. 'chat_id' => chat_session.chat_id,
  175. 'session_id' => chat_session.session_id,
  176. 'name' => nil,
  177. )
  178. )
  179. )
  180. end
  181. end
  182. context 'when starting a chat session as agent with transfered conversation' do
  183. it 'send out chat_session_start to customer and agent with already created messages' do
  184. chat_message_history
  185. expect(subject_as_agent.run).to eq(nil)
  186. messages_to_customer = Sessions.queue('customer_session_id')
  187. expect(messages_to_customer.count).to eq(0)
  188. messages_to_agent = Sessions.queue(client_id)
  189. expect(messages_to_agent.count).to eq(1)
  190. expect(messages_to_agent[0]).to include(
  191. 'event' => 'chat_session_start',
  192. 'data' => hash_including(
  193. 'session' => hash_including(
  194. 'user_id' => agent.id,
  195. 'state' => 'running',
  196. 'preferences' => hash_including(
  197. 'participants' => ['customer_session_id', client_id]
  198. ),
  199. 'messages' => array_including(
  200. hash_including(
  201. 'content' => 'some message',
  202. ),
  203. ),
  204. 'id' => chat_session.id,
  205. 'chat_id' => chat_session.chat_id,
  206. 'session_id' => chat_session.session_id,
  207. 'name' => nil,
  208. )
  209. )
  210. )
  211. end
  212. end
  213. end