Make iOS Flutter framework extension-safe (#165346)

Our current
[adoption/documentation](https://docs.flutter.dev/platform-integration/ios/app-extensions)
for iOS Extensions does not currently work because it's disallowed to
nest bundles (see flutter/flutter#142531).

As of [Xcode
13](https://developer.apple.com/documentation/xcode-release-notes/xcode-13-release-notes/#:~:text=Linking%20Swift%20packages%20from%20application%20extension%20targets%20or%20watchOS%20applications%20no%20longer%20emits%20unresolvable%20warnings%20about%20linking%20to%20libraries%20not%20safe%20for%20use%20in%20application%20extensions%2E),
linking to frameworks that contain non-extension-safe code no longer
gives warnings (or blocks from App Store it seems). Therefore, it has
become a runtime issue to ensure non-extension-safe code is not used.

Previously, we were building and shipping 2 separate
Flutter.xcframeworks. One that was extension-safe and one that was not.

This PR removes the "extension_safe" framework and instead makes the
entire framework extension-safe by annotating non-extension-safe code
with `NS_EXTENSION_UNAVAILABLE_IOS` and ensuring that code is not used
at runtime if the bundle is for an app extension.

This PR also disables wide gamut for app extensions to decrease the
chances of crashes (see
flutter/flutter#165086).

Fixes flutter/flutter#142531.
 
 ---
 
For reference:

App extensions were first evaluated in
https://flutter.dev/go/app-extensions. Here is the reasoning why neither
method described there is opportune.

Option 1 -
I did look into splitting the framework into 2 frameworks (one with all
extension-safe code and one with the non-extension-safe code). However,
the original idea was to use objc Categories/Extensions - this doesn’t
quite fit our needs. Categories/Extensions only allow you to add new
methods/properties, not override existing ones. We could hypothetically
add new methods, but that would require the user to change their code to
use the new methods.

I also looked into subclasses which does allow overrides, but it would
also require the user to change their code to use the new class.

We could do method swizzling, but opinion of that on the internet is
that it's not very safe.

I’m of the opinion that anything that requires the user to change code
isn’t super feasible due to plugins.

Option 2 -
We could still do the 2 frameworks but rename one to
`FlutterExtentionSafe`. This works without users needing to change any
code (including imports like `@import Flutter` / `#import
<Flutter/Flutter.h>`). I believe the reason this works is because at
compile time, it finds the `Flutter` framework on the framework search
path and it imports in the headers. Then at link time,
`FlutterExtentionSafe` is explicitly linked so it uses that framework
first when checking for symbols and since it finds all the symbols in
`FlutterExtentionSafe`, it doesn’t need/try to auto-link the `Flutter`
framework (despite `Flutter` being the framework imported).

This seems precarious to me since we’re relying on Xcode to not
auto-link the `Flutter` framework. If for some reason `Flutter`
framework did get auto-linked (such as the user using a symbol that’s
not in the `FlutterExtensionSafe` framework but is in the `Flutter`
framework - this is unlikely though), we’d get name collision issues

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

Author: vashworth

engine/src/build/config/ios/BUILD.gn

@@ -5,3 +5,9 @@
 config("sdk") {
   cflags_cc = [ "-stdlib=libc++" ]
 }
+
+config("ios_application_extension") {
+  cflags_objc = [ "-fapplication-extension" ]
+  cflags_objcc = [ "-fapplication-extension" ]
+  ldflags = [ "-fapplication-extension" ]
+}

engine/src/flutter/ci/licenses_golden/licenses_flutter

@@ -52788,6 +52788,9 @@ ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterResto
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterRestorationPluginTest.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSemanticsScrollView.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSemanticsScrollView.mm + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.mm + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplicationTest.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPluginTest.mm + ../../../flutter/LICENSE
@@ -55789,6 +55792,9 @@ FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterRestora
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterRestorationPluginTest.mm
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSemanticsScrollView.h
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSemanticsScrollView.mm
+FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.h
+FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.mm
+FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplicationTest.mm
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.h
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.mm
 FILE: ../../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPluginTest.mm

engine/src/flutter/common/config.gni

@@ -23,12 +23,6 @@ declare_args() {
   # Whether to include backtrace support.
   enable_backtrace = true
 
-  # Whether to include --fapplication-extension when build iOS framework.
-  # This is currently a test flag and does not work properly.
-  #TODO(cyanglaz): Remove above comment about test flag when the entire iOS embedder supports app extension
-  #https://github.com/flutter/flutter/issues/124289
-  darwin_extension_safe = false
-
   # Whether binary size optimizations with the assumption that Impeller is the
   # only supported rendering engine are enabled.
   #

engine/src/flutter/shell/platform/darwin/ios/BUILD.gn

@@ -45,14 +45,13 @@ source_set("flutter_framework_source") {
   cflags_objcc = flutter_cflags_objcc
 
   defines = [ "FLUTTER_FRAMEWORK=1" ]
-  if (darwin_extension_safe) {
-    defines += [ "APPLICATION_EXTENSION_API_ONLY=1" ]
-  }
   public_configs = [
     ":ios_gpu_configuration_config",
     "//flutter:config",
   ]
 
+  configs += [ "//build/config/ios:ios_application_extension" ]
+
   sources = [
     "framework/Source/FlutterAppDelegate.mm",
     "framework/Source/FlutterCallbackCache.mm",
@@ -88,6 +87,8 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterRestorationPlugin.mm",
     "framework/Source/FlutterSemanticsScrollView.h",
     "framework/Source/FlutterSemanticsScrollView.mm",
+    "framework/Source/FlutterSharedApplication.h",
+    "framework/Source/FlutterSharedApplication.mm",
     "framework/Source/FlutterSpellCheckPlugin.h",
     "framework/Source/FlutterSpellCheckPlugin.mm",
     "framework/Source/FlutterTextInputDelegate.h",
@@ -225,6 +226,7 @@ shared_library("ios_test_flutter") {
     "framework/Source/FlutterPlatformViewsTest.mm",
     "framework/Source/FlutterPluginAppLifeCycleDelegateTest.mm",
     "framework/Source/FlutterRestorationPluginTest.mm",
+    "framework/Source/FlutterSharedApplicationTest.mm",
     "framework/Source/FlutterSpellCheckPluginTest.mm",
     "framework/Source/FlutterTextInputPluginTest.mm",
     "framework/Source/FlutterTextureRegistryRelayTest.mm",
@@ -262,10 +264,6 @@ shared_library("ios_test_flutter") {
     ":ios_gpu_configuration_config",
     "//flutter:config",
   ]
-
-  if (darwin_extension_safe) {
-    defines = [ "APPLICATION_EXTENSION_API_ONLY=1" ]
-  }
 }
 
 shared_library("create_flutter_framework_dylib") {
@@ -275,15 +273,12 @@ shared_library("create_flutter_framework_dylib") {
 
   ldflags = [ "-Wl,-install_name,@rpath/Flutter.framework/Flutter" ]
 
-  if (darwin_extension_safe) {
-    ldflags += [ "-fapplication-extension" ]
-  }
-
   public = _flutter_framework_headers
 
   deps = [ ":flutter_framework_source" ]
 
   public_configs = [ "//flutter:config" ]
+  configs += [ "//build/config/ios:ios_application_extension" ]
 }
 
 copy("copy_dylib") {
@@ -375,9 +370,11 @@ copy("copy_license") {
 shared_library("copy_and_verify_framework_module") {
   framework_search_path = rebase_path("$root_out_dir")
   visibility = [ ":*" ]
-  cflags_objc = [
+  cflags_objc = [ "-F$framework_search_path" ]
+  ldflags = [
     "-F$framework_search_path",
-    "-fapplication-extension",
+    "-Xlinker",
+    "-fatal_warnings",
   ]
 
   sources = [ "framework/Source/FlutterUmbrellaImport.m" ]
@@ -388,16 +385,7 @@ shared_library("copy_and_verify_framework_module") {
     ":copy_framework_privacy_manifest",
   ]
 
-  if (darwin_extension_safe) {
-    ldflags = [
-      "-F$framework_search_path",
-      "-fapplication-extension",
-      "-Xlinker",
-      "-fatal_warnings",
-    ]
-    deps += [ ":copy_dylib" ]
-    frameworks = [ "Flutter.framework" ]
-  }
+  configs += [ "//build/config/ios:ios_application_extension" ]
 }
 
 group("universal_flutter_framework") {

engine/src/flutter/shell/platform/darwin/ios/framework/Source/FlutterAppDelegate.mm

@@ -10,6 +10,7 @@
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterAppDelegate_Test.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterEngine_Internal.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterPluginAppLifeCycleDelegate_internal.h"
+#import "flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterViewController_Internal.h"
 
 FLUTTER_ASSERT_ARC
@@ -154,6 +155,10 @@ - (BOOL)application:(UIApplication*)application
 - (BOOL)handleOpenURL:(NSURL*)url
                      options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
     relayToSystemIfUnhandled:(BOOL)throwBack {
+  UIApplication* flutterApplication = FlutterSharedApplication.application;
+  if (flutterApplication == nil) {
+    return NO;
+  }
   if (![self isFlutterDeepLinkingEnabled]) {
     return NO;
   }
@@ -164,9 +169,9 @@ - (BOOL)handleOpenURL:(NSURL*)url
                                  completionHandler:^(BOOL success) {
                                    if (!success && throwBack) {
                                      // throw it back to iOS
-                                     [UIApplication.sharedApplication openURL:url
-                                                                      options:@{}
-                                                            completionHandler:nil];
+                                     [flutterApplication openURL:url
+                                                         options:@{}
+                                               completionHandler:nil];
                                    }
                                  }];
   } else {

engine/src/flutter/shell/platform/darwin/ios/framework/Source/FlutterEngine.mm

@@ -26,6 +26,7 @@
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterDartVMServicePublisher.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterIndirectScribbleDelegate.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterPlatformPlugin.h"
+#import "flutter/shell/platform/darwin/ios/framework/Source/FlutterSharedApplication.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterTextInputDelegate.h"
 #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterTextureRegistryRelay.h"
@@ -227,15 +228,7 @@ - (instancetype)initWithName:(NSString*)labelPrefix
                  name:UIApplicationDidReceiveMemoryWarningNotification
                object:nil];
 
-#if APPLICATION_EXTENSION_API_ONLY
-  if (@available(iOS 13.0, *)) {
-    [self setUpSceneLifecycleNotifications:center];
-  } else {
-    [self setUpApplicationLifecycleNotifications:center];
-  }
-#else
-  [self setUpApplicationLifecycleNotifications:center];
-#endif
+  [self setUpLifecycleNotifications:center];
 
   [center addObserver:self
              selector:@selector(onLocaleUpdated:)
@@ -250,18 +243,21 @@ + (FlutterEngine*)engineForIdentifier:(int64_t)identifier {
   return (__bridge FlutterEngine*)reinterpret_cast<void*>(identifier);
 }
 
-- (void)setUpSceneLifecycleNotifications:(NSNotificationCenter*)center API_AVAILABLE(ios(13.0)) {
-  [center addObserver:self
-             selector:@selector(sceneWillEnterForeground:)
-                 name:UISceneWillEnterForegroundNotification
-               object:nil];
-  [center addObserver:self
-             selector:@selector(sceneDidEnterBackground:)
-                 name:UISceneDidEnterBackgroundNotification
-               object:nil];
-}
-
-- (void)setUpApplicationLifecycleNotifications:(NSNotificationCenter*)center {
+- (void)setUpLifecycleNotifications:(NSNotificationCenter*)center {
+  // If the application is not available, use the scene for lifecycle notifications if available.
+  if (!FlutterSharedApplication.isAvailable) {
+    if (@available(iOS 13.0, *)) {
+      [center addObserver:self
+                 selector:@selector(sceneWillEnterForeground:)
+                     name:UISceneWillEnterForegroundNotification
+                   object:nil];
+      [center addObserver:self
+                 selector:@selector(sceneDidEnterBackground:)
+                     name:UISceneDidEnterBackgroundNotification
+                   object:nil];
+      return;
+    }
+  }
   [center addObserver:self
              selector:@selector(applicationWillEnterForeground:)
                  name:UIApplicationWillEnterForegroundNotification
@@ -855,19 +851,8 @@ - (BOOL)createShell:(NSString*)entrypoint
                                     _threadHost->io_thread->GetTaskRunner()          // io
   );
 
-#if APPLICATION_EXTENSION_API_ONLY
-  if (@available(iOS 13.0, *)) {
-    _isGpuDisabled = self.viewController.flutterWindowSceneIfViewLoaded.activationState ==
-                     UISceneActivationStateBackground;
-  } else {
-    // [UIApplication sharedApplication API is not available for app extension.
-    // We intialize the shell assuming the GPU is required.
-    _isGpuDisabled = NO;
-  }
-#else
-  _isGpuDisabled =
-      [UIApplication sharedApplication].applicationState == UIApplicationStateBackground;
-#endif
+  // Disable GPU if the app or scene is running in the background.
+  self.isGpuDisabled = self.viewController.stateIsBackground;
 
   // Create the shell. This is a blocking operation.
   std::unique_ptr<flutter::Shell> shell = flutter::Shell::Create(
@@ -1342,23 +1327,21 @@ - (NSObject*)valuePublishedByPlugin:(NSString*)pluginKey {
 
 #pragma mark - Notifications
 
-#if APPLICATION_EXTENSION_API_ONLY
 - (void)sceneWillEnterForeground:(NSNotification*)notification API_AVAILABLE(ios(13.0)) {
   [self flutterWillEnterForeground:notification];
 }
 
 - (void)sceneDidEnterBackground:(NSNotification*)notification API_AVAILABLE(ios(13.0)) {
   [self flutterDidEnterBackground:notification];
 }
-#else
+
 - (void)applicationWillEnterForeground:(NSNotification*)notification {
   [self flutterWillEnterForeground:notification];
 }
 
 - (void)applicationDidEnterBackground:(NSNotification*)notification {
   [self flutterDidEnterBackground:notification];
 }
-#endif
 
 - (void)flutterWillEnterForeground:(NSNotification*)notification {
   [self setIsGpuDisabled:NO];