// 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:convert'; import 'package:file/file.dart'; import 'package:file/memory.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/base/io.dart' as io; import 'package:flutter_tools/src/base/logger.dart'; import 'package:flutter_tools/src/base/net.dart'; import 'package:flutter_tools/src/base/terminal.dart'; import 'package:platform/platform.dart'; import 'package:quiver/testing/async.dart'; import '../../src/common.dart'; import '../../src/mocks.dart' show MockStdio; void main() { BufferLogger testLogger; setUp(() { testLogger = BufferLogger( terminal: AnsiTerminal( stdio: MockStdio(), platform: FakePlatform.fromPlatform(const LocalPlatform())..stdoutSupportsAnsi = false, ), outputPreferences: OutputPreferences.test(), ); }); Net createNet(io.HttpClient client) { return Net( httpClientFactory: () => client, logger: testLogger, platform: FakePlatform.fromPlatform(const LocalPlatform()), ); } group('successful fetch', () { const String responseString = 'response string'; List responseData; setUp(() { responseData = utf8.encode(responseString); }); testWithoutContext('fetchUrl() gets the data', () async { final Net net = createNet(FakeHttpClient(200, data: responseString)); final List data = await net.fetchUrl(Uri.parse('http://example.invalid/')); expect(data, equals(responseData)); }); testWithoutContext('fetchUrl(destFile) writes the data to a file', () async { final Net net = createNet(FakeHttpClient(200, data: responseString)); final MemoryFileSystem fs = MemoryFileSystem(); final File destFile = fs.file('dest_file')..createSync(); final List data = await net.fetchUrl( Uri.parse('http://example.invalid/'), destFile: destFile, ); expect(data, equals([])); expect(destFile.readAsStringSync(), equals(responseString)); }); }); testWithoutContext('retry from 500', () async { final Net net = createNet(FakeHttpClient(500)); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- attempting retry 3 in 4 seconds...\n' 'Download failed -- attempting retry 4 in 8 seconds...\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); }); testWithoutContext('retry from network error', () async { final Net net = createNet(FakeHttpClient(200)); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- attempting retry 3 in 4 seconds...\n' 'Download failed -- attempting retry 4 in 8 seconds...\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); }); testWithoutContext('retry from SocketException', () async { final Net net = createNet(FakeHttpClientThrowing( const io.SocketException('test exception handling'), )); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- attempting retry 3 in 4 seconds...\n' 'Download failed -- attempting retry 4 in 8 seconds...\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); expect(testLogger.traceText, contains('Download error: SocketException')); }); testWithoutContext('no retry from HandshakeException', () async { final Net net = createNet(FakeHttpClientThrowing( const io.HandshakeException('test exception handling'), )); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, ''); }); expect(error, startsWith('test failed')); expect(testLogger.traceText, contains('HandshakeException')); }); testWithoutContext('check for bad override on ArgumentError', () async { final Net net = Net( httpClientFactory: () => FakeHttpClientThrowing( ArgumentError('test exception handling'), ), logger: testLogger, platform: FakePlatform.fromPlatform(const LocalPlatform()) ..environment = { 'FLUTTER_STORAGE_BASE_URL': 'example.invalid', }, ); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, ''); }); expect(error, startsWith('test failed')); expect(testLogger.errorText, contains('Invalid argument')); expect(error, contains('FLUTTER_STORAGE_BASE_URL')); }); testWithoutContext('retry from HttpException', () async { final Net net = createNet(FakeHttpClientThrowing( const io.HttpException('test exception handling'), )); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- attempting retry 3 in 4 seconds...\n' 'Download failed -- attempting retry 4 in 8 seconds...\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); expect(testLogger.traceText, contains('Download error: HttpException')); }); testWithoutContext('retry from HttpException when request throws', () async { final Net net = createNet(FakeHttpClientThrowingRequest( const io.HttpException('test exception handling'), )); String error; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/')).then((List value) { error = 'test completed unexpectedly'; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- attempting retry 3 in 4 seconds...\n' 'Download failed -- attempting retry 4 in 8 seconds...\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); expect(testLogger.traceText, contains('Download error: HttpException')); }); testWithoutContext('max attempts', () async { final Net net = createNet(FakeHttpClient(500)); String error; List actualResult; FakeAsync().run((FakeAsync time) { net.fetchUrl(Uri.parse('http://example.invalid/'), maxAttempts: 3).then((List value) { actualResult = value; }, onError: (dynamic exception) { error = 'test failed unexpectedly: $exception'; }); expect(testLogger.statusText, ''); time.elapse(const Duration(milliseconds: 10000)); expect(testLogger.statusText, 'Download failed -- attempting retry 1 in 1 second...\n' 'Download failed -- attempting retry 2 in 2 seconds...\n' 'Download failed -- retry 3\n', ); }); expect(testLogger.errorText, isEmpty); expect(error, isNull); expect(actualResult, isNull); }); testWithoutContext('remote file non-existant', () async { final Net net = createNet(FakeHttpClient(404)); final Uri invalid = Uri.parse('http://example.invalid/'); final bool result = await net.doesRemoteFileExist(invalid); expect(result, false); }); testWithoutContext('remote file server error', () async { final Net net = createNet(FakeHttpClient(500)); final Uri valid = Uri.parse('http://example.valid/'); final bool result = await net.doesRemoteFileExist(valid); expect(result, false); }); testWithoutContext('remote file exists', () async { final Net net = createNet(FakeHttpClient(200)); final Uri valid = Uri.parse('http://example.valid/'); final bool result = await net.doesRemoteFileExist(valid); expect(result, true); }); } class FakeHttpClientThrowing implements io.HttpClient { FakeHttpClientThrowing(this.exception); final Object exception; @override Future getUrl(Uri url) async { throw exception; } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClient - $invocation'; } } class FakeHttpClient implements io.HttpClient { FakeHttpClient(this.statusCode, { this.data }); final int statusCode; final String data; @override Future getUrl(Uri url) async { return FakeHttpClientRequest(statusCode, data: data); } @override Future headUrl(Uri url) async { return FakeHttpClientRequest(statusCode); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClient - $invocation'; } } class FakeHttpClientThrowingRequest implements io.HttpClient { FakeHttpClientThrowingRequest(this.exception); final Object exception; @override Future getUrl(Uri url) async { return FakeHttpClientRequestThrowing(exception); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClient - $invocation'; } } class FakeHttpClientRequest implements io.HttpClientRequest { FakeHttpClientRequest(this.statusCode, { this.data }); final int statusCode; final String data; @override Future close() async { return FakeHttpClientResponse(statusCode, data: data); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClientRequest - $invocation'; } } class FakeHttpClientRequestThrowing implements io.HttpClientRequest { FakeHttpClientRequestThrowing(this.exception); final Object exception; @override Future close() async { throw exception; } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClientRequest - $invocation'; } } class FakeHttpClientResponse implements io.HttpClientResponse { FakeHttpClientResponse(this.statusCode, { this.data }); @override final int statusCode; final String data; @override String get reasonPhrase => ''; @override StreamSubscription> listen( void onData(List event), { Function onError, void onDone(), bool cancelOnError, }) { if (data == null) { return Stream>.fromFuture(Future>.error( const io.SocketException('test'), )).listen(onData, onError: onError, onDone: onDone, cancelOnError: cancelOnError); } else { return Stream>.fromFuture(Future>.value( utf8.encode(data), )).listen(onData, onError: onError, onDone: onDone, cancelOnError: cancelOnError); } } @override Future forEach(void Function(List element) action) async { if (data == null) { return Future.error(const io.SocketException('test')); } else { return Future.microtask(() => action(utf8.encode(data))); } } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClientResponse - $invocation'; } }