@coasys/ad4m 0.13.1-staging.1 → 0.13.1-staging.2

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 (222) hide show
  1. package/lib/index.cjs +3789 -1192
  2. package/lib/index.js +3783 -1193
  3. package/lib/src/generated/api/AgentsByDidsRequest.d.ts +3 -0
  4. package/lib/src/generated/api/CallSessionInfo.d.ts +23 -0
  5. package/lib/src/generated/api/DiscardBatchRequest.d.ts +3 -0
  6. package/lib/src/generated/api/Events.d.ts +13 -3
  7. package/lib/src/generated/api/Events.js +1 -0
  8. package/lib/src/generated/api/FlowStateChangedEvent.d.ts +38 -0
  9. package/lib/src/generated/api/FlowStateEntry.d.ts +18 -0
  10. package/lib/src/generated/api/FlowStateEntry.js +2 -0
  11. package/lib/src/generated/api/IceServer.d.ts +18 -0
  12. package/lib/src/generated/api/IceServer.js +2 -0
  13. package/lib/src/generated/api/OnlineAgent.d.ts +4 -0
  14. package/lib/src/generated/api/PerspectiveDiscardBatchParams.d.ts +4 -0
  15. package/lib/src/generated/api/PerspectiveDiscardBatchParams.js +2 -0
  16. package/lib/src/generated/api/PerspectiveFlowFiredParams.d.ts +8 -0
  17. package/lib/src/generated/api/PerspectiveFlowFiredParams.js +2 -0
  18. package/lib/src/generated/api/PerspectiveFlowStatesParams.d.ts +11 -0
  19. package/lib/src/generated/api/PerspectiveFlowStatesParams.js +2 -0
  20. package/lib/src/generated/api/PerspectiveGetAllShaclParams.d.ts +7 -0
  21. package/lib/src/generated/api/PerspectiveGetAllShaclParams.js +2 -0
  22. package/lib/src/generated/api/PerspectiveModelQueryParams.d.ts +6 -1
  23. package/lib/src/generated/api/PerspectiveRemoveSubjectParams.d.ts +6 -0
  24. package/lib/src/generated/api/PerspectiveRemoveSubjectParams.js +2 -0
  25. package/lib/src/generated/api/PerspectiveResynced.d.ts +8 -0
  26. package/lib/src/generated/api/PerspectiveResynced.js +2 -0
  27. package/lib/src/generated/api/PerspectiveSubscribed.d.ts +10 -0
  28. package/lib/src/generated/api/PerspectiveSubscribed.js +2 -0
  29. package/lib/src/generated/api/PerspectiveUpdateSubjectParams.d.ts +10 -0
  30. package/lib/src/generated/api/PerspectiveUpdateSubjectParams.js +2 -0
  31. package/lib/src/generated/api/QuerySubscriptionUpdate.d.ts +19 -0
  32. package/lib/src/generated/api/QuerySubscriptionUpdate.js +2 -0
  33. package/lib/src/generated/api/QuerySubscriptionUpdateEvent.d.ts +7 -0
  34. package/lib/src/generated/api/QuerySubscriptionUpdateEvent.js +1 -0
  35. package/lib/src/generated/api/QueryUpdatesLagged.d.ts +7 -0
  36. package/lib/src/generated/api/QueryUpdatesLagged.js +2 -0
  37. package/lib/src/generated/api/RemoveSubjectRequest.d.ts +9 -0
  38. package/lib/src/generated/api/RemoveSubjectRequest.js +2 -0
  39. package/lib/src/generated/api/ResyncSubscriptionRequest.d.ts +3 -0
  40. package/lib/src/generated/api/ResyncSubscriptionRequest.js +2 -0
  41. package/lib/src/generated/api/RpcMethods.d.ts +134 -14
  42. package/lib/src/generated/api/RpcMethods.js +12 -0
  43. package/lib/src/generated/api/SfuAddIceCandidateParams.d.ts +8 -0
  44. package/lib/src/generated/api/SfuAddIceCandidateParams.js +2 -0
  45. package/lib/src/generated/api/SfuAnswerServerOfferParams.d.ts +8 -0
  46. package/lib/src/generated/api/SfuAnswerServerOfferParams.js +2 -0
  47. package/lib/src/generated/api/SfuCallJoinParams.d.ts +14 -0
  48. package/lib/src/generated/api/SfuCallJoinParams.js +2 -0
  49. package/lib/src/generated/api/SfuCallRenegotiationOffer.d.ts +30 -0
  50. package/lib/src/generated/api/SfuCallRenegotiationOffer.js +1 -0
  51. package/lib/src/generated/api/SfuCascadePipe.d.ts +4 -0
  52. package/lib/src/generated/api/SfuCascadePipe.js +2 -0
  53. package/lib/src/generated/api/SfuCascadeStatus.d.ts +8 -0
  54. package/lib/src/generated/api/SfuCascadeStatus.js +1 -0
  55. package/lib/src/generated/api/SfuConfig.d.ts +52 -0
  56. package/lib/src/generated/api/SfuConfig.js +1 -0
  57. package/lib/src/generated/api/SfuDataMessage.d.ts +24 -0
  58. package/lib/src/generated/api/SfuDataMessage.js +2 -0
  59. package/lib/src/generated/api/SfuEnsureMembershipParams.d.ts +4 -0
  60. package/lib/src/generated/api/SfuEnsureMembershipParams.js +2 -0
  61. package/lib/src/generated/api/SfuMigrateEvent.d.ts +21 -0
  62. package/lib/src/generated/api/SfuMigrateEvent.js +2 -0
  63. package/lib/src/generated/api/SfuNeighbourhoodParams.d.ts +3 -0
  64. package/lib/src/generated/api/SfuNeighbourhoodParams.js +2 -0
  65. package/lib/src/generated/api/SfuParticipantQualityPreference.d.ts +7 -0
  66. package/lib/src/generated/api/SfuParticipantQualityPreference.js +2 -0
  67. package/lib/src/generated/api/SfuPerspectiveParams.d.ts +6 -0
  68. package/lib/src/generated/api/SfuPerspectiveParams.js +2 -0
  69. package/lib/src/generated/api/SfuQualityPreferenceParams.d.ts +8 -0
  70. package/lib/src/generated/api/SfuQualityPreferenceParams.js +2 -0
  71. package/lib/src/generated/api/SfuRoomInfo.d.ts +11 -0
  72. package/lib/src/generated/api/SfuRoomInfo.js +1 -0
  73. package/lib/src/generated/api/SfuRoomParams.d.ts +4 -0
  74. package/lib/src/generated/api/SfuRoomParams.js +2 -0
  75. package/lib/src/generated/api/SfuRoomParticipantInfo.d.ts +11 -0
  76. package/lib/src/generated/api/SfuRoomParticipantInfo.js +2 -0
  77. package/lib/src/generated/api/SfuRoomRoster.d.ts +13 -0
  78. package/lib/src/generated/api/SfuRoomRoster.js +2 -0
  79. package/lib/src/generated/api/SfuSendDataParams.d.ts +10 -0
  80. package/lib/src/generated/api/SfuSendDataParams.js +2 -0
  81. package/lib/src/generated/api/SfuSetConfigParams.d.ts +5 -0
  82. package/lib/src/generated/api/SfuSetConfigParams.js +1 -0
  83. package/lib/src/generated/api/SfuStatus.d.ts +24 -0
  84. package/lib/src/generated/api/SfuStatus.js +2 -0
  85. package/lib/src/generated/api/TrackMapEntry.d.ts +17 -0
  86. package/lib/src/generated/api/TrackMapEntry.js +2 -0
  87. package/lib/src/generated/api/UpdateSubjectRequest.d.ts +12 -0
  88. package/lib/src/generated/api/UpdateSubjectRequest.js +2 -0
  89. package/lib/src/generated/api/index.d.ts +3 -0
  90. package/lib/src/index.d.ts +7 -0
  91. package/lib/src/index.js +4 -0
  92. package/lib/src/model/Ad4mModel.d.ts +84 -0
  93. package/lib/src/model/Ad4mModel.js +234 -4
  94. package/lib/src/model/ModelQueryBuilder.d.ts +16 -35
  95. package/lib/src/model/ModelQueryBuilder.js +88 -270
  96. package/lib/src/model/decorators.d.ts +32 -0
  97. package/lib/src/model/decorators.js +40 -1
  98. package/lib/src/model/shacl-gen.d.ts +3 -1
  99. package/lib/src/model/shacl-gen.js +13 -1
  100. package/lib/src/model/types.d.ts +7 -0
  101. package/lib/src/neighbourhood/MeshManager.d.ts +384 -0
  102. package/lib/src/neighbourhood/MeshManager.js +1144 -0
  103. package/lib/src/neighbourhood/NeighbourhoodClient.d.ts +91 -0
  104. package/lib/src/neighbourhood/NeighbourhoodClient.js +196 -0
  105. package/lib/src/neighbourhood/NeighbourhoodProxy.d.ts +55 -1
  106. package/lib/src/neighbourhood/NeighbourhoodProxy.js +170 -3
  107. package/lib/src/neighbourhood/Session.d.ts +105 -0
  108. package/lib/src/neighbourhood/Session.js +412 -0
  109. package/lib/src/neighbourhood/SfuManager.d.ts +174 -0
  110. package/lib/src/neighbourhood/SfuManager.js +619 -0
  111. package/lib/src/neighbourhood/SfuTypes.d.ts +35 -0
  112. package/lib/src/neighbourhood/SfuTypes.js +8 -0
  113. package/lib/src/perspectives/FlowInstance.d.ts +63 -24
  114. package/lib/src/perspectives/FlowInstance.js +74 -31
  115. package/lib/src/perspectives/FlowModels.d.ts +0 -16
  116. package/lib/src/perspectives/FlowModels.js +8 -16
  117. package/lib/src/perspectives/LiveQuery.d.ts +49 -0
  118. package/lib/src/perspectives/LiveQuery.js +169 -0
  119. package/lib/src/perspectives/PerspectiveClient.d.ts +24 -15
  120. package/lib/src/perspectives/PerspectiveClient.js +33 -36
  121. package/lib/src/perspectives/PerspectiveProxy.d.ts +67 -167
  122. package/lib/src/perspectives/PerspectiveProxy.js +121 -475
  123. package/lib/src/perspectives/TextContent.d.ts +31 -0
  124. package/lib/src/perspectives/TextContent.js +52 -0
  125. package/lib/src/perspectives/WakerSubscriptionManager.d.ts +23 -0
  126. package/lib/src/perspectives/WakerSubscriptionManager.js +58 -17
  127. package/lib/src/shacl/SHACLFlow.d.ts +7 -4
  128. package/lib/src/shacl/SHACLFlow.js +7 -4
  129. package/lib/src/shacl/SHACLShape.d.ts +9 -0
  130. package/lib/src/shacl/SHACLShape.js +37 -0
  131. package/package.json +2 -2
  132. package/pnpm-workspace.yaml +4 -1
  133. package/src/Ad4mClient.test.ts +89 -17
  134. package/src/generated/api/AgentsByDidsRequest.ts +3 -0
  135. package/src/generated/api/CallSessionInfo.ts +20 -0
  136. package/src/generated/api/DiscardBatchRequest.ts +3 -0
  137. package/src/generated/api/Events.ts +14 -3
  138. package/src/generated/api/FlowStateChangedEvent.ts +36 -0
  139. package/src/generated/api/FlowStateEntry.ts +18 -0
  140. package/src/generated/api/IceServer.ts +19 -0
  141. package/src/generated/api/OnlineAgent.ts +6 -1
  142. package/src/generated/api/PerspectiveDiscardBatchParams.ts +3 -0
  143. package/src/generated/api/PerspectiveFlowFiredParams.ts +7 -0
  144. package/src/generated/api/PerspectiveFlowStatesParams.ts +11 -0
  145. package/src/generated/api/PerspectiveGetAllShaclParams.ts +6 -0
  146. package/src/generated/api/PerspectiveModelQueryParams.ts +5 -1
  147. package/src/generated/api/PerspectiveRemoveSubjectParams.ts +3 -0
  148. package/src/generated/api/PerspectiveResynced.ts +7 -0
  149. package/src/generated/api/PerspectiveSubscribed.ts +8 -0
  150. package/src/generated/api/PerspectiveUpdateSubjectParams.ts +7 -0
  151. package/src/generated/api/QuerySubscriptionUpdate.ts +10 -0
  152. package/src/generated/api/QuerySubscriptionUpdateEvent.ts +9 -0
  153. package/src/generated/api/QueryUpdatesLagged.ts +7 -0
  154. package/src/generated/api/RemoveSubjectRequest.ts +7 -0
  155. package/src/generated/api/ResyncSubscriptionRequest.ts +3 -0
  156. package/src/generated/api/RpcMethods.ts +68 -8
  157. package/src/generated/api/SfuAddIceCandidateParams.ts +7 -0
  158. package/src/generated/api/SfuAnswerServerOfferParams.ts +7 -0
  159. package/src/generated/api/SfuCallJoinParams.ts +13 -0
  160. package/src/generated/api/SfuCallRenegotiationOffer.ts +29 -0
  161. package/src/generated/api/SfuCascadePipe.ts +3 -0
  162. package/src/generated/api/SfuCascadeStatus.ts +7 -0
  163. package/src/generated/api/SfuConfig.ts +53 -0
  164. package/src/generated/api/SfuDataMessage.ts +23 -0
  165. package/src/generated/api/SfuEnsureMembershipParams.ts +3 -0
  166. package/src/generated/api/SfuMigrateEvent.ts +20 -0
  167. package/src/generated/api/{KeepAliveQueryRequest.ts → SfuNeighbourhoodParams.ts} +1 -1
  168. package/src/generated/api/SfuParticipantQualityPreference.ts +6 -0
  169. package/src/generated/api/{PerspectiveSubscribeQueryResult.ts → SfuPerspectiveParams.ts} +4 -1
  170. package/src/generated/api/SfuQualityPreferenceParams.ts +7 -0
  171. package/src/generated/api/SfuRoomInfo.ts +7 -0
  172. package/src/generated/api/SfuRoomParams.ts +3 -0
  173. package/src/generated/api/SfuRoomParticipantInfo.ts +8 -0
  174. package/src/generated/api/SfuRoomRoster.ts +12 -0
  175. package/src/generated/api/SfuSendDataParams.ts +7 -0
  176. package/src/generated/api/SfuSetConfigParams.ts +4 -0
  177. package/src/generated/api/SfuStatus.ts +24 -0
  178. package/src/generated/api/TrackMapEntry.ts +18 -0
  179. package/src/generated/api/UpdateSubjectRequest.ts +10 -0
  180. package/src/generated/api/index.ts +3 -0
  181. package/src/index.ts +7 -0
  182. package/src/model/Ad4mModel.test.ts +255 -231
  183. package/src/model/Ad4mModel.ts +271 -4
  184. package/src/model/ModelQueryBuilder.ts +103 -310
  185. package/src/model/abstract-classes.test.ts +225 -0
  186. package/src/model/decorators.ts +81 -0
  187. package/src/model/shacl-gen.ts +13 -0
  188. package/src/model/types.ts +7 -0
  189. package/src/neighbourhood/MeshManager.test.ts +2640 -0
  190. package/src/neighbourhood/MeshManager.ts +1350 -0
  191. package/src/neighbourhood/NeighbourhoodClient.ts +271 -0
  192. package/src/neighbourhood/NeighbourhoodProxy.test.ts +23 -0
  193. package/src/neighbourhood/NeighbourhoodProxy.ts +247 -1
  194. package/src/neighbourhood/Session.test.ts +800 -0
  195. package/src/neighbourhood/Session.ts +525 -0
  196. package/src/neighbourhood/SfuManager.test.ts +677 -0
  197. package/src/neighbourhood/SfuManager.ts +803 -0
  198. package/src/neighbourhood/SfuTypes.ts +40 -0
  199. package/src/perspectives/FlowInstance.ts +108 -31
  200. package/src/perspectives/FlowModels.ts +8 -18
  201. package/src/perspectives/LiveQuery.test.ts +197 -0
  202. package/src/perspectives/LiveQuery.ts +189 -0
  203. package/src/perspectives/PerspectiveClient.ts +51 -51
  204. package/src/perspectives/PerspectiveProxy.test.ts +85 -401
  205. package/src/perspectives/PerspectiveProxy.ts +126 -536
  206. package/src/perspectives/TextContent.test.ts +123 -0
  207. package/src/perspectives/TextContent.ts +36 -0
  208. package/src/perspectives/WakerSubscriptionManager.test.ts +88 -6
  209. package/src/perspectives/WakerSubscriptionManager.ts +69 -18
  210. package/src/shacl/SHACLFlow.ts +7 -4
  211. package/src/shacl/SHACLShape.test.ts +2 -1
  212. package/src/shacl/SHACLShape.ts +49 -0
  213. package/lib/src/generated/api/KeepAliveQueryRequest.d.ts +0 -3
  214. package/lib/src/generated/api/PerspectiveModelSubscribeResult.d.ts +0 -7
  215. package/lib/src/generated/api/PerspectiveQuerySubscriptionFilter.d.ts +0 -6
  216. package/lib/src/generated/api/PerspectiveSubscribeQueryResult.d.ts +0 -4
  217. package/src/generated/api/PerspectiveModelSubscribeResult.ts +0 -6
  218. package/src/generated/api/PerspectiveQuerySubscriptionFilter.ts +0 -3
  219. /package/lib/src/generated/api/{KeepAliveQueryRequest.js → AgentsByDidsRequest.js} +0 -0
  220. /package/lib/src/generated/api/{PerspectiveModelSubscribeResult.js → CallSessionInfo.js} +0 -0
  221. /package/lib/src/generated/api/{PerspectiveQuerySubscriptionFilter.js → DiscardBatchRequest.js} +0 -0
  222. /package/lib/src/generated/api/{PerspectiveSubscribeQueryResult.js → FlowStateChangedEvent.js} +0 -0
@@ -0,0 +1,677 @@
1
+ /**
2
+ * SfuManager unit tests: the client's contract with the executor's SFU.
3
+ *
4
+ * Server events: the executor sends a socket only the events it watches,
5
+ * and the SDK sends a pending watch ahead of the next call. So the manager
6
+ * must subscribe before `sfuCallJoin`, or an event the join triggers can be
7
+ * lost. Offers that arrive before the join's answer is applied wait for
8
+ * it, then apply one at a time in arrival order.
9
+ *
10
+ * Membership comes from the room roster. A received track belongs to the
11
+ * participant the server mapped its media section to, and to no one when
12
+ * its section has no mapping.
13
+ */
14
+
15
+ class FakeTrack {
16
+ private listeners: (() => void)[] = []
17
+ constructor(readonly kind: "audio" | "video") {}
18
+ addEventListener(type: string, listener: () => void) {
19
+ if (type === "ended") this.listeners.push(listener)
20
+ }
21
+ end() {
22
+ for (const listener of this.listeners) listener()
23
+ }
24
+ }
25
+
26
+ class FakeMediaStream {
27
+ private tracks: FakeTrack[]
28
+ constructor(tracks: FakeTrack[] = []) {
29
+ this.tracks = [...tracks]
30
+ }
31
+ getTracks() { return [...this.tracks] }
32
+ getAudioTracks() { return this.tracks.filter((t) => t.kind === "audio") }
33
+ getVideoTracks() { return this.tracks.filter((t) => t.kind === "video") }
34
+ addTrack(track: FakeTrack) {
35
+ if (!this.tracks.includes(track)) this.tracks.push(track)
36
+ }
37
+ removeTrack(track: FakeTrack) {
38
+ this.tracks = this.tracks.filter((t) => t !== track)
39
+ }
40
+ }
41
+
42
+ interface FakeTransceiver {
43
+ trackOrKind: FakeTrack | string
44
+ init: RTCRtpTransceiverInit
45
+ sender: { replaceTrack: jest.Mock<Promise<void>, [FakeTrack | null]> }
46
+ }
47
+
48
+ class FakePeerConnection {
49
+ static instances: FakePeerConnection[] = []
50
+ localDescription: RTCSessionDescriptionInit | null = null
51
+ remoteDescriptions: RTCSessionDescriptionInit[] = []
52
+ transceivers: FakeTransceiver[] = []
53
+ offersCreated = 0
54
+ oniceconnectionstatechange: (() => void) | null = null
55
+ onicecandidate: ((e: { candidate: null }) => void) | null = null
56
+ ontrack: ((e: unknown) => void) | null = null
57
+ closed = false
58
+
59
+ constructor(readonly configuration?: RTCConfiguration) {
60
+ FakePeerConnection.instances.push(this)
61
+ }
62
+ addTransceiver(trackOrKind: FakeTrack | string, init: RTCRtpTransceiverInit) {
63
+ const transceiver: FakeTransceiver = {
64
+ trackOrKind,
65
+ init,
66
+ sender: { replaceTrack: jest.fn(async (_track: FakeTrack | null) => {}) },
67
+ }
68
+ this.transceivers.push(transceiver)
69
+ return transceiver
70
+ }
71
+ async createOffer() {
72
+ this.offersCreated++
73
+ return { type: "offer", sdp: "local-offer" }
74
+ }
75
+ async createAnswer() { return { type: "answer", sdp: "local-answer" } }
76
+ async setLocalDescription(d: RTCSessionDescriptionInit) { this.localDescription = d }
77
+ async setRemoteDescription(d: RTCSessionDescriptionInit) { this.remoteDescriptions.push(d) }
78
+ close() { this.closed = true }
79
+
80
+ /** A remote track arriving on the media section `mid`. */
81
+ receive(track: FakeTrack, mid: string | null) {
82
+ this.ontrack?.({ track, transceiver: { mid } })
83
+ }
84
+ /** The SDPs of the remote descriptions applied so far. */
85
+ remoteSdps() {
86
+ return this.remoteDescriptions.map((d) => d.sdp)
87
+ }
88
+ }
89
+ ;(globalThis as any).RTCPeerConnection = FakePeerConnection
90
+ ;(globalThis as any).MediaStream = FakeMediaStream
91
+ ;(globalThis as any).RTCSessionDescription = class {
92
+ constructor(init: RTCSessionDescriptionInit) { Object.assign(this, init) }
93
+ }
94
+
95
+ import { SfuManager, type SfuNeighbourhoodApi, type SfuParticipantState } from "./SfuManager"
96
+ import type {
97
+ CallSessionInfo,
98
+ SfuCallRenegotiationOffer,
99
+ SfuConfig,
100
+ SfuRoomRoster,
101
+ TrackMapEntry,
102
+ } from "./SfuTypes"
103
+
104
+ const URL = "neighbourhood://n"
105
+ const ROOM = "room"
106
+ const ME = "did:me"
107
+ const ALICE = "did:key:alice"
108
+ const BOB = "did:key:bob"
109
+
110
+ function fakeStream(...tracks: FakeTrack[]): MediaStream {
111
+ return new FakeMediaStream(tracks) as unknown as MediaStream
112
+ }
113
+
114
+ function session(overrides: Partial<CallSessionInfo> = {}): CallSessionInfo {
115
+ return {
116
+ roomName: ROOM,
117
+ neighbourhoodUrl: URL,
118
+ participantId: "p1",
119
+ sdpAnswer: JSON.stringify({ type: "answer", sdp: "server-answer" }),
120
+ streamMapping: [],
121
+ ...overrides,
122
+ }
123
+ }
124
+
125
+ function offer(sdp: string, trackMapping?: TrackMapEntry[]): SfuCallRenegotiationOffer {
126
+ return {
127
+ targetDid: ME,
128
+ neighbourhoodUrl: URL,
129
+ roomName: ROOM,
130
+ sdpOffer: JSON.stringify({ type: "offer", sdp }),
131
+ trackMapping,
132
+ }
133
+ }
134
+
135
+ function mapped(mid: string, agentDid: string, mediaKind: "audio" | "video"): TrackMapEntry {
136
+ return { mid, agentDid, mediaKind }
137
+ }
138
+
139
+ function roster(participants: string[], overrides: Partial<SfuRoomRoster> = {}): SfuRoomRoster {
140
+ return { neighbourhoodUrl: URL, roomName: ROOM, participants, ...overrides }
141
+ }
142
+
143
+ function deferred<T>() {
144
+ let resolve!: (value: T) => void
145
+ const promise = new Promise<T>((r) => { resolve = r })
146
+ return { promise, resolve }
147
+ }
148
+
149
+ /** A fake API that records the order of subscribe and RPC calls. */
150
+ function fakeApi() {
151
+ const log: string[] = []
152
+ const offerHandlers = new Set<(e: SfuCallRenegotiationOffer) => void>()
153
+ const rosterHandlers = new Set<(r: SfuRoomRoster) => void>()
154
+ const api = {
155
+ log,
156
+ offerHandlers,
157
+ rosterHandlers,
158
+ emitOffer(event: SfuCallRenegotiationOffer) {
159
+ for (const handler of offerHandlers) handler(event)
160
+ },
161
+ emitRoster(event: SfuRoomRoster) {
162
+ for (const handler of rosterHandlers) handler(event)
163
+ },
164
+ sfuCallJoin: jest.fn(async () => {
165
+ log.push("sfuCallJoin")
166
+ return session()
167
+ }),
168
+ sfuCallLeave: jest.fn(async () => {
169
+ log.push("sfuCallLeave")
170
+ return true
171
+ }),
172
+ sfuCallSetQualityPreference: jest.fn(async () => true),
173
+ sfuCallAnswerServerOffer: jest.fn(async () => {
174
+ log.push("sfuCallAnswerServerOffer")
175
+ return true
176
+ }),
177
+ subscribeSfuCallRenegotiationOffer: jest.fn(
178
+ (_did: string, handler: (e: SfuCallRenegotiationOffer) => void) => {
179
+ log.push("subscribe-offer")
180
+ offerHandlers.add(handler)
181
+ return () => {
182
+ log.push("unsubscribe-offer")
183
+ offerHandlers.delete(handler)
184
+ }
185
+ },
186
+ ),
187
+ subscribeSfuRoomRoster: jest.fn((handler: (r: SfuRoomRoster) => void) => {
188
+ log.push("subscribe-roster")
189
+ rosterHandlers.add(handler)
190
+ return () => {
191
+ log.push("unsubscribe-roster")
192
+ rosterHandlers.delete(handler)
193
+ }
194
+ }),
195
+ sfuAddIceCandidate: jest.fn(async () => true),
196
+ sfuSendData: jest.fn(async () => true),
197
+ subscribeSfuDataChannel: jest.fn(() => () => {}),
198
+ }
199
+ return api satisfies SfuNeighbourhoodApi & Record<string, unknown>
200
+ }
201
+
202
+ /** A manager with its membership and media events recorded. */
203
+ function recordedManager(api: ReturnType<typeof fakeApi>) {
204
+ const manager = new SfuManager(api, ROOM, ME, URL)
205
+ const joined: string[] = []
206
+ const left: string[] = []
207
+ const added: [MediaStream, FakeTrack][] = []
208
+ const removed: [MediaStream, FakeTrack][] = []
209
+ manager.on("participant-joined", (p: SfuParticipantState) => joined.push(p.did))
210
+ manager.on("participant-left", (p: SfuParticipantState) => left.push(p.did))
211
+ manager.on("stream-added", (s: MediaStream, t: FakeTrack) => added.push([s, t]))
212
+ manager.on("stream-removed", (s: MediaStream, t: FakeTrack) => removed.push([s, t]))
213
+ const participants = () => manager.getParticipants().map((p) => p.did)
214
+ return { manager, joined, left, added, removed, participants }
215
+ }
216
+
217
+ // setImmediate, which the fake-timer tests leave real, so a flush works under both.
218
+ const flush = () => new Promise((resolve) => setImmediate(resolve))
219
+ const currentPc = () => FakePeerConnection.instances[FakePeerConnection.instances.length - 1]
220
+
221
+ /** Drive the manager's current connection to an ICE state. */
222
+ async function iceState(state: string) {
223
+ const pc = currentPc() as any
224
+ pc.iceConnectionState = state
225
+ pc.oniceconnectionstatechange()
226
+ await flush()
227
+ }
228
+
229
+ beforeEach(() => {
230
+ FakePeerConnection.instances = []
231
+ })
232
+
233
+ // ── Server events ─────────────────────────────────────────────────
234
+
235
+ test("the app's ICE servers reach the connection as given, ahead of the config's", async () => {
236
+ const relay = {
237
+ urls: ["stun:relay.example.com:3478", "turn:relay.example.com:3478"],
238
+ username: "user",
239
+ credential: "pass",
240
+ }
241
+ const config = { iceServers: [{ urls: ["stun:config.example.com:3478"] }] } as unknown as SfuConfig
242
+ await new SfuManager(fakeApi(), ROOM, ME, URL, { servers: [relay] }, config).join(fakeStream())
243
+ expect(FakePeerConnection.instances[0].configuration).toEqual({ iceServers: [relay] })
244
+ })
245
+
246
+ test("subscribes to offers and the roster before sfuCallJoin", async () => {
247
+ const api = fakeApi()
248
+ await new SfuManager(api, ROOM, ME, URL).join(fakeStream())
249
+ expect(api.log.slice(0, 3)).toEqual(["subscribe-offer", "subscribe-roster", "sfuCallJoin"])
250
+ })
251
+
252
+ test("offers that arrive before the join completes apply after its answer, in arrival order", async () => {
253
+ const api = fakeApi()
254
+ const join = deferred<CallSessionInfo>()
255
+ api.sfuCallJoin.mockImplementation(() => join.promise)
256
+ const manager = new SfuManager(api, ROOM, ME, URL)
257
+ const joining = manager.join(fakeStream())
258
+ await flush()
259
+
260
+ api.emitOffer(offer("early-1"))
261
+ api.emitOffer(offer("early-2"))
262
+ await flush()
263
+ const pc = currentPc()
264
+ expect(pc.remoteSdps()).toEqual([])
265
+ expect(api.sfuCallAnswerServerOffer).not.toHaveBeenCalled()
266
+
267
+ join.resolve(session())
268
+ await joining
269
+ await flush()
270
+ expect(pc.remoteSdps()).toEqual(["server-answer", "early-1", "early-2"])
271
+ expect(api.sfuCallAnswerServerOffer).toHaveBeenCalledTimes(2)
272
+ expect(api.sfuCallAnswerServerOffer).toHaveBeenCalledWith(
273
+ URL,
274
+ ROOM,
275
+ JSON.stringify({ type: "answer", sdp: "local-answer" }),
276
+ )
277
+ })
278
+
279
+ test("a second offer waits until the first one is answered", async () => {
280
+ const api = fakeApi()
281
+ const manager = new SfuManager(api, ROOM, ME, URL)
282
+ await manager.join(fakeStream())
283
+ const answered = deferred<boolean>()
284
+ api.sfuCallAnswerServerOffer.mockImplementationOnce(() => answered.promise)
285
+
286
+ api.emitOffer(offer("first"))
287
+ api.emitOffer(offer("second"))
288
+ await flush()
289
+ const pc = currentPc()
290
+ expect(pc.remoteSdps()).toEqual(["server-answer", "first"])
291
+
292
+ answered.resolve(true)
293
+ await flush()
294
+ expect(pc.remoteSdps()).toEqual(["server-answer", "first", "second"])
295
+ expect(api.sfuCallAnswerServerOffer).toHaveBeenCalledTimes(2)
296
+ })
297
+
298
+ test("an offer queued for a connection that has since been replaced is dropped", async () => {
299
+ const api = fakeApi()
300
+ const manager = new SfuManager(api, ROOM, ME, URL)
301
+ await manager.join(fakeStream())
302
+ const old = currentPc()
303
+ const answered = deferred<boolean>()
304
+ api.sfuCallAnswerServerOffer.mockImplementationOnce(() => answered.promise)
305
+ api.emitOffer(offer("first"))
306
+ api.emitOffer(offer("stale"))
307
+ await flush()
308
+
309
+ await iceState("failed")
310
+ const replacement = currentPc()
311
+ expect(replacement).not.toBe(old)
312
+ answered.resolve(true)
313
+ await flush()
314
+
315
+ expect(old.remoteSdps()).toEqual(["server-answer", "first"])
316
+ expect(replacement.remoteSdps()).toEqual(["server-answer"])
317
+ expect(api.sfuCallAnswerServerOffer).toHaveBeenCalledTimes(1)
318
+ })
319
+
320
+ test("a failed join drops its subscriptions", async () => {
321
+ const api = fakeApi()
322
+ api.sfuCallJoin.mockRejectedValue(new Error("Not a member of this neighbourhood"))
323
+ await expect(new SfuManager(api, ROOM, ME, URL).join(fakeStream())).rejects.toThrow("Not a member")
324
+ expect(api.offerHandlers.size).toBe(0)
325
+ expect(api.rosterHandlers.size).toBe(0)
326
+ expect(api.log).toEqual(expect.arrayContaining(["unsubscribe-offer", "unsubscribe-roster"]))
327
+ })
328
+
329
+ test("a rejoin subscribes again before it releases the old subscriptions", async () => {
330
+ const api = fakeApi()
331
+ const manager = new SfuManager(api, ROOM, ME, URL)
332
+ await manager.join(fakeStream())
333
+ api.log.length = 0
334
+ await manager.join(fakeStream())
335
+ expect(api.log).toEqual([
336
+ "subscribe-offer",
337
+ "subscribe-roster",
338
+ "unsubscribe-offer",
339
+ "unsubscribe-roster",
340
+ "sfuCallJoin",
341
+ ])
342
+ expect(api.offerHandlers.size).toBe(1)
343
+ expect(api.rosterHandlers.size).toBe(1)
344
+ })
345
+
346
+ test("leave releases both subscriptions and ignores a roster delivered after it", async () => {
347
+ const api = fakeApi()
348
+ const { manager, joined, participants } = recordedManager(api)
349
+ await manager.join(fakeStream())
350
+ const lateRoster = [...api.rosterHandlers]
351
+
352
+ await manager.leave()
353
+ expect(api.offerHandlers.size).toBe(0)
354
+ expect(api.rosterHandlers.size).toBe(0)
355
+
356
+ // An event already in flight when the subscription went away.
357
+ for (const handler of lateRoster) handler(roster([ALICE]))
358
+ await flush()
359
+ expect(joined).toEqual([])
360
+ expect(participants()).toEqual([])
361
+ })
362
+
363
+ // ── Membership ────────────────────────────────────────────────────
364
+
365
+ test("a roster names participants before any media arrives, never the agent itself", async () => {
366
+ const api = fakeApi()
367
+ const { manager, joined, participants } = recordedManager(api)
368
+ await manager.join(fakeStream())
369
+
370
+ api.emitRoster(roster([ALICE, ME]))
371
+ await flush()
372
+
373
+ expect(joined).toEqual([ALICE])
374
+ expect(participants()).toEqual([ALICE])
375
+ expect(manager.getParticipants()[0].stream.getTracks()).toEqual([])
376
+ })
377
+
378
+ test("a participant missing from a later roster leaves, and their media sections stop attributing", async () => {
379
+ const api = fakeApi()
380
+ const { manager, joined, left, added, participants } = recordedManager(api)
381
+ await manager.join(fakeStream())
382
+ api.emitOffer(offer("alice", [mapped("0", ALICE, "audio")]))
383
+ api.emitRoster(roster([ALICE, BOB]))
384
+ await flush()
385
+
386
+ api.emitRoster(roster([BOB]))
387
+ await flush()
388
+ expect(left).toEqual([ALICE])
389
+ expect(participants()).toEqual([BOB])
390
+
391
+ currentPc().receive(new FakeTrack("audio"), "0")
392
+ expect(joined).toEqual([ALICE, BOB])
393
+ expect(added).toEqual([])
394
+ expect(participants()).toEqual([BOB])
395
+ })
396
+
397
+ test("a roster that arrives before the join completes applies after it", async () => {
398
+ const api = fakeApi()
399
+ const join = deferred<CallSessionInfo>()
400
+ api.sfuCallJoin.mockImplementation(() => join.promise)
401
+ const { manager, joined } = recordedManager(api)
402
+ const joining = manager.join(fakeStream())
403
+ await flush()
404
+
405
+ api.emitRoster(roster([ALICE]))
406
+ await flush()
407
+ expect(joined).toEqual([])
408
+
409
+ join.resolve(session())
410
+ await joining
411
+ await flush()
412
+ expect(joined).toEqual([ALICE])
413
+ })
414
+
415
+ test("a roster for another room is ignored", async () => {
416
+ const api = fakeApi()
417
+ const { manager, joined } = recordedManager(api)
418
+ await manager.join(fakeStream())
419
+
420
+ api.emitRoster(roster([ALICE], { roomName: "other" }))
421
+ api.emitRoster(roster([BOB], { neighbourhoodUrl: "neighbourhood://other" }))
422
+ await flush()
423
+
424
+ expect(joined).toEqual([])
425
+ })
426
+
427
+ test("the join's stream mapping seeds the participants", async () => {
428
+ const api = fakeApi()
429
+ api.sfuCallJoin.mockResolvedValueOnce(session({ streamMapping: [`p2:${ALICE}`, `p3:${BOB}`] }))
430
+ const { manager, joined, participants } = recordedManager(api)
431
+ await manager.join(fakeStream())
432
+
433
+ expect(joined).toEqual([ALICE, BOB])
434
+ expect(participants()).toEqual([ALICE, BOB])
435
+ })
436
+
437
+ // ── Received media ────────────────────────────────────────────────
438
+
439
+ test("a track on an unmapped media section is ignored", async () => {
440
+ const api = fakeApi()
441
+ const { manager, joined, added, participants } = recordedManager(api)
442
+ await manager.join(fakeStream())
443
+
444
+ currentPc().receive(new FakeTrack("audio"), "7")
445
+ currentPc().receive(new FakeTrack("video"), null)
446
+
447
+ expect(joined).toEqual([])
448
+ expect(added).toEqual([])
449
+ expect(participants()).toEqual([])
450
+ })
451
+
452
+ test("two tracks of one participant land in one participant and one stream", async () => {
453
+ const api = fakeApi()
454
+ const { manager, joined, added } = recordedManager(api)
455
+ await manager.join(fakeStream())
456
+ api.emitOffer(offer("alice", [mapped("0", ALICE, "audio"), mapped("1", ALICE, "video")]))
457
+ await flush()
458
+
459
+ const audio = new FakeTrack("audio")
460
+ const video = new FakeTrack("video")
461
+ currentPc().receive(audio, "0")
462
+ currentPc().receive(video, "1")
463
+
464
+ expect(joined).toEqual([ALICE])
465
+ const [alice] = manager.getParticipants()
466
+ expect(alice.stream.getTracks()).toEqual([audio, video])
467
+ expect(alice.hasAudio).toBe(true)
468
+ expect(alice.hasVideo).toBe(true)
469
+ expect(added).toEqual([[alice.stream, audio], [alice.stream, video]])
470
+ })
471
+
472
+ test("a track that ends leaves its participant's stream", async () => {
473
+ const api = fakeApi()
474
+ const { manager, removed } = recordedManager(api)
475
+ await manager.join(fakeStream())
476
+ api.emitOffer(offer("alice", [mapped("0", ALICE, "audio"), mapped("1", ALICE, "video")]))
477
+ await flush()
478
+ const audio = new FakeTrack("audio")
479
+ const video = new FakeTrack("video")
480
+ currentPc().receive(audio, "0")
481
+ currentPc().receive(video, "1")
482
+
483
+ video.end()
484
+
485
+ const [alice] = manager.getParticipants()
486
+ expect(alice.stream.getTracks()).toEqual([audio])
487
+ expect(removed).toEqual([[alice.stream, video]])
488
+ })
489
+
490
+ // ── Local media ───────────────────────────────────────────────────
491
+
492
+ test("join declares audio and video send-only, video as three simulcast layers", async () => {
493
+ const api = fakeApi()
494
+ const mic = new FakeTrack("audio")
495
+ const stream = fakeStream(mic)
496
+ await new SfuManager(api, ROOM, ME, URL).join(stream)
497
+
498
+ // No video track yet: the section is declared by kind.
499
+ expect(currentPc().transceivers.map((t) => [t.trackOrKind, t.init])).toEqual([
500
+ [mic, { direction: "sendonly", streams: [stream] }],
501
+ [
502
+ "video",
503
+ {
504
+ direction: "sendonly",
505
+ streams: [stream],
506
+ sendEncodings: [
507
+ expect.objectContaining({ rid: "high" }),
508
+ expect.objectContaining({ rid: "medium" }),
509
+ expect.objectContaining({ rid: "low" }),
510
+ ],
511
+ },
512
+ ],
513
+ ])
514
+ })
515
+
516
+ test("replaceTrack uses the sender declared at join, even for a kind the join had no track of", async () => {
517
+ const api = fakeApi()
518
+ const manager = new SfuManager(api, ROOM, ME, URL)
519
+ await manager.join(fakeStream(new FakeTrack("audio")))
520
+ const pc = currentPc()
521
+ const [audioSender, videoSender] = pc.transceivers.map((t) => t.sender)
522
+
523
+ const camera = new FakeTrack("video")
524
+ await manager.replaceTrack("video", camera as unknown as MediaStreamTrack)
525
+ await manager.replaceTrack("audio", null)
526
+
527
+ expect(videoSender.replaceTrack.mock.calls).toEqual([[camera]])
528
+ expect(audioSender.replaceTrack.mock.calls).toEqual([[null]])
529
+ // No new section and no renegotiation.
530
+ expect(pc.transceivers).toHaveLength(2)
531
+ expect(pc.offersCreated).toBe(1)
532
+ })
533
+
534
+ // ── Reconnecting ──────────────────────────────────────────────────
535
+
536
+ test("a failed connection leaves, then joins this executor again", async () => {
537
+ const api = fakeApi()
538
+ const manager = new SfuManager(api, ROOM, ME, URL)
539
+ await manager.join(fakeStream())
540
+ api.log.length = 0
541
+
542
+ const failed = currentPc()
543
+ await iceState("failed")
544
+
545
+ expect(failed.closed).toBe(true)
546
+ expect(api.log).toEqual([
547
+ "unsubscribe-offer",
548
+ "unsubscribe-roster",
549
+ "sfuCallLeave",
550
+ "subscribe-offer",
551
+ "subscribe-roster",
552
+ "sfuCallJoin",
553
+ ])
554
+ expect(api.sfuCallJoin).toHaveBeenLastCalledWith(URL, ROOM, expect.any(String))
555
+ expect(FakePeerConnection.instances).toHaveLength(2)
556
+ })
557
+
558
+ test("a rejoin the executor cannot take yet is retried, and succeeds once it can", async () => {
559
+ // A restart or an outage: the executor refuses for a while, then is back.
560
+ jest.useFakeTimers({ doNotFake: ["queueMicrotask", "nextTick", "setImmediate"] })
561
+ try {
562
+ const api = fakeApi()
563
+ const manager = new SfuManager(api, ROOM, ME, URL)
564
+ const errors: unknown[] = []
565
+ manager.on("error", (e) => errors.push(e))
566
+ await manager.join(fakeStream())
567
+ api.sfuCallJoin.mockRejectedValueOnce(new Error("unreachable")).mockRejectedValueOnce(new Error("unreachable"))
568
+
569
+ await iceState("failed")
570
+ for (let i = 0; i < 4; i++) {
571
+ await jest.advanceTimersByTimeAsync(5_000)
572
+ }
573
+
574
+ expect(api.sfuCallJoin).toHaveBeenCalledTimes(4)
575
+ expect(errors).toEqual([])
576
+ expect(currentPc().closed).toBe(false)
577
+ } finally {
578
+ jest.useRealTimers()
579
+ }
580
+ })
581
+
582
+ test("a rejoin that keeps failing reports the error after the window, its connections closed", async () => {
583
+ jest.useFakeTimers({ doNotFake: ["queueMicrotask", "nextTick", "setImmediate"] })
584
+ try {
585
+ const api = fakeApi()
586
+ const manager = new SfuManager(api, ROOM, ME, URL)
587
+ const errors: unknown[] = []
588
+ manager.on("error", (e) => errors.push(e))
589
+ await manager.join(fakeStream())
590
+ api.sfuCallJoin.mockRejectedValue(new Error("Room is full"))
591
+
592
+ await iceState("failed")
593
+ await jest.advanceTimersByTimeAsync(130_000)
594
+
595
+ expect(errors).toEqual([new Error("Room is full")])
596
+ expect(FakePeerConnection.instances.every((pc) => pc.closed)).toBe(true)
597
+ } finally {
598
+ jest.useRealTimers()
599
+ }
600
+ })
601
+
602
+ test("joins that succeed while ICE keeps failing stop after three reconnects", async () => {
603
+ const api = fakeApi()
604
+ const manager = new SfuManager(api, ROOM, ME, URL)
605
+ const errors: unknown[] = []
606
+ manager.on("error", (e) => errors.push(e))
607
+ await manager.join(fakeStream())
608
+
609
+ for (let i = 0; i < 4; i++) await iceState("failed")
610
+
611
+ expect(api.sfuCallLeave).toHaveBeenCalledTimes(3)
612
+ expect(errors).toEqual([new Error("SFU reconnect attempts exhausted")])
613
+ })
614
+
615
+ test("a connection that comes up resets the reconnect count", async () => {
616
+ const api = fakeApi()
617
+ const manager = new SfuManager(api, ROOM, ME, URL)
618
+ const errors: unknown[] = []
619
+ manager.on("error", (e) => errors.push(e))
620
+ await manager.join(fakeStream())
621
+
622
+ for (let i = 0; i < 6; i++) {
623
+ await iceState("failed")
624
+ await iceState("connected")
625
+ }
626
+
627
+ expect(api.sfuCallLeave).toHaveBeenCalledTimes(6)
628
+ expect(errors).toEqual([])
629
+ })
630
+
631
+ test("a rebuilt connection sends the tracks replaceTrack set and restores the quality preference", async () => {
632
+ const api = fakeApi()
633
+ const manager = new SfuManager(api, ROOM, ME, URL)
634
+ const screen = new FakeTrack("video")
635
+ await manager.join(fakeStream(new FakeTrack("audio"), new FakeTrack("video")))
636
+ await manager.replaceTrack("video", screen as unknown as MediaStreamTrack)
637
+ await manager.replaceTrack("audio", null)
638
+ await manager.setQualityPreference("low")
639
+
640
+ await iceState("failed")
641
+
642
+ expect(currentPc().transceivers.map((t) => t.trackOrKind)).toEqual(["audio", screen])
643
+ expect(api.sfuCallSetQualityPreference.mock.calls).toEqual([
644
+ [URL, ROOM, "low"],
645
+ [URL, ROOM, "low"],
646
+ ])
647
+ })
648
+
649
+ test("leave forgets replaced tracks, so the next join sends its own stream", async () => {
650
+ const api = fakeApi()
651
+ const manager = new SfuManager(api, ROOM, ME, URL)
652
+ await manager.join(fakeStream())
653
+ await manager.replaceTrack("video", new FakeTrack("video") as unknown as MediaStreamTrack)
654
+ await manager.leave()
655
+
656
+ const camera = new FakeTrack("video")
657
+ await manager.join(fakeStream(camera))
658
+
659
+ expect(currentPc().transceivers.map((t) => t.trackOrKind)).toEqual(["audio", camera])
660
+ })
661
+
662
+ test("leaving during a reconnect stops it before it joins again", async () => {
663
+ const api = fakeApi()
664
+ const manager = new SfuManager(api, ROOM, ME, URL)
665
+ await manager.join(fakeStream())
666
+ let releaseLeave!: () => void
667
+ api.sfuCallLeave.mockImplementationOnce(
668
+ () => new Promise((resolve) => { releaseLeave = () => resolve(true) }),
669
+ )
670
+
671
+ await iceState("failed")
672
+ await manager.leave()
673
+ releaseLeave()
674
+ await flush()
675
+
676
+ expect(api.sfuCallJoin).toHaveBeenCalledTimes(1)
677
+ })