Skip to content

Commit

Permalink
Check for watch companion in build settings (flutter#114078)
Browse files Browse the repository at this point in the history
  • Loading branch information
@vashworth
vashworth committed Oct 27, 2022
1 parent cece4a5 commit 8aad119
Show file tree
Hide file tree
Showing 8 changed files with 299 additions and 86 deletions.
61 changes: 6 additions & 55 deletions dev/devicelab/bin/tasks/ios_app_with_extensions_test.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import 'dart:io';

import 'package:flutter_devicelab/framework/framework.dart';
import 'package:flutter_devicelab/framework/ios.dart';
import 'package:flutter_devicelab/framework/task_result.dart';
import 'package:flutter_devicelab/framework/utils.dart';
import 'package:path/path.dart' as path;
Expand All @@ -28,54 +27,19 @@ Future<void> main() async {

section('Create release build');

// This only builds the iOS app, not the companion watchOS app. The watchOS app
// has been removed as a build dependency and is not embedded in the app to avoid
// requiring the watchOS being available in CI.
// Instead, validate the tool detects that there is a watch companion, and omits
// the "-sdk iphoneos" option, which fails to build the watchOS app.
// This attempts to build the companion watchOS app. However, the watchOS
// SDK is not available in CI and therefore the build will fail.
// Check to make sure that the tool attempts to build the companion watchOS app.
// See https://github.com/flutter/flutter/pull/94190.
await inDirectory(projectDir, () async {
final String buildOutput = await evalFlutter(
'build',
options: <String>['ios', '--no-codesign', '--release', '--verbose'],
);
if (!buildOutput.contains('Watch companion app found')) {
throw TaskResult.failure('Did not detect watch companion');
if (!buildOutput.contains('-destination generic/platform=watchOS')) {
print(buildOutput);
throw TaskResult.failure('Did not try to get watch build settings');
}
if (buildOutput.contains('-sdk iphoneos -destination')) {
throw TaskResult.failure('-sdk must be omitted for app with watch companion');
}
});

final String appBundle = Directory(path.join(
projectDir.path,
'build',
'ios',
'iphoneos',
'Runner.app',
)).path;

final String appFrameworkPath = path.join(
appBundle,
'Frameworks',
'App.framework',
'App',
);
final String flutterFrameworkPath = path.join(
appBundle,
'Frameworks',
'Flutter.framework',
'Flutter',
);

checkDirectoryExists(appBundle);
await _checkFlutterFrameworkArchs(appFrameworkPath);
await _checkFlutterFrameworkArchs(flutterFrameworkPath);

section('Clean build');

await inDirectory(projectDir, () async {
await flutter('clean');
});

return TaskResult.success(null);
Expand All @@ -86,16 +50,3 @@ Future<void> main() async {
}
});
}

Future<void> _checkFlutterFrameworkArchs(String frameworkPath) async {
checkFileExists(frameworkPath);

final String archs = await fileType(frameworkPath);
if (!archs.contains('arm64')) {
throw TaskResult.failure('$frameworkPath arm64 architecture missing');
}

if (archs.contains('x86_64')) {
throw TaskResult.failure('$frameworkPath x86_64 architecture unexpectedly present');
}
}
3 changes: 3 additions & 0 deletions dev/integration_tests/ios_app_with_extensions/ios/Runner.xcodeproj/project.pbxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,7 @@
GCC_C_LANGUAGE_STANDARD = gnu11;
IBSC_MODULE = watch_Extension;
INFOPLIST_FILE = watch/Info.plist;
INFOPLIST_KEY_WKCompanionAppBundleIdentifier = io.flutter.extensionTest;
MARKETING_VERSION = 1.0.0;
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -757,6 +758,7 @@
GCC_C_LANGUAGE_STANDARD = gnu11;
IBSC_MODULE = watch_Extension;
INFOPLIST_FILE = watch/Info.plist;
INFOPLIST_KEY_WKCompanionAppBundleIdentifier = io.flutter.extensionTest;
MARKETING_VERSION = 1.0.0;
MTL_FAST_MATH = YES;
OTHER_LDFLAGS = "";
Expand Down Expand Up @@ -785,6 +787,7 @@
GCC_C_LANGUAGE_STANDARD = gnu11;
IBSC_MODULE = watch_Extension;
INFOPLIST_FILE = watch/Info.plist;
INFOPLIST_KEY_WKCompanionAppBundleIdentifier = io.flutter.extensionTest;
MARKETING_VERSION = 1.0.0;
MTL_FAST_MATH = YES;
OTHER_LDFLAGS = "";
Expand Down
2 changes: 0 additions & 2 deletions dev/integration_tests/ios_app_with_extensions/ios/watch/Info.plist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@
<string>UIInterfaceOrientationPortrait</string>
<string>UIInterfaceOrientationPortraitUpsideDown</string>
</array>
<key>WKCompanionAppBundleIdentifier</key>
<string>$(APP_BUNDLE_IDENTIFIER)</string>
<key>WKWatchKitApp</key>
<true/>
</dict>
Expand Down
6 changes: 3 additions & 3 deletions packages/flutter_tools/lib/src/ios/mac.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,9 +265,9 @@ Future<XcodeBuildResult> buildXcodeProject({

// Check if the project contains a watchOS companion app.
final bool hasWatchCompanion = await app.project.containsWatchCompanion(
projectInfo.targets,
buildInfo,
deviceID,
projectInfo: projectInfo,
buildInfo: buildInfo,
deviceId: deviceID,
);
if (hasWatchCompanion) {
// The -sdk argument has to be omitted if a watchOS companion app exists.
Expand Down
11 changes: 9 additions & 2 deletions packages/flutter_tools/lib/src/ios/xcodeproj.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,11 @@ class XcodeProjectInterpreter {
if (buildContext.environmentType == EnvironmentType.simulator)
...<String>['-sdk', 'iphonesimulator'],
'-destination',
if (deviceId != null)
if (buildContext.isWatch == true && buildContext.environmentType == EnvironmentType.physical)
'generic/platform=watchOS'
else if (buildContext.isWatch == true)
'generic/platform=watchOS Simulator'
else if (deviceId != null)
'id=$deviceId'
else if (buildContext.environmentType == EnvironmentType.physical)
'generic/platform=iOS'
Expand Down Expand Up @@ -376,12 +380,14 @@ class XcodeProjectBuildContext {
this.configuration,
this.environmentType = EnvironmentType.physical,
this.deviceId,
this.isWatch = false,
});

final String? scheme;
final String? configuration;
final EnvironmentType environmentType;
final String? deviceId;
final bool isWatch;

@override
int get hashCode => Object.hash(scheme, configuration, environmentType, deviceId);
Expand All @@ -395,7 +401,8 @@ class XcodeProjectBuildContext {
other.scheme == scheme &&
other.configuration == configuration &&
other.deviceId == deviceId &&
other.environmentType == environmentType;
other.environmentType == environmentType &&
other.isWatch == isWatch;
}
}

Expand Down
58 changes: 52 additions & 6 deletions packages/flutter_tools/lib/src/xcode_project.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ class IosProject extends XcodeBasedProject {
BuildInfo? buildInfo, {
EnvironmentType environmentType = EnvironmentType.physical,
String? deviceId,
String? scheme,
bool isWatch = false,
}) async {
if (!existsSync()) {
return null;
Expand All @@ -265,9 +267,11 @@ class IosProject extends XcodeBasedProject {
return null;
}

final String? scheme = info.schemeFor(buildInfo);
if (scheme == null) {
info.reportFlavorNotFoundAndExit();
scheme = info.schemeFor(buildInfo);
if (scheme == null) {
info.reportFlavorNotFoundAndExit();
}
}

final String? configuration = (await projectInfo())?.buildConfigurationFor(
Expand All @@ -279,6 +283,7 @@ class IosProject extends XcodeBasedProject {
scheme: scheme,
configuration: configuration,
deviceId: deviceId,
isWatch: isWatch,
);
final Map<String, String>? currentBuildSettings = _buildSettingsByBuildContext[buildContext];
if (currentBuildSettings == null) {
Expand Down Expand Up @@ -327,17 +332,21 @@ class IosProject extends XcodeBasedProject {
}

/// Check if one the [targets] of the project is a watchOS companion app target.
Future<bool> containsWatchCompanion(List<String> targets, BuildInfo buildInfo, String? deviceId) async {
Future<bool> containsWatchCompanion({
required XcodeProjectInfo projectInfo,
required BuildInfo buildInfo,
String? deviceId,
}) async {
final String? bundleIdentifier = await productBundleIdentifier(buildInfo);
// A bundle identifier is required for a companion app.
if (bundleIdentifier == null) {
return false;
}
for (final String target in targets) {
for (final String target in projectInfo.targets) {
// Create Info.plist file of the target.
final File infoFile = hostAppRoot.childDirectory(target).childFile('Info.plist');
// The Info.plist file of a target contains the key WKCompanionAppBundleIdentifier,
// if it is a watchOS companion app.
// In older versions of Xcode, if the target was a watchOS companion app,
// the Info.plist file of the target contained the key WKCompanionAppBundleIdentifier.
if (infoFile.existsSync()) {
final String? fromPlist = globals.plistParser.getStringValueFromFile(infoFile.path, 'WKCompanionAppBundleIdentifier');
if (bundleIdentifier == fromPlist) {
Expand All @@ -357,6 +366,43 @@ class IosProject extends XcodeBasedProject {
}
}
}

// If key not found in Info.plist above, do more expensive check of build settings.
// In newer versions of Xcode, the build settings of the watchOS companion
// app's scheme should contain the key INFOPLIST_KEY_WKCompanionAppBundleIdentifier.
final bool watchIdentifierFound = xcodeProjectInfoFile.readAsStringSync().contains('WKCompanionAppBundleIdentifier');
if (watchIdentifierFound == false) {
return false;
}

final String? defaultScheme = projectInfo.schemeFor(buildInfo);
if (defaultScheme == null) {
projectInfo.reportFlavorNotFoundAndExit();
}
for (final String scheme in projectInfo.schemes) {
// the default scheme should not be a watch scheme, so skip it
if (scheme == defaultScheme) {
continue;
}
final Map<String, String>? allBuildSettings = await buildSettingsForBuildInfo(
buildInfo,
deviceId: deviceId,
scheme: scheme,
isWatch: true,
);
if (allBuildSettings != null) {
final String? fromBuild = allBuildSettings['INFOPLIST_KEY_WKCompanionAppBundleIdentifier'];
if (bundleIdentifier == fromBuild) {
return true;
}
if (fromBuild != null && fromBuild.contains(r'$')) {
final String substitutedVariable = substituteXcodeVariables(fromBuild, allBuildSettings);
if (substitutedVariable == bundleIdentifier) {
return true;
}
}
}
}
return false;
}

Expand Down
70 changes: 70 additions & 0 deletions packages/flutter_tools/test/general.shard/ios/xcodeproj_test.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,76 @@ void main() {
ProcessManager: () => FakeProcessManager.any(),
});

testUsingContext('build settings uses watch destination if isWatch is true', () async {
platform.environment = const <String, String>{};

fakeProcessManager.addCommands(<FakeCommand>[
kWhichSysctlCommand,
kx64CheckCommand,
FakeCommand(
command: <String>[
'xcrun',
'xcodebuild',
'-project',
'/',
'-destination',
'generic/platform=watchOS',
'-showBuildSettings',
'BUILD_DIR=${fileSystem.path.absolute('build', 'ios')}',
],
exitCode: 1,
),
]);

expect(
await xcodeProjectInterpreter.getBuildSettings(
'',
buildContext: const XcodeProjectBuildContext(isWatch: true),
),
const <String, String>{},
);
expect(fakeProcessManager, hasNoRemainingExpectations);
}, overrides: <Type, Generator>{
FileSystem: () => fileSystem,
ProcessManager: () => FakeProcessManager.any(),
});

testUsingContext('build settings uses watch simulator destination if isWatch is true and environment type is simulator', () async {
platform.environment = const <String, String>{};

fakeProcessManager.addCommands(<FakeCommand>[
kWhichSysctlCommand,
kx64CheckCommand,
FakeCommand(
command: <String>[
'xcrun',
'xcodebuild',
'-project',
'/',
'-sdk',
'iphonesimulator',
'-destination',
'generic/platform=watchOS Simulator',
'-showBuildSettings',
'BUILD_DIR=${fileSystem.path.absolute('build', 'ios')}',
],
exitCode: 1,
),
]);

expect(
await xcodeProjectInterpreter.getBuildSettings(
'',
buildContext: const XcodeProjectBuildContext(environmentType: EnvironmentType.simulator, isWatch: true),
),
const <String, String>{},
);
expect(fakeProcessManager, hasNoRemainingExpectations);
}, overrides: <Type, Generator>{
FileSystem: () => fileSystem,
ProcessManager: () => FakeProcessManager.any(),
});

testWithoutContext('xcodebuild clean contains Flutter Xcode environment variables', () async {
platform.environment = const <String, String>{
'FLUTTER_XCODE_CODE_SIGN_STYLE': 'Manual',
Expand Down

0 comments on commit 8aad119

Please sign in to comment.