Skip to content

Commit c89af39

Browse files
Khader-1gnprice
authored andcommitted
api [nfc]: Rename StreamEvent to ChannelEvent, and subclasses
Fixes parts of zulip#631
1 parent 6b99a72 commit c89af39

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

lib/api/model/events.dart

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ sealed class Event {
3737
}
3838
case 'stream':
3939
switch (json['op'] as String) {
40-
case 'create': return StreamCreateEvent.fromJson(json);
41-
case 'delete': return StreamDeleteEvent.fromJson(json);
40+
case 'create': return ChannelCreateEvent.fromJson(json);
41+
case 'delete': return ChannelDeleteEvent.fromJson(json);
4242
// TODO(#182): case 'update': …
4343
default: return UnexpectedEvent.fromJson(json);
4444
}
@@ -332,51 +332,51 @@ class RealmUserUpdateEvent extends RealmUserEvent {
332332
///
333333
/// The corresponding API docs are in several places for
334334
/// different values of `op`; see subclasses.
335-
sealed class StreamEvent extends Event {
335+
sealed class ChannelEvent extends Event {
336336
@override
337337
@JsonKey(includeToJson: true)
338338
String get type => 'stream';
339339

340340
String get op;
341341

342-
StreamEvent({required super.id});
342+
ChannelEvent({required super.id});
343343
}
344344

345-
/// A [StreamEvent] with op `create`: https://zulip.com/api/get-events#stream-create
345+
/// A [ChannelEvent] with op `create`: https://zulip.com/api/get-events#stream-create
346346
@JsonSerializable(fieldRename: FieldRename.snake)
347-
class StreamCreateEvent extends StreamEvent {
347+
class ChannelCreateEvent extends ChannelEvent {
348348
@override
349349
String get op => 'create';
350350

351351
final List<ZulipStream> streams;
352352

353-
StreamCreateEvent({required super.id, required this.streams});
353+
ChannelCreateEvent({required super.id, required this.streams});
354354

355-
factory StreamCreateEvent.fromJson(Map<String, dynamic> json) =>
356-
_$StreamCreateEventFromJson(json);
355+
factory ChannelCreateEvent.fromJson(Map<String, dynamic> json) =>
356+
_$ChannelCreateEventFromJson(json);
357357

358358
@override
359-
Map<String, dynamic> toJson() => _$StreamCreateEventToJson(this);
359+
Map<String, dynamic> toJson() => _$ChannelCreateEventToJson(this);
360360
}
361361

362-
/// A [StreamEvent] with op `delete`: https://zulip.com/api/get-events#stream-delete
362+
/// A [ChannelEvent] with op `delete`: https://zulip.com/api/get-events#stream-delete
363363
@JsonSerializable(fieldRename: FieldRename.snake)
364-
class StreamDeleteEvent extends StreamEvent {
364+
class ChannelDeleteEvent extends ChannelEvent {
365365
@override
366366
String get op => 'delete';
367367

368368
final List<ZulipStream> streams;
369369

370-
StreamDeleteEvent({required super.id, required this.streams});
370+
ChannelDeleteEvent({required super.id, required this.streams});
371371

372-
factory StreamDeleteEvent.fromJson(Map<String, dynamic> json) =>
373-
_$StreamDeleteEventFromJson(json);
372+
factory ChannelDeleteEvent.fromJson(Map<String, dynamic> json) =>
373+
_$ChannelDeleteEventFromJson(json);
374374

375375
@override
376-
Map<String, dynamic> toJson() => _$StreamDeleteEventToJson(this);
376+
Map<String, dynamic> toJson() => _$ChannelDeleteEventToJson(this);
377377
}
378378

379-
// TODO(#182) StreamUpdateEvent, for a [StreamEvent] with op `update`:
379+
// TODO(#182) ChannelUpdateEvent, for a [ChannelEvent] with op `update`:
380380
// https://zulip.com/api/get-events#stream-update
381381

382382
/// A Zulip event of type `subscription`.

lib/api/model/events.g.dart

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/model/channel.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ class ChannelStoreImpl with ChannelStore {
129129
return false;
130130
}
131131

132-
void handleStreamEvent(StreamEvent event) {
132+
void handleChannelEvent(ChannelEvent event) {
133133
switch (event) {
134-
case StreamCreateEvent():
134+
case ChannelCreateEvent():
135135
assert(event.streams.every((stream) =>
136136
!streams.containsKey(stream.streamId)
137137
&& !streamsByName.containsKey(stream.name)));
@@ -140,7 +140,7 @@ class ChannelStoreImpl with ChannelStore {
140140
// (Don't touch `subscriptions`. If the user is subscribed to the stream,
141141
// details will come in a later `subscription` event.)
142142

143-
case StreamDeleteEvent():
143+
case ChannelDeleteEvent():
144144
for (final stream in event.streams) {
145145
assert(identical(streams[stream.streamId], streamsByName[stream.name]));
146146
assert(subscriptions[stream.streamId] == null

lib/model/store.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -477,9 +477,9 @@ class PerAccountStore extends ChangeNotifier with ChannelStore, MessageStore {
477477
autocompleteViewManager.handleRealmUserUpdateEvent(event);
478478
notifyListeners();
479479

480-
case StreamEvent():
480+
case ChannelEvent():
481481
assert(debugLog("server event: stream/${event.op}"));
482-
_channels.handleStreamEvent(event);
482+
_channels.handleChannelEvent(event);
483483
notifyListeners();
484484

485485
case SubscriptionEvent():

test/model/test_store.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ extension PerAccountStoreTestExtension on PerAccountStore {
134134
}
135135

136136
Future<void> addStreams(List<ZulipStream> streams) async {
137-
await handleEvent(StreamCreateEvent(id: 1, streams: streams));
137+
await handleEvent(ChannelCreateEvent(id: 1, streams: streams));
138138
}
139139

140140
Future<void> addSubscription(Subscription subscription) async {

test/widgets/message_list_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ void main() {
406406

407407
testWidgets('show stream name from stream data when known', (tester) async {
408408
final streamBefore = eg.stream(name: 'old stream name');
409-
// TODO(#182) this test would be more realistic using a StreamUpdateEvent
409+
// TODO(#182) this test would be more realistic using a ChannelUpdateEvent
410410
final streamAfter = ZulipStream.fromJson({
411411
...(deepToJson(streamBefore) as Map<String, dynamic>),
412412
'name': 'new stream name',

0 commit comments

Comments
 (0)