2016-04-26 23:25:11 +00:00
|
|
|
// Copyright 2016 The Chromium 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 'package:args/command_runner.dart';
|
2019-07-19 21:54:18 +00:00
|
|
|
import 'package:file/memory.dart';
|
2019-07-18 17:41:13 +00:00
|
|
|
import 'package:flutter_tools/src/base/config.dart';
|
2017-01-09 16:37:00 +00:00
|
|
|
import 'package:flutter_tools/src/base/file_system.dart';
|
2019-07-19 21:54:18 +00:00
|
|
|
import 'package:flutter_tools/src/base/io.dart';
|
2019-07-29 14:24:02 +00:00
|
|
|
import 'package:flutter_tools/src/base/platform.dart';
|
|
|
|
import 'package:flutter_tools/src/base/time.dart';
|
2016-05-12 22:54:35 +00:00
|
|
|
import 'package:flutter_tools/src/cache.dart';
|
2018-04-21 00:39:32 +00:00
|
|
|
import 'package:flutter_tools/src/commands/build.dart';
|
2016-04-26 23:25:11 +00:00
|
|
|
import 'package:flutter_tools/src/commands/config.dart';
|
|
|
|
import 'package:flutter_tools/src/commands/doctor.dart';
|
2017-05-08 18:10:36 +00:00
|
|
|
import 'package:flutter_tools/src/doctor.dart';
|
2019-07-29 14:24:02 +00:00
|
|
|
import 'package:flutter_tools/src/features.dart';
|
|
|
|
import 'package:flutter_tools/src/reporting/reporting.dart';
|
2019-07-19 21:54:18 +00:00
|
|
|
import 'package:flutter_tools/src/runner/flutter_command.dart';
|
2017-11-11 01:31:18 +00:00
|
|
|
import 'package:flutter_tools/src/version.dart';
|
2019-07-29 14:24:02 +00:00
|
|
|
import 'package:mockito/mockito.dart';
|
2019-07-19 21:54:18 +00:00
|
|
|
import 'package:platform/platform.dart';
|
2016-04-26 23:25:11 +00:00
|
|
|
|
2019-07-13 18:51:44 +00:00
|
|
|
import '../src/common.dart';
|
|
|
|
import '../src/context.dart';
|
2019-07-19 21:54:18 +00:00
|
|
|
import '../src/mocks.dart';
|
2016-04-26 23:25:11 +00:00
|
|
|
|
|
|
|
void main() {
|
|
|
|
group('analytics', () {
|
2018-08-17 20:17:23 +00:00
|
|
|
Directory tempDir;
|
2019-07-18 17:41:13 +00:00
|
|
|
MockFlutterConfig mockFlutterConfig;
|
2016-04-26 23:25:11 +00:00
|
|
|
|
2017-03-10 17:39:01 +00:00
|
|
|
setUpAll(() {
|
|
|
|
Cache.disableLocking();
|
|
|
|
});
|
|
|
|
|
2016-04-26 23:25:11 +00:00
|
|
|
setUp(() {
|
2016-05-12 22:54:35 +00:00
|
|
|
Cache.flutterRoot = '../..';
|
2018-08-17 20:17:23 +00:00
|
|
|
tempDir = fs.systemTempDirectory.createTempSync('flutter_tools_analytics_test.');
|
2019-07-18 17:41:13 +00:00
|
|
|
mockFlutterConfig = MockFlutterConfig();
|
2016-04-26 23:25:11 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
tearDown(() {
|
2018-08-17 20:17:23 +00:00
|
|
|
tryToDelete(tempDir);
|
2016-04-26 23:25:11 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
// Ensure we don't send anything when analytics is disabled.
|
|
|
|
testUsingContext('doesn\'t send when disabled', () async {
|
|
|
|
int count = 0;
|
|
|
|
flutterUsage.onSend.listen((Map<String, dynamic> data) => count++);
|
|
|
|
|
|
|
|
flutterUsage.enabled = false;
|
2018-08-17 20:17:23 +00:00
|
|
|
await createProject(tempDir);
|
2016-04-26 23:25:11 +00:00
|
|
|
expect(count, 0);
|
|
|
|
|
|
|
|
flutterUsage.enabled = true;
|
2018-08-17 20:17:23 +00:00
|
|
|
await createProject(tempDir);
|
2019-08-06 16:08:43 +00:00
|
|
|
expect(count, flutterUsage.isFirstRun ? 0 : 3);
|
2016-04-26 23:25:11 +00:00
|
|
|
|
|
|
|
count = 0;
|
|
|
|
flutterUsage.enabled = false;
|
2018-09-12 06:29:29 +00:00
|
|
|
final DoctorCommand doctorCommand = DoctorCommand();
|
2018-10-05 05:54:56 +00:00
|
|
|
final CommandRunner<void>runner = createTestCommandRunner(doctorCommand);
|
2016-11-14 19:21:30 +00:00
|
|
|
await runner.run(<String>['doctor']);
|
2016-04-26 23:25:11 +00:00
|
|
|
expect(count, 0);
|
2016-11-30 16:42:42 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
2018-11-11 01:02:32 +00:00
|
|
|
FlutterVersion: () => FlutterVersion(const SystemClock()),
|
2019-08-06 16:08:43 +00:00
|
|
|
Usage: () => Usage(
|
|
|
|
configDirOverride: tempDir.path,
|
|
|
|
logFile: tempDir.childFile('analytics.log').path
|
|
|
|
),
|
2016-04-26 23:25:11 +00:00
|
|
|
});
|
|
|
|
|
2017-04-26 00:23:00 +00:00
|
|
|
// Ensure we don't send for the 'flutter config' command.
|
2016-04-26 23:25:11 +00:00
|
|
|
testUsingContext('config doesn\'t send', () async {
|
|
|
|
int count = 0;
|
|
|
|
flutterUsage.onSend.listen((Map<String, dynamic> data) => count++);
|
|
|
|
|
|
|
|
flutterUsage.enabled = false;
|
2018-09-12 06:29:29 +00:00
|
|
|
final ConfigCommand command = ConfigCommand();
|
2018-10-05 05:54:56 +00:00
|
|
|
final CommandRunner<void> runner = createTestCommandRunner(command);
|
2016-04-26 23:25:11 +00:00
|
|
|
await runner.run(<String>['config']);
|
|
|
|
expect(count, 0);
|
|
|
|
|
|
|
|
flutterUsage.enabled = true;
|
|
|
|
await runner.run(<String>['config']);
|
|
|
|
expect(count, 0);
|
2016-11-30 16:42:42 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
2018-11-11 01:02:32 +00:00
|
|
|
FlutterVersion: () => FlutterVersion(const SystemClock()),
|
2019-08-06 16:08:43 +00:00
|
|
|
Usage: () => Usage(
|
|
|
|
configDirOverride: tempDir.path,
|
|
|
|
logFile: tempDir.childFile('analytics.log').path
|
|
|
|
),
|
2016-04-26 23:25:11 +00:00
|
|
|
});
|
2019-07-18 17:41:13 +00:00
|
|
|
|
|
|
|
testUsingContext('Usage records one feature in experiment setting', () async {
|
|
|
|
when<bool>(mockFlutterConfig.getValue(flutterWebFeature.configSetting))
|
|
|
|
.thenReturn(true);
|
|
|
|
final Usage usage = Usage();
|
|
|
|
usage.sendCommand('test');
|
|
|
|
|
2019-07-29 14:24:02 +00:00
|
|
|
final String featuresKey = cdKey(CustomDimensions.enabledFlutterFeatures);
|
|
|
|
expect(fs.file('test').readAsStringSync(), contains('$featuresKey: enable-web'));
|
2019-07-18 17:41:13 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
FlutterVersion: () => FlutterVersion(const SystemClock()),
|
|
|
|
Config: () => mockFlutterConfig,
|
2019-07-23 18:02:02 +00:00
|
|
|
Platform: () => FakePlatform(environment: <String, String>{
|
|
|
|
'FLUTTER_ANALYTICS_LOG_FILE': 'test',
|
|
|
|
}),
|
|
|
|
FileSystem: () => MemoryFileSystem(),
|
2019-07-18 17:41:13 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('Usage records multiple features in experiment setting', () async {
|
|
|
|
when<bool>(mockFlutterConfig.getValue(flutterWebFeature.configSetting))
|
|
|
|
.thenReturn(true);
|
|
|
|
when<bool>(mockFlutterConfig.getValue(flutterLinuxDesktopFeature.configSetting))
|
|
|
|
.thenReturn(true);
|
|
|
|
when<bool>(mockFlutterConfig.getValue(flutterMacOSDesktopFeature.configSetting))
|
|
|
|
.thenReturn(true);
|
|
|
|
final Usage usage = Usage();
|
|
|
|
usage.sendCommand('test');
|
|
|
|
|
2019-07-29 14:24:02 +00:00
|
|
|
final String featuresKey = cdKey(CustomDimensions.enabledFlutterFeatures);
|
|
|
|
expect(fs.file('test').readAsStringSync(), contains('$featuresKey: enable-web,enable-linux-desktop,enable-macos-desktop'));
|
2019-07-18 17:41:13 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
FlutterVersion: () => FlutterVersion(const SystemClock()),
|
|
|
|
Config: () => mockFlutterConfig,
|
2019-07-23 18:02:02 +00:00
|
|
|
Platform: () => FakePlatform(environment: <String, String>{
|
|
|
|
'FLUTTER_ANALYTICS_LOG_FILE': 'test',
|
|
|
|
}),
|
|
|
|
FileSystem: () => MemoryFileSystem(),
|
2019-07-18 17:41:13 +00:00
|
|
|
});
|
2016-04-26 23:25:11 +00:00
|
|
|
});
|
2016-05-19 17:51:31 +00:00
|
|
|
|
2017-04-27 22:28:15 +00:00
|
|
|
group('analytics with mocks', () {
|
2019-07-19 21:54:18 +00:00
|
|
|
MemoryFileSystem memoryFileSystem;
|
|
|
|
MockStdio mockStdio;
|
2017-04-27 22:28:15 +00:00
|
|
|
Usage mockUsage;
|
2018-11-11 01:02:32 +00:00
|
|
|
SystemClock mockClock;
|
2017-05-08 18:10:36 +00:00
|
|
|
Doctor mockDoctor;
|
2017-04-27 22:28:15 +00:00
|
|
|
List<int> mockTimes;
|
|
|
|
|
|
|
|
setUp(() {
|
2019-07-19 21:54:18 +00:00
|
|
|
memoryFileSystem = MemoryFileSystem();
|
|
|
|
mockStdio = MockStdio();
|
2018-09-12 06:29:29 +00:00
|
|
|
mockUsage = MockUsage();
|
2017-04-27 22:28:15 +00:00
|
|
|
when(mockUsage.isFirstRun).thenReturn(false);
|
2018-09-12 06:29:29 +00:00
|
|
|
mockClock = MockClock();
|
|
|
|
mockDoctor = MockDoctor();
|
2017-04-27 22:28:15 +00:00
|
|
|
when(mockClock.now()).thenAnswer(
|
2018-09-12 06:29:29 +00:00
|
|
|
(Invocation _) => DateTime.fromMillisecondsSinceEpoch(mockTimes.removeAt(0))
|
2017-04-27 22:28:15 +00:00
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('flutter commands send timing events', () async {
|
|
|
|
mockTimes = <int>[1000, 2000];
|
2018-04-09 19:43:31 +00:00
|
|
|
when(mockDoctor.diagnose(androidLicenses: false, verbose: false)).thenAnswer((_) async => true);
|
2018-09-12 06:29:29 +00:00
|
|
|
final DoctorCommand command = DoctorCommand();
|
2018-10-05 05:54:56 +00:00
|
|
|
final CommandRunner<void> runner = createTestCommandRunner(command);
|
2017-04-27 22:28:15 +00:00
|
|
|
await runner.run(<String>['doctor']);
|
|
|
|
|
|
|
|
verify(mockClock.now()).called(2);
|
|
|
|
|
|
|
|
expect(
|
2018-06-21 23:23:47 +00:00
|
|
|
verify(mockUsage.sendTiming(captureAny, captureAny, captureAny, label: captureAnyNamed('label'))).captured,
|
2019-03-01 07:17:55 +00:00
|
|
|
<dynamic>['flutter', 'doctor', const Duration(milliseconds: 1000), 'success'],
|
2017-04-27 22:28:15 +00:00
|
|
|
);
|
|
|
|
}, overrides: <Type, Generator>{
|
2018-11-11 01:02:32 +00:00
|
|
|
SystemClock: () => mockClock,
|
2017-05-08 18:10:36 +00:00
|
|
|
Doctor: () => mockDoctor,
|
|
|
|
Usage: () => mockUsage,
|
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('doctor fail sends warning', () async {
|
|
|
|
mockTimes = <int>[1000, 2000];
|
2018-04-09 19:43:31 +00:00
|
|
|
when(mockDoctor.diagnose(androidLicenses: false, verbose: false)).thenAnswer((_) async => false);
|
2018-09-12 06:29:29 +00:00
|
|
|
final DoctorCommand command = DoctorCommand();
|
2018-10-05 05:54:56 +00:00
|
|
|
final CommandRunner<void> runner = createTestCommandRunner(command);
|
2017-05-08 18:10:36 +00:00
|
|
|
await runner.run(<String>['doctor']);
|
|
|
|
|
|
|
|
verify(mockClock.now()).called(2);
|
|
|
|
|
|
|
|
expect(
|
2018-06-21 23:23:47 +00:00
|
|
|
verify(mockUsage.sendTiming(captureAny, captureAny, captureAny, label: captureAnyNamed('label'))).captured,
|
2019-03-01 07:17:55 +00:00
|
|
|
<dynamic>['flutter', 'doctor', const Duration(milliseconds: 1000), 'warning'],
|
2017-05-08 18:10:36 +00:00
|
|
|
);
|
|
|
|
}, overrides: <Type, Generator>{
|
2018-11-11 01:02:32 +00:00
|
|
|
SystemClock: () => mockClock,
|
2017-05-08 18:10:36 +00:00
|
|
|
Doctor: () => mockDoctor,
|
2017-04-27 22:28:15 +00:00
|
|
|
Usage: () => mockUsage,
|
|
|
|
});
|
2018-04-21 00:39:32 +00:00
|
|
|
|
|
|
|
testUsingContext('single command usage path', () async {
|
2018-09-12 06:29:29 +00:00
|
|
|
final FlutterCommand doctorCommand = DoctorCommand();
|
2018-04-21 00:39:32 +00:00
|
|
|
expect(await doctorCommand.usagePath, 'doctor');
|
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
Usage: () => mockUsage,
|
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('compound command usage path', () async {
|
2018-09-12 06:29:29 +00:00
|
|
|
final BuildCommand buildCommand = BuildCommand();
|
2018-04-21 00:39:32 +00:00
|
|
|
final FlutterCommand buildApkCommand = buildCommand.subcommands['apk'];
|
|
|
|
expect(await buildApkCommand.usagePath, 'build/apk');
|
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
Usage: () => mockUsage,
|
|
|
|
});
|
2019-07-19 21:54:18 +00:00
|
|
|
|
|
|
|
testUsingContext('command sends localtime', () async {
|
|
|
|
const int kMillis = 1000;
|
|
|
|
mockTimes = <int>[kMillis];
|
|
|
|
// Since FLUTTER_ANALYTICS_LOG_FILE is set in the environment, analytics
|
|
|
|
// will be written to a file.
|
|
|
|
final Usage usage = Usage(versionOverride: 'test');
|
|
|
|
usage.suppressAnalytics = false;
|
|
|
|
usage.enabled = true;
|
|
|
|
|
|
|
|
usage.sendCommand('test');
|
|
|
|
|
|
|
|
final String log = fs.file('analytics.log').readAsStringSync();
|
|
|
|
final DateTime dateTime = DateTime.fromMillisecondsSinceEpoch(kMillis);
|
2019-08-01 06:28:18 +00:00
|
|
|
expect(log.contains(formatDateTime(dateTime)), isTrue);
|
2019-07-19 21:54:18 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
FileSystem: () => memoryFileSystem,
|
|
|
|
SystemClock: () => mockClock,
|
|
|
|
Platform: () => FakePlatform(
|
|
|
|
environment: <String, String>{
|
|
|
|
'FLUTTER_ANALYTICS_LOG_FILE': 'analytics.log',
|
|
|
|
},
|
|
|
|
),
|
|
|
|
Stdio: () => mockStdio,
|
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('event sends localtime', () async {
|
|
|
|
const int kMillis = 1000;
|
|
|
|
mockTimes = <int>[kMillis];
|
|
|
|
// Since FLUTTER_ANALYTICS_LOG_FILE is set in the environment, analytics
|
|
|
|
// will be written to a file.
|
|
|
|
final Usage usage = Usage(versionOverride: 'test');
|
|
|
|
usage.suppressAnalytics = false;
|
|
|
|
usage.enabled = true;
|
|
|
|
|
|
|
|
usage.sendEvent('test', 'test');
|
|
|
|
|
|
|
|
final String log = fs.file('analytics.log').readAsStringSync();
|
|
|
|
final DateTime dateTime = DateTime.fromMillisecondsSinceEpoch(kMillis);
|
2019-08-01 06:28:18 +00:00
|
|
|
expect(log.contains(formatDateTime(dateTime)), isTrue);
|
2019-07-19 21:54:18 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
|
|
|
FileSystem: () => memoryFileSystem,
|
|
|
|
SystemClock: () => mockClock,
|
|
|
|
Platform: () => FakePlatform(
|
|
|
|
environment: <String, String>{
|
|
|
|
'FLUTTER_ANALYTICS_LOG_FILE': 'analytics.log',
|
|
|
|
},
|
|
|
|
),
|
|
|
|
Stdio: () => mockStdio,
|
|
|
|
});
|
2017-04-27 22:28:15 +00:00
|
|
|
});
|
|
|
|
|
2016-05-19 17:51:31 +00:00
|
|
|
group('analytics bots', () {
|
2018-08-17 20:17:23 +00:00
|
|
|
Directory tempDir;
|
|
|
|
|
2018-01-05 17:38:13 +00:00
|
|
|
setUp(() {
|
2018-08-17 20:17:23 +00:00
|
|
|
tempDir = fs.systemTempDirectory.createTempSync('flutter_tools_analytics_bots_test.');
|
|
|
|
});
|
|
|
|
|
|
|
|
tearDown(() {
|
|
|
|
tryToDelete(tempDir);
|
2018-01-05 17:38:13 +00:00
|
|
|
});
|
|
|
|
|
2016-05-19 17:51:31 +00:00
|
|
|
testUsingContext('don\'t send on bots', () async {
|
|
|
|
int count = 0;
|
|
|
|
flutterUsage.onSend.listen((Map<String, dynamic> data) => count++);
|
|
|
|
|
|
|
|
await createTestCommandRunner().run(<String>['--version']);
|
|
|
|
expect(count, 0);
|
2016-11-30 16:42:42 +00:00
|
|
|
}, overrides: <Type, Generator>{
|
2018-09-12 06:29:29 +00:00
|
|
|
Usage: () => Usage(
|
2016-11-30 16:42:42 +00:00
|
|
|
settingsName: 'flutter_bot_test',
|
|
|
|
versionOverride: 'dev/unknown',
|
2018-08-17 20:17:23 +00:00
|
|
|
configDirOverride: tempDir.path,
|
2018-01-05 17:38:13 +00:00
|
|
|
),
|
|
|
|
});
|
|
|
|
|
|
|
|
testUsingContext('don\'t send on bots even when opted in', () async {
|
|
|
|
int count = 0;
|
|
|
|
flutterUsage.onSend.listen((Map<String, dynamic> data) => count++);
|
|
|
|
flutterUsage.enabled = true;
|
|
|
|
|
|
|
|
await createTestCommandRunner().run(<String>['--version']);
|
|
|
|
expect(count, 0);
|
|
|
|
}, overrides: <Type, Generator>{
|
2018-09-12 06:29:29 +00:00
|
|
|
Usage: () => Usage(
|
2018-01-05 17:38:13 +00:00
|
|
|
settingsName: 'flutter_bot_test',
|
|
|
|
versionOverride: 'dev/unknown',
|
2018-08-17 20:17:23 +00:00
|
|
|
configDirOverride: tempDir.path,
|
2016-11-30 16:42:42 +00:00
|
|
|
),
|
2016-05-19 17:51:31 +00:00
|
|
|
});
|
|
|
|
});
|
2016-04-26 23:25:11 +00:00
|
|
|
}
|
2017-04-27 22:28:15 +00:00
|
|
|
|
|
|
|
class MockUsage extends Mock implements Usage {}
|
2017-05-08 18:10:36 +00:00
|
|
|
|
|
|
|
class MockDoctor extends Mock implements Doctor {}
|
2019-07-18 17:41:13 +00:00
|
|
|
|
|
|
|
class MockFlutterConfig extends Mock implements Config {}
|