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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'dart:io';
import 'dart:typed_data';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/daemon.dart';
import 'package:flutter_tools/src/proxied_devices/devices.dart';
import 'package:test/fake.dart';
import '../../src/common.dart';
void main() {
late BufferLogger bufferLogger;
late DaemonConnection serverDaemonConnection;
late DaemonConnection clientDaemonConnection;
setUp(() {
bufferLogger = BufferLogger.test();
final FakeDaemonStreams serverDaemonStreams = FakeDaemonStreams();
serverDaemonConnection = DaemonConnection(
daemonStreams: serverDaemonStreams,
logger: bufferLogger,
);
final FakeDaemonStreams clientDaemonStreams = FakeDaemonStreams();
clientDaemonConnection = DaemonConnection(
daemonStreams: clientDaemonStreams,
logger: bufferLogger,
);
serverDaemonStreams.inputs.addStream(clientDaemonStreams.outputs.stream);
clientDaemonStreams.inputs.addStream(serverDaemonStreams.outputs.stream);
});
tearDown(() async {
await serverDaemonConnection.dispose();
await clientDaemonConnection.dispose();
});
group('ProxiedPortForwarder', () {
testWithoutContext('works correctly without device id', () async {
final FakeServerSocket fakeServerSocket = FakeServerSocket(200);
final ProxiedPortForwarder portForwarder = ProxiedPortForwarder(
clientDaemonConnection,
logger: bufferLogger,
createSocketServer: (Logger logger, int? hostPort) async =>
fakeServerSocket,
);
final int result = await portForwarder.forward(100);
expect(result, 200);
final FakeSocket fakeSocket = FakeSocket();
fakeServerSocket.controller.add(fakeSocket);
final Stream<DaemonMessage> broadcastOutput = serverDaemonConnection.incomingCommands.asBroadcastStream();
DaemonMessage message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'proxy.connect');
expect(message.data['params'], <String, Object?>{'port': 100});
const String id = 'random_id';
serverDaemonConnection.sendResponse(message.data['id']!, id);
// Forwards the data received from socket to daemon.
fakeSocket.controller.add(Uint8List.fromList(<int>[1, 2, 3]));
message = await broadcastOutput.first;
expect(message.data['method'], 'proxy.write');
expect(message.data['params'], <String, Object?>{'id': id});
expect(message.binary, isNotNull);
final List<List<int>> binary = await message.binary!.toList();
expect(binary, <List<int>>[<int>[1, 2, 3]]);
// Forwards data received as event to socket.
expect(fakeSocket.addedData.isEmpty, true);
serverDaemonConnection.sendEvent('proxy.data.$id', null, <int>[4, 5, 6]);
await pumpEventQueue();
expect(fakeSocket.addedData.isNotEmpty, true);
expect(fakeSocket.addedData[0], <int>[4, 5, 6]);
// Closes the socket after the remote end disconnects
expect(fakeSocket.closeCalled, false);
serverDaemonConnection.sendEvent('proxy.disconnected.$id');
await pumpEventQueue();
expect(fakeSocket.closeCalled, true);
});
testWithoutContext('forwards the port from the remote end with device id', () async {
final FakeServerSocket fakeServerSocket = FakeServerSocket(400);
final ProxiedPortForwarder portForwarder = ProxiedPortForwarder(
clientDaemonConnection,
deviceId: 'device_id',
logger: bufferLogger,
createSocketServer: (Logger logger, int? hostPort) async =>
fakeServerSocket,
);
final Stream<DaemonMessage> broadcastOutput = serverDaemonConnection.incomingCommands.asBroadcastStream();
final Future<int> result = portForwarder.forward(300);
DaemonMessage message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'device.forward');
expect(message.data['params'], <String, Object?>{'deviceId': 'device_id', 'devicePort': 300});
serverDaemonConnection.sendResponse(message.data['id']!, <String, Object?>{'hostPort': 350});
expect(await result, 400);
final FakeSocket fakeSocket = FakeSocket();
fakeServerSocket.controller.add(fakeSocket);
message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'proxy.connect');
expect(message.data['params'], <String, Object?>{'port': 350});
const String id = 'random_id';
serverDaemonConnection.sendResponse(message.data['id']!, id);
// Unforward will try to disconnect the remote port.
portForwarder.forwardedPorts.single.dispose();
expect(fakeServerSocket.closeCalled, true);
message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'device.unforward');
expect(message.data['params'], <String, Object?>{
'deviceId': 'device_id',
'devicePort': 300,
'hostPort': 350,
});
});
group('socket done', () {
late Stream<DaemonMessage> broadcastOutput;
late FakeSocket fakeSocket;
const String id = 'random_id';
setUp(() async {
final FakeServerSocket fakeServerSocket = FakeServerSocket(400);
final ProxiedPortForwarder portForwarder = ProxiedPortForwarder(
clientDaemonConnection,
deviceId: 'device_id',
logger: bufferLogger,
createSocketServer: (Logger logger, int? hostPort) async =>
fakeServerSocket,
);
broadcastOutput = serverDaemonConnection.incomingCommands.asBroadcastStream();
unawaited(portForwarder.forward(300));
// Consumes the message.
DaemonMessage message = await broadcastOutput.first;
serverDaemonConnection.sendResponse(message.data['id']!, <String, Object?>{'hostPort': 350});
fakeSocket = FakeSocket();
fakeServerSocket.controller.add(fakeSocket);
// Consumes the message.
message = await broadcastOutput.first;
serverDaemonConnection.sendResponse(message.data['id']!, id);
// Pump the event queue so that the socket future error handler has a
// chance to be listened to.
await pumpEventQueue();
});
testWithoutContext('without error, should calls proxy.disconnect', () async {
// It will try to disconnect the remote port when socket is done.
fakeSocket.doneCompleter.complete(true);
final DaemonMessage message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'proxy.disconnect');
expect(message.data['params'], <String, Object?>{
'id': 'random_id',
});
});
testWithoutContext('with error, should also calls proxy.disconnect', () async {
fakeSocket.doneCompleter.complete(true);
final DaemonMessage message = await broadcastOutput.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'proxy.disconnect');
expect(message.data['params'], <String, Object?>{
'id': 'random_id',
});
// Send an error response and make sure that it won't crash the client.
serverDaemonConnection.sendErrorResponse(message.data['id']!, 'some error', StackTrace.current);
// Wait the event queue and make sure that it doesn't crash.
await pumpEventQueue();
});
});
});
group('ProxiedDevice', () {
final Map<String, Object> fakeDevice = <String, Object>{
'name': 'device-name',
'id': 'device-id',
'category': 'mobile',
'platformType': 'android',
'platform': 'android-arm',
'emulator': true,
'ephemeral': false,
'sdk': 'Test SDK (1.2.3)',
'capabilities': <String, Object>{
'hotReload': true,
'hotRestart': true,
'screenshot': false,
'fastStart': false,
'flutterExit': true,
'hardwareRendering': true,
'startPaused': true,
},
};
testWithoutContext('calls stopApp without application package if not passed', () async {
bufferLogger = BufferLogger.test();
final ProxiedDevices proxiedDevices = ProxiedDevices(
clientDaemonConnection,
logger: bufferLogger,
);
final ProxiedDevice device = proxiedDevices.deviceFromDaemonResult(fakeDevice);
unawaited(device.stopApp(null, userIdentifier: 'user-id'));
final DaemonMessage message = await serverDaemonConnection.incomingCommands.first;
expect(message.data['id'], isNotNull);
expect(message.data['method'], 'device.stopApp');
expect(message.data['params'], <String, Object?>{'deviceId': 'device-id', 'userIdentifier': 'user-id'});
});
});
}
class FakeDaemonStreams implements DaemonStreams {
final StreamController<DaemonMessage> inputs = StreamController<DaemonMessage>();
final StreamController<DaemonMessage> outputs = StreamController<DaemonMessage>();
@override
Stream<DaemonMessage> get inputStream {
return inputs.stream;
}
@override
void send(Map<String, dynamic> message, [List<int>? binary]) {
outputs.add(DaemonMessage(message, binary != null ? Stream<List<int>>.value(binary) : null));
}
@override
Future<void> dispose() async {
await inputs.close();
// In some tests, outputs have no listeners. We don't wait for outputs to close.
unawaited(outputs.close());
}
}
class FakeServerSocket extends Fake implements ServerSocket {
FakeServerSocket(this.port);
@override
final int port;
bool closeCalled = false;
final StreamController<Socket> controller = StreamController<Socket>();
@override
StreamSubscription<Socket> listen(
void Function(Socket event)? onData, {
Function? onError,
void Function()? onDone,
bool? cancelOnError,
}) {
return controller.stream.listen(onData,
onError: onError, onDone: onDone, cancelOnError: cancelOnError);
}
@override
Future<ServerSocket> close() async {
closeCalled = true;
return this;
}
}
class FakeSocket extends Fake implements Socket {
bool closeCalled = false;
final StreamController<Uint8List> controller = StreamController<Uint8List>();
final List<List<int>> addedData = <List<int>>[];
final Completer<bool> doneCompleter = Completer<bool>();
@override
StreamSubscription<Uint8List> listen(
void Function(Uint8List event)? onData, {
Function? onError,
void Function()? onDone,
bool? cancelOnError,
}) {
return controller.stream.listen(onData,
onError: onError, onDone: onDone, cancelOnError: cancelOnError);
}
@override
void add(List<int> data) {
addedData.add(data);
}
@override
Future<void> close() async {
closeCalled = true;
}
@override
Future<bool> get done => doneCompleter.future;
@override
void destroy() {}
}