-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The three legacy cases will need to be dropped separately at different server versions. The tests will fail accordingly as we do that. Signed-off-by: Zixuan James Li <[email protected]>
- Loading branch information
Showing
4 changed files
with
135 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
import '../core.dart'; | ||
import '../model/events.dart'; | ||
import 'messages.dart'; | ||
|
||
|
||
/// https://zulip.com/api/set-typing-status | ||
Future<void> setTypingStatus(ApiConnection connection, { | ||
required TypingOp op, | ||
required MessageDestination destination, | ||
}) { | ||
switch (destination) { | ||
case StreamDestination(): | ||
final supportsTypeChannel = connection.zulipFeatureLevel! >= 248; // TODO(server-9) | ||
final supportsStreamId = connection.zulipFeatureLevel! >= 215; // TODO(server-8) | ||
return connection.post('setTypingStatus', (_) {}, 'typing', { | ||
'op': RawParameter(op.toJson()), | ||
'type': RawParameter(supportsTypeChannel ? 'channel' : 'stream'), | ||
if (supportsStreamId) 'stream_id': destination.streamId | ||
else 'to': [destination.streamId], | ||
'topic': RawParameter(destination.topic), | ||
}); | ||
case DmDestination(): | ||
final supportsDirect = connection.zulipFeatureLevel! >= 174; // TODO(server-7) | ||
return connection.post('setTypingStatus', (_) {}, 'typing', { | ||
'op': RawParameter(op.toJson()), | ||
'type': RawParameter(supportsDirect ? 'direct' : 'private'), | ||
'to': destination.userIds, | ||
}); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
import 'dart:convert'; | ||
|
||
import 'package:http/http.dart' as http; | ||
import 'package:checks/checks.dart'; | ||
import 'package:flutter_test/flutter_test.dart'; | ||
import 'package:zulip/api/model/events.dart'; | ||
import 'package:zulip/api/route/messages.dart'; | ||
import 'package:zulip/api/route/typing.dart'; | ||
|
||
import '../../stdlib_checks.dart'; | ||
import '../fake_api.dart'; | ||
|
||
void main() { | ||
const streamId = 123; | ||
const topic = 'topic'; | ||
const userIds = [101, 102, 103]; | ||
|
||
Future<void> checkSetTypingStatus(FakeApiConnection connection, | ||
TypingOp op, { | ||
required MessageDestination destination, | ||
required Map<String, String> expectedBodyFields, | ||
}) async { | ||
connection.prepare(json: {}); | ||
await setTypingStatus(connection, op: op, destination: destination); | ||
check(connection.lastRequest).isA<http.Request>() | ||
..method.equals('POST') | ||
..url.path.equals('/api/v1/typing') | ||
..bodyFields.deepEquals(expectedBodyFields); | ||
} | ||
|
||
Future<void> checkSetTypingStatusForTopic(TypingOp op, String expectedOp) { | ||
return FakeApiConnection.with_((connection) { | ||
return checkSetTypingStatus(connection, op, | ||
destination: const StreamDestination(streamId, topic), | ||
expectedBodyFields: { | ||
'op': expectedOp, | ||
'type': 'channel', | ||
'stream_id': streamId.toString(), | ||
'topic': topic, | ||
}); | ||
}); | ||
} | ||
|
||
test('send typing status start for topic', () { | ||
return checkSetTypingStatusForTopic(TypingOp.start, 'start'); | ||
}); | ||
|
||
test('send typing status stop for topic', () { | ||
return checkSetTypingStatusForTopic(TypingOp.stop, 'stop'); | ||
}); | ||
|
||
test('send typing status start for dm', () { | ||
return FakeApiConnection.with_((connection) { | ||
return checkSetTypingStatus(connection, TypingOp.start, | ||
destination: const DmDestination(userIds: userIds), | ||
expectedBodyFields: { | ||
'op': 'start', | ||
'type': 'direct', | ||
'to': jsonEncode(userIds), | ||
}); | ||
}); | ||
}); | ||
|
||
test('legacy: use "stream" instead of "channel"', () { | ||
return FakeApiConnection.with_(zulipFeatureLevel: 247, (connection) { | ||
return checkSetTypingStatus(connection, TypingOp.start, | ||
destination: const StreamDestination(streamId, topic), | ||
expectedBodyFields: { | ||
'op': 'start', | ||
'type': 'stream', | ||
'stream_id': streamId.toString(), | ||
'topic': topic, | ||
}); | ||
}); | ||
}); | ||
|
||
test('legacy: use to=[streamId] instead of stream_id=streamId', () { | ||
return FakeApiConnection.with_(zulipFeatureLevel: 214, (connection) { | ||
return checkSetTypingStatus(connection, TypingOp.start, | ||
destination: const StreamDestination(streamId, topic), | ||
expectedBodyFields: { | ||
'op': 'start', | ||
'type': 'stream', | ||
'to': jsonEncode([streamId]), | ||
'topic': topic, | ||
}); | ||
}); | ||
}); | ||
|
||
test('legacy: use "private" instead of "direct"', () { | ||
return FakeApiConnection.with_(zulipFeatureLevel: 173, (connection) { | ||
return checkSetTypingStatus(connection, TypingOp.start, | ||
destination: const DmDestination(userIds: userIds), | ||
expectedBodyFields: { | ||
'op': 'start', | ||
'type': 'private', | ||
'to': jsonEncode(userIds), | ||
}); | ||
}); | ||
}); | ||
} |