development/flutter
development/flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter synced 2024-09-13 21:32:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CADisableMinimumFrameDurationOnPhone migration (#100647)

Browse source
This commit is contained in:
Chris Yang 2022-03-25 17:50:09 -07:00 committed by GitHub
parent 22a3b4dc1e
commit c01cbd23cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 138 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/flutter_tools/lib/src/ios/mac.dart
View file

@ -25,6 +25,7 @@ import 'application_package.dart';
import 'code_signing.dart';
import 'iproxy.dart';
import 'migrations/deployment_target_migration.dart';
import 'migrations/minimum_frame_duration_migration.dart';
import 'migrations/project_base_configuration_migration.dart';
import 'migrations/project_build_location_migration.dart';
import 'migrations/project_object_version_migration.dart';
@ -123,6 +124,7 @@ Future<XcodeBuildResult> buildXcodeProject({
ProjectBuildLocationMigration(app.project, globals.logger),
DeploymentTargetMigration(app.project, globals.logger),
ProjectObjectVersionMigration(app.project, globals.logger),
MinimumFrameDurationMigration(app.project, globals.logger),
];
final ProjectMigration migration = ProjectMigration(migrators);

53
packages/flutter_tools/lib/src/ios/migrations/minimum_frame_duration_migration.dart Normal file
View file

@ -0,0 +1,53 @@
// 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 '../../base/file_system.dart';
import '../../base/logger.dart';
import '../../base/project_migrator.dart';
import '../../xcode_project.dart';
const String _kDisableMinimumFrameDurationKey = 'CADisableMinimumFrameDurationOnPhone';
/// Add "CADisableMinimumFrameDurationOnPhone: true" to the Info.plist.
class MinimumFrameDurationMigration extends ProjectMigrator {
MinimumFrameDurationMigration(
IosProject project,
Logger logger,
) : _infoPlist = project.defaultHostInfoPlist,
super(logger);
final File _infoPlist;
@override
bool migrate() {
if (!_infoPlist.existsSync()) {
logger.printTrace('Info.plist not found, skipping minimum frame duration migration.');
return true;
}
processFileLines(_infoPlist);
return true;
}
@override
String migrateFileContents(String fileContents) {
if (fileContents.contains(_kDisableMinimumFrameDurationKey)) {
// No migration needed if the key already exits.
return fileContents;
}
logger.printTrace('Adding $_kDisableMinimumFrameDurationKey to Info.plist');
const String plistEnd = '''
</dict>
</plist>
''';
const String plistWithKey = '''
<key>$_kDisableMinimumFrameDurationKey</key>
<true/>
</dict>
</plist>
''';
return fileContents.replaceAll(plistEnd, plistWithKey);
}
}

83
packages/flutter_tools/test/general.shard/ios/ios_project_migration_test.dart
View file

@ -7,6 +7,7 @@ import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/base/project_migrator.dart';
import 'package:flutter_tools/src/ios/migrations/deployment_target_migration.dart';
import 'package:flutter_tools/src/ios/migrations/minimum_frame_duration_migration.dart';
import 'package:flutter_tools/src/ios/migrations/project_base_configuration_migration.dart';
import 'package:flutter_tools/src/ios/migrations/project_build_location_migration.dart';
import 'package:flutter_tools/src/ios/migrations/project_object_version_migration.dart';
@ -708,6 +709,85 @@ keep this 3
expect('Updating project for Xcode compatibility'.allMatches(testLogger.statusText).length, 1);
});
});
group('add CADisableMinimumFrameDurationOnPhone key to info.plist migration', () {
late MemoryFileSystem memoryFileSystem;
late BufferLogger testLogger;
late FakeIosProject project;
late File infoPlistFile;
setUp(() {
memoryFileSystem = MemoryFileSystem();
testLogger = BufferLogger.test();
project = FakeIosProject();
infoPlistFile = memoryFileSystem.file('info.plist');
project.defaultHostInfoPlist = infoPlistFile;
});
testWithoutContext('skipped if files are missing', () {
final MinimumFrameDurationMigration iosProjectMigration = MinimumFrameDurationMigration(
project,
testLogger,
);
expect(iosProjectMigration.migrate(), isTrue);
expect(infoPlistFile.existsSync(), isFalse);
expect(testLogger.traceText, contains('Info.plist not found, skipping minimum frame duration migration.'));
expect(testLogger.statusText, isEmpty);
});
testWithoutContext('skipped if nothing to upgrade', () {
const String infoPlistFileContent = '''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>
</dict>
</plist>
''';
infoPlistFile.writeAsStringSync(infoPlistFileContent);
final MinimumFrameDurationMigration iosProjectMigration = MinimumFrameDurationMigration(
project,
testLogger,
);
final DateTime infoPlistFileLastModified = infoPlistFile.lastModifiedSync();
expect(iosProjectMigration.migrate(), isTrue);
expect(infoPlistFile.lastModifiedSync(), infoPlistFileLastModified);
expect(testLogger.statusText, isEmpty);
});
testWithoutContext('info.plist is migrated to use CADisableMinimumFrameDurationOnPhone', () {
const String infoPlistFileContent = '''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
</dict>
</plist>
''';
infoPlistFile.writeAsStringSync(infoPlistFileContent);
final MinimumFrameDurationMigration iosProjectMigration = MinimumFrameDurationMigration(
project,
testLogger,
);
expect(iosProjectMigration.migrate(), isTrue);
expect(infoPlistFile.readAsStringSync(), equals('''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>
</dict>
</plist>
'''));
});
});
});
}
@ -726,6 +806,9 @@ class FakeIosProject extends Fake implements IosProject {
@override
File appFrameworkInfoPlist = MemoryFileSystem.test().file('appFrameworkInfoPlist');
@override
File defaultHostInfoPlist = MemoryFileSystem.test().file('defaultHostInfoPlist');
}
class FakeIOSMigrator extends ProjectMigrator {