@webex/plugin-meetings 2.59.1 → 2.59.3-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/.eslintrc.js +6 -6
  2. package/LICENSE +1 -1
  3. package/README.md +1204 -1204
  4. package/UPGRADING.md +287 -287
  5. package/babel.config.js +3 -3
  6. package/browsers.js +108 -108
  7. package/dist/common/browser-detection.d.ts +9 -9
  8. package/dist/common/browser-detection.js.map +1 -1
  9. package/dist/common/collection.d.ts +48 -48
  10. package/dist/common/collection.js +43 -43
  11. package/dist/common/collection.js.map +1 -1
  12. package/dist/common/config.d.ts +2 -2
  13. package/dist/common/config.js.map +1 -1
  14. package/dist/common/errors/captcha-error.d.ts +15 -15
  15. package/dist/common/errors/captcha-error.js +7 -7
  16. package/dist/common/errors/captcha-error.js.map +1 -1
  17. package/dist/common/errors/intent-to-join.d.ts +16 -16
  18. package/dist/common/errors/intent-to-join.js +7 -7
  19. package/dist/common/errors/intent-to-join.js.map +1 -1
  20. package/dist/common/errors/join-meeting.d.ts +17 -17
  21. package/dist/common/errors/join-meeting.js +8 -8
  22. package/dist/common/errors/join-meeting.js.map +1 -1
  23. package/dist/common/errors/media.d.ts +15 -15
  24. package/dist/common/errors/media.js +7 -7
  25. package/dist/common/errors/media.js.map +1 -1
  26. package/dist/common/errors/parameter.d.ts +15 -15
  27. package/dist/common/errors/parameter.js +7 -7
  28. package/dist/common/errors/parameter.js.map +1 -1
  29. package/dist/common/errors/password-error.d.ts +15 -15
  30. package/dist/common/errors/password-error.js +7 -7
  31. package/dist/common/errors/password-error.js.map +1 -1
  32. package/dist/common/errors/permission.d.ts +14 -14
  33. package/dist/common/errors/permission.js +6 -6
  34. package/dist/common/errors/permission.js.map +1 -1
  35. package/dist/common/errors/reconnection-in-progress.d.ts +9 -9
  36. package/dist/common/errors/reconnection-in-progress.js +6 -6
  37. package/dist/common/errors/reconnection-in-progress.js.map +1 -1
  38. package/dist/common/errors/reconnection.d.ts +15 -15
  39. package/dist/common/errors/reconnection.js +7 -7
  40. package/dist/common/errors/reconnection.js.map +1 -1
  41. package/dist/common/errors/stats.d.ts +15 -15
  42. package/dist/common/errors/stats.js +7 -7
  43. package/dist/common/errors/stats.js.map +1 -1
  44. package/dist/common/errors/webex-errors.d.ts +81 -81
  45. package/dist/common/errors/webex-errors.js +42 -42
  46. package/dist/common/errors/webex-errors.js.map +1 -1
  47. package/dist/common/errors/webex-meetings-error.d.ts +20 -20
  48. package/dist/common/errors/webex-meetings-error.js +12 -12
  49. package/dist/common/errors/webex-meetings-error.js.map +1 -1
  50. package/dist/common/events/events-scope.d.ts +17 -17
  51. package/dist/common/events/events-scope.js +10 -10
  52. package/dist/common/events/events-scope.js.map +1 -1
  53. package/dist/common/events/events.d.ts +12 -12
  54. package/dist/common/events/events.js +4 -4
  55. package/dist/common/events/events.js.map +1 -1
  56. package/dist/common/events/trigger-proxy.d.ts +2 -2
  57. package/dist/common/events/trigger-proxy.js.map +1 -1
  58. package/dist/common/events/util.d.ts +2 -2
  59. package/dist/common/events/util.js.map +1 -1
  60. package/dist/common/logs/logger-config.d.ts +2 -2
  61. package/dist/common/logs/logger-config.js.map +1 -1
  62. package/dist/common/logs/logger-proxy.d.ts +2 -2
  63. package/dist/common/logs/logger-proxy.js.map +1 -1
  64. package/dist/common/logs/request.d.ts +34 -34
  65. package/dist/common/logs/request.js +18 -18
  66. package/dist/common/logs/request.js.map +1 -1
  67. package/dist/common/queue.d.ts +32 -32
  68. package/dist/common/queue.js +18 -18
  69. package/dist/common/queue.js.map +1 -1
  70. package/dist/config.d.ts +73 -73
  71. package/dist/config.js.map +1 -1
  72. package/dist/constants.d.ts +924 -924
  73. package/dist/constants.js +9 -9
  74. package/dist/constants.js.map +1 -1
  75. package/dist/controls-options-manager/constants.d.ts +4 -4
  76. package/dist/controls-options-manager/constants.js.map +1 -1
  77. package/dist/controls-options-manager/enums.d.ts +5 -5
  78. package/dist/controls-options-manager/enums.js.map +1 -1
  79. package/dist/controls-options-manager/index.d.ts +120 -120
  80. package/dist/controls-options-manager/index.js +81 -81
  81. package/dist/controls-options-manager/index.js.map +1 -1
  82. package/dist/controls-options-manager/util.d.ts +7 -7
  83. package/dist/controls-options-manager/util.js.map +1 -1
  84. package/dist/index.d.ts +4 -4
  85. package/dist/index.js.map +1 -1
  86. package/dist/locus-info/controlsUtils.d.ts +2 -2
  87. package/dist/locus-info/controlsUtils.js +21 -21
  88. package/dist/locus-info/controlsUtils.js.map +1 -1
  89. package/dist/locus-info/embeddedAppsUtils.d.ts +2 -2
  90. package/dist/locus-info/embeddedAppsUtils.js +14 -14
  91. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  92. package/dist/locus-info/fullState.d.ts +2 -2
  93. package/dist/locus-info/fullState.js.map +1 -1
  94. package/dist/locus-info/hostUtils.d.ts +2 -2
  95. package/dist/locus-info/hostUtils.js +19 -19
  96. package/dist/locus-info/hostUtils.js.map +1 -1
  97. package/dist/locus-info/index.d.ts +269 -269
  98. package/dist/locus-info/index.js +180 -180
  99. package/dist/locus-info/index.js.map +1 -1
  100. package/dist/locus-info/infoUtils.d.ts +2 -2
  101. package/dist/locus-info/infoUtils.js.map +1 -1
  102. package/dist/locus-info/mediaSharesUtils.d.ts +2 -2
  103. package/dist/locus-info/mediaSharesUtils.js +50 -50
  104. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  105. package/dist/locus-info/parser.d.ts +212 -212
  106. package/dist/locus-info/parser.js +136 -136
  107. package/dist/locus-info/parser.js.map +1 -1
  108. package/dist/locus-info/selfUtils.d.ts +2 -2
  109. package/dist/locus-info/selfUtils.js +52 -52
  110. package/dist/locus-info/selfUtils.js.map +1 -1
  111. package/dist/media/index.d.ts +32 -32
  112. package/dist/media/index.js +145 -145
  113. package/dist/media/index.js.map +1 -1
  114. package/dist/media/properties.d.ts +108 -108
  115. package/dist/media/properties.js +49 -49
  116. package/dist/media/properties.js.map +1 -1
  117. package/dist/media/util.d.ts +2 -2
  118. package/dist/media/util.js.map +1 -1
  119. package/dist/mediaQualityMetrics/config.d.ts +233 -233
  120. package/dist/mediaQualityMetrics/config.js.map +1 -1
  121. package/dist/meeting/effectsState.d.ts +42 -42
  122. package/dist/meeting/effectsState.js +24 -24
  123. package/dist/meeting/effectsState.js.map +1 -1
  124. package/dist/meeting/in-meeting-actions.d.ts +79 -79
  125. package/dist/meeting/in-meeting-actions.js +11 -11
  126. package/dist/meeting/in-meeting-actions.js.map +1 -1
  127. package/dist/meeting/index.d.ts +1621 -1621
  128. package/dist/meeting/index.js +1502 -1505
  129. package/dist/meeting/index.js.map +1 -1
  130. package/dist/meeting/muteState.d.ts +116 -116
  131. package/dist/meeting/muteState.js +85 -85
  132. package/dist/meeting/muteState.js.map +1 -1
  133. package/dist/meeting/request.d.ts +255 -255
  134. package/dist/meeting/request.js +141 -141
  135. package/dist/meeting/request.js.map +1 -1
  136. package/dist/meeting/state.d.ts +9 -9
  137. package/dist/meeting/state.js +30 -30
  138. package/dist/meeting/state.js.map +1 -1
  139. package/dist/meeting/util.d.ts +2 -2
  140. package/dist/meeting/util.js.map +1 -1
  141. package/dist/meeting-info/collection.d.ts +20 -20
  142. package/dist/meeting-info/collection.js +11 -11
  143. package/dist/meeting-info/collection.js.map +1 -1
  144. package/dist/meeting-info/index.d.ts +57 -57
  145. package/dist/meeting-info/index.js +50 -50
  146. package/dist/meeting-info/index.js.map +1 -1
  147. package/dist/meeting-info/meeting-info-v2.d.ts +93 -93
  148. package/dist/meeting-info/meeting-info-v2.js +52 -52
  149. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  150. package/dist/meeting-info/request.d.ts +22 -22
  151. package/dist/meeting-info/request.js +14 -14
  152. package/dist/meeting-info/request.js.map +1 -1
  153. package/dist/meeting-info/util.d.ts +2 -2
  154. package/dist/meeting-info/util.js +9 -9
  155. package/dist/meeting-info/util.js.map +1 -1
  156. package/dist/meeting-info/utilv2.d.ts +2 -2
  157. package/dist/meeting-info/utilv2.js +20 -20
  158. package/dist/meeting-info/utilv2.js.map +1 -1
  159. package/dist/meetings/collection.d.ts +23 -23
  160. package/dist/meetings/collection.js +14 -14
  161. package/dist/meetings/collection.js.map +1 -1
  162. package/dist/meetings/index.d.ts +296 -296
  163. package/dist/meetings/index.js +259 -259
  164. package/dist/meetings/index.js.map +1 -1
  165. package/dist/meetings/request.d.ts +27 -27
  166. package/dist/meetings/request.js +15 -15
  167. package/dist/meetings/request.js.map +1 -1
  168. package/dist/meetings/util.d.ts +18 -18
  169. package/dist/meetings/util.js +29 -29
  170. package/dist/meetings/util.js.map +1 -1
  171. package/dist/member/index.d.ts +147 -147
  172. package/dist/member/index.js +214 -214
  173. package/dist/member/index.js.map +1 -1
  174. package/dist/member/member.types.d.ts +11 -11
  175. package/dist/member/member.types.js.map +1 -1
  176. package/dist/member/util.d.ts +2 -2
  177. package/dist/member/util.js +60 -60
  178. package/dist/member/util.js.map +1 -1
  179. package/dist/members/collection.d.ts +24 -24
  180. package/dist/members/collection.js +11 -11
  181. package/dist/members/collection.js.map +1 -1
  182. package/dist/members/index.d.ts +298 -298
  183. package/dist/members/index.js +275 -275
  184. package/dist/members/index.js.map +1 -1
  185. package/dist/members/request.d.ts +50 -50
  186. package/dist/members/request.js +27 -27
  187. package/dist/members/request.js.map +1 -1
  188. package/dist/members/util.d.ts +2 -2
  189. package/dist/members/util.js +21 -21
  190. package/dist/members/util.js.map +1 -1
  191. package/dist/metrics/config.d.ts +169 -169
  192. package/dist/metrics/config.js.map +1 -1
  193. package/dist/metrics/constants.d.ts +57 -57
  194. package/dist/metrics/constants.js.map +1 -1
  195. package/dist/metrics/index.d.ts +152 -152
  196. package/dist/metrics/index.js +90 -90
  197. package/dist/metrics/index.js.map +1 -1
  198. package/dist/networkQualityMonitor/index.d.ts +70 -70
  199. package/dist/networkQualityMonitor/index.js +65 -65
  200. package/dist/networkQualityMonitor/index.js.map +1 -1
  201. package/dist/peer-connection-manager/index.d.ts +6 -6
  202. package/dist/peer-connection-manager/index.js +87 -87
  203. package/dist/peer-connection-manager/index.js.map +1 -1
  204. package/dist/peer-connection-manager/util.d.ts +6 -6
  205. package/dist/peer-connection-manager/util.js +9 -9
  206. package/dist/peer-connection-manager/util.js.map +1 -1
  207. package/dist/personal-meeting-room/index.d.ts +47 -47
  208. package/dist/personal-meeting-room/index.js +67 -67
  209. package/dist/personal-meeting-room/index.js.map +1 -1
  210. package/dist/personal-meeting-room/request.d.ts +14 -14
  211. package/dist/personal-meeting-room/request.js +7 -7
  212. package/dist/personal-meeting-room/request.js.map +1 -1
  213. package/dist/personal-meeting-room/util.d.ts +2 -2
  214. package/dist/personal-meeting-room/util.js.map +1 -1
  215. package/dist/reachability/index.d.ts +139 -139
  216. package/dist/reachability/index.js +110 -110
  217. package/dist/reachability/index.js.map +1 -1
  218. package/dist/reachability/request.d.ts +35 -35
  219. package/dist/reachability/request.js +15 -15
  220. package/dist/reachability/request.js.map +1 -1
  221. package/dist/reactions/reactions.d.ts +4 -4
  222. package/dist/reactions/reactions.js.map +1 -1
  223. package/dist/reactions/reactions.type.d.ts +32 -32
  224. package/dist/reactions/reactions.type.js.map +1 -1
  225. package/dist/reconnection-manager/index.d.ts +112 -112
  226. package/dist/reconnection-manager/index.js +112 -112
  227. package/dist/reconnection-manager/index.js.map +1 -1
  228. package/dist/recording-controller/enums.d.ts +7 -7
  229. package/dist/recording-controller/enums.js.map +1 -1
  230. package/dist/recording-controller/index.d.ts +193 -193
  231. package/dist/recording-controller/index.js +127 -127
  232. package/dist/recording-controller/index.js.map +1 -1
  233. package/dist/recording-controller/util.d.ts +13 -13
  234. package/dist/recording-controller/util.js.map +1 -1
  235. package/dist/roap/collection.d.ts +10 -10
  236. package/dist/roap/collection.js.map +1 -1
  237. package/dist/roap/handler.d.ts +47 -47
  238. package/dist/roap/handler.js +27 -27
  239. package/dist/roap/handler.js.map +1 -1
  240. package/dist/roap/index.d.ts +116 -116
  241. package/dist/roap/index.js +111 -111
  242. package/dist/roap/index.js.map +1 -1
  243. package/dist/roap/request.d.ts +35 -35
  244. package/dist/roap/request.js +17 -17
  245. package/dist/roap/request.js.map +1 -1
  246. package/dist/roap/state.d.ts +9 -9
  247. package/dist/roap/state.js +14 -14
  248. package/dist/roap/state.js.map +1 -1
  249. package/dist/roap/turnDiscovery.d.ts +67 -67
  250. package/dist/roap/turnDiscovery.js +46 -46
  251. package/dist/roap/turnDiscovery.js.map +1 -1
  252. package/dist/roap/util.d.ts +2 -2
  253. package/dist/roap/util.js.map +1 -1
  254. package/dist/statsAnalyzer/global.d.ts +126 -126
  255. package/dist/statsAnalyzer/global.js.map +1 -1
  256. package/dist/statsAnalyzer/index.d.ts +190 -190
  257. package/dist/statsAnalyzer/index.js +128 -128
  258. package/dist/statsAnalyzer/index.js.map +1 -1
  259. package/dist/statsAnalyzer/mqaUtil.d.ts +22 -22
  260. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  261. package/dist/transcription/index.d.ts +64 -64
  262. package/dist/transcription/index.js +42 -42
  263. package/dist/transcription/index.js.map +1 -1
  264. package/internal-README.md +172 -172
  265. package/jest.config.js +3 -3
  266. package/package.json +22 -21
  267. package/process +1 -1
  268. package/src/common/browser-detection.ts +39 -39
  269. package/src/common/collection.ts +94 -94
  270. package/src/common/config.ts +9 -9
  271. package/src/common/errors/captcha-error.ts +25 -25
  272. package/src/common/errors/intent-to-join.ts +27 -27
  273. package/src/common/errors/join-meeting.ts +32 -32
  274. package/src/common/errors/media.ts +25 -25
  275. package/src/common/errors/parameter.ts +33 -33
  276. package/src/common/errors/password-error.ts +25 -25
  277. package/src/common/errors/permission.ts +24 -24
  278. package/src/common/errors/reconnection-in-progress.ts +8 -8
  279. package/src/common/errors/reconnection.ts +25 -25
  280. package/src/common/errors/stats.ts +25 -25
  281. package/src/common/errors/webex-errors.ts +140 -140
  282. package/src/common/errors/webex-meetings-error.ts +35 -35
  283. package/src/common/events/events-scope.ts +30 -30
  284. package/src/common/events/events.ts +25 -25
  285. package/src/common/events/trigger-proxy.ts +25 -25
  286. package/src/common/events/util.ts +39 -39
  287. package/src/common/logs/logger-config.ts +8 -8
  288. package/src/common/logs/logger-proxy.ts +44 -44
  289. package/src/common/logs/request.ts +65 -65
  290. package/src/common/queue.ts +50 -50
  291. package/src/config.ts +96 -96
  292. package/src/constants.ts +1121 -1121
  293. package/src/controls-options-manager/constants.ts +5 -5
  294. package/src/controls-options-manager/enums.ts +6 -6
  295. package/src/controls-options-manager/index.ts +183 -183
  296. package/src/controls-options-manager/util.ts +20 -20
  297. package/src/index.js +15 -15
  298. package/src/locus-info/controlsUtils.ts +112 -112
  299. package/src/locus-info/embeddedAppsUtils.ts +57 -57
  300. package/src/locus-info/fullState.ts +69 -69
  301. package/src/locus-info/hostUtils.ts +60 -60
  302. package/src/locus-info/index.ts +1303 -1303
  303. package/src/locus-info/infoUtils.ts +101 -101
  304. package/src/locus-info/mediaSharesUtils.ts +173 -173
  305. package/src/locus-info/parser.ts +680 -680
  306. package/src/locus-info/selfUtils.ts +428 -428
  307. package/src/media/index.ts +675 -675
  308. package/src/media/properties.ts +313 -313
  309. package/src/media/util.ts +37 -37
  310. package/src/mediaQualityMetrics/config.ts +382 -382
  311. package/src/meeting/effectsState.ts +209 -209
  312. package/src/meeting/in-meeting-actions.ts +153 -153
  313. package/src/meeting/index.ts +6537 -6543
  314. package/src/meeting/muteState.ts +365 -365
  315. package/src/meeting/request.ts +810 -810
  316. package/src/meeting/state.ts +194 -194
  317. package/src/meeting/util.ts +530 -530
  318. package/src/meeting-info/collection.ts +41 -41
  319. package/src/meeting-info/index.ts +137 -137
  320. package/src/meeting-info/meeting-info-v2.ts +273 -273
  321. package/src/meeting-info/request.ts +46 -46
  322. package/src/meeting-info/util.ts +314 -314
  323. package/src/meeting-info/utilv2.ts +324 -324
  324. package/src/meetings/collection.ts +43 -43
  325. package/src/meetings/index.ts +1128 -1128
  326. package/src/meetings/request.ts +81 -81
  327. package/src/meetings/util.ts +181 -181
  328. package/src/member/index.ts +446 -446
  329. package/src/member/member.types.ts +13 -13
  330. package/src/member/util.ts +286 -286
  331. package/src/members/collection.ts +40 -40
  332. package/src/members/index.ts +900 -900
  333. package/src/members/request.ts +175 -175
  334. package/src/members/util.ts +260 -260
  335. package/src/metrics/config.ts +485 -485
  336. package/src/metrics/constants.ts +61 -61
  337. package/src/metrics/index.ts +543 -543
  338. package/src/networkQualityMonitor/index.ts +211 -211
  339. package/src/peer-connection-manager/index.ts +847 -847
  340. package/src/peer-connection-manager/util.ts +119 -119
  341. package/src/personal-meeting-room/index.ts +157 -157
  342. package/src/personal-meeting-room/request.ts +48 -48
  343. package/src/personal-meeting-room/util.ts +49 -49
  344. package/src/reachability/index.ts +478 -478
  345. package/src/reachability/request.ts +81 -81
  346. package/src/reactions/reactions.ts +104 -104
  347. package/src/reactions/reactions.type.ts +36 -36
  348. package/src/reconnection-manager/index.ts +622 -622
  349. package/src/recording-controller/enums.ts +8 -8
  350. package/src/recording-controller/index.ts +315 -315
  351. package/src/recording-controller/util.ts +58 -58
  352. package/src/roap/collection.ts +62 -62
  353. package/src/roap/handler.ts +294 -294
  354. package/src/roap/index.ts +413 -413
  355. package/src/roap/request.ts +229 -229
  356. package/src/roap/state.ts +156 -156
  357. package/src/roap/turnDiscovery.ts +283 -283
  358. package/src/roap/util.ts +100 -100
  359. package/src/statsAnalyzer/global.ts +128 -128
  360. package/src/statsAnalyzer/index.ts +1266 -1266
  361. package/src/statsAnalyzer/mqaUtil.ts +290 -290
  362. package/src/transcription/index.ts +154 -154
  363. package/test/integration/spec/journey.js +941 -941
  364. package/test/integration/spec/space-meeting.js +457 -457
  365. package/test/integration/spec/transcription.js +55 -55
  366. package/test/unit/spec/common/browser-detection.js +119 -119
  367. package/test/unit/spec/common/queue.js +69 -69
  368. package/test/unit/spec/controls-options-manager/index.js +123 -123
  369. package/test/unit/spec/controls-options-manager/util.js +65 -65
  370. package/test/unit/spec/fixture/locus.js +406 -406
  371. package/test/unit/spec/locus-info/controlsUtils.js +82 -82
  372. package/test/unit/spec/locus-info/embeddedAppsUtils.js +104 -104
  373. package/test/unit/spec/locus-info/index.js +1272 -1272
  374. package/test/unit/spec/locus-info/infoUtils.js +138 -138
  375. package/test/unit/spec/locus-info/lib/BasicSeqCmp.json +975 -975
  376. package/test/unit/spec/locus-info/lib/SeqCmp.json +522 -522
  377. package/test/unit/spec/locus-info/lib/selfConstant.js +286 -286
  378. package/test/unit/spec/locus-info/parser.js +298 -298
  379. package/test/unit/spec/locus-info/selfUtils.js +185 -185
  380. package/test/unit/spec/media/properties.ts +305 -305
  381. package/test/unit/spec/meeting/effectsState.js +281 -281
  382. package/test/unit/spec/meeting/in-meeting-actions.ts +90 -90
  383. package/test/unit/spec/meeting/index.js +5227 -5227
  384. package/test/unit/spec/meeting/muteState.js +430 -430
  385. package/test/unit/spec/meeting/request.js +317 -317
  386. package/test/unit/spec/meeting/utils.js +319 -319
  387. package/test/unit/spec/meeting-info/meetinginfov2.js +376 -376
  388. package/test/unit/spec/meeting-info/request.js +64 -64
  389. package/test/unit/spec/meeting-info/util.js +37 -37
  390. package/test/unit/spec/meeting-info/utilv2.js +330 -330
  391. package/test/unit/spec/meetings/collection.js +52 -52
  392. package/test/unit/spec/meetings/index.js +1375 -1375
  393. package/test/unit/spec/meetings/utils.js +66 -66
  394. package/test/unit/spec/member/index.js +47 -47
  395. package/test/unit/spec/member/util.js +80 -80
  396. package/test/unit/spec/members/index.js +364 -364
  397. package/test/unit/spec/members/request.js +200 -200
  398. package/test/unit/spec/members/utils.js +42 -42
  399. package/test/unit/spec/metrics/index.js +111 -111
  400. package/test/unit/spec/networkQualityMonitor/index.js +99 -99
  401. package/test/unit/spec/peerconnection-manager/index.js +218 -218
  402. package/test/unit/spec/peerconnection-manager/utils.js +49 -49
  403. package/test/unit/spec/peerconnection-manager/utils.test-fixtures.ts +388 -388
  404. package/test/unit/spec/personal-meeting-room/personal-meeting-room.js +29 -29
  405. package/test/unit/spec/reachability/index.ts +50 -50
  406. package/test/unit/spec/reconnection-manager/index.js +206 -206
  407. package/test/unit/spec/recording-controller/index.js +230 -230
  408. package/test/unit/spec/recording-controller/util.js +101 -101
  409. package/test/unit/spec/roap/index.ts +128 -128
  410. package/test/unit/spec/roap/turnDiscovery.ts +372 -372
  411. package/test/unit/spec/roap/util.js +30 -30
  412. package/test/unit/spec/stats-analyzer/index.js +287 -287
  413. package/test/utils/cmr.js +104 -104
  414. package/test/utils/testUtils.js +287 -287
  415. package/test/utils/webex-config.js +77 -77
  416. package/test/utils/webex-test-users.js +82 -82
  417. package/tsconfig.json +5 -5
@@ -1,1272 +1,1272 @@
1
- import 'jsdom-global/register';
2
- import sinon from 'sinon';
3
- import {cloneDeep} from 'lodash';
4
- import {assert} from '@webex/test-helper-chai';
5
- import MockWebex from '@webex/test-helper-mock-webex';
6
- import Meetings from '@webex/plugin-meetings';
7
- import LocusInfo from '@webex/plugin-meetings/src/locus-info';
8
- import SelfUtils from '@webex/plugin-meetings/src/locus-info/selfUtils';
9
- import InfoUtils from '@webex/plugin-meetings/src/locus-info/infoUtils';
10
- import EmbeddedAppsUtils from '@webex/plugin-meetings/src/locus-info/embeddedAppsUtils';
11
- import LocusDeltaParser from '@webex/plugin-meetings/src/locus-info/parser';
12
-
13
- import {
14
- LOCUSINFO,
15
- RECORDING_STATE,
16
- LOCUSEVENT,
17
- EVENTS,
18
- DISPLAY_HINTS,
19
- } from '../../../../src/constants';
20
-
21
- import {self, selfWithInactivity} from './lib/selfConstant';
22
-
23
- describe('plugin-meetings', () => {
24
- describe('LocusInfo index', () => {
25
- let mockMeeting;
26
- const updateMeeting = (object) => {
27
- if (mockMeeting && object && Object.keys(object).length) {
28
- Object.keys(object).forEach((key) => {
29
- mockMeeting[key] = object[key];
30
- });
31
- }
32
- };
33
- const locus = {};
34
- const meetingId = 'meetingId';
35
- let locusInfo;
36
-
37
- const webex = new MockWebex({
38
- children: {
39
- meetings: Meetings,
40
- },
41
- });
42
-
43
- beforeEach(() => {
44
- mockMeeting = {};
45
- locusInfo = new LocusInfo(updateMeeting, webex, meetingId);
46
-
47
- locusInfo.init(locus);
48
-
49
- locusInfo.parsedLocus = {
50
- states: [{one: 'one'}],
51
- fullState: {type: 'MEETING'},
52
- info: {
53
- sipUri: 'abc@webex.com',
54
- isUnlocked: true,
55
- isLocked: false,
56
- displayHints: {
57
- joined: ['ROSTER_IN_MEETING', 'LOCK_STATUS_UNLOCKED'],
58
- moderator: [],
59
- },
60
- },
61
- };
62
- });
63
-
64
- describe('#updateControls', () => {
65
- let newControls;
66
-
67
- beforeEach('setup new controls', () => {
68
- newControls = {
69
- lock: {},
70
- meetingFull: {},
71
- record: {
72
- recording: false,
73
- paused: false,
74
- meta: {
75
- lastModified: 'TODAY',
76
- modifiedBy: 'George Kittle',
77
- },
78
- },
79
- shareControl: {},
80
- transcribe: {},
81
- meetingContainer: {
82
- meetingContainerUrl: 'http://new-url.com',
83
- },
84
- entryExitTone: {enabled: true, mode: 'foo'},
85
- };
86
- });
87
-
88
- afterEach(() => {
89
- newControls = null;
90
- });
91
-
92
- it('should update the controls object', () => {
93
- locusInfo.updateControls(newControls);
94
-
95
- assert.equal(locusInfo.controls, newControls);
96
- });
97
-
98
- it('should not trigger the CONTROLS_RECORDING_UPDATED event', () => {
99
- locusInfo.controls = {};
100
- locusInfo.emitScoped = sinon.stub();
101
- locusInfo.updateControls(newControls);
102
-
103
- locusInfo.emitScoped.getCalls().forEach((x) => {
104
- // check that no calls in emitScoped are for CONTROLS_RECORDING_UPDATED
105
- assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED);
106
- });
107
- });
108
-
109
- it('should keep the recording state to `IDLE`', () => {
110
- locusInfo.controls = {
111
- record: {
112
- recording: true,
113
- paused: false,
114
- meta: {
115
- lastModified: 'TODAY',
116
- modifiedBy: 'George Kittle',
117
- },
118
- },
119
- shareControl: {},
120
- transcribe: {},
121
- };
122
- locusInfo.emitScoped = sinon.stub();
123
- locusInfo.updateControls(newControls);
124
-
125
- assert.calledWith(
126
- locusInfo.emitScoped,
127
- {
128
- file: 'locus-info',
129
- function: 'updateControls',
130
- },
131
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
132
- {
133
- state: RECORDING_STATE.IDLE,
134
- modifiedBy: 'George Kittle',
135
- lastModified: 'TODAY',
136
- }
137
- );
138
- });
139
-
140
- it('should update the recording state to `RECORDING`', () => {
141
- locusInfo.controls = {
142
- lock: {},
143
- meetingFull: {},
144
- record: {
145
- recording: false,
146
- paused: false,
147
- meta: {
148
- lastModified: 'TODAY',
149
- modifiedBy: 'George Kittle',
150
- },
151
- },
152
- shareControl: {},
153
- transcribe: {},
154
- };
155
- newControls.record.recording = true;
156
- locusInfo.emitScoped = sinon.stub();
157
- locusInfo.updateControls(newControls);
158
-
159
- assert.calledWith(
160
- locusInfo.emitScoped,
161
- {
162
- file: 'locus-info',
163
- function: 'updateControls',
164
- },
165
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
166
- {
167
- state: RECORDING_STATE.RECORDING,
168
- modifiedBy: 'George Kittle',
169
- lastModified: 'TODAY',
170
- }
171
- );
172
- });
173
-
174
- it('should update the recording state to `PAUSED`', () => {
175
- locusInfo.emitScoped = sinon.stub();
176
- locusInfo.controls = {
177
- lock: {},
178
- meetingFull: {},
179
- record: {
180
- recording: false,
181
- paused: false,
182
- meta: {
183
- lastModified: 'TODAY',
184
- modifiedBy: 'George Kittle',
185
- },
186
- },
187
- shareControl: {},
188
- transcribe: {},
189
- };
190
- newControls.record.paused = true;
191
- newControls.record.recording = true;
192
- locusInfo.updateControls(newControls);
193
-
194
- assert.calledWith(
195
- locusInfo.emitScoped,
196
- {
197
- file: 'locus-info',
198
- function: 'updateControls',
199
- },
200
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
201
- {
202
- state: RECORDING_STATE.PAUSED,
203
- modifiedBy: 'George Kittle',
204
- lastModified: 'TODAY',
205
- }
206
- );
207
- });
208
-
209
- it('should update the recording state to `RESUMED`', () => {
210
- locusInfo.emitScoped = sinon.stub();
211
- locusInfo.controls = {
212
- lock: {},
213
- meetingFull: {},
214
- record: {
215
- recording: false,
216
- paused: true,
217
- meta: {
218
- lastModified: 'TODAY',
219
- modifiedBy: 'George Kittle',
220
- },
221
- },
222
- shareControl: {},
223
- transcribe: {},
224
- };
225
- // there must be a recording to be paused/resumed
226
- newControls.record.recording = true;
227
- newControls.record.paused = false;
228
- locusInfo.updateControls(newControls);
229
-
230
- assert.calledWith(
231
- locusInfo.emitScoped,
232
- {
233
- file: 'locus-info',
234
- function: 'updateControls',
235
- },
236
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
237
- {
238
- state: RECORDING_STATE.RESUMED,
239
- modifiedBy: 'George Kittle',
240
- lastModified: 'TODAY',
241
- }
242
- );
243
- });
244
-
245
- it('should update the recording state to `IDLE` even if `pause`status changes', () => {
246
- locusInfo.emitScoped = sinon.stub();
247
- locusInfo.controls = {
248
- lock: {},
249
- meetingFull: {},
250
- record: {
251
- recording: true,
252
- paused: true,
253
- meta: {
254
- lastModified: 'TODAY',
255
- modifiedBy: 'George Kittle',
256
- },
257
- },
258
- shareControl: {},
259
- transcribe: {},
260
- };
261
- newControls.record.recording = false;
262
- newControls.record.paused = false;
263
- locusInfo.updateControls(newControls);
264
-
265
- assert.calledWith(
266
- locusInfo.emitScoped,
267
- {
268
- file: 'locus-info',
269
- function: 'updateControls',
270
- },
271
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
272
- {
273
- state: RECORDING_STATE.IDLE,
274
- modifiedBy: 'George Kittle',
275
- lastModified: 'TODAY',
276
- }
277
- );
278
- });
279
-
280
- it('should update the transcript state', () => {
281
- locusInfo.emitScoped = sinon.stub();
282
- locusInfo.controls = {
283
- lock: {},
284
- meetingFull: {},
285
- record: {
286
- recording: false,
287
- paused: true,
288
- meta: {
289
- lastModified: 'TODAY',
290
- modifiedBy: 'George Kittle',
291
- },
292
- },
293
- shareControl: {},
294
- transcribe: {
295
- transcribing: false,
296
- caption: false,
297
- },
298
- };
299
- newControls.transcribe.transcribing = true;
300
- newControls.transcribe.caption = true;
301
-
302
- locusInfo.updateControls(newControls);
303
-
304
- assert.calledWith(
305
- locusInfo.emitScoped,
306
- {
307
- file: 'locus-info',
308
- function: 'updateControls',
309
- },
310
- LOCUSINFO.EVENTS.CONTROLS_MEETING_TRANSCRIBE_UPDATED,
311
- {
312
- transcribing: true,
313
- caption: true,
314
- }
315
- );
316
- });
317
-
318
- it('should update the meetingContainerURL from null', () => {
319
- locusInfo.controls = {
320
- meetingContainer: {meetingContainerUrl: null},
321
- };
322
-
323
- locusInfo.emitScoped = sinon.stub();
324
- locusInfo.updateControls(newControls);
325
-
326
- assert.calledWith(
327
- locusInfo.emitScoped,
328
- {
329
- file: 'locus-info',
330
- function: 'updateControls',
331
- },
332
- LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
333
- {meetingContainerUrl: 'http://new-url.com'}
334
- );
335
- });
336
-
337
- it('should update the meetingContainerURL from not null', () => {
338
- locusInfo.controls = {
339
- meetingContainer: {meetingContainerUrl: 'http://old-url.com'},
340
- };
341
-
342
- locusInfo.emitScoped = sinon.stub();
343
- locusInfo.updateControls(newControls);
344
-
345
- assert.calledWith(
346
- locusInfo.emitScoped,
347
- {
348
- file: 'locus-info',
349
- function: 'updateControls',
350
- },
351
- LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
352
- {meetingContainerUrl: 'http://new-url.com'}
353
- );
354
- });
355
-
356
- it('should update the meetingContainerURL from missing', () => {
357
- locusInfo.controls = {};
358
-
359
- locusInfo.emitScoped = sinon.stub();
360
- locusInfo.updateControls(newControls);
361
-
362
- assert.calledWith(
363
- locusInfo.emitScoped,
364
- {
365
- file: 'locus-info',
366
- function: 'updateControls',
367
- },
368
- LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
369
- {meetingContainerUrl: 'http://new-url.com'}
370
- );
371
- });
372
-
373
- it('should update the entryExitTone when changed', () => {
374
- locusInfo.controls = {};
375
-
376
- locusInfo.emitScoped = sinon.stub();
377
- locusInfo.updateControls(newControls);
378
-
379
- assert.calledWith(
380
- locusInfo.emitScoped,
381
- {
382
- file: 'locus-info',
383
- function: 'updateControls',
384
- },
385
- LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
386
- {entryExitTone: 'foo'}
387
- );
388
- });
389
-
390
- it('should not update the entryExitTone when unchanged', () => {
391
- locusInfo.controls = {entryExitTone: {enabled: true, mode: 'foo'}};
392
-
393
- locusInfo.emitScoped = sinon.stub();
394
- locusInfo.updateControls(newControls);
395
-
396
- locusInfo.emitScoped.getCalls().forEach((x) => {
397
- // check that no calls in emitScoped are for CONTROLS_ENTRY_EXIT_TONE_UPDATED
398
- assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED);
399
- });
400
- });
401
- });
402
-
403
- describe('#updateParticipants()', () => {
404
- let newParticipants;
405
-
406
- beforeEach('setup new participants', () => {
407
- newParticipants = [
408
- {
409
- person: {
410
- id: 1234,
411
- },
412
- status: {
413
- audioStatus: 'testValue',
414
- videoSlidesStatus: 'testValue',
415
- videoStatus: 'testValue',
416
- },
417
- },
418
- ];
419
- });
420
-
421
- it('should assert that the correct recordingId, selfIdentity, selfId, and hostId are being set and emitted from updateParticipants', () => {
422
- locusInfo.parsedLocus = {
423
- controls: {
424
- record: {
425
- modifiedBy: '1',
426
- },
427
- },
428
- self: {
429
- selfIdentity: '123',
430
- selfId: '2',
431
- },
432
- host: {
433
- hostId: '3',
434
- },
435
- };
436
- locusInfo.emitScoped = sinon.stub();
437
- locusInfo.updateParticipants({});
438
-
439
- // if this assertion fails, double-check the attributes used in
440
- // the updateParticipants function in locus-info/index.js
441
- assert.calledWith(
442
- locusInfo.emitScoped,
443
- {
444
- file: 'locus-info',
445
- function: 'updateParticipants',
446
- },
447
- EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
448
- {
449
- participants: {},
450
- recordingId: '1',
451
- selfIdentity: '123',
452
- selfId: '2',
453
- hostId: '3',
454
- }
455
- );
456
- // note: in a real use case, recordingId, selfId, and hostId would all be the same
457
- // for this specific test, we are double-checking that each of the id's
458
- // are being correctly grabbed from locusInfo.parsedLocus within updateParticipants
459
- });
460
-
461
- it('should update the deltaParticipants object', () => {
462
- const prev = locusInfo.deltaParticipants;
463
-
464
- locusInfo.updateParticipantDeltas(newParticipants);
465
-
466
- assert.notEqual(locusInfo.deltaParticipants, prev);
467
- });
468
-
469
- it('should update the delta property on all changed states', () => {
470
- locusInfo.updateParticipantDeltas(newParticipants);
471
-
472
- const [exampleParticipant] = locusInfo.deltaParticipants;
473
-
474
- assert.isTrue(exampleParticipant.delta.audioStatus);
475
- assert.isTrue(exampleParticipant.delta.videoSlidesStatus);
476
- assert.isTrue(exampleParticipant.delta.videoStatus);
477
- });
478
-
479
- it('should include the person details of the changed participant', () => {
480
- locusInfo.updateParticipantDeltas(newParticipants);
481
-
482
- const [exampleParticipant] = locusInfo.deltaParticipants;
483
-
484
- assert.equal(exampleParticipant.person, newParticipants[0].person);
485
- });
486
-
487
- it('should clear deltaParticipants when no changes occured', () => {
488
- locusInfo.participants = [...newParticipants];
489
-
490
- locusInfo.updateParticipantDeltas(locusInfo.participants);
491
-
492
- assert.isTrue(locusInfo.deltaParticipants.length === 0);
493
- });
494
- });
495
-
496
- describe('#updateSelf', () => {
497
- it('should trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls change', () => {
498
- const layoutType = 'EXAMPLE TYPE';
499
-
500
- locusInfo.self = undefined;
501
- const selfWithLayoutChanged = cloneDeep(self);
502
-
503
- selfWithLayoutChanged.controls.layouts = [
504
- {
505
- type: layoutType,
506
- },
507
- ];
508
-
509
- locusInfo.emitScoped = sinon.stub();
510
- locusInfo.updateSelf(selfWithLayoutChanged, []);
511
-
512
- assert.calledWith(
513
- locusInfo.emitScoped,
514
- {
515
- file: 'locus-info',
516
- function: 'updateSelf',
517
- },
518
- LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
519
- {layout: layoutType}
520
- );
521
- });
522
-
523
- it('should not trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls did not change', () => {
524
- const layoutType = 'EXAMPLE TYPE';
525
-
526
- locusInfo.self = undefined;
527
- const selfWithLayoutChanged = cloneDeep(self);
528
-
529
- selfWithLayoutChanged.controls.layouts = [
530
- {
531
- type: layoutType,
532
- },
533
- ];
534
-
535
- // Set the layout prior to stubbing to validate it does not change.
536
- locusInfo.updateSelf(selfWithLayoutChanged, []);
537
-
538
- locusInfo.emitScoped = sinon.stub();
539
-
540
- locusInfo.updateSelf(selfWithLayoutChanged, []);
541
-
542
- assert.neverCalledWith(
543
- locusInfo.emitScoped,
544
- {
545
- file: 'locus-info',
546
- function: 'updateSelf',
547
- },
548
- LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
549
- {layout: layoutType}
550
- );
551
- });
552
-
553
- it('should trigger MEDIA_INACTIVITY on server media inactivity', () => {
554
- locusInfo.self = self;
555
-
556
- locusInfo.webex.internal.device.url = selfWithInactivity.deviceUrl;
557
- locusInfo.emitScoped = sinon.stub();
558
- locusInfo.updateSelf(selfWithInactivity, []);
559
-
560
- assert.calledWith(
561
- locusInfo.emitScoped,
562
- {
563
- file: 'locus-info',
564
- function: 'updateSelf',
565
- },
566
- LOCUSINFO.EVENTS.MEDIA_INACTIVITY,
567
- SelfUtils.getMediaStatus(selfWithInactivity.mediaSessions)
568
- );
569
- });
570
-
571
- it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED when muted on entry', () => {
572
- // usually "previous self" is just undefined when we get first self from locus with remote mute
573
- locusInfo.self = undefined;
574
- const selfWithMutedByOthers = cloneDeep(self);
575
-
576
- selfWithMutedByOthers.controls.audio.muted = true;
577
-
578
- locusInfo.webex.internal.device.url = self.deviceUrl;
579
- locusInfo.emitScoped = sinon.stub();
580
- locusInfo.updateSelf(selfWithMutedByOthers, []);
581
-
582
- assert.calledWith(
583
- locusInfo.emitScoped,
584
- {
585
- file: 'locus-info',
586
- function: 'updateSelf',
587
- },
588
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
589
- {muted: true, unmuteAllowed: true}
590
- );
591
-
592
- // but sometimes "previous self" is defined, but without controls.audio.muted, so we test this here:
593
- locusInfo.self = cloneDeep(self);
594
- locusInfo.self.controls.audio = {};
595
-
596
- locusInfo.updateSelf(selfWithMutedByOthers, []);
597
- assert.calledWith(
598
- locusInfo.emitScoped,
599
- {
600
- file: 'locus-info',
601
- function: 'updateSelf',
602
- },
603
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
604
- {muted: true, unmuteAllowed: true}
605
- );
606
- });
607
-
608
- it('should not trigger SELF_REMOTE_MUTE_STATUS_UPDATED when not muted on entry', () => {
609
- locusInfo.self = undefined;
610
- const selfWithMutedByOthersFalse = cloneDeep(self);
611
-
612
- selfWithMutedByOthersFalse.controls.audio.muted = false;
613
-
614
- locusInfo.webex.internal.device.url = self.deviceUrl;
615
- locusInfo.emitScoped = sinon.stub();
616
- locusInfo.updateSelf(selfWithMutedByOthersFalse, []);
617
-
618
- // we might get some calls to emitScoped, but we need to check that none of them are for SELF_REMOTE_MUTE_STATUS_UPDATED
619
- locusInfo.emitScoped.getCalls().forEach((x) => {
620
- assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED);
621
- });
622
- });
623
-
624
- it('should not trigger SELF_REMOTE_MUTE_STATUS_UPDATED when being removed from meeting', () => {
625
- const selfWithMutedByOthers = cloneDeep(self);
626
-
627
- selfWithMutedByOthers.controls.audio.muted = true;
628
-
629
- locusInfo.self = selfWithMutedByOthers;
630
-
631
- // when user gets removed from meeting we receive a Locus DTO without any self.controls
632
- const selfWithoutControls = cloneDeep(self);
633
-
634
- selfWithoutControls.controls = undefined;
635
-
636
- locusInfo.webex.internal.device.url = self.deviceUrl;
637
- locusInfo.emitScoped = sinon.stub();
638
- locusInfo.updateSelf(selfWithoutControls, []);
639
-
640
- // we might get some calls to emitScoped, but we need to check that none of them are for SELF_REMOTE_MUTE_STATUS_UPDATED
641
- locusInfo.emitScoped.getCalls().forEach((x) => {
642
- assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED);
643
- });
644
- });
645
-
646
- it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED on othersMuted', () => {
647
- locusInfo.self = self;
648
- const selfWithMutedByOthers = cloneDeep(self);
649
-
650
- selfWithMutedByOthers.controls.audio.muted = true;
651
-
652
- locusInfo.webex.internal.device.url = self.deviceUrl;
653
- locusInfo.emitScoped = sinon.stub();
654
- locusInfo.updateSelf(selfWithMutedByOthers, []);
655
-
656
- assert.calledWith(
657
- locusInfo.emitScoped,
658
- {
659
- file: 'locus-info',
660
- function: 'updateSelf',
661
- },
662
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
663
- {muted: true, unmuteAllowed: true}
664
- );
665
- });
666
-
667
- it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED if muted and disallowUnmute changed', () => {
668
- locusInfo.self = self;
669
- const selfWithMutedByOthersAndDissalowUnmute = cloneDeep(self);
670
-
671
- // first simulate remote mute
672
- selfWithMutedByOthersAndDissalowUnmute.controls.audio.muted = true;
673
- selfWithMutedByOthersAndDissalowUnmute.controls.audio.disallowUnmute = true;
674
-
675
- locusInfo.webex.internal.device.url = self.deviceUrl;
676
- locusInfo.emitScoped = sinon.stub();
677
- locusInfo.updateSelf(selfWithMutedByOthersAndDissalowUnmute, []);
678
-
679
- assert.calledWith(
680
- locusInfo.emitScoped,
681
- {
682
- file: 'locus-info',
683
- function: 'updateSelf',
684
- },
685
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
686
- {muted: true, unmuteAllowed: false}
687
- );
688
-
689
- // now change only disallowUnmute
690
- const selfWithMutedByOthers = cloneDeep(self);
691
-
692
- selfWithMutedByOthers.controls.audio.muted = true;
693
- selfWithMutedByOthers.controls.audio.disallowUnmute = false;
694
-
695
- locusInfo.updateSelf(selfWithMutedByOthers, []);
696
-
697
- assert.calledWith(
698
- locusInfo.emitScoped,
699
- {
700
- file: 'locus-info',
701
- function: 'updateSelf',
702
- },
703
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
704
- {muted: true, unmuteAllowed: true}
705
- );
706
- });
707
-
708
- it('should trigger LOCAL_UNMUTE_REQUIRED on localAudioUnmuteRequired', () => {
709
- locusInfo.self = self;
710
- const selfWithLocalUnmuteRequired = cloneDeep(self);
711
-
712
- selfWithLocalUnmuteRequired.controls.audio.muted = false;
713
- selfWithLocalUnmuteRequired.controls.audio.localAudioUnmuteRequired = true;
714
-
715
- locusInfo.webex.internal.device.url = self.deviceUrl;
716
- locusInfo.emitScoped = sinon.stub();
717
- locusInfo.updateSelf(selfWithLocalUnmuteRequired, []);
718
-
719
- assert.calledWith(
720
- locusInfo.emitScoped,
721
- {
722
- file: 'locus-info',
723
- function: 'updateSelf',
724
- },
725
- LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUIRED,
726
- {
727
- muted: false,
728
- unmuteAllowed: true,
729
- }
730
- );
731
- });
732
-
733
- it('should trigger LOCAL_UNMUTE_REQUESTED when receiving requestedToUnmute=true', () => {
734
- locusInfo.self = self;
735
- const selfWithRequestedToUnmute = cloneDeep(self);
736
-
737
- selfWithRequestedToUnmute.controls.audio.requestedToUnmute = true;
738
-
739
- locusInfo.webex.internal.device.url = self.deviceUrl;
740
- locusInfo.emitScoped = sinon.stub();
741
- locusInfo.updateSelf(selfWithRequestedToUnmute, []);
742
-
743
- assert.calledWith(
744
- locusInfo.emitScoped,
745
- {
746
- file: 'locus-info',
747
- function: 'updateSelf',
748
- },
749
- LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
750
- {}
751
- );
752
-
753
- // now change requestedToUnmute back to false -> it should NOT trigger LOCAL_UNMUTE_REQUESTED
754
- const selfWithoutRequestedToUnmute = cloneDeep(selfWithRequestedToUnmute);
755
-
756
- selfWithoutRequestedToUnmute.controls.audio.requestedToUnmute = false;
757
-
758
- locusInfo.emitScoped.resetHistory();
759
- locusInfo.updateSelf(selfWithoutRequestedToUnmute, []);
760
-
761
- assert.neverCalledWith(
762
- locusInfo.emitScoped,
763
- {
764
- file: 'locus-info',
765
- function: 'updateSelf',
766
- },
767
- LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
768
- {}
769
- );
770
- });
771
-
772
- it('should trigger SELF_OBSERVING when moving meeting to DX', () => {
773
- locusInfo.self = self;
774
- const selfInitiatedMove = cloneDeep(self);
775
-
776
- // Inital move meeting is iniated
777
- selfInitiatedMove.devices[0].intent.type = 'MOVE_MEDIA';
778
-
779
- locusInfo.webex.internal.device.url = self.deviceUrl;
780
-
781
- locusInfo.updateSelf(selfInitiatedMove, []);
782
-
783
- locusInfo.emitScoped = sinon.stub();
784
- // When dx joined the meeting after move
785
- const selfAfterDxJoins = cloneDeep(self);
786
-
787
- selfAfterDxJoins.devices[0].intent.type = 'OBSERVE';
788
-
789
- locusInfo.updateSelf(selfAfterDxJoins, []);
790
-
791
- assert.calledWith(
792
- locusInfo.emitScoped,
793
- {
794
- file: 'locus-info',
795
- function: 'updateSelf',
796
- },
797
- LOCUSINFO.EVENTS.SELF_OBSERVING
798
- );
799
- });
800
-
801
- it('should not trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when not updated', () => {
802
- const selfClone = cloneDeep(self);
803
-
804
- selfClone.canNotViewTheParticipantList = false; // same
805
-
806
- // Set the layout prior to stubbing to validate it does not change.
807
- locusInfo.updateSelf(self, []);
808
-
809
- locusInfo.emitScoped = sinon.stub();
810
-
811
- locusInfo.updateSelf(selfClone, []);
812
-
813
- assert.neverCalledWith(
814
- locusInfo.emitScoped,
815
- {
816
- file: 'locus-info',
817
- function: 'updateSelf',
818
- },
819
- LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
820
- {canNotViewTheParticipantList: false}
821
- );
822
- });
823
-
824
- it('should trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when updated', () => {
825
- const selfClone = cloneDeep(self);
826
-
827
- selfClone.canNotViewTheParticipantList = true; // different
828
-
829
- // Set the layout prior to stubbing to validate it does not change.
830
- locusInfo.updateSelf(self, []);
831
-
832
- locusInfo.emitScoped = sinon.stub();
833
-
834
- locusInfo.updateSelf(selfClone, []);
835
-
836
- assert.calledWith(
837
- locusInfo.emitScoped,
838
- {
839
- file: 'locus-info',
840
- function: 'updateSelf',
841
- },
842
- LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
843
- {canNotViewTheParticipantList: true}
844
- );
845
- });
846
-
847
- it('should not trigger SELF_IS_SHARING_BLOCKED_CHANGE when not updated', () => {
848
- const selfClone = cloneDeep(self);
849
-
850
- selfClone.isSharingBlocked = false; // same
851
-
852
- // Set the layout prior to stubbing to validate it does not change.
853
- locusInfo.updateSelf(self, []);
854
-
855
- locusInfo.emitScoped = sinon.stub();
856
-
857
- locusInfo.updateSelf(selfClone, []);
858
-
859
- assert.neverCalledWith(
860
- locusInfo.emitScoped,
861
- {
862
- file: 'locus-info',
863
- function: 'updateSelf',
864
- },
865
- LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
866
- {isSharingBlocked: false}
867
- );
868
- });
869
-
870
- it('should trigger SELF_IS_SHARING_BLOCKED_CHANGE when updated', () => {
871
- const selfClone = cloneDeep(self);
872
-
873
- selfClone.isSharingBlocked = true; // different
874
-
875
- // Set the layout prior to stubbing to validate it does not change.
876
- locusInfo.updateSelf(self, []);
877
-
878
- locusInfo.emitScoped = sinon.stub();
879
-
880
- locusInfo.updateSelf(selfClone, []);
881
-
882
- assert.calledWith(
883
- locusInfo.emitScoped,
884
- {
885
- file: 'locus-info',
886
- function: 'updateSelf',
887
- },
888
- LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
889
- {isSharingBlocked: true}
890
- );
891
- });
892
- });
893
-
894
- describe('#updateMeetingInfo', () => {
895
- let meetingInfo;
896
- let getInfosSpy;
897
- let getRolesSpy;
898
- let isJoinedSpy;
899
-
900
- beforeEach('setup meeting info', () => {
901
- meetingInfo = {
902
- displayHints: {
903
- joined: ['ROSTER_IN_MEETING', 'LOCK_STATUS_UNLOCKED'],
904
- moderator: [],
905
- },
906
- };
907
- getInfosSpy = sinon.spy(InfoUtils, 'getInfos');
908
- getRolesSpy = sinon.spy(SelfUtils, 'getRoles');
909
- isJoinedSpy = sinon.spy(SelfUtils, 'isJoined');
910
- });
911
-
912
- afterEach(() => {
913
- getRolesSpy.restore();
914
- getInfosSpy.restore();
915
- isJoinedSpy.restore();
916
- });
917
-
918
- it('should trigger MEETING_LOCKED/UNLOCKED when meeting gets locked/unlocked', () => {
919
- const meetingInfoLocked = cloneDeep(meetingInfo);
920
-
921
- const idx = meetingInfoLocked.displayHints.joined.indexOf('LOCK_STATUS_UNLOCKED');
922
-
923
- if (idx !== -1) {
924
- meetingInfoLocked.displayHints.joined[idx] = 'LOCK_STATUS_LOCKED';
925
- }
926
-
927
- locusInfo.webex.internal.device.url = self.deviceUrl;
928
- locusInfo.emitScoped = sinon.stub();
929
- locusInfo.updateMeetingInfo(meetingInfoLocked, self);
930
-
931
- assert.calledWith(
932
- locusInfo.emitScoped,
933
- {
934
- file: 'locus-info',
935
- function: 'updateMeetingInfo',
936
- },
937
- LOCUSINFO.EVENTS.MEETING_LOCKED,
938
- meetingInfoLocked
939
- );
940
-
941
- // now unlock the meeting and verify that we get the right event
942
- const meetingInfoUnlocked = cloneDeep(meetingInfo); // meetingInfo already is "unlocked"
943
-
944
- locusInfo.updateMeetingInfo(meetingInfoUnlocked, self);
945
-
946
- assert.calledWith(
947
- locusInfo.emitScoped,
948
- {
949
- file: 'locus-info',
950
- function: 'updateMeetingInfo',
951
- },
952
- LOCUSINFO.EVENTS.MEETING_UNLOCKED,
953
- meetingInfoUnlocked
954
- );
955
- });
956
-
957
- const checkMeetingInfoUpdatedCalled = (expected) => {
958
- const expectedArgs = [
959
- locusInfo.emitScoped,
960
- {
961
- file: 'locus-info',
962
- function: 'updateMeetingInfo',
963
- },
964
- LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
965
- {info: locusInfo.parsedLocus.info, self},
966
- ];
967
-
968
- if (expected) {
969
- assert.calledWith(...expectedArgs);
970
- } else {
971
- assert.neverCalledWith(...expectedArgs);
972
- }
973
- locusInfo.emitScoped.resetHistory();
974
- };
975
-
976
- it('emits MEETING_INFO_UPDATED if the info changes', () => {
977
- const initialInfo = cloneDeep(meetingInfo);
978
-
979
- locusInfo.emitScoped = sinon.stub();
980
-
981
- // set the info initially as locusInfo.info starts as undefined
982
- locusInfo.updateMeetingInfo(initialInfo, self);
983
-
984
- // since it was initially undefined, this should trigger the event
985
- checkMeetingInfoUpdatedCalled(true);
986
-
987
- const newInfo = cloneDeep(meetingInfo);
988
-
989
- newInfo.displayHints.coHost = [DISPLAY_HINTS.LOCK_CONTROL_LOCK];
990
-
991
- // Updating with different info should trigger the event
992
- locusInfo.updateMeetingInfo(newInfo, self);
993
-
994
- checkMeetingInfoUpdatedCalled(true);
995
-
996
- // update it with the same info
997
- locusInfo.updateMeetingInfo(newInfo, self);
998
-
999
- // since the info is the same it should not call trigger the event
1000
- checkMeetingInfoUpdatedCalled(false);
1001
- });
1002
-
1003
- it('gets roles from self if available', () => {
1004
- const initialInfo = cloneDeep(meetingInfo);
1005
-
1006
- const parsedLocusInfo = cloneDeep(locusInfo.parsedLocus.info);
1007
-
1008
- locusInfo.updateMeetingInfo(initialInfo, self);
1009
-
1010
- assert.calledWith(getRolesSpy, self);
1011
- assert.calledWith(getInfosSpy, parsedLocusInfo, initialInfo, ['PRESENTER']);
1012
- });
1013
-
1014
- it('gets roles from parsedLocus if self not passed in', () => {
1015
- const initialInfo = cloneDeep(meetingInfo);
1016
-
1017
- locusInfo.parsedLocus.self = {
1018
- roles: ['MODERATOR', 'COHOST'],
1019
- };
1020
-
1021
- const parsedLocusInfo = cloneDeep(locusInfo.parsedLocus.info);
1022
-
1023
- locusInfo.updateMeetingInfo(initialInfo);
1024
- assert.calledWith(isJoinedSpy, locusInfo.parsedLocus.self);
1025
- assert.neverCalledWith(getRolesSpy, self);
1026
- assert.calledWith(getInfosSpy, parsedLocusInfo, initialInfo, ['MODERATOR', 'COHOST']);
1027
- });
1028
- });
1029
-
1030
- describe('#updateEmbeddedApps()', () => {
1031
- const newEmbeddedApps = [
1032
- {
1033
- url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
1034
- sequence: 138849877016800000,
1035
- appId:
1036
- 'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
1037
- instanceInfo: {
1038
- appInstanceUrl:
1039
- 'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
1040
- externalAppInstanceUrl: '',
1041
- title: 'Active session',
1042
- },
1043
- state: 'STARTED',
1044
- lastModified: '2022-10-13T21:01:41.680Z',
1045
- },
1046
- ];
1047
-
1048
- it('properly updates the meeting embeddedApps', () => {
1049
- const prev = mockMeeting.embeddedApps;
1050
-
1051
- locusInfo.updateEmbeddedApps(newEmbeddedApps);
1052
-
1053
- assert.notEqual(mockMeeting.embeddedApps, prev);
1054
- assert.isNotNull(mockMeeting.embeddedApps?.[0].type);
1055
- });
1056
-
1057
- it("does not emit EMBEDDED_APPS_UPDATED when apps didn't change", () => {
1058
- locusInfo.updateEmbeddedApps(newEmbeddedApps);
1059
-
1060
- locusInfo.emitScoped = sinon.stub();
1061
-
1062
- const clonedApps = cloneDeep(newEmbeddedApps);
1063
-
1064
- locusInfo.updateEmbeddedApps(clonedApps);
1065
-
1066
- assert.notCalled(locusInfo.emitScoped);
1067
- });
1068
-
1069
- it('emits EMBEDDED_APPS_UPDATED when apps changed', () => {
1070
- locusInfo.updateEmbeddedApps(newEmbeddedApps);
1071
-
1072
- locusInfo.emitScoped = sinon.stub();
1073
-
1074
- const clonedApps = cloneDeep(newEmbeddedApps);
1075
-
1076
- clonedApps[0].state = 'STOPPED';
1077
- const expectedApps = EmbeddedAppsUtils.parse(clonedApps);
1078
-
1079
- locusInfo.updateEmbeddedApps(clonedApps);
1080
-
1081
- assert.calledWith(
1082
- locusInfo.emitScoped,
1083
- {
1084
- file: 'locus-info',
1085
- function: 'updateEmbeddedApps',
1086
- },
1087
- LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
1088
- expectedApps
1089
- );
1090
- });
1091
- });
1092
-
1093
- describe('#LocusDeltaEvents', () => {
1094
- const fakeMeeting = 'fakeMeeting';
1095
- let sandbox = null;
1096
- let locusParser = null;
1097
- let fakeLocus = null;
1098
-
1099
- beforeEach(() => {
1100
- locusParser = locusInfo.locusParser;
1101
- sandbox = sinon.createSandbox();
1102
-
1103
- fakeLocus = {
1104
- meeting: true,
1105
- participants: true,
1106
- };
1107
- });
1108
-
1109
- afterEach(() => {
1110
- sandbox.restore();
1111
- sandbox = null;
1112
- });
1113
-
1114
- it('handles locus delta events', () => {
1115
- sandbox.stub(locusInfo, 'handleLocusDelta');
1116
-
1117
- const data = {
1118
- eventType: LOCUSEVENT.DIFFERENCE,
1119
- locus: fakeLocus,
1120
- };
1121
-
1122
- locusInfo.parse(fakeMeeting, data);
1123
-
1124
- assert.calledWith(locusInfo.handleLocusDelta, fakeLocus, fakeMeeting);
1125
- });
1126
-
1127
- it('should queue delta event with internal locus parser', () => {
1128
- sandbox.stub(locusParser, 'onDeltaEvent');
1129
-
1130
- const data = {
1131
- eventType: LOCUSEVENT.DIFFERENCE,
1132
- locus: fakeLocus,
1133
- };
1134
-
1135
- locusInfo.parse(fakeMeeting, data);
1136
-
1137
- // queues locus delta event
1138
- assert.calledWith(locusParser.onDeltaEvent, fakeLocus);
1139
- });
1140
-
1141
- it('should assign a function to onDeltaAction', () => {
1142
- sandbox.stub(locusParser, 'onDeltaEvent');
1143
- assert.isNull(locusParser.onDeltaAction);
1144
-
1145
- locusInfo.handleLocusDelta(fakeLocus, fakeMeeting);
1146
-
1147
- assert.isFunction(locusParser.onDeltaAction);
1148
- });
1149
-
1150
- it('onFullLocus() updates the working-copy of locus parser', () => {
1151
- const eventType = 'fakeEvent';
1152
-
1153
- sandbox.stub(locusInfo, 'updateParticipantDeltas');
1154
- sandbox.stub(locusInfo, 'updateLocusInfo');
1155
- sandbox.stub(locusInfo, 'updateParticipants');
1156
- sandbox.stub(locusInfo, 'isMeetingActive');
1157
- sandbox.stub(locusInfo, 'handleOneOnOneEvent');
1158
-
1159
- locusInfo.onFullLocus(fakeLocus, eventType);
1160
-
1161
- assert.equal(fakeLocus, locusParser.workingCopy);
1162
- });
1163
-
1164
- it('onDeltaAction applies locus delta data to meeting', () => {
1165
- const action = 'fake action';
1166
- const parsedLoci = 'fake loci';
1167
-
1168
- sandbox.stub(locusParser, 'onDeltaEvent');
1169
- locusInfo.handleLocusDelta(fakeLocus, fakeMeeting);
1170
- sandbox.spy(locusInfo, 'applyLocusDeltaData');
1171
-
1172
- locusParser.onDeltaAction(action, parsedLoci);
1173
-
1174
- assert.calledWith(locusInfo.applyLocusDeltaData, action, parsedLoci, fakeMeeting);
1175
- });
1176
-
1177
- it('applyLocusDeltaData handles USE_INCOMING action correctly', () => {
1178
- const {USE_INCOMING} = LocusDeltaParser.loci;
1179
- const meeting = {
1180
- locusInfo: {
1181
- onDeltaLocus: sandbox.stub(),
1182
- },
1183
- };
1184
-
1185
- locusInfo.applyLocusDeltaData(USE_INCOMING, fakeLocus, meeting);
1186
-
1187
- assert.calledWith(meeting.locusInfo.onDeltaLocus, fakeLocus);
1188
- });
1189
-
1190
- it('applyLocusDeltaData gets full locus on DESYNC action', () => {
1191
- const {DESYNC} = LocusDeltaParser.loci;
1192
- const meeting = {
1193
- meetingRequest: {
1194
- getFullLocus: sandbox.stub().resolves(true),
1195
- },
1196
- locusInfo: {
1197
- onFullLocus: sandbox.stub(),
1198
- },
1199
- };
1200
-
1201
- locusInfo.locusParser.resume = sandbox.stub();
1202
- locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
1203
-
1204
- assert.calledOnce(meeting.meetingRequest.getFullLocus);
1205
- });
1206
-
1207
- it('getFullLocus handles DESYNC action correctly', () => {
1208
- const {DESYNC} = LocusDeltaParser.loci;
1209
- const meeting = {
1210
- meetingRequest: {
1211
- getFullLocus: sandbox.stub().resolves({body: true}),
1212
- },
1213
- locusInfo,
1214
- };
1215
-
1216
- locusInfo.onFullLocus = sandbox.stub();
1217
-
1218
- // Since we have a promise inside a function we want to test that's not returned,
1219
- // we will wait and stub it's last function to resolve this waiting promise.
1220
- // Also ensures .onFullLocus() is called before .resume()
1221
- return new Promise((resolve) => {
1222
- locusInfo.locusParser.resume = sandbox.stub().callsFake(() => resolve());
1223
- locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
1224
- }).then(() => {
1225
- assert.calledOnce(meeting.locusInfo.onFullLocus);
1226
- assert.calledOnce(locusInfo.locusParser.resume);
1227
- });
1228
- });
1229
- });
1230
-
1231
- describe('#handleOneonOneEvent', () => {
1232
- beforeEach(() => {
1233
- locusInfo.emitScoped = sinon.stub();
1234
- });
1235
- it('emits `REMOTE_RESPONSE`', () => {
1236
- // 'locus.participant_joined'
1237
-
1238
- locusInfo.parsedLocus.fullState.type = 'SIP_BRIDGE';
1239
- locusInfo.handleOneOnOneEvent('locus.participant_declined');
1240
-
1241
- assert.calledWith(
1242
- locusInfo.emitScoped,
1243
- {
1244
- file: 'locus-info',
1245
- function: 'handleOneonOneEvent',
1246
- },
1247
- 'REMOTE_RESPONSE',
1248
- {
1249
- remoteDeclined: true,
1250
- remoteAnswered: false,
1251
- }
1252
- );
1253
-
1254
- locusInfo.parsedLocus.fullState.type = 'SIP_BRIDGE';
1255
- locusInfo.handleOneOnOneEvent('locus.participant_joined');
1256
-
1257
- assert.calledWith(
1258
- locusInfo.emitScoped,
1259
- {
1260
- file: 'locus-info',
1261
- function: 'handleOneonOneEvent',
1262
- },
1263
- 'REMOTE_RESPONSE',
1264
- {
1265
- remoteDeclined: false,
1266
- remoteAnswered: true,
1267
- }
1268
- );
1269
- });
1270
- });
1271
- });
1272
- });
1
+ import 'jsdom-global/register';
2
+ import sinon from 'sinon';
3
+ import {cloneDeep} from 'lodash';
4
+ import {assert} from '@webex/test-helper-chai';
5
+ import MockWebex from '@webex/test-helper-mock-webex';
6
+ import Meetings from '@webex/plugin-meetings';
7
+ import LocusInfo from '@webex/plugin-meetings/src/locus-info';
8
+ import SelfUtils from '@webex/plugin-meetings/src/locus-info/selfUtils';
9
+ import InfoUtils from '@webex/plugin-meetings/src/locus-info/infoUtils';
10
+ import EmbeddedAppsUtils from '@webex/plugin-meetings/src/locus-info/embeddedAppsUtils';
11
+ import LocusDeltaParser from '@webex/plugin-meetings/src/locus-info/parser';
12
+
13
+ import {
14
+ LOCUSINFO,
15
+ RECORDING_STATE,
16
+ LOCUSEVENT,
17
+ EVENTS,
18
+ DISPLAY_HINTS,
19
+ } from '../../../../src/constants';
20
+
21
+ import {self, selfWithInactivity} from './lib/selfConstant';
22
+
23
+ describe('plugin-meetings', () => {
24
+ describe('LocusInfo index', () => {
25
+ let mockMeeting;
26
+ const updateMeeting = (object) => {
27
+ if (mockMeeting && object && Object.keys(object).length) {
28
+ Object.keys(object).forEach((key) => {
29
+ mockMeeting[key] = object[key];
30
+ });
31
+ }
32
+ };
33
+ const locus = {};
34
+ const meetingId = 'meetingId';
35
+ let locusInfo;
36
+
37
+ const webex = new MockWebex({
38
+ children: {
39
+ meetings: Meetings,
40
+ },
41
+ });
42
+
43
+ beforeEach(() => {
44
+ mockMeeting = {};
45
+ locusInfo = new LocusInfo(updateMeeting, webex, meetingId);
46
+
47
+ locusInfo.init(locus);
48
+
49
+ locusInfo.parsedLocus = {
50
+ states: [{one: 'one'}],
51
+ fullState: {type: 'MEETING'},
52
+ info: {
53
+ sipUri: 'abc@webex.com',
54
+ isUnlocked: true,
55
+ isLocked: false,
56
+ displayHints: {
57
+ joined: ['ROSTER_IN_MEETING', 'LOCK_STATUS_UNLOCKED'],
58
+ moderator: [],
59
+ },
60
+ },
61
+ };
62
+ });
63
+
64
+ describe('#updateControls', () => {
65
+ let newControls;
66
+
67
+ beforeEach('setup new controls', () => {
68
+ newControls = {
69
+ lock: {},
70
+ meetingFull: {},
71
+ record: {
72
+ recording: false,
73
+ paused: false,
74
+ meta: {
75
+ lastModified: 'TODAY',
76
+ modifiedBy: 'George Kittle',
77
+ },
78
+ },
79
+ shareControl: {},
80
+ transcribe: {},
81
+ meetingContainer: {
82
+ meetingContainerUrl: 'http://new-url.com',
83
+ },
84
+ entryExitTone: {enabled: true, mode: 'foo'},
85
+ };
86
+ });
87
+
88
+ afterEach(() => {
89
+ newControls = null;
90
+ });
91
+
92
+ it('should update the controls object', () => {
93
+ locusInfo.updateControls(newControls);
94
+
95
+ assert.equal(locusInfo.controls, newControls);
96
+ });
97
+
98
+ it('should not trigger the CONTROLS_RECORDING_UPDATED event', () => {
99
+ locusInfo.controls = {};
100
+ locusInfo.emitScoped = sinon.stub();
101
+ locusInfo.updateControls(newControls);
102
+
103
+ locusInfo.emitScoped.getCalls().forEach((x) => {
104
+ // check that no calls in emitScoped are for CONTROLS_RECORDING_UPDATED
105
+ assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED);
106
+ });
107
+ });
108
+
109
+ it('should keep the recording state to `IDLE`', () => {
110
+ locusInfo.controls = {
111
+ record: {
112
+ recording: true,
113
+ paused: false,
114
+ meta: {
115
+ lastModified: 'TODAY',
116
+ modifiedBy: 'George Kittle',
117
+ },
118
+ },
119
+ shareControl: {},
120
+ transcribe: {},
121
+ };
122
+ locusInfo.emitScoped = sinon.stub();
123
+ locusInfo.updateControls(newControls);
124
+
125
+ assert.calledWith(
126
+ locusInfo.emitScoped,
127
+ {
128
+ file: 'locus-info',
129
+ function: 'updateControls',
130
+ },
131
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
132
+ {
133
+ state: RECORDING_STATE.IDLE,
134
+ modifiedBy: 'George Kittle',
135
+ lastModified: 'TODAY',
136
+ }
137
+ );
138
+ });
139
+
140
+ it('should update the recording state to `RECORDING`', () => {
141
+ locusInfo.controls = {
142
+ lock: {},
143
+ meetingFull: {},
144
+ record: {
145
+ recording: false,
146
+ paused: false,
147
+ meta: {
148
+ lastModified: 'TODAY',
149
+ modifiedBy: 'George Kittle',
150
+ },
151
+ },
152
+ shareControl: {},
153
+ transcribe: {},
154
+ };
155
+ newControls.record.recording = true;
156
+ locusInfo.emitScoped = sinon.stub();
157
+ locusInfo.updateControls(newControls);
158
+
159
+ assert.calledWith(
160
+ locusInfo.emitScoped,
161
+ {
162
+ file: 'locus-info',
163
+ function: 'updateControls',
164
+ },
165
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
166
+ {
167
+ state: RECORDING_STATE.RECORDING,
168
+ modifiedBy: 'George Kittle',
169
+ lastModified: 'TODAY',
170
+ }
171
+ );
172
+ });
173
+
174
+ it('should update the recording state to `PAUSED`', () => {
175
+ locusInfo.emitScoped = sinon.stub();
176
+ locusInfo.controls = {
177
+ lock: {},
178
+ meetingFull: {},
179
+ record: {
180
+ recording: false,
181
+ paused: false,
182
+ meta: {
183
+ lastModified: 'TODAY',
184
+ modifiedBy: 'George Kittle',
185
+ },
186
+ },
187
+ shareControl: {},
188
+ transcribe: {},
189
+ };
190
+ newControls.record.paused = true;
191
+ newControls.record.recording = true;
192
+ locusInfo.updateControls(newControls);
193
+
194
+ assert.calledWith(
195
+ locusInfo.emitScoped,
196
+ {
197
+ file: 'locus-info',
198
+ function: 'updateControls',
199
+ },
200
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
201
+ {
202
+ state: RECORDING_STATE.PAUSED,
203
+ modifiedBy: 'George Kittle',
204
+ lastModified: 'TODAY',
205
+ }
206
+ );
207
+ });
208
+
209
+ it('should update the recording state to `RESUMED`', () => {
210
+ locusInfo.emitScoped = sinon.stub();
211
+ locusInfo.controls = {
212
+ lock: {},
213
+ meetingFull: {},
214
+ record: {
215
+ recording: false,
216
+ paused: true,
217
+ meta: {
218
+ lastModified: 'TODAY',
219
+ modifiedBy: 'George Kittle',
220
+ },
221
+ },
222
+ shareControl: {},
223
+ transcribe: {},
224
+ };
225
+ // there must be a recording to be paused/resumed
226
+ newControls.record.recording = true;
227
+ newControls.record.paused = false;
228
+ locusInfo.updateControls(newControls);
229
+
230
+ assert.calledWith(
231
+ locusInfo.emitScoped,
232
+ {
233
+ file: 'locus-info',
234
+ function: 'updateControls',
235
+ },
236
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
237
+ {
238
+ state: RECORDING_STATE.RESUMED,
239
+ modifiedBy: 'George Kittle',
240
+ lastModified: 'TODAY',
241
+ }
242
+ );
243
+ });
244
+
245
+ it('should update the recording state to `IDLE` even if `pause`status changes', () => {
246
+ locusInfo.emitScoped = sinon.stub();
247
+ locusInfo.controls = {
248
+ lock: {},
249
+ meetingFull: {},
250
+ record: {
251
+ recording: true,
252
+ paused: true,
253
+ meta: {
254
+ lastModified: 'TODAY',
255
+ modifiedBy: 'George Kittle',
256
+ },
257
+ },
258
+ shareControl: {},
259
+ transcribe: {},
260
+ };
261
+ newControls.record.recording = false;
262
+ newControls.record.paused = false;
263
+ locusInfo.updateControls(newControls);
264
+
265
+ assert.calledWith(
266
+ locusInfo.emitScoped,
267
+ {
268
+ file: 'locus-info',
269
+ function: 'updateControls',
270
+ },
271
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
272
+ {
273
+ state: RECORDING_STATE.IDLE,
274
+ modifiedBy: 'George Kittle',
275
+ lastModified: 'TODAY',
276
+ }
277
+ );
278
+ });
279
+
280
+ it('should update the transcript state', () => {
281
+ locusInfo.emitScoped = sinon.stub();
282
+ locusInfo.controls = {
283
+ lock: {},
284
+ meetingFull: {},
285
+ record: {
286
+ recording: false,
287
+ paused: true,
288
+ meta: {
289
+ lastModified: 'TODAY',
290
+ modifiedBy: 'George Kittle',
291
+ },
292
+ },
293
+ shareControl: {},
294
+ transcribe: {
295
+ transcribing: false,
296
+ caption: false,
297
+ },
298
+ };
299
+ newControls.transcribe.transcribing = true;
300
+ newControls.transcribe.caption = true;
301
+
302
+ locusInfo.updateControls(newControls);
303
+
304
+ assert.calledWith(
305
+ locusInfo.emitScoped,
306
+ {
307
+ file: 'locus-info',
308
+ function: 'updateControls',
309
+ },
310
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_TRANSCRIBE_UPDATED,
311
+ {
312
+ transcribing: true,
313
+ caption: true,
314
+ }
315
+ );
316
+ });
317
+
318
+ it('should update the meetingContainerURL from null', () => {
319
+ locusInfo.controls = {
320
+ meetingContainer: {meetingContainerUrl: null},
321
+ };
322
+
323
+ locusInfo.emitScoped = sinon.stub();
324
+ locusInfo.updateControls(newControls);
325
+
326
+ assert.calledWith(
327
+ locusInfo.emitScoped,
328
+ {
329
+ file: 'locus-info',
330
+ function: 'updateControls',
331
+ },
332
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
333
+ {meetingContainerUrl: 'http://new-url.com'}
334
+ );
335
+ });
336
+
337
+ it('should update the meetingContainerURL from not null', () => {
338
+ locusInfo.controls = {
339
+ meetingContainer: {meetingContainerUrl: 'http://old-url.com'},
340
+ };
341
+
342
+ locusInfo.emitScoped = sinon.stub();
343
+ locusInfo.updateControls(newControls);
344
+
345
+ assert.calledWith(
346
+ locusInfo.emitScoped,
347
+ {
348
+ file: 'locus-info',
349
+ function: 'updateControls',
350
+ },
351
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
352
+ {meetingContainerUrl: 'http://new-url.com'}
353
+ );
354
+ });
355
+
356
+ it('should update the meetingContainerURL from missing', () => {
357
+ locusInfo.controls = {};
358
+
359
+ locusInfo.emitScoped = sinon.stub();
360
+ locusInfo.updateControls(newControls);
361
+
362
+ assert.calledWith(
363
+ locusInfo.emitScoped,
364
+ {
365
+ file: 'locus-info',
366
+ function: 'updateControls',
367
+ },
368
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
369
+ {meetingContainerUrl: 'http://new-url.com'}
370
+ );
371
+ });
372
+
373
+ it('should update the entryExitTone when changed', () => {
374
+ locusInfo.controls = {};
375
+
376
+ locusInfo.emitScoped = sinon.stub();
377
+ locusInfo.updateControls(newControls);
378
+
379
+ assert.calledWith(
380
+ locusInfo.emitScoped,
381
+ {
382
+ file: 'locus-info',
383
+ function: 'updateControls',
384
+ },
385
+ LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
386
+ {entryExitTone: 'foo'}
387
+ );
388
+ });
389
+
390
+ it('should not update the entryExitTone when unchanged', () => {
391
+ locusInfo.controls = {entryExitTone: {enabled: true, mode: 'foo'}};
392
+
393
+ locusInfo.emitScoped = sinon.stub();
394
+ locusInfo.updateControls(newControls);
395
+
396
+ locusInfo.emitScoped.getCalls().forEach((x) => {
397
+ // check that no calls in emitScoped are for CONTROLS_ENTRY_EXIT_TONE_UPDATED
398
+ assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED);
399
+ });
400
+ });
401
+ });
402
+
403
+ describe('#updateParticipants()', () => {
404
+ let newParticipants;
405
+
406
+ beforeEach('setup new participants', () => {
407
+ newParticipants = [
408
+ {
409
+ person: {
410
+ id: 1234,
411
+ },
412
+ status: {
413
+ audioStatus: 'testValue',
414
+ videoSlidesStatus: 'testValue',
415
+ videoStatus: 'testValue',
416
+ },
417
+ },
418
+ ];
419
+ });
420
+
421
+ it('should assert that the correct recordingId, selfIdentity, selfId, and hostId are being set and emitted from updateParticipants', () => {
422
+ locusInfo.parsedLocus = {
423
+ controls: {
424
+ record: {
425
+ modifiedBy: '1',
426
+ },
427
+ },
428
+ self: {
429
+ selfIdentity: '123',
430
+ selfId: '2',
431
+ },
432
+ host: {
433
+ hostId: '3',
434
+ },
435
+ };
436
+ locusInfo.emitScoped = sinon.stub();
437
+ locusInfo.updateParticipants({});
438
+
439
+ // if this assertion fails, double-check the attributes used in
440
+ // the updateParticipants function in locus-info/index.js
441
+ assert.calledWith(
442
+ locusInfo.emitScoped,
443
+ {
444
+ file: 'locus-info',
445
+ function: 'updateParticipants',
446
+ },
447
+ EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
448
+ {
449
+ participants: {},
450
+ recordingId: '1',
451
+ selfIdentity: '123',
452
+ selfId: '2',
453
+ hostId: '3',
454
+ }
455
+ );
456
+ // note: in a real use case, recordingId, selfId, and hostId would all be the same
457
+ // for this specific test, we are double-checking that each of the id's
458
+ // are being correctly grabbed from locusInfo.parsedLocus within updateParticipants
459
+ });
460
+
461
+ it('should update the deltaParticipants object', () => {
462
+ const prev = locusInfo.deltaParticipants;
463
+
464
+ locusInfo.updateParticipantDeltas(newParticipants);
465
+
466
+ assert.notEqual(locusInfo.deltaParticipants, prev);
467
+ });
468
+
469
+ it('should update the delta property on all changed states', () => {
470
+ locusInfo.updateParticipantDeltas(newParticipants);
471
+
472
+ const [exampleParticipant] = locusInfo.deltaParticipants;
473
+
474
+ assert.isTrue(exampleParticipant.delta.audioStatus);
475
+ assert.isTrue(exampleParticipant.delta.videoSlidesStatus);
476
+ assert.isTrue(exampleParticipant.delta.videoStatus);
477
+ });
478
+
479
+ it('should include the person details of the changed participant', () => {
480
+ locusInfo.updateParticipantDeltas(newParticipants);
481
+
482
+ const [exampleParticipant] = locusInfo.deltaParticipants;
483
+
484
+ assert.equal(exampleParticipant.person, newParticipants[0].person);
485
+ });
486
+
487
+ it('should clear deltaParticipants when no changes occured', () => {
488
+ locusInfo.participants = [...newParticipants];
489
+
490
+ locusInfo.updateParticipantDeltas(locusInfo.participants);
491
+
492
+ assert.isTrue(locusInfo.deltaParticipants.length === 0);
493
+ });
494
+ });
495
+
496
+ describe('#updateSelf', () => {
497
+ it('should trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls change', () => {
498
+ const layoutType = 'EXAMPLE TYPE';
499
+
500
+ locusInfo.self = undefined;
501
+ const selfWithLayoutChanged = cloneDeep(self);
502
+
503
+ selfWithLayoutChanged.controls.layouts = [
504
+ {
505
+ type: layoutType,
506
+ },
507
+ ];
508
+
509
+ locusInfo.emitScoped = sinon.stub();
510
+ locusInfo.updateSelf(selfWithLayoutChanged, []);
511
+
512
+ assert.calledWith(
513
+ locusInfo.emitScoped,
514
+ {
515
+ file: 'locus-info',
516
+ function: 'updateSelf',
517
+ },
518
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
519
+ {layout: layoutType}
520
+ );
521
+ });
522
+
523
+ it('should not trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls did not change', () => {
524
+ const layoutType = 'EXAMPLE TYPE';
525
+
526
+ locusInfo.self = undefined;
527
+ const selfWithLayoutChanged = cloneDeep(self);
528
+
529
+ selfWithLayoutChanged.controls.layouts = [
530
+ {
531
+ type: layoutType,
532
+ },
533
+ ];
534
+
535
+ // Set the layout prior to stubbing to validate it does not change.
536
+ locusInfo.updateSelf(selfWithLayoutChanged, []);
537
+
538
+ locusInfo.emitScoped = sinon.stub();
539
+
540
+ locusInfo.updateSelf(selfWithLayoutChanged, []);
541
+
542
+ assert.neverCalledWith(
543
+ locusInfo.emitScoped,
544
+ {
545
+ file: 'locus-info',
546
+ function: 'updateSelf',
547
+ },
548
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
549
+ {layout: layoutType}
550
+ );
551
+ });
552
+
553
+ it('should trigger MEDIA_INACTIVITY on server media inactivity', () => {
554
+ locusInfo.self = self;
555
+
556
+ locusInfo.webex.internal.device.url = selfWithInactivity.deviceUrl;
557
+ locusInfo.emitScoped = sinon.stub();
558
+ locusInfo.updateSelf(selfWithInactivity, []);
559
+
560
+ assert.calledWith(
561
+ locusInfo.emitScoped,
562
+ {
563
+ file: 'locus-info',
564
+ function: 'updateSelf',
565
+ },
566
+ LOCUSINFO.EVENTS.MEDIA_INACTIVITY,
567
+ SelfUtils.getMediaStatus(selfWithInactivity.mediaSessions)
568
+ );
569
+ });
570
+
571
+ it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED when muted on entry', () => {
572
+ // usually "previous self" is just undefined when we get first self from locus with remote mute
573
+ locusInfo.self = undefined;
574
+ const selfWithMutedByOthers = cloneDeep(self);
575
+
576
+ selfWithMutedByOthers.controls.audio.muted = true;
577
+
578
+ locusInfo.webex.internal.device.url = self.deviceUrl;
579
+ locusInfo.emitScoped = sinon.stub();
580
+ locusInfo.updateSelf(selfWithMutedByOthers, []);
581
+
582
+ assert.calledWith(
583
+ locusInfo.emitScoped,
584
+ {
585
+ file: 'locus-info',
586
+ function: 'updateSelf',
587
+ },
588
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
589
+ {muted: true, unmuteAllowed: true}
590
+ );
591
+
592
+ // but sometimes "previous self" is defined, but without controls.audio.muted, so we test this here:
593
+ locusInfo.self = cloneDeep(self);
594
+ locusInfo.self.controls.audio = {};
595
+
596
+ locusInfo.updateSelf(selfWithMutedByOthers, []);
597
+ assert.calledWith(
598
+ locusInfo.emitScoped,
599
+ {
600
+ file: 'locus-info',
601
+ function: 'updateSelf',
602
+ },
603
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
604
+ {muted: true, unmuteAllowed: true}
605
+ );
606
+ });
607
+
608
+ it('should not trigger SELF_REMOTE_MUTE_STATUS_UPDATED when not muted on entry', () => {
609
+ locusInfo.self = undefined;
610
+ const selfWithMutedByOthersFalse = cloneDeep(self);
611
+
612
+ selfWithMutedByOthersFalse.controls.audio.muted = false;
613
+
614
+ locusInfo.webex.internal.device.url = self.deviceUrl;
615
+ locusInfo.emitScoped = sinon.stub();
616
+ locusInfo.updateSelf(selfWithMutedByOthersFalse, []);
617
+
618
+ // we might get some calls to emitScoped, but we need to check that none of them are for SELF_REMOTE_MUTE_STATUS_UPDATED
619
+ locusInfo.emitScoped.getCalls().forEach((x) => {
620
+ assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED);
621
+ });
622
+ });
623
+
624
+ it('should not trigger SELF_REMOTE_MUTE_STATUS_UPDATED when being removed from meeting', () => {
625
+ const selfWithMutedByOthers = cloneDeep(self);
626
+
627
+ selfWithMutedByOthers.controls.audio.muted = true;
628
+
629
+ locusInfo.self = selfWithMutedByOthers;
630
+
631
+ // when user gets removed from meeting we receive a Locus DTO without any self.controls
632
+ const selfWithoutControls = cloneDeep(self);
633
+
634
+ selfWithoutControls.controls = undefined;
635
+
636
+ locusInfo.webex.internal.device.url = self.deviceUrl;
637
+ locusInfo.emitScoped = sinon.stub();
638
+ locusInfo.updateSelf(selfWithoutControls, []);
639
+
640
+ // we might get some calls to emitScoped, but we need to check that none of them are for SELF_REMOTE_MUTE_STATUS_UPDATED
641
+ locusInfo.emitScoped.getCalls().forEach((x) => {
642
+ assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED);
643
+ });
644
+ });
645
+
646
+ it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED on othersMuted', () => {
647
+ locusInfo.self = self;
648
+ const selfWithMutedByOthers = cloneDeep(self);
649
+
650
+ selfWithMutedByOthers.controls.audio.muted = true;
651
+
652
+ locusInfo.webex.internal.device.url = self.deviceUrl;
653
+ locusInfo.emitScoped = sinon.stub();
654
+ locusInfo.updateSelf(selfWithMutedByOthers, []);
655
+
656
+ assert.calledWith(
657
+ locusInfo.emitScoped,
658
+ {
659
+ file: 'locus-info',
660
+ function: 'updateSelf',
661
+ },
662
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
663
+ {muted: true, unmuteAllowed: true}
664
+ );
665
+ });
666
+
667
+ it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED if muted and disallowUnmute changed', () => {
668
+ locusInfo.self = self;
669
+ const selfWithMutedByOthersAndDissalowUnmute = cloneDeep(self);
670
+
671
+ // first simulate remote mute
672
+ selfWithMutedByOthersAndDissalowUnmute.controls.audio.muted = true;
673
+ selfWithMutedByOthersAndDissalowUnmute.controls.audio.disallowUnmute = true;
674
+
675
+ locusInfo.webex.internal.device.url = self.deviceUrl;
676
+ locusInfo.emitScoped = sinon.stub();
677
+ locusInfo.updateSelf(selfWithMutedByOthersAndDissalowUnmute, []);
678
+
679
+ assert.calledWith(
680
+ locusInfo.emitScoped,
681
+ {
682
+ file: 'locus-info',
683
+ function: 'updateSelf',
684
+ },
685
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
686
+ {muted: true, unmuteAllowed: false}
687
+ );
688
+
689
+ // now change only disallowUnmute
690
+ const selfWithMutedByOthers = cloneDeep(self);
691
+
692
+ selfWithMutedByOthers.controls.audio.muted = true;
693
+ selfWithMutedByOthers.controls.audio.disallowUnmute = false;
694
+
695
+ locusInfo.updateSelf(selfWithMutedByOthers, []);
696
+
697
+ assert.calledWith(
698
+ locusInfo.emitScoped,
699
+ {
700
+ file: 'locus-info',
701
+ function: 'updateSelf',
702
+ },
703
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
704
+ {muted: true, unmuteAllowed: true}
705
+ );
706
+ });
707
+
708
+ it('should trigger LOCAL_UNMUTE_REQUIRED on localAudioUnmuteRequired', () => {
709
+ locusInfo.self = self;
710
+ const selfWithLocalUnmuteRequired = cloneDeep(self);
711
+
712
+ selfWithLocalUnmuteRequired.controls.audio.muted = false;
713
+ selfWithLocalUnmuteRequired.controls.audio.localAudioUnmuteRequired = true;
714
+
715
+ locusInfo.webex.internal.device.url = self.deviceUrl;
716
+ locusInfo.emitScoped = sinon.stub();
717
+ locusInfo.updateSelf(selfWithLocalUnmuteRequired, []);
718
+
719
+ assert.calledWith(
720
+ locusInfo.emitScoped,
721
+ {
722
+ file: 'locus-info',
723
+ function: 'updateSelf',
724
+ },
725
+ LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUIRED,
726
+ {
727
+ muted: false,
728
+ unmuteAllowed: true,
729
+ }
730
+ );
731
+ });
732
+
733
+ it('should trigger LOCAL_UNMUTE_REQUESTED when receiving requestedToUnmute=true', () => {
734
+ locusInfo.self = self;
735
+ const selfWithRequestedToUnmute = cloneDeep(self);
736
+
737
+ selfWithRequestedToUnmute.controls.audio.requestedToUnmute = true;
738
+
739
+ locusInfo.webex.internal.device.url = self.deviceUrl;
740
+ locusInfo.emitScoped = sinon.stub();
741
+ locusInfo.updateSelf(selfWithRequestedToUnmute, []);
742
+
743
+ assert.calledWith(
744
+ locusInfo.emitScoped,
745
+ {
746
+ file: 'locus-info',
747
+ function: 'updateSelf',
748
+ },
749
+ LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
750
+ {}
751
+ );
752
+
753
+ // now change requestedToUnmute back to false -> it should NOT trigger LOCAL_UNMUTE_REQUESTED
754
+ const selfWithoutRequestedToUnmute = cloneDeep(selfWithRequestedToUnmute);
755
+
756
+ selfWithoutRequestedToUnmute.controls.audio.requestedToUnmute = false;
757
+
758
+ locusInfo.emitScoped.resetHistory();
759
+ locusInfo.updateSelf(selfWithoutRequestedToUnmute, []);
760
+
761
+ assert.neverCalledWith(
762
+ locusInfo.emitScoped,
763
+ {
764
+ file: 'locus-info',
765
+ function: 'updateSelf',
766
+ },
767
+ LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
768
+ {}
769
+ );
770
+ });
771
+
772
+ it('should trigger SELF_OBSERVING when moving meeting to DX', () => {
773
+ locusInfo.self = self;
774
+ const selfInitiatedMove = cloneDeep(self);
775
+
776
+ // Inital move meeting is iniated
777
+ selfInitiatedMove.devices[0].intent.type = 'MOVE_MEDIA';
778
+
779
+ locusInfo.webex.internal.device.url = self.deviceUrl;
780
+
781
+ locusInfo.updateSelf(selfInitiatedMove, []);
782
+
783
+ locusInfo.emitScoped = sinon.stub();
784
+ // When dx joined the meeting after move
785
+ const selfAfterDxJoins = cloneDeep(self);
786
+
787
+ selfAfterDxJoins.devices[0].intent.type = 'OBSERVE';
788
+
789
+ locusInfo.updateSelf(selfAfterDxJoins, []);
790
+
791
+ assert.calledWith(
792
+ locusInfo.emitScoped,
793
+ {
794
+ file: 'locus-info',
795
+ function: 'updateSelf',
796
+ },
797
+ LOCUSINFO.EVENTS.SELF_OBSERVING
798
+ );
799
+ });
800
+
801
+ it('should not trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when not updated', () => {
802
+ const selfClone = cloneDeep(self);
803
+
804
+ selfClone.canNotViewTheParticipantList = false; // same
805
+
806
+ // Set the layout prior to stubbing to validate it does not change.
807
+ locusInfo.updateSelf(self, []);
808
+
809
+ locusInfo.emitScoped = sinon.stub();
810
+
811
+ locusInfo.updateSelf(selfClone, []);
812
+
813
+ assert.neverCalledWith(
814
+ locusInfo.emitScoped,
815
+ {
816
+ file: 'locus-info',
817
+ function: 'updateSelf',
818
+ },
819
+ LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
820
+ {canNotViewTheParticipantList: false}
821
+ );
822
+ });
823
+
824
+ it('should trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when updated', () => {
825
+ const selfClone = cloneDeep(self);
826
+
827
+ selfClone.canNotViewTheParticipantList = true; // different
828
+
829
+ // Set the layout prior to stubbing to validate it does not change.
830
+ locusInfo.updateSelf(self, []);
831
+
832
+ locusInfo.emitScoped = sinon.stub();
833
+
834
+ locusInfo.updateSelf(selfClone, []);
835
+
836
+ assert.calledWith(
837
+ locusInfo.emitScoped,
838
+ {
839
+ file: 'locus-info',
840
+ function: 'updateSelf',
841
+ },
842
+ LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
843
+ {canNotViewTheParticipantList: true}
844
+ );
845
+ });
846
+
847
+ it('should not trigger SELF_IS_SHARING_BLOCKED_CHANGE when not updated', () => {
848
+ const selfClone = cloneDeep(self);
849
+
850
+ selfClone.isSharingBlocked = false; // same
851
+
852
+ // Set the layout prior to stubbing to validate it does not change.
853
+ locusInfo.updateSelf(self, []);
854
+
855
+ locusInfo.emitScoped = sinon.stub();
856
+
857
+ locusInfo.updateSelf(selfClone, []);
858
+
859
+ assert.neverCalledWith(
860
+ locusInfo.emitScoped,
861
+ {
862
+ file: 'locus-info',
863
+ function: 'updateSelf',
864
+ },
865
+ LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
866
+ {isSharingBlocked: false}
867
+ );
868
+ });
869
+
870
+ it('should trigger SELF_IS_SHARING_BLOCKED_CHANGE when updated', () => {
871
+ const selfClone = cloneDeep(self);
872
+
873
+ selfClone.isSharingBlocked = true; // different
874
+
875
+ // Set the layout prior to stubbing to validate it does not change.
876
+ locusInfo.updateSelf(self, []);
877
+
878
+ locusInfo.emitScoped = sinon.stub();
879
+
880
+ locusInfo.updateSelf(selfClone, []);
881
+
882
+ assert.calledWith(
883
+ locusInfo.emitScoped,
884
+ {
885
+ file: 'locus-info',
886
+ function: 'updateSelf',
887
+ },
888
+ LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
889
+ {isSharingBlocked: true}
890
+ );
891
+ });
892
+ });
893
+
894
+ describe('#updateMeetingInfo', () => {
895
+ let meetingInfo;
896
+ let getInfosSpy;
897
+ let getRolesSpy;
898
+ let isJoinedSpy;
899
+
900
+ beforeEach('setup meeting info', () => {
901
+ meetingInfo = {
902
+ displayHints: {
903
+ joined: ['ROSTER_IN_MEETING', 'LOCK_STATUS_UNLOCKED'],
904
+ moderator: [],
905
+ },
906
+ };
907
+ getInfosSpy = sinon.spy(InfoUtils, 'getInfos');
908
+ getRolesSpy = sinon.spy(SelfUtils, 'getRoles');
909
+ isJoinedSpy = sinon.spy(SelfUtils, 'isJoined');
910
+ });
911
+
912
+ afterEach(() => {
913
+ getRolesSpy.restore();
914
+ getInfosSpy.restore();
915
+ isJoinedSpy.restore();
916
+ });
917
+
918
+ it('should trigger MEETING_LOCKED/UNLOCKED when meeting gets locked/unlocked', () => {
919
+ const meetingInfoLocked = cloneDeep(meetingInfo);
920
+
921
+ const idx = meetingInfoLocked.displayHints.joined.indexOf('LOCK_STATUS_UNLOCKED');
922
+
923
+ if (idx !== -1) {
924
+ meetingInfoLocked.displayHints.joined[idx] = 'LOCK_STATUS_LOCKED';
925
+ }
926
+
927
+ locusInfo.webex.internal.device.url = self.deviceUrl;
928
+ locusInfo.emitScoped = sinon.stub();
929
+ locusInfo.updateMeetingInfo(meetingInfoLocked, self);
930
+
931
+ assert.calledWith(
932
+ locusInfo.emitScoped,
933
+ {
934
+ file: 'locus-info',
935
+ function: 'updateMeetingInfo',
936
+ },
937
+ LOCUSINFO.EVENTS.MEETING_LOCKED,
938
+ meetingInfoLocked
939
+ );
940
+
941
+ // now unlock the meeting and verify that we get the right event
942
+ const meetingInfoUnlocked = cloneDeep(meetingInfo); // meetingInfo already is "unlocked"
943
+
944
+ locusInfo.updateMeetingInfo(meetingInfoUnlocked, self);
945
+
946
+ assert.calledWith(
947
+ locusInfo.emitScoped,
948
+ {
949
+ file: 'locus-info',
950
+ function: 'updateMeetingInfo',
951
+ },
952
+ LOCUSINFO.EVENTS.MEETING_UNLOCKED,
953
+ meetingInfoUnlocked
954
+ );
955
+ });
956
+
957
+ const checkMeetingInfoUpdatedCalled = (expected) => {
958
+ const expectedArgs = [
959
+ locusInfo.emitScoped,
960
+ {
961
+ file: 'locus-info',
962
+ function: 'updateMeetingInfo',
963
+ },
964
+ LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
965
+ {info: locusInfo.parsedLocus.info, self},
966
+ ];
967
+
968
+ if (expected) {
969
+ assert.calledWith(...expectedArgs);
970
+ } else {
971
+ assert.neverCalledWith(...expectedArgs);
972
+ }
973
+ locusInfo.emitScoped.resetHistory();
974
+ };
975
+
976
+ it('emits MEETING_INFO_UPDATED if the info changes', () => {
977
+ const initialInfo = cloneDeep(meetingInfo);
978
+
979
+ locusInfo.emitScoped = sinon.stub();
980
+
981
+ // set the info initially as locusInfo.info starts as undefined
982
+ locusInfo.updateMeetingInfo(initialInfo, self);
983
+
984
+ // since it was initially undefined, this should trigger the event
985
+ checkMeetingInfoUpdatedCalled(true);
986
+
987
+ const newInfo = cloneDeep(meetingInfo);
988
+
989
+ newInfo.displayHints.coHost = [DISPLAY_HINTS.LOCK_CONTROL_LOCK];
990
+
991
+ // Updating with different info should trigger the event
992
+ locusInfo.updateMeetingInfo(newInfo, self);
993
+
994
+ checkMeetingInfoUpdatedCalled(true);
995
+
996
+ // update it with the same info
997
+ locusInfo.updateMeetingInfo(newInfo, self);
998
+
999
+ // since the info is the same it should not call trigger the event
1000
+ checkMeetingInfoUpdatedCalled(false);
1001
+ });
1002
+
1003
+ it('gets roles from self if available', () => {
1004
+ const initialInfo = cloneDeep(meetingInfo);
1005
+
1006
+ const parsedLocusInfo = cloneDeep(locusInfo.parsedLocus.info);
1007
+
1008
+ locusInfo.updateMeetingInfo(initialInfo, self);
1009
+
1010
+ assert.calledWith(getRolesSpy, self);
1011
+ assert.calledWith(getInfosSpy, parsedLocusInfo, initialInfo, ['PRESENTER']);
1012
+ });
1013
+
1014
+ it('gets roles from parsedLocus if self not passed in', () => {
1015
+ const initialInfo = cloneDeep(meetingInfo);
1016
+
1017
+ locusInfo.parsedLocus.self = {
1018
+ roles: ['MODERATOR', 'COHOST'],
1019
+ };
1020
+
1021
+ const parsedLocusInfo = cloneDeep(locusInfo.parsedLocus.info);
1022
+
1023
+ locusInfo.updateMeetingInfo(initialInfo);
1024
+ assert.calledWith(isJoinedSpy, locusInfo.parsedLocus.self);
1025
+ assert.neverCalledWith(getRolesSpy, self);
1026
+ assert.calledWith(getInfosSpy, parsedLocusInfo, initialInfo, ['MODERATOR', 'COHOST']);
1027
+ });
1028
+ });
1029
+
1030
+ describe('#updateEmbeddedApps()', () => {
1031
+ const newEmbeddedApps = [
1032
+ {
1033
+ url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
1034
+ sequence: 138849877016800000,
1035
+ appId:
1036
+ 'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
1037
+ instanceInfo: {
1038
+ appInstanceUrl:
1039
+ 'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
1040
+ externalAppInstanceUrl: '',
1041
+ title: 'Active session',
1042
+ },
1043
+ state: 'STARTED',
1044
+ lastModified: '2022-10-13T21:01:41.680Z',
1045
+ },
1046
+ ];
1047
+
1048
+ it('properly updates the meeting embeddedApps', () => {
1049
+ const prev = mockMeeting.embeddedApps;
1050
+
1051
+ locusInfo.updateEmbeddedApps(newEmbeddedApps);
1052
+
1053
+ assert.notEqual(mockMeeting.embeddedApps, prev);
1054
+ assert.isNotNull(mockMeeting.embeddedApps?.[0].type);
1055
+ });
1056
+
1057
+ it("does not emit EMBEDDED_APPS_UPDATED when apps didn't change", () => {
1058
+ locusInfo.updateEmbeddedApps(newEmbeddedApps);
1059
+
1060
+ locusInfo.emitScoped = sinon.stub();
1061
+
1062
+ const clonedApps = cloneDeep(newEmbeddedApps);
1063
+
1064
+ locusInfo.updateEmbeddedApps(clonedApps);
1065
+
1066
+ assert.notCalled(locusInfo.emitScoped);
1067
+ });
1068
+
1069
+ it('emits EMBEDDED_APPS_UPDATED when apps changed', () => {
1070
+ locusInfo.updateEmbeddedApps(newEmbeddedApps);
1071
+
1072
+ locusInfo.emitScoped = sinon.stub();
1073
+
1074
+ const clonedApps = cloneDeep(newEmbeddedApps);
1075
+
1076
+ clonedApps[0].state = 'STOPPED';
1077
+ const expectedApps = EmbeddedAppsUtils.parse(clonedApps);
1078
+
1079
+ locusInfo.updateEmbeddedApps(clonedApps);
1080
+
1081
+ assert.calledWith(
1082
+ locusInfo.emitScoped,
1083
+ {
1084
+ file: 'locus-info',
1085
+ function: 'updateEmbeddedApps',
1086
+ },
1087
+ LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
1088
+ expectedApps
1089
+ );
1090
+ });
1091
+ });
1092
+
1093
+ describe('#LocusDeltaEvents', () => {
1094
+ const fakeMeeting = 'fakeMeeting';
1095
+ let sandbox = null;
1096
+ let locusParser = null;
1097
+ let fakeLocus = null;
1098
+
1099
+ beforeEach(() => {
1100
+ locusParser = locusInfo.locusParser;
1101
+ sandbox = sinon.createSandbox();
1102
+
1103
+ fakeLocus = {
1104
+ meeting: true,
1105
+ participants: true,
1106
+ };
1107
+ });
1108
+
1109
+ afterEach(() => {
1110
+ sandbox.restore();
1111
+ sandbox = null;
1112
+ });
1113
+
1114
+ it('handles locus delta events', () => {
1115
+ sandbox.stub(locusInfo, 'handleLocusDelta');
1116
+
1117
+ const data = {
1118
+ eventType: LOCUSEVENT.DIFFERENCE,
1119
+ locus: fakeLocus,
1120
+ };
1121
+
1122
+ locusInfo.parse(fakeMeeting, data);
1123
+
1124
+ assert.calledWith(locusInfo.handleLocusDelta, fakeLocus, fakeMeeting);
1125
+ });
1126
+
1127
+ it('should queue delta event with internal locus parser', () => {
1128
+ sandbox.stub(locusParser, 'onDeltaEvent');
1129
+
1130
+ const data = {
1131
+ eventType: LOCUSEVENT.DIFFERENCE,
1132
+ locus: fakeLocus,
1133
+ };
1134
+
1135
+ locusInfo.parse(fakeMeeting, data);
1136
+
1137
+ // queues locus delta event
1138
+ assert.calledWith(locusParser.onDeltaEvent, fakeLocus);
1139
+ });
1140
+
1141
+ it('should assign a function to onDeltaAction', () => {
1142
+ sandbox.stub(locusParser, 'onDeltaEvent');
1143
+ assert.isNull(locusParser.onDeltaAction);
1144
+
1145
+ locusInfo.handleLocusDelta(fakeLocus, fakeMeeting);
1146
+
1147
+ assert.isFunction(locusParser.onDeltaAction);
1148
+ });
1149
+
1150
+ it('onFullLocus() updates the working-copy of locus parser', () => {
1151
+ const eventType = 'fakeEvent';
1152
+
1153
+ sandbox.stub(locusInfo, 'updateParticipantDeltas');
1154
+ sandbox.stub(locusInfo, 'updateLocusInfo');
1155
+ sandbox.stub(locusInfo, 'updateParticipants');
1156
+ sandbox.stub(locusInfo, 'isMeetingActive');
1157
+ sandbox.stub(locusInfo, 'handleOneOnOneEvent');
1158
+
1159
+ locusInfo.onFullLocus(fakeLocus, eventType);
1160
+
1161
+ assert.equal(fakeLocus, locusParser.workingCopy);
1162
+ });
1163
+
1164
+ it('onDeltaAction applies locus delta data to meeting', () => {
1165
+ const action = 'fake action';
1166
+ const parsedLoci = 'fake loci';
1167
+
1168
+ sandbox.stub(locusParser, 'onDeltaEvent');
1169
+ locusInfo.handleLocusDelta(fakeLocus, fakeMeeting);
1170
+ sandbox.spy(locusInfo, 'applyLocusDeltaData');
1171
+
1172
+ locusParser.onDeltaAction(action, parsedLoci);
1173
+
1174
+ assert.calledWith(locusInfo.applyLocusDeltaData, action, parsedLoci, fakeMeeting);
1175
+ });
1176
+
1177
+ it('applyLocusDeltaData handles USE_INCOMING action correctly', () => {
1178
+ const {USE_INCOMING} = LocusDeltaParser.loci;
1179
+ const meeting = {
1180
+ locusInfo: {
1181
+ onDeltaLocus: sandbox.stub(),
1182
+ },
1183
+ };
1184
+
1185
+ locusInfo.applyLocusDeltaData(USE_INCOMING, fakeLocus, meeting);
1186
+
1187
+ assert.calledWith(meeting.locusInfo.onDeltaLocus, fakeLocus);
1188
+ });
1189
+
1190
+ it('applyLocusDeltaData gets full locus on DESYNC action', () => {
1191
+ const {DESYNC} = LocusDeltaParser.loci;
1192
+ const meeting = {
1193
+ meetingRequest: {
1194
+ getFullLocus: sandbox.stub().resolves(true),
1195
+ },
1196
+ locusInfo: {
1197
+ onFullLocus: sandbox.stub(),
1198
+ },
1199
+ };
1200
+
1201
+ locusInfo.locusParser.resume = sandbox.stub();
1202
+ locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
1203
+
1204
+ assert.calledOnce(meeting.meetingRequest.getFullLocus);
1205
+ });
1206
+
1207
+ it('getFullLocus handles DESYNC action correctly', () => {
1208
+ const {DESYNC} = LocusDeltaParser.loci;
1209
+ const meeting = {
1210
+ meetingRequest: {
1211
+ getFullLocus: sandbox.stub().resolves({body: true}),
1212
+ },
1213
+ locusInfo,
1214
+ };
1215
+
1216
+ locusInfo.onFullLocus = sandbox.stub();
1217
+
1218
+ // Since we have a promise inside a function we want to test that's not returned,
1219
+ // we will wait and stub it's last function to resolve this waiting promise.
1220
+ // Also ensures .onFullLocus() is called before .resume()
1221
+ return new Promise((resolve) => {
1222
+ locusInfo.locusParser.resume = sandbox.stub().callsFake(() => resolve());
1223
+ locusInfo.applyLocusDeltaData(DESYNC, fakeLocus, meeting);
1224
+ }).then(() => {
1225
+ assert.calledOnce(meeting.locusInfo.onFullLocus);
1226
+ assert.calledOnce(locusInfo.locusParser.resume);
1227
+ });
1228
+ });
1229
+ });
1230
+
1231
+ describe('#handleOneonOneEvent', () => {
1232
+ beforeEach(() => {
1233
+ locusInfo.emitScoped = sinon.stub();
1234
+ });
1235
+ it('emits `REMOTE_RESPONSE`', () => {
1236
+ // 'locus.participant_joined'
1237
+
1238
+ locusInfo.parsedLocus.fullState.type = 'SIP_BRIDGE';
1239
+ locusInfo.handleOneOnOneEvent('locus.participant_declined');
1240
+
1241
+ assert.calledWith(
1242
+ locusInfo.emitScoped,
1243
+ {
1244
+ file: 'locus-info',
1245
+ function: 'handleOneonOneEvent',
1246
+ },
1247
+ 'REMOTE_RESPONSE',
1248
+ {
1249
+ remoteDeclined: true,
1250
+ remoteAnswered: false,
1251
+ }
1252
+ );
1253
+
1254
+ locusInfo.parsedLocus.fullState.type = 'SIP_BRIDGE';
1255
+ locusInfo.handleOneOnOneEvent('locus.participant_joined');
1256
+
1257
+ assert.calledWith(
1258
+ locusInfo.emitScoped,
1259
+ {
1260
+ file: 'locus-info',
1261
+ function: 'handleOneonOneEvent',
1262
+ },
1263
+ 'REMOTE_RESPONSE',
1264
+ {
1265
+ remoteDeclined: false,
1266
+ remoteAnswered: true,
1267
+ }
1268
+ );
1269
+ });
1270
+ });
1271
+ });
1272
+ });