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
|
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.isPollEvent = exports.PollEvent = exports.Poll = void 0;
var _matrixEventsSdk = require("matrix-events-sdk");
var _polls = require("../@types/polls");
var _relations = require("./relations");
var _typedEventEmitter = require("./typed-event-emitter");
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
let PollEvent = /*#__PURE__*/function (PollEvent) {
PollEvent["New"] = "Poll.new";
PollEvent["End"] = "Poll.end";
PollEvent["Update"] = "Poll.update";
PollEvent["Responses"] = "Poll.Responses";
PollEvent["Destroy"] = "Poll.Destroy";
PollEvent["UndecryptableRelations"] = "Poll.UndecryptableRelations";
return PollEvent;
}({});
exports.PollEvent = PollEvent;
const filterResponseRelations = (relationEvents, pollEndTimestamp) => {
const responseEvents = relationEvents.filter(event => {
if (event.isDecryptionFailure()) {
return;
}
return _polls.M_POLL_RESPONSE.matches(event.getType()) &&
// From MSC3381:
// "Votes sent on or before the end event's timestamp are valid votes"
event.getTs() <= pollEndTimestamp;
});
return {
responseEvents
};
};
class Poll extends _typedEventEmitter.TypedEventEmitter {
constructor(rootEvent, matrixClient, room) {
super();
this.rootEvent = rootEvent;
this.matrixClient = matrixClient;
this.room = room;
_defineProperty(this, "roomId", void 0);
_defineProperty(this, "pollEvent", void 0);
_defineProperty(this, "_isFetchingResponses", false);
_defineProperty(this, "relationsNextBatch", void 0);
_defineProperty(this, "responses", null);
_defineProperty(this, "endEvent", void 0);
/**
* Keep track of undecryptable relations
* As incomplete result sets affect poll results
*/
_defineProperty(this, "undecryptableRelationEventIds", new Set());
_defineProperty(this, "countUndecryptableEvents", events => {
const undecryptableEventIds = events.filter(event => event.isDecryptionFailure()).map(event => event.getId());
const previousCount = this.undecryptableRelationsCount;
this.undecryptableRelationEventIds = new Set([...this.undecryptableRelationEventIds, ...undecryptableEventIds]);
if (this.undecryptableRelationsCount !== previousCount) {
this.emit(PollEvent.UndecryptableRelations, this.undecryptableRelationsCount);
}
});
if (!this.rootEvent.getRoomId() || !this.rootEvent.getId()) {
throw new Error("Invalid poll start event.");
}
this.roomId = this.rootEvent.getRoomId();
this.pollEvent = this.rootEvent.unstableExtensibleEvent;
}
get pollId() {
return this.rootEvent.getId();
}
get endEventId() {
return this.endEvent?.getId();
}
get isEnded() {
return !!this.endEvent;
}
get isFetchingResponses() {
return this._isFetchingResponses;
}
get undecryptableRelationsCount() {
return this.undecryptableRelationEventIds.size;
}
async getResponses() {
// if we have already fetched some responses
// just return them
if (this.responses) {
return this.responses;
}
// if there is no fetching in progress
// start fetching
if (!this.isFetchingResponses) {
await this.fetchResponses();
}
// return whatever responses we got from the first page
return this.responses;
}
/**
*
* @param event - event with a relation to the rootEvent
* @returns void
*/
onNewRelation(event) {
if (_polls.M_POLL_END.matches(event.getType()) && this.validateEndEvent(event)) {
this.endEvent = event;
this.refilterResponsesOnEnd();
this.emit(PollEvent.End);
}
// wait for poll responses to be initialised
if (!this.responses) {
return;
}
const pollEndTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;
const {
responseEvents
} = filterResponseRelations([event], pollEndTimestamp);
this.countUndecryptableEvents([event]);
if (responseEvents.length) {
responseEvents.forEach(event => {
this.responses.addEvent(event);
});
this.emit(PollEvent.Responses, this.responses);
}
}
async fetchResponses() {
this._isFetchingResponses = true;
// we want:
// - stable and unstable M_POLL_RESPONSE
// - stable and unstable M_POLL_END
// so make one api call and filter by event type client side
const allRelations = await this.matrixClient.relations(this.roomId, this.rootEvent.getId(), "m.reference", undefined, {
from: this.relationsNextBatch || undefined
});
await Promise.all(allRelations.events.map(event => this.matrixClient.decryptEventIfNeeded(event)));
const responses = this.responses || new _relations.Relations("m.reference", _polls.M_POLL_RESPONSE.name, this.matrixClient, [_polls.M_POLL_RESPONSE.altName]);
const pollEndEvent = allRelations.events.find(event => _polls.M_POLL_END.matches(event.getType()));
if (this.validateEndEvent(pollEndEvent)) {
this.endEvent = pollEndEvent;
this.refilterResponsesOnEnd();
this.emit(PollEvent.End);
}
const pollCloseTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;
const {
responseEvents
} = filterResponseRelations(allRelations.events, pollCloseTimestamp);
responseEvents.forEach(event => {
responses.addEvent(event);
});
this.relationsNextBatch = allRelations.nextBatch ?? undefined;
this.responses = responses;
this.countUndecryptableEvents(allRelations.events);
// while there are more pages of relations
// fetch them
if (this.relationsNextBatch) {
// don't await
// we want to return the first page as soon as possible
this.fetchResponses();
} else {
// no more pages
this._isFetchingResponses = false;
}
// emit after updating _isFetchingResponses state
this.emit(PollEvent.Responses, this.responses);
}
/**
* Only responses made before the poll ended are valid
* Refilter after an end event is recieved
* To ensure responses are valid
*/
refilterResponsesOnEnd() {
if (!this.responses) {
return;
}
const pollEndTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;
this.responses.getRelations().forEach(event => {
if (event.getTs() > pollEndTimestamp) {
this.responses?.removeEvent(event);
}
});
this.emit(PollEvent.Responses, this.responses);
}
validateEndEvent(endEvent) {
if (!endEvent) {
return false;
}
/**
* Repeated end events are ignored -
* only the first (valid) closure event by origin_server_ts is counted.
*/
if (this.endEvent && this.endEvent.getTs() < endEvent.getTs()) {
return false;
}
/**
* MSC3381
* If a m.poll.end event is received from someone other than the poll creator or user with permission to redact
* others' messages in the room, the event must be ignored by clients due to being invalid.
*/
const roomCurrentState = this.room.currentState;
const endEventSender = endEvent.getSender();
return !!endEventSender && (endEventSender === this.rootEvent.getSender() || roomCurrentState.maySendRedactionForEvent(this.rootEvent, endEventSender));
}
}
/**
* Tests whether the event is a start, response or end poll event.
*
* @param event - Event to test
* @returns true if the event is a poll event, else false
*/
exports.Poll = Poll;
const isPollEvent = event => {
const eventType = event.getType();
return _matrixEventsSdk.M_POLL_START.matches(eventType) || _polls.M_POLL_RESPONSE.matches(eventType) || _polls.M_POLL_END.matches(eventType);
};
exports.isPollEvent = isPollEvent;
|
