1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
"""
Defines the RealtimePresence class and its dependencies.
"""
import logging
from typing import Any, Callable, Dict, List, Optional, Union
from ..types import (
PresenceDiff,
PresenceEvents,
PresenceOnJoinCallback,
PresenceOnLeaveCallback,
PresenceOpts,
RawPresenceDiff,
RawPresenceState,
RealtimePresenceState,
)
logger = logging.getLogger(__name__)
class AsyncRealtimePresence:
def __init__(self, channel, opts: Optional[PresenceOpts] = None):
self.channel = channel
self.state: RealtimePresenceState = {}
self.pending_diffs: List[RawPresenceDiff] = []
self.join_ref: Optional[str] = None
self.caller = {
"onJoin": lambda *args: None,
"onLeave": lambda *args: None,
"onSync": lambda: None,
"onAuthSuccess": lambda: None,
"onAuthFailure": lambda: None,
}
# Initialize with default events if not provided
events = (
opts.events
if opts
else PresenceEvents(state="presence_state", diff="presence_diff")
)
# Set up event listeners for presence state and diff
self.channel._on(events.state, callback=self._on_state_event)
self.channel._on(events.diff, callback=self._on_diff_event)
self.channel._on("phx_auth", callback=self._on_auth_event)
def on_join(self, callback: PresenceOnJoinCallback):
self.caller["onJoin"] = callback
def on_leave(self, callback: PresenceOnLeaveCallback):
self.caller["onLeave"] = callback
def on_sync(self, callback: Callable[[], None]):
self.caller["onSync"] = callback
def on_auth_success(self, callback: Callable[[], None]):
self.caller["onAuthSuccess"] = callback
def on_auth_failure(self, callback: Callable[[], None]):
self.caller["onAuthFailure"] = callback
def _on_state_event(self, payload: RawPresenceState, *args):
onJoin = self.caller["onJoin"]
onLeave = self.caller["onLeave"]
onSync = self.caller["onSync"]
self.join_ref = self.channel.join_ref
self.state = self._sync_state(self.state, payload, onJoin, onLeave)
for diff in self.pending_diffs:
self.state = self._sync_diff(self.state, diff, onJoin, onLeave)
self.pending_diffs = []
onSync()
def _on_diff_event(self, payload: Dict[str, Any], *args):
onJoin = self.caller["onJoin"]
onLeave = self.caller["onLeave"]
onSync = self.caller["onSync"]
if self.in_pending_sync_state():
self.pending_diffs.append(payload)
else:
self.state = self._sync_diff(self.state, payload, onJoin, onLeave)
onSync()
def _on_auth_event(self, payload: Dict[str, Any], *args):
if payload.get("status") == "ok":
self.caller["onAuthSuccess"]()
else:
self.caller["onAuthFailure"]()
def _sync_state(
self,
current_state: RealtimePresenceState,
new_state: Union[RawPresenceState, RealtimePresenceState],
onJoin: PresenceOnJoinCallback,
onLeave: PresenceOnLeaveCallback,
) -> RealtimePresenceState:
state = {key: list(value) for key, value in current_state.items()}
transformed_state = AsyncRealtimePresence._transform_state(new_state)
joins: Dict[str, Any] = {}
leaves: Dict[str, Any] = {
k: v for k, v in state.items() if k not in transformed_state
}
for key, value in transformed_state.items():
current_presences = state.get(key, [])
if len(current_presences) > 0:
new_presence_refs = {presence.get("presence_ref") for presence in value}
cur_presence_refs = {
presence.get("presence_ref") for presence in current_presences
}
joined_presences = [
p for p in value if p.get("presence_ref") not in cur_presence_refs
]
left_presences = [
p
for p in current_presences
if p.get("presence_ref") not in new_presence_refs
]
if joined_presences:
joins[key] = joined_presences
if left_presences:
leaves[key] = left_presences
else:
joins[key] = value
return self._sync_diff(
state, {"joins": joins, "leaves": leaves}, onJoin, onLeave
)
def _sync_diff(
self,
state: RealtimePresenceState,
diff: Union[RawPresenceDiff, PresenceDiff],
onJoin: PresenceOnJoinCallback,
onLeave: PresenceOnLeaveCallback,
) -> RealtimePresenceState:
joins = AsyncRealtimePresence._transform_state(diff.get("joins", {}))
leaves = AsyncRealtimePresence._transform_state(diff.get("leaves", {}))
for key, new_presences in joins.items():
current_presences = state.get(key, [])
state[key] = new_presences
if len(current_presences) > 0:
joined_presence_refs = {
presence.get("presence_ref") for presence in state.get(key)
}
cur_presences = list(
presence
for presence in current_presences
if presence.get("presence_ref") not in joined_presence_refs
)
state[key] = cur_presences + state[key]
onJoin(key, current_presences, new_presences)
for key, left_presences in leaves.items():
current_presences = state.get(key, [])
if len(current_presences) == 0:
break
presence_refs_to_remove = {
presence.get("presence_ref") for presence in left_presences
}
current_presences = [
presence
for presence in current_presences
if presence.get("presence_ref") not in presence_refs_to_remove
]
state[key] = current_presences
onLeave(key, current_presences, left_presences)
if len(current_presences) == 0:
del state[key]
return state
def in_pending_sync_state(self) -> bool:
return self.join_ref is None or self.join_ref != self.channel.join_ref
@staticmethod
def _transform_state(
state: Union[RawPresenceState, RealtimePresenceState]
) -> RealtimePresenceState:
"""
Transform the raw presence state into a standardized RealtimePresenceState format.
This method processes the input state, which can be either a RawPresenceState or
an already transformed RealtimePresenceState. It handles the conversion of the
Phoenix channel's presence format to our internal representation.
Args:
state (Union[RawPresenceState, RealtimePresenceState[T]]): The presence state to transform.
Returns:
RealtimePresenceState[T]: The transformed presence state.
Example:
Input (RawPresenceState):
{
"user1": {
"metas": [
{"phx_ref": "ABC123", "user_id": "user1", "status": "online"},
{"phx_ref": "DEF456", "phx_ref_prev": "ABC123", "user_id": "user1", "status": "away"}
]
},
"user2": [{"user_id": "user2", "status": "offline"}]
}
Output (RealtimePresenceState):
{
"user1": [
{"presence_ref": "ABC123", "user_id": "user1", "status": "online"},
{"presence_ref": "DEF456", "user_id": "user1", "status": "away"}
],
"user2": [{"user_id": "user2", "status": "offline"}]
}
"""
new_state: RealtimePresenceState = {}
for key, presences in state.items():
if isinstance(presences, dict) and "metas" in presences:
new_state[key] = []
for presence in presences["metas"]:
presence["presence_ref"] = presence.pop("phx_ref", None)
presence.pop("phx_ref_prev", None)
new_state[key].append(presence)
else:
new_state[key] = presences
return new_state
|
