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

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 (420) 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 +2 -2
  72. package/dist/config.js.map +1 -1
  73. package/dist/constants.d.ts +926 -924
  74. package/dist/constants.js +11 -9
  75. package/dist/constants.js.map +1 -1
  76. package/dist/controls-options-manager/constants.d.ts +4 -4
  77. package/dist/controls-options-manager/constants.js.map +1 -1
  78. package/dist/controls-options-manager/enums.d.ts +5 -5
  79. package/dist/controls-options-manager/enums.js.map +1 -1
  80. package/dist/controls-options-manager/index.d.ts +120 -120
  81. package/dist/controls-options-manager/index.js +81 -81
  82. package/dist/controls-options-manager/index.js.map +1 -1
  83. package/dist/controls-options-manager/util.d.ts +7 -7
  84. package/dist/controls-options-manager/util.js.map +1 -1
  85. package/dist/index.d.ts +4 -4
  86. package/dist/index.js.map +1 -1
  87. package/dist/locus-info/controlsUtils.d.ts +2 -2
  88. package/dist/locus-info/controlsUtils.js +21 -21
  89. package/dist/locus-info/controlsUtils.js.map +1 -1
  90. package/dist/locus-info/embeddedAppsUtils.d.ts +2 -2
  91. package/dist/locus-info/embeddedAppsUtils.js +14 -14
  92. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  93. package/dist/locus-info/fullState.d.ts +2 -2
  94. package/dist/locus-info/fullState.js.map +1 -1
  95. package/dist/locus-info/hostUtils.d.ts +2 -2
  96. package/dist/locus-info/hostUtils.js +19 -19
  97. package/dist/locus-info/hostUtils.js.map +1 -1
  98. package/dist/locus-info/index.d.ts +269 -269
  99. package/dist/locus-info/index.js +180 -180
  100. package/dist/locus-info/index.js.map +1 -1
  101. package/dist/locus-info/infoUtils.d.ts +2 -2
  102. package/dist/locus-info/infoUtils.js.map +1 -1
  103. package/dist/locus-info/mediaSharesUtils.d.ts +2 -2
  104. package/dist/locus-info/mediaSharesUtils.js +50 -50
  105. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  106. package/dist/locus-info/parser.d.ts +212 -212
  107. package/dist/locus-info/parser.js +136 -136
  108. package/dist/locus-info/parser.js.map +1 -1
  109. package/dist/locus-info/selfUtils.d.ts +2 -2
  110. package/dist/locus-info/selfUtils.js +52 -52
  111. package/dist/locus-info/selfUtils.js.map +1 -1
  112. package/dist/media/index.d.ts +32 -32
  113. package/dist/media/index.js +145 -145
  114. package/dist/media/index.js.map +1 -1
  115. package/dist/media/properties.d.ts +108 -108
  116. package/dist/media/properties.js +49 -49
  117. package/dist/media/properties.js.map +1 -1
  118. package/dist/media/util.d.ts +2 -2
  119. package/dist/media/util.js.map +1 -1
  120. package/dist/mediaQualityMetrics/config.d.ts +233 -233
  121. package/dist/mediaQualityMetrics/config.js.map +1 -1
  122. package/dist/meeting/effectsState.d.ts +42 -42
  123. package/dist/meeting/effectsState.js +24 -24
  124. package/dist/meeting/effectsState.js.map +1 -1
  125. package/dist/meeting/in-meeting-actions.d.ts +79 -79
  126. package/dist/meeting/in-meeting-actions.js +11 -11
  127. package/dist/meeting/in-meeting-actions.js.map +1 -1
  128. package/dist/meeting/index.d.ts +1621 -1621
  129. package/dist/meeting/index.js +1538 -1518
  130. package/dist/meeting/index.js.map +1 -1
  131. package/dist/meeting/muteState.d.ts +116 -116
  132. package/dist/meeting/muteState.js +85 -85
  133. package/dist/meeting/muteState.js.map +1 -1
  134. package/dist/meeting/request.d.ts +255 -255
  135. package/dist/meeting/request.js +141 -141
  136. package/dist/meeting/request.js.map +1 -1
  137. package/dist/meeting/state.d.ts +9 -9
  138. package/dist/meeting/state.js +30 -30
  139. package/dist/meeting/state.js.map +1 -1
  140. package/dist/meeting/util.d.ts +2 -2
  141. package/dist/meeting/util.js.map +1 -1
  142. package/dist/meeting-info/collection.d.ts +20 -20
  143. package/dist/meeting-info/collection.js +11 -11
  144. package/dist/meeting-info/collection.js.map +1 -1
  145. package/dist/meeting-info/index.d.ts +57 -57
  146. package/dist/meeting-info/index.js +50 -50
  147. package/dist/meeting-info/index.js.map +1 -1
  148. package/dist/meeting-info/meeting-info-v2.d.ts +93 -93
  149. package/dist/meeting-info/meeting-info-v2.js +52 -52
  150. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  151. package/dist/meeting-info/request.d.ts +22 -22
  152. package/dist/meeting-info/request.js +14 -14
  153. package/dist/meeting-info/request.js.map +1 -1
  154. package/dist/meeting-info/util.d.ts +2 -2
  155. package/dist/meeting-info/util.js +9 -9
  156. package/dist/meeting-info/util.js.map +1 -1
  157. package/dist/meeting-info/utilv2.d.ts +2 -2
  158. package/dist/meeting-info/utilv2.js +20 -20
  159. package/dist/meeting-info/utilv2.js.map +1 -1
  160. package/dist/meetings/collection.d.ts +23 -23
  161. package/dist/meetings/collection.js +14 -14
  162. package/dist/meetings/collection.js.map +1 -1
  163. package/dist/meetings/index.d.ts +296 -296
  164. package/dist/meetings/index.js +259 -259
  165. package/dist/meetings/index.js.map +1 -1
  166. package/dist/meetings/request.d.ts +27 -27
  167. package/dist/meetings/request.js +15 -15
  168. package/dist/meetings/request.js.map +1 -1
  169. package/dist/meetings/util.d.ts +18 -18
  170. package/dist/meetings/util.js +29 -29
  171. package/dist/meetings/util.js.map +1 -1
  172. package/dist/member/index.d.ts +147 -147
  173. package/dist/member/index.js +214 -214
  174. package/dist/member/index.js.map +1 -1
  175. package/dist/member/member.types.d.ts +11 -11
  176. package/dist/member/member.types.js.map +1 -1
  177. package/dist/member/util.d.ts +2 -2
  178. package/dist/member/util.js +60 -60
  179. package/dist/member/util.js.map +1 -1
  180. package/dist/members/collection.d.ts +24 -24
  181. package/dist/members/collection.js +11 -11
  182. package/dist/members/collection.js.map +1 -1
  183. package/dist/members/index.d.ts +298 -298
  184. package/dist/members/index.js +275 -275
  185. package/dist/members/index.js.map +1 -1
  186. package/dist/members/request.d.ts +50 -50
  187. package/dist/members/request.js +27 -27
  188. package/dist/members/request.js.map +1 -1
  189. package/dist/members/util.d.ts +2 -2
  190. package/dist/members/util.js +21 -21
  191. package/dist/members/util.js.map +1 -1
  192. package/dist/metrics/config.d.ts +169 -169
  193. package/dist/metrics/config.js.map +1 -1
  194. package/dist/metrics/constants.d.ts +59 -57
  195. package/dist/metrics/constants.js +2 -0
  196. package/dist/metrics/constants.js.map +1 -1
  197. package/dist/metrics/index.d.ts +152 -152
  198. package/dist/metrics/index.js +90 -90
  199. package/dist/metrics/index.js.map +1 -1
  200. package/dist/networkQualityMonitor/index.d.ts +70 -70
  201. package/dist/networkQualityMonitor/index.js +65 -65
  202. package/dist/networkQualityMonitor/index.js.map +1 -1
  203. package/dist/peer-connection-manager/index.d.ts +6 -6
  204. package/dist/peer-connection-manager/index.js +87 -87
  205. package/dist/peer-connection-manager/index.js.map +1 -1
  206. package/dist/peer-connection-manager/util.d.ts +6 -6
  207. package/dist/peer-connection-manager/util.js +9 -9
  208. package/dist/peer-connection-manager/util.js.map +1 -1
  209. package/dist/personal-meeting-room/index.d.ts +47 -47
  210. package/dist/personal-meeting-room/index.js +67 -67
  211. package/dist/personal-meeting-room/index.js.map +1 -1
  212. package/dist/personal-meeting-room/request.d.ts +14 -14
  213. package/dist/personal-meeting-room/request.js +7 -7
  214. package/dist/personal-meeting-room/request.js.map +1 -1
  215. package/dist/personal-meeting-room/util.d.ts +2 -2
  216. package/dist/personal-meeting-room/util.js.map +1 -1
  217. package/dist/reachability/index.d.ts +139 -139
  218. package/dist/reachability/index.js +110 -110
  219. package/dist/reachability/index.js.map +1 -1
  220. package/dist/reachability/request.d.ts +35 -35
  221. package/dist/reachability/request.js +15 -15
  222. package/dist/reachability/request.js.map +1 -1
  223. package/dist/reactions/reactions.d.ts +4 -4
  224. package/dist/reactions/reactions.js.map +1 -1
  225. package/dist/reactions/reactions.type.d.ts +32 -32
  226. package/dist/reactions/reactions.type.js.map +1 -1
  227. package/dist/reconnection-manager/index.d.ts +112 -112
  228. package/dist/reconnection-manager/index.js +112 -112
  229. package/dist/reconnection-manager/index.js.map +1 -1
  230. package/dist/recording-controller/enums.d.ts +7 -7
  231. package/dist/recording-controller/enums.js.map +1 -1
  232. package/dist/recording-controller/index.d.ts +193 -193
  233. package/dist/recording-controller/index.js +127 -127
  234. package/dist/recording-controller/index.js.map +1 -1
  235. package/dist/recording-controller/util.d.ts +13 -13
  236. package/dist/recording-controller/util.js.map +1 -1
  237. package/dist/roap/collection.d.ts +10 -10
  238. package/dist/roap/collection.js.map +1 -1
  239. package/dist/roap/handler.d.ts +47 -47
  240. package/dist/roap/handler.js +27 -27
  241. package/dist/roap/handler.js.map +1 -1
  242. package/dist/roap/index.d.ts +116 -116
  243. package/dist/roap/index.js +111 -111
  244. package/dist/roap/index.js.map +1 -1
  245. package/dist/roap/request.d.ts +35 -35
  246. package/dist/roap/request.js +17 -17
  247. package/dist/roap/request.js.map +1 -1
  248. package/dist/roap/state.d.ts +9 -9
  249. package/dist/roap/state.js +14 -14
  250. package/dist/roap/state.js.map +1 -1
  251. package/dist/roap/turnDiscovery.d.ts +67 -67
  252. package/dist/roap/turnDiscovery.js +46 -46
  253. package/dist/roap/turnDiscovery.js.map +1 -1
  254. package/dist/roap/util.d.ts +2 -2
  255. package/dist/roap/util.js.map +1 -1
  256. package/dist/statsAnalyzer/global.d.ts +118 -126
  257. package/dist/statsAnalyzer/global.js +4 -12
  258. package/dist/statsAnalyzer/global.js.map +1 -1
  259. package/dist/statsAnalyzer/index.d.ts +193 -190
  260. package/dist/statsAnalyzer/index.js +182 -140
  261. package/dist/statsAnalyzer/index.js.map +1 -1
  262. package/dist/statsAnalyzer/mqaUtil.d.ts +22 -22
  263. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  264. package/dist/transcription/index.d.ts +64 -64
  265. package/dist/transcription/index.js +42 -42
  266. package/dist/transcription/index.js.map +1 -1
  267. package/internal-README.md +172 -172
  268. package/jest.config.js +3 -3
  269. package/package.json +21 -22
  270. package/process +1 -1
  271. package/src/common/browser-detection.ts +39 -39
  272. package/src/common/collection.ts +94 -94
  273. package/src/common/config.ts +9 -9
  274. package/src/common/errors/captcha-error.ts +25 -25
  275. package/src/common/errors/intent-to-join.ts +27 -27
  276. package/src/common/errors/join-meeting.ts +32 -32
  277. package/src/common/errors/media.ts +25 -25
  278. package/src/common/errors/parameter.ts +33 -33
  279. package/src/common/errors/password-error.ts +25 -25
  280. package/src/common/errors/permission.ts +24 -24
  281. package/src/common/errors/reconnection-in-progress.ts +8 -8
  282. package/src/common/errors/reconnection.ts +25 -25
  283. package/src/common/errors/stats.ts +25 -25
  284. package/src/common/errors/webex-errors.ts +140 -140
  285. package/src/common/errors/webex-meetings-error.ts +35 -35
  286. package/src/common/events/events-scope.ts +30 -30
  287. package/src/common/events/events.ts +25 -25
  288. package/src/common/events/trigger-proxy.ts +25 -25
  289. package/src/common/events/util.ts +39 -39
  290. package/src/common/logs/logger-config.ts +8 -8
  291. package/src/common/logs/logger-proxy.ts +44 -44
  292. package/src/common/logs/request.ts +65 -65
  293. package/src/common/queue.ts +50 -50
  294. package/src/config.ts +96 -96
  295. package/src/constants.ts +1123 -1121
  296. package/src/controls-options-manager/constants.ts +5 -5
  297. package/src/controls-options-manager/enums.ts +6 -6
  298. package/src/controls-options-manager/index.ts +183 -183
  299. package/src/controls-options-manager/util.ts +20 -20
  300. package/src/index.js +15 -15
  301. package/src/locus-info/controlsUtils.ts +112 -112
  302. package/src/locus-info/embeddedAppsUtils.ts +57 -57
  303. package/src/locus-info/fullState.ts +69 -69
  304. package/src/locus-info/hostUtils.ts +60 -60
  305. package/src/locus-info/index.ts +1303 -1303
  306. package/src/locus-info/infoUtils.ts +101 -101
  307. package/src/locus-info/mediaSharesUtils.ts +173 -173
  308. package/src/locus-info/parser.ts +680 -680
  309. package/src/locus-info/selfUtils.ts +428 -428
  310. package/src/media/index.ts +675 -675
  311. package/src/media/properties.ts +313 -313
  312. package/src/media/util.ts +37 -37
  313. package/src/mediaQualityMetrics/config.ts +382 -382
  314. package/src/meeting/effectsState.ts +209 -209
  315. package/src/meeting/in-meeting-actions.ts +153 -153
  316. package/src/meeting/index.ts +6572 -6537
  317. package/src/meeting/muteState.ts +365 -365
  318. package/src/meeting/request.ts +810 -810
  319. package/src/meeting/state.ts +194 -194
  320. package/src/meeting/util.ts +530 -530
  321. package/src/meeting-info/collection.ts +41 -41
  322. package/src/meeting-info/index.ts +137 -137
  323. package/src/meeting-info/meeting-info-v2.ts +273 -273
  324. package/src/meeting-info/request.ts +46 -46
  325. package/src/meeting-info/util.ts +314 -314
  326. package/src/meeting-info/utilv2.ts +324 -324
  327. package/src/meetings/collection.ts +43 -43
  328. package/src/meetings/index.ts +1128 -1128
  329. package/src/meetings/request.ts +81 -81
  330. package/src/meetings/util.ts +181 -181
  331. package/src/member/index.ts +446 -446
  332. package/src/member/member.types.ts +13 -13
  333. package/src/member/util.ts +286 -286
  334. package/src/members/collection.ts +40 -40
  335. package/src/members/index.ts +900 -900
  336. package/src/members/request.ts +175 -175
  337. package/src/members/util.ts +260 -260
  338. package/src/metrics/config.ts +485 -485
  339. package/src/metrics/constants.ts +63 -61
  340. package/src/metrics/index.ts +543 -543
  341. package/src/networkQualityMonitor/index.ts +211 -211
  342. package/src/peer-connection-manager/index.ts +847 -847
  343. package/src/peer-connection-manager/util.ts +119 -119
  344. package/src/personal-meeting-room/index.ts +157 -157
  345. package/src/personal-meeting-room/request.ts +48 -48
  346. package/src/personal-meeting-room/util.ts +49 -49
  347. package/src/reachability/index.ts +478 -478
  348. package/src/reachability/request.ts +81 -81
  349. package/src/reactions/reactions.ts +104 -104
  350. package/src/reactions/reactions.type.ts +36 -36
  351. package/src/reconnection-manager/index.ts +622 -622
  352. package/src/recording-controller/enums.ts +8 -8
  353. package/src/recording-controller/index.ts +315 -315
  354. package/src/recording-controller/util.ts +58 -58
  355. package/src/roap/collection.ts +62 -62
  356. package/src/roap/handler.ts +294 -294
  357. package/src/roap/index.ts +413 -413
  358. package/src/roap/request.ts +229 -229
  359. package/src/roap/state.ts +156 -156
  360. package/src/roap/turnDiscovery.ts +283 -283
  361. package/src/roap/util.ts +100 -100
  362. package/src/statsAnalyzer/global.ts +120 -128
  363. package/src/statsAnalyzer/index.ts +1329 -1266
  364. package/src/statsAnalyzer/mqaUtil.ts +290 -290
  365. package/src/transcription/index.ts +154 -154
  366. package/test/integration/spec/journey.js +941 -941
  367. package/test/integration/spec/space-meeting.js +457 -457
  368. package/test/integration/spec/transcription.js +55 -55
  369. package/test/unit/spec/common/browser-detection.js +119 -119
  370. package/test/unit/spec/common/queue.js +69 -69
  371. package/test/unit/spec/controls-options-manager/index.js +123 -123
  372. package/test/unit/spec/controls-options-manager/util.js +65 -65
  373. package/test/unit/spec/fixture/locus.js +406 -406
  374. package/test/unit/spec/locus-info/controlsUtils.js +82 -82
  375. package/test/unit/spec/locus-info/embeddedAppsUtils.js +104 -104
  376. package/test/unit/spec/locus-info/index.js +1272 -1272
  377. package/test/unit/spec/locus-info/infoUtils.js +138 -138
  378. package/test/unit/spec/locus-info/lib/BasicSeqCmp.json +975 -975
  379. package/test/unit/spec/locus-info/lib/SeqCmp.json +522 -522
  380. package/test/unit/spec/locus-info/lib/selfConstant.js +286 -286
  381. package/test/unit/spec/locus-info/parser.js +298 -298
  382. package/test/unit/spec/locus-info/selfUtils.js +185 -185
  383. package/test/unit/spec/media/properties.ts +305 -305
  384. package/test/unit/spec/meeting/effectsState.js +281 -281
  385. package/test/unit/spec/meeting/in-meeting-actions.ts +90 -90
  386. package/test/unit/spec/meeting/index.js +5298 -5227
  387. package/test/unit/spec/meeting/muteState.js +430 -430
  388. package/test/unit/spec/meeting/request.js +317 -317
  389. package/test/unit/spec/meeting/utils.js +319 -319
  390. package/test/unit/spec/meeting-info/meetinginfov2.js +376 -376
  391. package/test/unit/spec/meeting-info/request.js +64 -64
  392. package/test/unit/spec/meeting-info/util.js +37 -37
  393. package/test/unit/spec/meeting-info/utilv2.js +330 -330
  394. package/test/unit/spec/meetings/collection.js +52 -52
  395. package/test/unit/spec/meetings/index.js +1375 -1375
  396. package/test/unit/spec/meetings/utils.js +66 -66
  397. package/test/unit/spec/member/index.js +47 -47
  398. package/test/unit/spec/member/util.js +80 -80
  399. package/test/unit/spec/members/index.js +364 -364
  400. package/test/unit/spec/members/request.js +200 -200
  401. package/test/unit/spec/members/utils.js +42 -42
  402. package/test/unit/spec/metrics/index.js +111 -111
  403. package/test/unit/spec/networkQualityMonitor/index.js +99 -99
  404. package/test/unit/spec/peerconnection-manager/index.js +218 -218
  405. package/test/unit/spec/peerconnection-manager/utils.js +49 -49
  406. package/test/unit/spec/peerconnection-manager/utils.test-fixtures.ts +388 -388
  407. package/test/unit/spec/personal-meeting-room/personal-meeting-room.js +29 -29
  408. package/test/unit/spec/reachability/index.ts +50 -50
  409. package/test/unit/spec/reconnection-manager/index.js +206 -206
  410. package/test/unit/spec/recording-controller/index.js +230 -230
  411. package/test/unit/spec/recording-controller/util.js +101 -101
  412. package/test/unit/spec/roap/index.ts +128 -128
  413. package/test/unit/spec/roap/turnDiscovery.ts +372 -372
  414. package/test/unit/spec/roap/util.js +30 -30
  415. package/test/unit/spec/stats-analyzer/index.js +438 -287
  416. package/test/utils/cmr.js +104 -104
  417. package/test/utils/testUtils.js +287 -287
  418. package/test/utils/webex-config.js +77 -77
  419. package/test/utils/webex-test-users.js +82 -82
  420. package/tsconfig.json +5 -5
@@ -1,622 +1,622 @@
1
- /*!
2
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
3
- */
4
-
5
- /* eslint-disable no-warning-comments */
6
-
7
- import LoggerProxy from '../common/logs/logger-proxy';
8
- import Trigger from '../common/events/trigger-proxy';
9
- import {
10
- EVENT_TRIGGERS,
11
- RECONNECTION,
12
- SHARE_STATUS,
13
- SHARE_STOPPED_REASON,
14
- _CALL_,
15
- _LEFT_,
16
- _ID_,
17
- } from '../constants';
18
- import BEHAVIORAL_METRICS from '../metrics/constants';
19
- import ReconnectionError from '../common/errors/reconnection';
20
- import ReconnectInProgress from '../common/errors/reconnection-in-progress';
21
- import PeerConnectionManager from '../peer-connection-manager';
22
- import {eventType, reconnection, errorObjects} from '../metrics/config';
23
- import Media from '../media';
24
- import Metrics from '../metrics';
25
- import RoapCollection from '../roap/collection';
26
- import Meeting from '../meeting';
27
-
28
- /**
29
- * Used to indicate that the reconnect logic needs to be retried.
30
- *
31
- * @class NeedsRetryError
32
- * @extends {Error}
33
- */
34
- class NeedsRetryError extends Error {}
35
-
36
- /**
37
- * Used to indicate that the meeting needs to be rejoined, not just media reconnected
38
- *
39
- * @class NeedsRejoinError
40
- * @extends {Error}
41
- */
42
- class NeedsRejoinError extends Error {
43
- wasSharing: any;
44
-
45
- /**
46
- * Creates an instance of NeedsRejoinError.
47
- * @param {Object} params
48
- * @param {boolean} params.wasSharing
49
- * @param {Error} params.error
50
- * @memberof NeedsRejoinError
51
- */
52
- constructor({
53
- wasSharing,
54
- error = new Error('Meeting needs to be rejoined'),
55
- }: {
56
- wasSharing?: boolean;
57
- error?: Error;
58
- }) {
59
- // @ts-ignore
60
- super(error);
61
-
62
- this.wasSharing = wasSharing;
63
- }
64
- }
65
-
66
- /**
67
- * @export
68
- * @class ReconnectionManager
69
- */
70
- export default class ReconnectionManager {
71
- autoRejoinEnabled: any;
72
- iceState: any;
73
- maxRejoinAttempts: any;
74
- meeting: any;
75
- rejoinAttempts: any;
76
- shareStatus: any;
77
- status: any;
78
- tryCount: any;
79
- webex: any;
80
- /**
81
- * @param {Meeting} meeting
82
- */
83
- constructor(meeting: Meeting) {
84
- /**
85
- * Stores ICE reconnection state data.
86
- *
87
- * @instance
88
- * @type {Object}
89
- * @private
90
- * @memberof ReconnectionManager
91
- */
92
- this.iceState = {
93
- disconnected: false,
94
- resolve: () => {},
95
- timer: undefined,
96
- // @ts-ignore
97
- timeoutDuration: meeting.config.reconnection.iceReconnectionTimeout,
98
- };
99
-
100
- /**
101
- * @instance
102
- * @type {String}
103
- * @private
104
- * @memberof ReconnectionManager
105
- */
106
- this.status = RECONNECTION.STATE.DEFAULT_STATUS;
107
- /**
108
- * @instance
109
- * @type {Number}
110
- * @private
111
- * @memberof ReconnectionManager
112
- */
113
- this.tryCount = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
114
- /**
115
- * @instance
116
- * @type {Object}
117
- * @private
118
- * @memberof ReconnectionManager
119
- */
120
- // TODO : change this logic to not save the meeting instance
121
- // It gets complicated when meeting ends on remote side , We have a old meeting instance which is not up to date
122
- // @ts-ignore
123
- this.webex = meeting.webex;
124
- /**
125
- * @instance
126
- * @type {Meeting}
127
- * @private
128
- * @memberof ReconnectionManager
129
- */
130
- // TODO: try removing the circular dependency for meeting and reconnection manager
131
- // try moving this to meetings collection
132
- this.meeting = meeting;
133
-
134
- // @ts-ignore
135
- this.maxRejoinAttempts = meeting.config.reconnection.maxRejoinAttempts;
136
- this.rejoinAttempts = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
137
- // @ts-ignore
138
- this.autoRejoinEnabled = meeting.config.reconnection.autoRejoin;
139
-
140
- // Make sure reconnection state is in default
141
- this.reset();
142
- }
143
-
144
- /**
145
- * Sets the iceState to connected and clears any disconnect timeouts and
146
- * related timeout data within the iceState.
147
- *
148
- * @returns {undefined}
149
- * @public
150
- * @memberof ReconnectionManager
151
- */
152
- public iceReconnected() {
153
- if (this.iceState.disconnected) {
154
- LoggerProxy.logger.log('ReconnectionManager:index#iceReconnected --> ice has reconnected');
155
-
156
- this.iceState.resolve();
157
- this.iceState.resolve = () => {};
158
-
159
- if (this.iceState.timer) {
160
- clearTimeout(this.iceState.timer);
161
- delete this.iceState.timer;
162
- }
163
-
164
- this.iceState.disconnected = false;
165
- }
166
- }
167
-
168
- /**
169
- * Set the iceState to disconnected and generates a timeout that waits for the
170
- * iceState to reconnect and then resolves. If the ice state is already
171
- * processing a reconnect, it immediately resolves. Rejects if the timeout
172
- * duration is reached.
173
- *
174
- * @returns {Promise<undefined>}
175
- * @public
176
- * @memberof ReconnectionManager
177
- */
178
- public waitForIceReconnect() {
179
- if (!this.iceState.disconnected) {
180
- LoggerProxy.logger.log(
181
- 'ReconnectionManager:index#waitForIceReconnect --> waiting for ice reconnect'
182
- );
183
-
184
- this.iceState.disconnected = true;
185
-
186
- return new Promise<void>((resolve, reject) => {
187
- this.iceState.timer = setTimeout(() => {
188
- if (this.iceState.disconnected === false) {
189
- resolve();
190
- } else {
191
- this.iceState.disconnected = false;
192
- reject(
193
- new Error(`ice reconnection did not occur in ${this.iceState.timeoutDuration}ms`)
194
- );
195
- }
196
- }, this.iceState.timeoutDuration);
197
-
198
- this.iceState.resolve = resolve;
199
- });
200
- }
201
-
202
- // return a resolved promise to prevent multiple catch executions of reconnect
203
- return Promise.resolve();
204
- }
205
-
206
- /**
207
- * @returns {undefined}
208
- * @public
209
- * @memberof ReconnectionManager
210
- */
211
- public reset() {
212
- this.status = RECONNECTION.STATE.DEFAULT_STATUS;
213
- this.tryCount = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
214
- this.rejoinAttempts = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
215
- }
216
-
217
- /**
218
- * @returns {undefined}
219
- * @public
220
- * @memberof ReconnectionManager
221
- */
222
- public cleanUp() {
223
- this.reset();
224
- this.meeting = null;
225
- }
226
-
227
- /**
228
- * @returns {Boolean}
229
- * @throws {ReconnectionError}
230
- * @private
231
- * @memberof ReconnectionManager
232
- */
233
- private validate() {
234
- if (this.meeting.config.reconnection.enabled) {
235
- if (
236
- this.status === RECONNECTION.STATE.DEFAULT_STATUS ||
237
- this.status === RECONNECTION.STATE.COMPLETE
238
- ) {
239
- return true;
240
- }
241
-
242
- LoggerProxy.logger.info(
243
- 'ReconnectionManager:index#validate --> Reconnection already in progress.'
244
- );
245
-
246
- throw new ReconnectInProgress('Reconnection already in progress.');
247
- }
248
-
249
- LoggerProxy.logger.info('ReconnectionManager:index#validate --> Reconnection is not enabled.');
250
-
251
- throw new ReconnectionError('Reconnection is not enabled.');
252
- }
253
-
254
- /**
255
- * Initiates a media reconnect for the active meeting
256
- * @param {Object} reconnectOptions
257
- * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
258
- * @param {boolean} [reconnectOptions.networkRetry=false] indicates if we are retrying the reconnect
259
- * @returns {Promise}
260
- * @public
261
- * @memberof ReconnectionManager
262
- */
263
- public async reconnect({
264
- networkDisconnect = false,
265
- networkRetry = false,
266
- }: {
267
- networkDisconnect?: boolean;
268
- networkRetry?: boolean;
269
- } = {}) {
270
- LoggerProxy.logger.info(
271
- `ReconnectionManager:index#reconnect --> Reconnection start for meeting ${this.meeting.id}.`
272
- );
273
- // First, validate that we can reconnect, if not, it will throw an error
274
- try {
275
- this.validate();
276
- } catch (error) {
277
- LoggerProxy.logger.info(
278
- 'ReconnectionManager:index#reconnect --> Reconnection unable to begin.',
279
- error
280
- );
281
- throw error;
282
- }
283
-
284
- if (!networkRetry) {
285
- // Only log START metrics on the initial reconnect
286
- LoggerProxy.logger.info(
287
- 'ReconnectionManager:index#reconnect --> Sending reconnect start metric.'
288
- );
289
- Metrics.postEvent({
290
- event: eventType.MEDIA_RECONNECTING,
291
- meeting: this.meeting,
292
- });
293
- }
294
-
295
- return this.executeReconnection({networkDisconnect})
296
- .then(() => {
297
- LoggerProxy.logger.info('ReconnectionManager:index#reconnect --> Reconnection successful.');
298
- LoggerProxy.logger.info(
299
- 'ReconnectionManager:index#reconnect --> Sending reconnect success metric.'
300
- );
301
- Metrics.postEvent({
302
- event: eventType.MEDIA_RECOVERED,
303
- meeting: this.meeting,
304
- data: {recoveredBy: reconnection.RECOVERED_BY_NEW},
305
- });
306
- })
307
- .catch((reconnectError) => {
308
- if (reconnectError instanceof NeedsRetryError) {
309
- LoggerProxy.logger.info(
310
- 'ReconnectionManager:index#reconnect --> Reconnection not successful, retrying.'
311
- );
312
- // Reset our reconnect status since we are looping back to the beginning
313
- this.status = RECONNECTION.STATE.DEFAULT_STATUS;
314
-
315
- // This is a network retry, so we should not log START metrics again
316
- return this.reconnect({networkDisconnect: true, networkRetry: true});
317
- }
318
-
319
- // Reconnect has failed
320
- LoggerProxy.logger.error(
321
- 'ReconnectionManager:index#reconnect --> Reconnection failed.',
322
- reconnectError.message
323
- );
324
- LoggerProxy.logger.info(
325
- 'ReconnectionManager:index#reconnect --> Sending reconnect abort metric.'
326
- );
327
-
328
- const reconnectMetric = {
329
- event: eventType.CALL_ABORTED,
330
- meeting: this.meeting,
331
- data: {
332
- errors: [
333
- {
334
- category: errorObjects.category.expected,
335
- errorCode: 2008,
336
- fatal: true,
337
- name: errorObjects.name.mediaEngine,
338
- shownToUser: false,
339
- },
340
- ],
341
- },
342
- };
343
-
344
- Metrics.postEvent(reconnectMetric);
345
- if (reconnectError instanceof NeedsRejoinError) {
346
- // send call aborded event with catogery as expected as we are trying to rejoin
347
-
348
- if (this.autoRejoinEnabled) {
349
- return this.rejoinMeeting(reconnectError.wasSharing);
350
- }
351
- }
352
-
353
- throw reconnectError;
354
- });
355
- }
356
-
357
- /**
358
- * @param {Object} reconnectOptions
359
- * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
360
- * @returns {Promise}
361
- * @throws {NeedsRetryError}
362
- * @private
363
- * @memberof ReconnectionManager
364
- */
365
- private async executeReconnection({networkDisconnect = false}: {networkDisconnect?: boolean}) {
366
- this.status = RECONNECTION.STATE.IN_PROGRESS;
367
-
368
- LoggerProxy.logger.info(
369
- 'ReconnectionManager:index#executeReconnection --> Attempting to reconnect to meeting.'
370
- );
371
-
372
- if (networkDisconnect) {
373
- try {
374
- await this.reconnectMercuryWebSocket();
375
- LoggerProxy.logger.error(
376
- 'ReconnectionManager:index#executeReconnection --> Websocket reconnected.',
377
- this.webex.internal.device.url
378
- );
379
- } catch (error) {
380
- LoggerProxy.logger.error(
381
- 'ReconnectionManager:index#executeReconnection --> Unable to reconnect to websocket, giving up.'
382
- );
383
- this.status = RECONNECTION.STATE.FAILURE;
384
- throw error;
385
- }
386
- }
387
-
388
- const wasSharing = this.meeting.shareStatus === SHARE_STATUS.LOCAL_SHARE_ACTIVE;
389
-
390
- try {
391
- LoggerProxy.logger.info(
392
- 'ReconnectionManager:index#executeReconnection --> Updating meeting data from server.'
393
- );
394
- await this.webex.meetings.syncMeetings();
395
- } catch (syncError) {
396
- LoggerProxy.logger.info(
397
- 'ReconnectionManager:index#executeReconnection --> Unable to sync meetings, reconnecting.',
398
- syncError
399
- );
400
- throw new NeedsRetryError(syncError);
401
- }
402
-
403
- // TODO: try to improve this logic as the reconnection manager saves the instance of deleted meeting object
404
- // So that on rejoin it known what parametrs it was using
405
- if (!this.meeting || !this.webex.meetings.getMeetingByType(_ID_, this.meeting.id)) {
406
- LoggerProxy.logger.info(
407
- 'ReconnectionManager:index#executeReconnection --> Meeting got deleted due to inactivity or ended remotely '
408
- );
409
-
410
- throw new Error('Unable to rejoin a meeting already ended or inactive .');
411
- }
412
-
413
- LoggerProxy.logger.info(
414
- `ReconnectionManager:index#executeReconnection --> Current state of meeting is ${this.meeting.state}`
415
- );
416
-
417
- // If the meeting state was left, no longer reconnect media
418
- if (this.meeting.state === _LEFT_) {
419
- if (this.meeting.type === _CALL_) {
420
- throw new Error('Unable to rejoin a call in LEFT state.');
421
- }
422
-
423
- throw new NeedsRejoinError({wasSharing});
424
- }
425
-
426
- try {
427
- const media = await this.reconnectMedia();
428
-
429
- LoggerProxy.logger.log(
430
- 'ReconnectionManager:index#executeReconnection --> Media reestablished'
431
- );
432
- this.status = RECONNECTION.STATE.COMPLETE;
433
-
434
- return media;
435
- } catch (error) {
436
- LoggerProxy.logger.error(
437
- 'ReconnectionManager:index#executeReconnection --> Media reestablishment failed'
438
- );
439
- this.status = RECONNECTION.STATE.FAILURE;
440
-
441
- throw error;
442
- }
443
- }
444
-
445
- /**
446
- * Rejoins a meeting after detecting the member was in a LEFT state
447
- *
448
- * @async
449
- * @param {boolean} wasSharing
450
- * @returns {Promise}
451
- */
452
- async rejoinMeeting(wasSharing = false) {
453
- try {
454
- LoggerProxy.logger.info(
455
- 'ReconnectionManager:index#rejoinMeeting --> attemping meeting rejoin'
456
- );
457
- const previousCorrelationId = this.meeting.correlationId;
458
-
459
- await this.meeting.join({rejoin: true});
460
- LoggerProxy.logger.info('ReconnectionManager:index#rejoinMeeting --> meeting rejoined');
461
-
462
- RoapCollection.deleteSession(previousCorrelationId);
463
-
464
- if (wasSharing) {
465
- // Stop the share streams if user tried to rejoin
466
- Media.stopTracks(this.meeting.mediaProperties.shareTrack);
467
- this.meeting.isSharing = false;
468
- if (this.shareStatus === SHARE_STATUS.LOCAL_SHARE_ACTIVE) {
469
- this.meeting.shareStatus = SHARE_STATUS.NO_SHARE;
470
- }
471
- this.meeting.mediaProperties.mediaDirection.sendShare = false;
472
- Trigger.trigger(
473
- this.meeting,
474
- {
475
- file: 'reconnection-manager/index',
476
- function: 'rejoinMeeting',
477
- },
478
- EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
479
- {
480
- reason: SHARE_STOPPED_REASON.MEETING_REJOIN,
481
- }
482
- );
483
- }
484
- } catch (joinError) {
485
- this.rejoinAttempts += 1;
486
- if (this.rejoinAttempts <= this.maxRejoinAttempts) {
487
- LoggerProxy.logger.info(
488
- `ReconnectionManager:index#rejoinMeeting --> Unable to rejoin meeting, attempt #${this.rejoinAttempts}, retrying.`,
489
- joinError
490
- );
491
- this.rejoinMeeting();
492
- } else {
493
- LoggerProxy.logger.error(
494
- 'ReconnectionManager:index#rejoinMeeting --> Unable to rejoin meeting after max attempts.',
495
- joinError
496
- );
497
- Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.MEETING_MAX_REJOIN_FAILURE, {
498
- locus_id: this.meeting.locusUrl.split('/').pop(),
499
- reason: joinError.message,
500
- stack: joinError.stack,
501
- });
502
- this.status = RECONNECTION.STATE.FAILURE;
503
- throw joinError;
504
- }
505
- }
506
-
507
- try {
508
- await this.reconnectMedia();
509
- } catch (mediaError) {
510
- LoggerProxy.logger.error(
511
- 'ReconnectionManager:index#rejoinMeeting --> Unable to reestablish media after rejoining.',
512
- mediaError
513
- );
514
- throw mediaError;
515
- }
516
- }
517
-
518
- /**
519
- * @returns {Promise}
520
- * @private
521
- * @memberof ReconnectionManager
522
- */
523
- reconnectMedia() {
524
- LoggerProxy.logger.log(
525
- 'ReconnectionManager:index#reconnectMedia --> Begin reestablishment of media'
526
- );
527
-
528
- return ReconnectionManager.setupPeerConnection(this.meeting)
529
- .then(() =>
530
- Media.attachMedia(this.meeting.mediaProperties, {
531
- meetingId: this.meeting.id,
532
- remoteQualityLevel: this.meeting.mediaProperties.remoteQualityLevel,
533
- enableRtx: this.meeting.config.enableRtx,
534
- enableExtmap: this.meeting.config.enableExtmap,
535
- })
536
- )
537
- .then((peerConnection) => this.meeting.setRemoteStream(peerConnection))
538
- .then(() => {
539
- LoggerProxy.logger.log(
540
- 'ReconnectionManager:index#reconnectMedia --> Sending ROAP media request'
541
- );
542
-
543
- return this.meeting.roap.sendRoapMediaRequest({
544
- sdp: this.meeting.mediaProperties.peerConnection.sdp,
545
- roapSeq: this.meeting.roapSeq,
546
- meeting: this.meeting,
547
- reconnect: true,
548
- });
549
- });
550
- }
551
-
552
- /**
553
- * Attempt to Reconnect Mercury Websocket
554
- * @returns {Promise}
555
- * @private
556
- * @memberof ReconnectionManager
557
- */
558
- private async reconnectMercuryWebSocket() {
559
- LoggerProxy.logger.info(
560
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Reconnecting websocket.'
561
- );
562
- // First, attempt to disconnect if we think we are already connected.
563
- if (this.webex.internal.mercury.connected) {
564
- LoggerProxy.logger.info(
565
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Disconnecting existing websocket.'
566
- );
567
- try {
568
- await this.webex.internal.mercury.disconnect();
569
- LoggerProxy.logger.info(
570
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Websocket disconnected successfully.'
571
- );
572
- } catch (disconnectError) {
573
- // If we can't disconnect, the sdk is in such a bad state that reconnecting is not going to happen.
574
- LoggerProxy.logger.error(
575
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Unable to disconnect from websocket, giving up.',
576
- disconnectError
577
- );
578
- throw disconnectError;
579
- }
580
- }
581
-
582
- try {
583
- LoggerProxy.logger.info(
584
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Connecting websocket.'
585
- );
586
- await this.webex.internal.mercury.connect();
587
- LoggerProxy.logger.info(
588
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Websocket connected successfully.'
589
- );
590
- } catch (connectError) {
591
- LoggerProxy.logger.error(
592
- 'ReconnectionManager:index#reconnectMercuryWebSocket --> Unable to connect to websocket, giving up.',
593
- connectError
594
- );
595
-
596
- throw connectError;
597
- }
598
- }
599
-
600
- /**
601
- * @param {Meeting} meeting
602
- * @returns {undefined}
603
- * @private
604
- * @memberof ReconnectionManager
605
- */
606
- private static async setupPeerConnection(meeting: Meeting) {
607
- LoggerProxy.logger.log(
608
- 'ReconnectionManager:index#setupPeerConnection --> Begin resetting peer connection'
609
- );
610
- // close pcs, unset to null and create a new one with out closing any streams
611
- PeerConnectionManager.close(meeting.mediaProperties.peerConnection);
612
- meeting.mediaProperties.unsetPeerConnection();
613
-
614
- const turnServerResult = await meeting.roap.doTurnDiscovery(meeting, true);
615
-
616
- meeting.mediaProperties.reInitiatePeerconnection(turnServerResult.turnServerInfo);
617
- PeerConnectionManager.setPeerConnectionEvents(meeting);
618
-
619
- // update the peerconnection in the stats manager when ever we reconnect
620
- meeting.statsAnalyzer.updatePeerconnection(meeting.mediaProperties.peerConnection);
621
- }
622
- }
1
+ /*!
2
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
3
+ */
4
+
5
+ /* eslint-disable no-warning-comments */
6
+
7
+ import LoggerProxy from '../common/logs/logger-proxy';
8
+ import Trigger from '../common/events/trigger-proxy';
9
+ import {
10
+ EVENT_TRIGGERS,
11
+ RECONNECTION,
12
+ SHARE_STATUS,
13
+ SHARE_STOPPED_REASON,
14
+ _CALL_,
15
+ _LEFT_,
16
+ _ID_,
17
+ } from '../constants';
18
+ import BEHAVIORAL_METRICS from '../metrics/constants';
19
+ import ReconnectionError from '../common/errors/reconnection';
20
+ import ReconnectInProgress from '../common/errors/reconnection-in-progress';
21
+ import PeerConnectionManager from '../peer-connection-manager';
22
+ import {eventType, reconnection, errorObjects} from '../metrics/config';
23
+ import Media from '../media';
24
+ import Metrics from '../metrics';
25
+ import RoapCollection from '../roap/collection';
26
+ import Meeting from '../meeting';
27
+
28
+ /**
29
+ * Used to indicate that the reconnect logic needs to be retried.
30
+ *
31
+ * @class NeedsRetryError
32
+ * @extends {Error}
33
+ */
34
+ class NeedsRetryError extends Error {}
35
+
36
+ /**
37
+ * Used to indicate that the meeting needs to be rejoined, not just media reconnected
38
+ *
39
+ * @class NeedsRejoinError
40
+ * @extends {Error}
41
+ */
42
+ class NeedsRejoinError extends Error {
43
+ wasSharing: any;
44
+
45
+ /**
46
+ * Creates an instance of NeedsRejoinError.
47
+ * @param {Object} params
48
+ * @param {boolean} params.wasSharing
49
+ * @param {Error} params.error
50
+ * @memberof NeedsRejoinError
51
+ */
52
+ constructor({
53
+ wasSharing,
54
+ error = new Error('Meeting needs to be rejoined'),
55
+ }: {
56
+ wasSharing?: boolean;
57
+ error?: Error;
58
+ }) {
59
+ // @ts-ignore
60
+ super(error);
61
+
62
+ this.wasSharing = wasSharing;
63
+ }
64
+ }
65
+
66
+ /**
67
+ * @export
68
+ * @class ReconnectionManager
69
+ */
70
+ export default class ReconnectionManager {
71
+ autoRejoinEnabled: any;
72
+ iceState: any;
73
+ maxRejoinAttempts: any;
74
+ meeting: any;
75
+ rejoinAttempts: any;
76
+ shareStatus: any;
77
+ status: any;
78
+ tryCount: any;
79
+ webex: any;
80
+ /**
81
+ * @param {Meeting} meeting
82
+ */
83
+ constructor(meeting: Meeting) {
84
+ /**
85
+ * Stores ICE reconnection state data.
86
+ *
87
+ * @instance
88
+ * @type {Object}
89
+ * @private
90
+ * @memberof ReconnectionManager
91
+ */
92
+ this.iceState = {
93
+ disconnected: false,
94
+ resolve: () => {},
95
+ timer: undefined,
96
+ // @ts-ignore
97
+ timeoutDuration: meeting.config.reconnection.iceReconnectionTimeout,
98
+ };
99
+
100
+ /**
101
+ * @instance
102
+ * @type {String}
103
+ * @private
104
+ * @memberof ReconnectionManager
105
+ */
106
+ this.status = RECONNECTION.STATE.DEFAULT_STATUS;
107
+ /**
108
+ * @instance
109
+ * @type {Number}
110
+ * @private
111
+ * @memberof ReconnectionManager
112
+ */
113
+ this.tryCount = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
114
+ /**
115
+ * @instance
116
+ * @type {Object}
117
+ * @private
118
+ * @memberof ReconnectionManager
119
+ */
120
+ // TODO : change this logic to not save the meeting instance
121
+ // It gets complicated when meeting ends on remote side , We have a old meeting instance which is not up to date
122
+ // @ts-ignore
123
+ this.webex = meeting.webex;
124
+ /**
125
+ * @instance
126
+ * @type {Meeting}
127
+ * @private
128
+ * @memberof ReconnectionManager
129
+ */
130
+ // TODO: try removing the circular dependency for meeting and reconnection manager
131
+ // try moving this to meetings collection
132
+ this.meeting = meeting;
133
+
134
+ // @ts-ignore
135
+ this.maxRejoinAttempts = meeting.config.reconnection.maxRejoinAttempts;
136
+ this.rejoinAttempts = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
137
+ // @ts-ignore
138
+ this.autoRejoinEnabled = meeting.config.reconnection.autoRejoin;
139
+
140
+ // Make sure reconnection state is in default
141
+ this.reset();
142
+ }
143
+
144
+ /**
145
+ * Sets the iceState to connected and clears any disconnect timeouts and
146
+ * related timeout data within the iceState.
147
+ *
148
+ * @returns {undefined}
149
+ * @public
150
+ * @memberof ReconnectionManager
151
+ */
152
+ public iceReconnected() {
153
+ if (this.iceState.disconnected) {
154
+ LoggerProxy.logger.log('ReconnectionManager:index#iceReconnected --> ice has reconnected');
155
+
156
+ this.iceState.resolve();
157
+ this.iceState.resolve = () => {};
158
+
159
+ if (this.iceState.timer) {
160
+ clearTimeout(this.iceState.timer);
161
+ delete this.iceState.timer;
162
+ }
163
+
164
+ this.iceState.disconnected = false;
165
+ }
166
+ }
167
+
168
+ /**
169
+ * Set the iceState to disconnected and generates a timeout that waits for the
170
+ * iceState to reconnect and then resolves. If the ice state is already
171
+ * processing a reconnect, it immediately resolves. Rejects if the timeout
172
+ * duration is reached.
173
+ *
174
+ * @returns {Promise<undefined>}
175
+ * @public
176
+ * @memberof ReconnectionManager
177
+ */
178
+ public waitForIceReconnect() {
179
+ if (!this.iceState.disconnected) {
180
+ LoggerProxy.logger.log(
181
+ 'ReconnectionManager:index#waitForIceReconnect --> waiting for ice reconnect'
182
+ );
183
+
184
+ this.iceState.disconnected = true;
185
+
186
+ return new Promise<void>((resolve, reject) => {
187
+ this.iceState.timer = setTimeout(() => {
188
+ if (this.iceState.disconnected === false) {
189
+ resolve();
190
+ } else {
191
+ this.iceState.disconnected = false;
192
+ reject(
193
+ new Error(`ice reconnection did not occur in ${this.iceState.timeoutDuration}ms`)
194
+ );
195
+ }
196
+ }, this.iceState.timeoutDuration);
197
+
198
+ this.iceState.resolve = resolve;
199
+ });
200
+ }
201
+
202
+ // return a resolved promise to prevent multiple catch executions of reconnect
203
+ return Promise.resolve();
204
+ }
205
+
206
+ /**
207
+ * @returns {undefined}
208
+ * @public
209
+ * @memberof ReconnectionManager
210
+ */
211
+ public reset() {
212
+ this.status = RECONNECTION.STATE.DEFAULT_STATUS;
213
+ this.tryCount = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
214
+ this.rejoinAttempts = RECONNECTION.STATE.DEFAULT_TRY_COUNT;
215
+ }
216
+
217
+ /**
218
+ * @returns {undefined}
219
+ * @public
220
+ * @memberof ReconnectionManager
221
+ */
222
+ public cleanUp() {
223
+ this.reset();
224
+ this.meeting = null;
225
+ }
226
+
227
+ /**
228
+ * @returns {Boolean}
229
+ * @throws {ReconnectionError}
230
+ * @private
231
+ * @memberof ReconnectionManager
232
+ */
233
+ private validate() {
234
+ if (this.meeting.config.reconnection.enabled) {
235
+ if (
236
+ this.status === RECONNECTION.STATE.DEFAULT_STATUS ||
237
+ this.status === RECONNECTION.STATE.COMPLETE
238
+ ) {
239
+ return true;
240
+ }
241
+
242
+ LoggerProxy.logger.info(
243
+ 'ReconnectionManager:index#validate --> Reconnection already in progress.'
244
+ );
245
+
246
+ throw new ReconnectInProgress('Reconnection already in progress.');
247
+ }
248
+
249
+ LoggerProxy.logger.info('ReconnectionManager:index#validate --> Reconnection is not enabled.');
250
+
251
+ throw new ReconnectionError('Reconnection is not enabled.');
252
+ }
253
+
254
+ /**
255
+ * Initiates a media reconnect for the active meeting
256
+ * @param {Object} reconnectOptions
257
+ * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
258
+ * @param {boolean} [reconnectOptions.networkRetry=false] indicates if we are retrying the reconnect
259
+ * @returns {Promise}
260
+ * @public
261
+ * @memberof ReconnectionManager
262
+ */
263
+ public async reconnect({
264
+ networkDisconnect = false,
265
+ networkRetry = false,
266
+ }: {
267
+ networkDisconnect?: boolean;
268
+ networkRetry?: boolean;
269
+ } = {}) {
270
+ LoggerProxy.logger.info(
271
+ `ReconnectionManager:index#reconnect --> Reconnection start for meeting ${this.meeting.id}.`
272
+ );
273
+ // First, validate that we can reconnect, if not, it will throw an error
274
+ try {
275
+ this.validate();
276
+ } catch (error) {
277
+ LoggerProxy.logger.info(
278
+ 'ReconnectionManager:index#reconnect --> Reconnection unable to begin.',
279
+ error
280
+ );
281
+ throw error;
282
+ }
283
+
284
+ if (!networkRetry) {
285
+ // Only log START metrics on the initial reconnect
286
+ LoggerProxy.logger.info(
287
+ 'ReconnectionManager:index#reconnect --> Sending reconnect start metric.'
288
+ );
289
+ Metrics.postEvent({
290
+ event: eventType.MEDIA_RECONNECTING,
291
+ meeting: this.meeting,
292
+ });
293
+ }
294
+
295
+ return this.executeReconnection({networkDisconnect})
296
+ .then(() => {
297
+ LoggerProxy.logger.info('ReconnectionManager:index#reconnect --> Reconnection successful.');
298
+ LoggerProxy.logger.info(
299
+ 'ReconnectionManager:index#reconnect --> Sending reconnect success metric.'
300
+ );
301
+ Metrics.postEvent({
302
+ event: eventType.MEDIA_RECOVERED,
303
+ meeting: this.meeting,
304
+ data: {recoveredBy: reconnection.RECOVERED_BY_NEW},
305
+ });
306
+ })
307
+ .catch((reconnectError) => {
308
+ if (reconnectError instanceof NeedsRetryError) {
309
+ LoggerProxy.logger.info(
310
+ 'ReconnectionManager:index#reconnect --> Reconnection not successful, retrying.'
311
+ );
312
+ // Reset our reconnect status since we are looping back to the beginning
313
+ this.status = RECONNECTION.STATE.DEFAULT_STATUS;
314
+
315
+ // This is a network retry, so we should not log START metrics again
316
+ return this.reconnect({networkDisconnect: true, networkRetry: true});
317
+ }
318
+
319
+ // Reconnect has failed
320
+ LoggerProxy.logger.error(
321
+ 'ReconnectionManager:index#reconnect --> Reconnection failed.',
322
+ reconnectError.message
323
+ );
324
+ LoggerProxy.logger.info(
325
+ 'ReconnectionManager:index#reconnect --> Sending reconnect abort metric.'
326
+ );
327
+
328
+ const reconnectMetric = {
329
+ event: eventType.CALL_ABORTED,
330
+ meeting: this.meeting,
331
+ data: {
332
+ errors: [
333
+ {
334
+ category: errorObjects.category.expected,
335
+ errorCode: 2008,
336
+ fatal: true,
337
+ name: errorObjects.name.mediaEngine,
338
+ shownToUser: false,
339
+ },
340
+ ],
341
+ },
342
+ };
343
+
344
+ Metrics.postEvent(reconnectMetric);
345
+ if (reconnectError instanceof NeedsRejoinError) {
346
+ // send call aborded event with catogery as expected as we are trying to rejoin
347
+
348
+ if (this.autoRejoinEnabled) {
349
+ return this.rejoinMeeting(reconnectError.wasSharing);
350
+ }
351
+ }
352
+
353
+ throw reconnectError;
354
+ });
355
+ }
356
+
357
+ /**
358
+ * @param {Object} reconnectOptions
359
+ * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
360
+ * @returns {Promise}
361
+ * @throws {NeedsRetryError}
362
+ * @private
363
+ * @memberof ReconnectionManager
364
+ */
365
+ private async executeReconnection({networkDisconnect = false}: {networkDisconnect?: boolean}) {
366
+ this.status = RECONNECTION.STATE.IN_PROGRESS;
367
+
368
+ LoggerProxy.logger.info(
369
+ 'ReconnectionManager:index#executeReconnection --> Attempting to reconnect to meeting.'
370
+ );
371
+
372
+ if (networkDisconnect) {
373
+ try {
374
+ await this.reconnectMercuryWebSocket();
375
+ LoggerProxy.logger.error(
376
+ 'ReconnectionManager:index#executeReconnection --> Websocket reconnected.',
377
+ this.webex.internal.device.url
378
+ );
379
+ } catch (error) {
380
+ LoggerProxy.logger.error(
381
+ 'ReconnectionManager:index#executeReconnection --> Unable to reconnect to websocket, giving up.'
382
+ );
383
+ this.status = RECONNECTION.STATE.FAILURE;
384
+ throw error;
385
+ }
386
+ }
387
+
388
+ const wasSharing = this.meeting.shareStatus === SHARE_STATUS.LOCAL_SHARE_ACTIVE;
389
+
390
+ try {
391
+ LoggerProxy.logger.info(
392
+ 'ReconnectionManager:index#executeReconnection --> Updating meeting data from server.'
393
+ );
394
+ await this.webex.meetings.syncMeetings();
395
+ } catch (syncError) {
396
+ LoggerProxy.logger.info(
397
+ 'ReconnectionManager:index#executeReconnection --> Unable to sync meetings, reconnecting.',
398
+ syncError
399
+ );
400
+ throw new NeedsRetryError(syncError);
401
+ }
402
+
403
+ // TODO: try to improve this logic as the reconnection manager saves the instance of deleted meeting object
404
+ // So that on rejoin it known what parametrs it was using
405
+ if (!this.meeting || !this.webex.meetings.getMeetingByType(_ID_, this.meeting.id)) {
406
+ LoggerProxy.logger.info(
407
+ 'ReconnectionManager:index#executeReconnection --> Meeting got deleted due to inactivity or ended remotely '
408
+ );
409
+
410
+ throw new Error('Unable to rejoin a meeting already ended or inactive .');
411
+ }
412
+
413
+ LoggerProxy.logger.info(
414
+ `ReconnectionManager:index#executeReconnection --> Current state of meeting is ${this.meeting.state}`
415
+ );
416
+
417
+ // If the meeting state was left, no longer reconnect media
418
+ if (this.meeting.state === _LEFT_) {
419
+ if (this.meeting.type === _CALL_) {
420
+ throw new Error('Unable to rejoin a call in LEFT state.');
421
+ }
422
+
423
+ throw new NeedsRejoinError({wasSharing});
424
+ }
425
+
426
+ try {
427
+ const media = await this.reconnectMedia();
428
+
429
+ LoggerProxy.logger.log(
430
+ 'ReconnectionManager:index#executeReconnection --> Media reestablished'
431
+ );
432
+ this.status = RECONNECTION.STATE.COMPLETE;
433
+
434
+ return media;
435
+ } catch (error) {
436
+ LoggerProxy.logger.error(
437
+ 'ReconnectionManager:index#executeReconnection --> Media reestablishment failed'
438
+ );
439
+ this.status = RECONNECTION.STATE.FAILURE;
440
+
441
+ throw error;
442
+ }
443
+ }
444
+
445
+ /**
446
+ * Rejoins a meeting after detecting the member was in a LEFT state
447
+ *
448
+ * @async
449
+ * @param {boolean} wasSharing
450
+ * @returns {Promise}
451
+ */
452
+ async rejoinMeeting(wasSharing = false) {
453
+ try {
454
+ LoggerProxy.logger.info(
455
+ 'ReconnectionManager:index#rejoinMeeting --> attemping meeting rejoin'
456
+ );
457
+ const previousCorrelationId = this.meeting.correlationId;
458
+
459
+ await this.meeting.join({rejoin: true});
460
+ LoggerProxy.logger.info('ReconnectionManager:index#rejoinMeeting --> meeting rejoined');
461
+
462
+ RoapCollection.deleteSession(previousCorrelationId);
463
+
464
+ if (wasSharing) {
465
+ // Stop the share streams if user tried to rejoin
466
+ Media.stopTracks(this.meeting.mediaProperties.shareTrack);
467
+ this.meeting.isSharing = false;
468
+ if (this.shareStatus === SHARE_STATUS.LOCAL_SHARE_ACTIVE) {
469
+ this.meeting.shareStatus = SHARE_STATUS.NO_SHARE;
470
+ }
471
+ this.meeting.mediaProperties.mediaDirection.sendShare = false;
472
+ Trigger.trigger(
473
+ this.meeting,
474
+ {
475
+ file: 'reconnection-manager/index',
476
+ function: 'rejoinMeeting',
477
+ },
478
+ EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
479
+ {
480
+ reason: SHARE_STOPPED_REASON.MEETING_REJOIN,
481
+ }
482
+ );
483
+ }
484
+ } catch (joinError) {
485
+ this.rejoinAttempts += 1;
486
+ if (this.rejoinAttempts <= this.maxRejoinAttempts) {
487
+ LoggerProxy.logger.info(
488
+ `ReconnectionManager:index#rejoinMeeting --> Unable to rejoin meeting, attempt #${this.rejoinAttempts}, retrying.`,
489
+ joinError
490
+ );
491
+ this.rejoinMeeting();
492
+ } else {
493
+ LoggerProxy.logger.error(
494
+ 'ReconnectionManager:index#rejoinMeeting --> Unable to rejoin meeting after max attempts.',
495
+ joinError
496
+ );
497
+ Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.MEETING_MAX_REJOIN_FAILURE, {
498
+ locus_id: this.meeting.locusUrl.split('/').pop(),
499
+ reason: joinError.message,
500
+ stack: joinError.stack,
501
+ });
502
+ this.status = RECONNECTION.STATE.FAILURE;
503
+ throw joinError;
504
+ }
505
+ }
506
+
507
+ try {
508
+ await this.reconnectMedia();
509
+ } catch (mediaError) {
510
+ LoggerProxy.logger.error(
511
+ 'ReconnectionManager:index#rejoinMeeting --> Unable to reestablish media after rejoining.',
512
+ mediaError
513
+ );
514
+ throw mediaError;
515
+ }
516
+ }
517
+
518
+ /**
519
+ * @returns {Promise}
520
+ * @private
521
+ * @memberof ReconnectionManager
522
+ */
523
+ reconnectMedia() {
524
+ LoggerProxy.logger.log(
525
+ 'ReconnectionManager:index#reconnectMedia --> Begin reestablishment of media'
526
+ );
527
+
528
+ return ReconnectionManager.setupPeerConnection(this.meeting)
529
+ .then(() =>
530
+ Media.attachMedia(this.meeting.mediaProperties, {
531
+ meetingId: this.meeting.id,
532
+ remoteQualityLevel: this.meeting.mediaProperties.remoteQualityLevel,
533
+ enableRtx: this.meeting.config.enableRtx,
534
+ enableExtmap: this.meeting.config.enableExtmap,
535
+ })
536
+ )
537
+ .then((peerConnection) => this.meeting.setRemoteStream(peerConnection))
538
+ .then(() => {
539
+ LoggerProxy.logger.log(
540
+ 'ReconnectionManager:index#reconnectMedia --> Sending ROAP media request'
541
+ );
542
+
543
+ return this.meeting.roap.sendRoapMediaRequest({
544
+ sdp: this.meeting.mediaProperties.peerConnection.sdp,
545
+ roapSeq: this.meeting.roapSeq,
546
+ meeting: this.meeting,
547
+ reconnect: true,
548
+ });
549
+ });
550
+ }
551
+
552
+ /**
553
+ * Attempt to Reconnect Mercury Websocket
554
+ * @returns {Promise}
555
+ * @private
556
+ * @memberof ReconnectionManager
557
+ */
558
+ private async reconnectMercuryWebSocket() {
559
+ LoggerProxy.logger.info(
560
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Reconnecting websocket.'
561
+ );
562
+ // First, attempt to disconnect if we think we are already connected.
563
+ if (this.webex.internal.mercury.connected) {
564
+ LoggerProxy.logger.info(
565
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Disconnecting existing websocket.'
566
+ );
567
+ try {
568
+ await this.webex.internal.mercury.disconnect();
569
+ LoggerProxy.logger.info(
570
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Websocket disconnected successfully.'
571
+ );
572
+ } catch (disconnectError) {
573
+ // If we can't disconnect, the sdk is in such a bad state that reconnecting is not going to happen.
574
+ LoggerProxy.logger.error(
575
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Unable to disconnect from websocket, giving up.',
576
+ disconnectError
577
+ );
578
+ throw disconnectError;
579
+ }
580
+ }
581
+
582
+ try {
583
+ LoggerProxy.logger.info(
584
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Connecting websocket.'
585
+ );
586
+ await this.webex.internal.mercury.connect();
587
+ LoggerProxy.logger.info(
588
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Websocket connected successfully.'
589
+ );
590
+ } catch (connectError) {
591
+ LoggerProxy.logger.error(
592
+ 'ReconnectionManager:index#reconnectMercuryWebSocket --> Unable to connect to websocket, giving up.',
593
+ connectError
594
+ );
595
+
596
+ throw connectError;
597
+ }
598
+ }
599
+
600
+ /**
601
+ * @param {Meeting} meeting
602
+ * @returns {undefined}
603
+ * @private
604
+ * @memberof ReconnectionManager
605
+ */
606
+ private static async setupPeerConnection(meeting: Meeting) {
607
+ LoggerProxy.logger.log(
608
+ 'ReconnectionManager:index#setupPeerConnection --> Begin resetting peer connection'
609
+ );
610
+ // close pcs, unset to null and create a new one with out closing any streams
611
+ PeerConnectionManager.close(meeting.mediaProperties.peerConnection);
612
+ meeting.mediaProperties.unsetPeerConnection();
613
+
614
+ const turnServerResult = await meeting.roap.doTurnDiscovery(meeting, true);
615
+
616
+ meeting.mediaProperties.reInitiatePeerconnection(turnServerResult.turnServerInfo);
617
+ PeerConnectionManager.setPeerConnectionEvents(meeting);
618
+
619
+ // update the peerconnection in the stats manager when ever we reconnect
620
+ meeting.statsAnalyzer.updatePeerconnection(meeting.mediaProperties.peerConnection);
621
+ }
622
+ }