App Extension support #1895

yusefnapora · 2015-07-07T14:13:29Z

This adds workarounds for the code that was preventing React from compiling when linked against an iOS App Extension target.

Some iOS APIs are unavailable to App Extensions, and Xcode's static analysis will catch attempts to use methods that have been flagged as unavailable.

React currently uses two APIs that are off limits to extensions: [UIApplication sharedApplication] and [UIAlertView initWith ...].

This commit adds a helper function to RCTUtils.[hm] called RCTRunningInAppExtension(), which returns YES if, at runtime, it can be determined that we're running in an app extension (by checking whether the path to [NSBundle mainBundle] has the "appex" path extension).

It also adds a RCTSharedApplication() function, which will return nil if running in an App Extension. If running in an App, RCTSharedApplication() calls sharedApplication by calling performSelector: on the UIApplication class. This passes the static analysis check, and, in my opinion, obeys the "spirit of the law" by only calling sharedApplication after we've determined that it's kosher to do so.

Existing calls to [UIApplication sharedApplication] have been replaced with calls to RCTSharedApplication(), with nil checks where appropriate.

The absence of UIAlertView is similarly handled with a runtime workaround. If we're running in an App, the RCTAlertView(NSString *title, NSString *message, id delegate, NSString *cancelButtonTitle, NSArray *otherButtonTitles) function uses NSInvocation to call the extension-unavailable initWithTitle:message:delegate:cancelButtonTitle:otherButtonTitles: selector. In an Extension it just logs an error and returns nil.

As a result of these changes, React can be linked into a shared library that is then linked into both an App and an App Extension. When running in the App, all existing functionality will continue to work as before. When running in the Extension, AlertIOS will be unavailable, as will APIs that depend on access to [UIApplication sharedApplication].

APIs that are unavailable to extensions are:

RCTActionSheetManager - uses sharedApplication to access the window of the app delegate
RCTImagePickerManager - uses sharedApplication to get the keyWindow property
RCTLinkingManager - uses sharedApplication to open URLs
RCTPushNotificationManager - uses sharedApplication to badge the app icon and register for permissions
RCTDevMenu - uses sharedApplication to get the keyWindow property
RCTPerfStats - uses sharedApplication to access the window of the app delegate

RCTAppState has been updated to return "extension" if running in an app extension.

This PR doesn't attempt to expose the NSExtensionContext to javascript, although a native module could be written to do so.

UIExplorer integration and unit tests all pass. I have a basic proof of concept app, but it needs some cleanup; I'll push it to a repo soonish

nicklockwood · 2015-07-07T20:42:05Z

OK, if you remove the extra error, this looks good to me.

yusefnapora · 2015-07-07T22:43:44Z

@nicklockwood last commit removes the error. Thanks for reviewing this!

brentvatne · 2015-07-08T00:02:59Z

Lovely, nice work @yusefnapora

yusefnapora · 2015-07-08T00:55:54Z

@brentvatne thanks!

brentvatne · 2015-07-21T22:49:49Z

@yusefnapora - can you rebase this please so it can be a clean merge? Thanks!

yusefnapora · 2015-07-21T23:03:19Z

@brentvatne I just force-pushed a rebase onto this existing branch; hope that's alright. I encountered a small conflict in RCTPushNotificationManger.m, but it was straightforward. Integration tests still pass. Don't have time to poke at it more tonight, but if there's anything else you need let me know and I'll circle back tomorrow :)

brentvatne · 2015-07-22T03:14:53Z

Great, ping me when you've had a chance to circle back and verify, then I will check it out and update the tag @yusefnapora!

yusefnapora · 2015-07-22T14:50:00Z

@brentvatne last commit fixes up a couple new invocations of [UIApplication sharedApplication] that I missed last night.

I added a brain-dead example project here: https://github.com/yusefnapora/ReactExtensionDemo/ which is pegged to the last commit and works as expected

brentvatne · 2015-07-22T17:33:44Z

cc @nicklockwood - this looks ready for review and is rebased against master so it's sync ready

nicklockwood · 2015-07-23T12:55:06Z

@yusefnapora I notice you've not done anything to disable UIActionSheet - are action sheets available in extensions?

yusefnapora · 2015-07-23T20:29:35Z

@nicklockwood I'm glad you brought that up, since I hadn't really thought it through. I looked in the headers, and the designated initializer is marked as unavailable:

- (instancetype)initWithTitle:(NSString *)title delegate:(id<UIActionSheetDelegate>)delegate cancelButtonTitle:(NSString *)cancelButtonTitle destructiveButtonTitle:(NSString *)destructiveButtonTitle otherButtonTitles:(NSString *)otherButtonTitles, ...  NS_REQUIRES_NIL_TERMINATION NS_EXTENSION_UNAVAILABLE_IOS("Use UIAlertController instead.");

It didn't trigger the static analysis because RCTActionSheetManager calls [[UIActionSheet alloc] init] instead. But that means we should bail out and hit the failure callback in showActionSheetWithOptions..., since I assume trying to use it from an extension will trigger a runtime error.

I'll do that as soon as I've got time, probably tonight.

yusefnapora · 2015-07-23T20:34:34Z

Although, the fact that the call to alloc/init slipped by the static analysis makes me think that we might not need to use NSInvocation for creating a UIAlertView. We could just use alloc/init and call the setters, like RCTActionSheetManager is doing now.

I'm not sure, but the fact that the call to init is allowed makes me think that Apple is just blacklisting selectors. Since init is everywhere they can't outlaw that, but there's nothing else using the initWithAMillionSpecificParameters selectors.

yusefnapora · 2015-08-07T23:47:51Z

Hey @nicklockwood, this took me a little longer to get to than I thought, sorry about that. I added a check to RCTActionSheetManager to bail out if running in an extension, and also changed RCTAlertView() to use [[UIAlertView alloc] init] which does pass the static analysis check. That seems cleaner than using NSInvocation.

Also rebased onto latest master.

Let me know if anything else is blocking this, and I'll try to get to it soon. Thanks :)

brentvatne · 2015-09-13T21:31:25Z

@yusefnapora - sorry for the delay, could you rebase this again so it would be a clean merge?

idibidiart · 2015-09-17T17:16:43Z

What is the status of App Extensions support for React Native? @brentvatne

@yusefnapora can you rebase as requested? :) excited to try!

This adds workarounds for the code that was preventing React from compiling when linked against an iOS App Extension target. Some iOS APIs are unavailable to App Extensions, and Xcode's static analysis will catch attempts to use methods that have been flagged as unavailable. React currently uses two APIs that are off limits to extensions: `[UIApplication sharedApplication]` and `UIAlertView`. This commit adds a helper function to `RCTUtils.[hm]` called `RCTRunningInAppExtension()`, which returns `YES` if, at runtime, it can be determined that we're running in an app extension (by checking whether the path to `[NSBundle mainBundle]` has the `"appex"` path extension). It also adds a `RCTSharedApplication()` function, which will return `nil` if running in an App Extension. If running in an App, `RCTSharedApplication()` calls `sharedApplication` by calling `performSelector:` on the `UIApplication` class. This passes the static analysis check, and, in my opinion, obeys the "spirit of the law" by only calling `sharedApplication` after we've determined that it's kosher to do so. Existing calls to `[UIApplication sharedApplication]` have been replaced with calls to `RCTSharedApplication()`, with `nil` checks where appropriate. The absence of `UIAlertView` is similarly handled with a runtime workaround. If we're running in an App, the `RCTAlertView(NSString *title, NSString *message, id delegate, NSString *cancelButtonTitle, NSArray *otherButtonTitles)` function uses `NSInvocation` to call the extension-unavailable `initWithTitle:message:delegate:cancelButtonTitle:otherButtonTitles:` selector. In an Extension it just logs an error and returns `nil`. As a result of these changes, React can be linked into a shared library that is then linked into both an App and an App Extension. When running in the App, all existing functionality will continue to work as before. When running in the Extension, `AlertIOS` will be unavailable, as will APIs that depend on access to `[UIApplication sharedApplication]`. APIs that are unavailable to extensions are: `RCTActionSheetManager` - uses `sharedApplication` to access the `window` of the app delegate `RCTImagePickerManager` - uses `sharedApplication` to get the `keyWindow` property `RCTLinkingManager` - uses `sharedApplication` to open URLs `RCTPushNotificationManager` - uses `sharedApplication` to badge the app icon and register for permissions `RCTDevMenu` - uses `sharedApplication` to get the `keyWindow` property `RCTPerfStats` - uses `sharedApplication` to access the `window` of the app delegate

`RCTAlertView()` already logs an error if running in an extension, so this isn't needed.

…plication()

UIActionSheet is off limits, so exit early if we're running in an app extension. The menu wouldn't show anyway, since we can't get the app delegate's keyWindow property. But this prevents us from trying to use UIActionSheet at all, so is probably safer.

yusefnapora · 2015-09-17T19:07:24Z

@brentvatne: I just rebased this & ran the UIExplorer integration tests. Don't have much time today, but hopefully soon I can put up a decent example of using react in an extension.

@idibidiart: right now the support is pretty basic; you can link react into an extension and use it to render (so long as you create your own RCTRootView), but you're missing out on the Dev Menu, redbox, etc.

This PR also doesn't do anything to expose extension inputs to javascript, although I've got a proof-of-concept native module that can load images shared from the camera roll, via the extension. Needs cleanup though & I don't know when I'll have time to work on it.

javache · 2015-09-21T17:12:42Z

Libraries/PushNotificationIOS/RCTPushNotificationManager.m

-
+  [app registerUserNotificationSettings:notificationSettings];
+  [app registerForRemoteNotifications];
+  


nit: can you remove the whitespace here?

javache · 2015-09-21T17:13:49Z

React/Modules/RCTAlertManager.m

-                                                     delegate:self
-                                            cancelButtonTitle:nil
-                                            otherButtonTitles:nil];
+


nit: whitespace

javache · 2015-09-21T17:14:40Z

Looks good to me. I left some small remarks, if you could address those, I'll merge this in master.

javache · 2015-09-22T16:33:18Z

@facebook-github-bot shipit

facebook-github-bot · 2015-09-22T16:36:46Z

Thanks for importing. If you are an FB employee go to https://our.intern.facebook.com/intern/opensource/github/pull_request/1626368660962669/int_phab to review.

@nicklockwood

Summary: This adds workarounds for the code that was preventing React from compiling when linked against an iOS App Extension target. Some iOS APIs are unavailable to App Extensions, and Xcode's static analysis will catch attempts to use methods that have been flagged as unavailable. React currently uses two APIs that are off limits to extensions: `[UIApplication sharedApplication]` and `[UIAlertView initWith ...]`. This commit adds a helper function to `RCTUtils.[hm]` called `RCTRunningInAppExtension()`, which returns `YES` if, at runtime, it can be determined that we're running in an app extension (by checking whether the path to `[NSBundle mainBundle]` has the `"appex"` path extension). It also adds a `RCTSharedApplication()` function, which will return `nil` if running in an App Extension. If running in an App, `RCTSharedApplication()` calls `sharedApplication` by calling `performSelector:` on the `UIApplication` class. This passes the static analysis check, and, in my opinion, obeys the "spirit of th Closes facebook#1895 Reviewed By: @svcscm Differential Revision: D2224128 Pulled By: @nicklockwood

facebook-github-bot added GH Review: review-needed CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. labels Jul 7, 2015

brentvatne assigned nicklockwood Jul 8, 2015

exentrich mentioned this pull request Aug 17, 2015

Merge App Extension support with 0.10 #2357

Closed

yusefnapora added 8 commits September 17, 2015 13:36

Remove redundant error message

ca52627

`RCTAlertView()` already logs an error if running in an extension, so this isn't needed.

Replace new uses of [UIApplication sharedApplication] with RCTShareAp…

7892c0c

…plication()

Use [[UIAlertView alloc] init] instead of NSInvocation

93bbe2a

Use RCTSharedApplication() in RCTStatusBarManager

6666395

Nil check for cancel button title in UIAlertView

37aef7a

Prevent RCTActionSheetMananger from showing action sheet in extensions

6a1cc67

javache reviewed Sep 21, 2015
View reviewed changes

React/Modules/RCTAlertManager.m

delegate:self

cancelButtonTitle:nil

otherButtonTitles:nil];

Copy link

Member

javache Sep 21, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: whitespace

rm whitespace

4d6893d

javache added GH Review: accepted and removed GH Review: review-needed labels Sep 22, 2015

ghost closed this in 2f9bd1f Sep 22, 2015

chrisbianca mentioned this pull request Oct 13, 2017

Support iOS app extensions yamill/react-native-orientation#240

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

App Extension support #1895

App Extension support #1895

yusefnapora commented Jul 7, 2015

nicklockwood commented Jul 7, 2015

yusefnapora commented Jul 7, 2015

brentvatne commented Jul 8, 2015

yusefnapora commented Jul 8, 2015

brentvatne commented Jul 21, 2015

yusefnapora commented Jul 21, 2015

brentvatne commented Jul 22, 2015

yusefnapora commented Jul 22, 2015

brentvatne commented Jul 22, 2015

nicklockwood commented Jul 23, 2015

yusefnapora commented Jul 23, 2015

yusefnapora commented Jul 23, 2015

yusefnapora commented Aug 7, 2015

brentvatne commented Sep 13, 2015

idibidiart commented Sep 17, 2015

yusefnapora commented Sep 17, 2015

javache Sep 21, 2015

javache Sep 21, 2015

javache commented Sep 21, 2015

javache commented Sep 22, 2015

facebook-github-bot commented Sep 22, 2015


		[app registerUserNotificationSettings:notificationSettings];
		[app registerForRemoteNotifications];

App Extension support #1895

App Extension support #1895

Conversation

yusefnapora commented Jul 7, 2015

nicklockwood commented Jul 7, 2015

yusefnapora commented Jul 7, 2015

brentvatne commented Jul 8, 2015

yusefnapora commented Jul 8, 2015

brentvatne commented Jul 21, 2015

yusefnapora commented Jul 21, 2015

brentvatne commented Jul 22, 2015

yusefnapora commented Jul 22, 2015

brentvatne commented Jul 22, 2015

nicklockwood commented Jul 23, 2015

yusefnapora commented Jul 23, 2015

yusefnapora commented Jul 23, 2015

yusefnapora commented Aug 7, 2015

brentvatne commented Sep 13, 2015

idibidiart commented Sep 17, 2015

yusefnapora commented Sep 17, 2015

javache Sep 21, 2015

Choose a reason for hiding this comment

javache Sep 21, 2015

Choose a reason for hiding this comment

javache commented Sep 21, 2015

javache commented Sep 22, 2015

facebook-github-bot commented Sep 22, 2015