Merge branch 'master' into bs-core-tests

* master: (36 commits)
  Make sure Firestore/core/include is in the podspec (#748)
  fix null block execution crash
  Increase expectation timeout to 25 seconds. (#744)
  fix (#739)
  Align tests and integration test header search paths (#737)
  Remove predecessorKey,Object,Document, etc (#735)
  Start on ArraySortedMap in C++ (#721)
  Move all Firestore Objective-C to Objective-C++ (#734)
  Fix tests.
  [FCM] Add completion handler to subscribe/unsubscribe topic actions
  Schema migrations for LevelDB (#728)
  Firestore DatabaseId in C++ (#727)
  Add absl_strings to firebase_firestore_util_test dependencies (#725)
  Add changelog entry for my last PR (oops) and also add a few that we missed last release. (#724)
  Import iterator_adaptors from google3 (#718)
  Use fixed-sized types (#719)
  Version updates to 4.8.2 (#722)
  Fix a number of c++ build errors (#715)
  Add the C++ linter to the repo (#720)
  travis: check for copyright in sources (#717)
  ...

Author: bstpierr

.travis.yml

@@ -28,6 +28,7 @@ before_install:
 
 script:
   - "! git grep -I ' $'" # Fail on trailing whitespace in non-binary files
+  - "! git grep -EL --name-only 'Copyright [0-9]{4}.*Google' | grep -v third_party | egrep '\\.(m|h|cc|mm|c)$'"
   - ./scripts/style.sh test-only # Validate clang-format compliance
   - |
     if [ $SKIP_FIREBASE != 1 ]; then

Example/Messaging/App/iOS/Messaging-Info.plist

@@ -2,6 +2,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>FirebaseMessagingAutoInitEnabled</key>
+	<false/>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleDisplayName</key>

Example/Messaging/Tests/FIRMessagingServiceTest.m

@@ -198,7 +198,8 @@ - (void)testSubscribeWithNoTopicPrefix {
   NSString *topicNameWithPrefix = [FIRMessagingPubSub addPrefixToTopic:topicName];
   messaging.pubsub = mockPubSub;
   messaging.defaultFcmToken = @"fake-default-token";
-  OCMExpect([messaging.pubsub subscribeToTopic:[OCMArg isEqual:topicNameWithPrefix]]);
+  OCMExpect([messaging.pubsub subscribeToTopic:[OCMArg isEqual:topicNameWithPrefix]
+                                       handler:[OCMArg any]]);
   [messaging subscribeToTopic:topicName];
   OCMVerifyAll(mockPubSub);
   // Need to swap back since it's a singleton and hence will live beyond the scope of this test.
@@ -213,7 +214,7 @@ - (void)testSubscribeWithTopicPrefix {
   NSString *topicName = @"/topics/topicWithoutPrefix";
   messaging.pubsub = mockPubSub;
   messaging.defaultFcmToken = @"fake-default-token";
-  OCMExpect([messaging.pubsub subscribeToTopic:[OCMArg isEqual:topicName]]);
+  OCMExpect([messaging.pubsub subscribeToTopic:[OCMArg isEqual:topicName] handler:[OCMArg any]]);
   [messaging subscribeToTopic:topicName];
   OCMVerifyAll(mockPubSub);
   // Need to swap back since it's a singleton and hence will live beyond the scope of this test.
@@ -229,7 +230,8 @@ - (void)testUnsubscribeWithNoTopicPrefix {
   NSString *topicNameWithPrefix = [FIRMessagingPubSub addPrefixToTopic:topicName];
   messaging.pubsub = mockPubSub;
   messaging.defaultFcmToken = @"fake-default-token";
-  OCMExpect([messaging.pubsub unsubscribeFromTopic:[OCMArg isEqual:topicNameWithPrefix]]);
+  OCMExpect([messaging.pubsub unsubscribeFromTopic:[OCMArg isEqual:topicNameWithPrefix]
+                                           handler:[OCMArg any]]);
   [messaging unsubscribeFromTopic:topicName];
   OCMVerifyAll(mockPubSub);
   // Need to swap back since it's a singleton and hence will live beyond the scope of this test.
@@ -244,7 +246,8 @@ - (void)testUnsubscribeWithTopicPrefix {
   NSString *topicName = @"/topics/topicWithPrefix";
   messaging.pubsub = mockPubSub;
   messaging.defaultFcmToken = @"fake-default-token";
-  OCMExpect([messaging.pubsub unsubscribeFromTopic:[OCMArg isEqual:topicName]]);
+  OCMExpect([messaging.pubsub unsubscribeFromTopic:[OCMArg isEqual:topicName]
+                                           handler:[OCMArg any]]);
   [messaging unsubscribeFromTopic:topicName];
   OCMVerifyAll(mockPubSub);
   // Need to swap back since it's a singleton and hence will live beyond the scope of this test.

Example/Messaging/Tests/FIRMessagingTest.m

@@ -20,6 +20,7 @@
 
 #import "FIRMessaging.h"
 #import "FIRMessagingInstanceIDProxy.h"
+#import "FIRMessaging_Private.h"
 
 extern NSString *const kFIRMessagingFCMTokenFetchAPNSOption;
 
@@ -28,6 +29,7 @@ @interface FIRMessaging ()
 @property(nonatomic, readwrite, strong) NSString *defaultFcmToken;
 @property(nonatomic, readwrite, strong) NSData *apnsTokenData;
 @property(nonatomic, readwrite, strong) FIRMessagingInstanceIDProxy *instanceIDProxy;
+@property(nonatomic, readwrite, strong) NSUserDefaults *messagingUserDefaults;
 
 - (instancetype)initPrivately;
 // Direct Channel Methods
@@ -52,6 +54,9 @@ - (void)setUp {
   _mockMessaging = OCMPartialMock(self.messaging);
   _mockInstanceIDProxy = OCMPartialMock(self.messaging.instanceIDProxy);
   self.messaging.instanceIDProxy = _mockInstanceIDProxy;
+  [self.messaging.messagingUserDefaults removePersistentDomainForName:kFIRMessagingSuiteName];
+  self.messaging.messagingUserDefaults =
+      [[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingSuiteName];
 }
 
 - (void)tearDown {
@@ -60,6 +65,15 @@ - (void)tearDown {
   [super tearDown];
 }
 
+- (void)testAutoInitEnableFlag {
+  // Should read from Info.plist
+  XCTAssertFalse(_messaging.isAutoInitEnabled);
+
+  // Now set the flag should overwrite Info.plist value.
+  _messaging.autoInitEnabled = YES;
+  XCTAssertTrue(_messaging.isAutoInitEnabled);
+}
+
 #pragma mark - Direct Channel Establishment Testing
 
 // Should connect with valid token and application in foreground

Example/Messaging/Tests/Info.plist

@@ -20,5 +20,7 @@
 	<string>????</string>
 	<key>CFBundleVersion</key>
 	<string>1</string>
+        <key>FirebaseMessagingAutoInitEnabled</key>
+        <false/>
 </dict>
 </plist>

Example/Podfile

@@ -8,7 +8,7 @@ target 'Core_Example_iOS' do
   # The next line is the forcing function for the Firebase pod. The Firebase
   # version's subspecs should depend on the component versions in their
   # corresponding podspec's.
-  pod 'Firebase/Core', '4.8.1'
+  pod 'Firebase/Core', '4.8.2'
 
   target 'Core_Tests_iOS' do
     inherit! :search_paths

Firebase/Auth/FirebaseAuth.podspec

@@ -45,6 +45,7 @@ Simplify your iOS development, grow your user base, and monetize more effectivel
     '$(inherited) ' + 'FIRAuth_VERSION=' + s.version.to_s +
     ' FIRAuth_MINOR_VERSION=' + s.version.to_s.split(".")[0] + "." + s.version.to_s.split(".")[1]
   }
+  s.framework = 'CoreGraphics'
   s.framework = 'SafariServices'
   s.framework = 'Security'
 #  s.dependency 'FirebaseCommunity/Core'

Firebase/Auth/Source/Public/FIREmailAuthProvider.h

@@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
 extern NSString *const FIREmailAuthProviderID NS_SWIFT_NAME(EmailAuthProviderID);
 
 /**
-    @brief please use `FIREmailAuthProviderID` instead.
+    @brief Please use `FIREmailAuthProviderID` for Objective-C or `EmailAuthProviderID` for Swift instead.
  */
 extern NSString *const FIREmailPasswordAuthProviderID __attribute__((deprecated));
 

Firebase/Core/CHANGELOG.md

@@ -1,4 +1,6 @@
-# v4.0.14 -- M21.1
+# Unreleased
+
+# 2018-01-18 -- v4.0.14 -- M21.1
 - [changed] Removed AppKit dependency for community macOS build.
 
 # 2017-11-30 -- v4.0.12 -- M20.2

Firebase/Messaging/FIRMessaging.m

@@ -70,6 +70,14 @@
     @"com.firebase.messaging.notif.fcm-token-refreshed";
 #endif  // defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
 
+NSString *const kFIRMessagingUserDefaultsKeyAutoInitEnabled =
+    @"com.firebase.messaging.auto-init.enabled";  // Auto Init Enabled key stored in NSUserDefaults
+NSString *const kFIRMessagingSuiteName =
+    @"com.firebase.messaging.user_defaults";  // Suite name for NSUserDefaults
+
+static NSString *const kFIRMessagingPlistAutoInitEnabled =
+    @"FirebaseMessagingAutoInitEnabled";  // Auto Init Enabled key stored in Info.plist
+
 // Copied from Apple's header in case it is missing in some cases (e.g. pre-Xcode 8 builds).
 #ifndef NSFoundationVersionNumber_iOS_8_x_Max
 #define NSFoundationVersionNumber_iOS_8_x_Max 1199
@@ -120,8 +128,8 @@ - (instancetype)initWithMessage:(FIRMessagingRemoteMessage *)message {
 
 @end
 
-@interface FIRMessaging ()
-    <FIRMessagingClientDelegate, FIRMessagingReceiverDelegate, FIRReachabilityDelegate>
+@interface FIRMessaging ()<FIRMessagingClientDelegate, FIRMessagingReceiverDelegate,
+                           FIRReachabilityDelegate>
 
 // FIRApp properties
 @property(nonatomic, readwrite, copy) NSString *fcmSenderID;
@@ -141,6 +149,7 @@ @interface FIRMessaging ()
 @property(nonatomic, readwrite, strong) FIRMessagingRmqManager *rmq2Manager;
 @property(nonatomic, readwrite, strong) FIRMessagingReceiver *receiver;
 @property(nonatomic, readwrite, strong) FIRMessagingSyncMessageManager *syncMessageManager;
+@property(nonatomic, readwrite, strong) NSUserDefaults *messagingUserDefaults;
 
 /// Message ID's logged for analytics. This prevents us from logging the same message twice
 /// which can happen if the user inadvertently calls `appDidReceiveMessage` along with us
@@ -166,6 +175,7 @@ - (instancetype)initPrivately {
   if (self) {
     _loggedMessageIDs = [NSMutableSet set];
     _instanceIDProxy = [[FIRMessagingInstanceIDProxy alloc] init];
+    _messagingUserDefaults = [[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingSuiteName];
   }
   return self;
 }
@@ -451,6 +461,33 @@ - (void)setAPNSToken:(NSData *)apnsToken type:(FIRMessagingAPNSTokenType)type {
 
 #pragma mark - FCM
 
+- (BOOL)isAutoInitEnabled {
+  // Check storage
+  id isAutoInitEnabledObject =
+      [_messagingUserDefaults objectForKey:kFIRMessagingUserDefaultsKeyAutoInitEnabled];
+  if (isAutoInitEnabledObject) {
+    return [isAutoInitEnabledObject boolValue];
+  }
+
+  // Check Info.plist
+  isAutoInitEnabledObject =
+      [[NSBundle mainBundle] objectForInfoDictionaryKey:kFIRMessagingPlistAutoInitEnabled];
+  if (isAutoInitEnabledObject) {
+    return [isAutoInitEnabledObject boolValue];
+  }
+  // If none of above exists, we default assume FCM auto init is enabled.
+  return YES;
+}
+
+- (void)setAutoInitEnabled:(BOOL)autoInitEnabled {
+  BOOL isFCMAutoInitEnabled = [self isAutoInitEnabled];
+  [_messagingUserDefaults setBool:autoInitEnabled
+                           forKey:kFIRMessagingUserDefaultsKeyAutoInitEnabled];
+  if (!isFCMAutoInitEnabled && autoInitEnabled) {
+    self.defaultFcmToken = [self.instanceIDProxy token];
+  }
+}
+
 - (NSString *)FCMToken {
   NSString *token = self.defaultFcmToken;
   if (!token) {
@@ -646,10 +683,15 @@ + (NSString *)normalizeTopic:(NSString *)topic {
 }
 
 - (void)subscribeToTopic:(NSString *)topic {
+  [self subscribeToTopic:topic completion:nil];
+}
+
+- (void)subscribeToTopic:(NSString *)topic
+              completion:(nullable FIRMessagingTopicOperationCompletion)completion {
   if (self.defaultFcmToken.length && topic.length) {
     NSString *normalizeTopic = [[self class ] normalizeTopic:topic];
     if (normalizeTopic.length) {
-      [self.pubsub subscribeToTopic:normalizeTopic];
+      [self.pubsub subscribeToTopic:normalizeTopic handler:completion];
     } else {
       FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging009,
                               @"Cannot parse topic name %@. Will not subscribe.", topic);
@@ -662,10 +704,15 @@ - (void)subscribeToTopic:(NSString *)topic {
 }
 
 - (void)unsubscribeFromTopic:(NSString *)topic {
+  [self unsubscribeFromTopic:topic completion:nil];
+}
+
+- (void)unsubscribeFromTopic:(NSString *)topic
+                  completion:(nullable FIRMessagingTopicOperationCompletion)completion {
   if (self.defaultFcmToken.length && topic.length) {
     NSString *normalizeTopic = [[self class] normalizeTopic:topic];
     if (normalizeTopic.length) {
-      [self.pubsub unsubscribeFromTopic:normalizeTopic];
+      [self.pubsub unsubscribeFromTopic:normalizeTopic handler:completion];
     } else {
       FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging011,
                               @"Cannot parse topic name %@. Will not unsubscribe.", topic);
@@ -787,7 +834,7 @@ - (FIRMessagingNetworkStatus)networkType {
 #pragma mark - Notifications
 
 - (void)didReceiveDefaultInstanceIDToken:(NSNotification *)notification {
-  if (![notification.object isKindOfClass:[NSString class]]) {
+  if (notification.object && ![notification.object isKindOfClass:[NSString class]]) {
     FIRMessagingLoggerDebug(kFIRMessagingMessageCodeMessaging015,
                             @"Invalid default FCM token type %@",
                             NSStringFromClass([notification.object class]));

Firebase/Messaging/FIRMessagingPubSub.h

@@ -59,6 +59,7 @@
  *                   library for a given `authorizedEntity` and "gcm" scope.
  *  @param topic    The topic to subscribe to. Should be of the form
  *                  `"/topics/<topic-name>"`.
+ *  @param options  Unused parameter, please pass nil or empty dictionary.
  *  @param handler  The callback handler invoked when the subscribe call
  *                  ends. In case of success, a nil error is returned. Otherwise,
  *                  an appropriate error object is returned.
@@ -70,7 +71,6 @@
                    options:(NSDictionary *)options
                    handler:(FIRMessagingTopicOperationCompletion)handler;
 
-
 /**
  *  Unsubscribes an app instance from a topic, stopping it from receiving
  *  any further messages sent to that topic.
@@ -81,6 +81,7 @@
  *  @param token   The token used to subscribe to this topic.
  *  @param topic   The topic to unsubscribe from. Should be of the form
  *                 `"/topics/<topic-name>"`.
+ *  @param options Unused parameter, please pass nil or empty dictionary.
  *  @param handler The handler that is invoked once the unsubscribe call ends.
  *                 In case of success, nil error is returned. Otherwise, an
  *                  appropriate error object is returned.
@@ -98,17 +99,25 @@
  *  as compared to the `subscribe` method above which tries once.
  *
  *  @param topic The topic name to subscribe to. Should be of the form `"/topics/<topic-name>"`.
+ *  @param handler The handler that is invoked once the unsubscribe call ends.
+ *                 In case of success, nil error is returned. Otherwise, an
+ *                  appropriate error object is returned.
  */
-- (void)subscribeToTopic:(NSString *)topic;
+- (void)subscribeToTopic:(NSString *)topic
+                 handler:(nullable FIRMessagingTopicOperationCompletion)handler;
 
 /**
  *  Asynchronously unsubscribe from the topic. Adds to the pending list of topic operations.
  *  Retry in case of failures. This makes a repeated attempt to unsubscribe from the topic
  *  as compared to the `unsubscribe` method above which tries once.
  *
  *  @param topic The topic name to unsubscribe from. Should be of the form `"/topics/<topic-name>"`.
+ *  @param handler The handler that is invoked once the unsubscribe call ends.
+ *                 In case of success, nil error is returned. Otherwise, an
+ *                  appropriate error object is returned.
  */
-- (void)unsubscribeFromTopic:(NSString *)topic;
+- (void)unsubscribeFromTopic:(NSString *)topic
+                     handler:(nullable FIRMessagingTopicOperationCompletion)handler;
 
 /**
  *  Schedule subscriptions sync.

Firebase/Messaging/FIRMessagingPubSub.m

@@ -146,16 +146,18 @@ - (void)unsubscribeWithToken:(NSString *)token
   }];
 }
 
-- (void)subscribeToTopic:(NSString *)topic {
+- (void)subscribeToTopic:(NSString *)topic
+                 handler:(nullable FIRMessagingTopicOperationCompletion)handler {
   [self.pendingTopicUpdates addOperationForTopic:topic
                                       withAction:FIRMessagingTopicActionSubscribe
-                                      completion:nil];
+                                      completion:handler];
 }
 
-- (void)unsubscribeFromTopic:(NSString *)topic {
+- (void)unsubscribeFromTopic:(NSString *)topic
+                     handler:(nullable FIRMessagingTopicOperationCompletion)handler {
   [self.pendingTopicUpdates addOperationForTopic:topic
                                       withAction:FIRMessagingTopicActionUnsubscribe
-                                      completion:nil];
+                                      completion:handler];
 }
 
 - (void)scheduleSync:(BOOL)immediately {

Firebase/Messaging/FIRMessagingTopicOperation.m

@@ -82,6 +82,7 @@ - (instancetype)initWithTopic:(NSString *)topic
     _topic = topic;
     _action = action;
     _token = token;
+    _options = options;
     _checkinService = checkinService;
     _completion = completion;
 

Firebase/Messaging/FIRMessaging_Private.h

@@ -25,6 +25,9 @@ typedef NS_ENUM(int8_t, FIRMessagingNetworkStatus) {
   kFIRMessagingReachabilityReachableViaWWAN,
 };
 
+FOUNDATION_EXPORT NSString *const kFIRMessagingUserDefaultsKeyAutoInitEnabled;
+FOUNDATION_EXPORT NSString *const kFIRMessagingSuiteName;
+
 @interface FIRMessagingRemoteMessage ()
 
 @property(nonatomic, strong) NSDictionary *appData;

Firebase/Messaging/Public/FIRMessaging.h

@@ -289,7 +289,6 @@ NS_SWIFT_NAME(Messaging)
  */
 @property(nonatomic, weak, nullable) id<FIRMessagingDelegate> delegate;
 
-
 /**
  * Delegate to handle remote data messages received via FCM for devices running iOS 10 or above.
  */
@@ -353,6 +352,20 @@ NS_SWIFT_NAME(Messaging)
 
 #pragma mark - FCM Tokens
 
+/**
+ * Is Firebase Messaging token auto generation enabled?  If this flag is disabled,
+ * Firebase Messaging will not generate token automatically for message delivery.
+ *
+ * This setting is persisted, and is applied on future
+ * invocations of your application.  Once explicitly set, it overrides any
+ * settings in your Info.plist.
+ *
+ * By default, FCM automatic initialization is enabled.  If you need to change the
+ * default (for example, because you want to prompt the user before getting token)
+ * set FirebaseMessagingAutoInitEnabled to false in your application's Info.plist.
+ */
+@property(nonatomic, assign, getter=isAutoInitEnabled) BOOL autoInitEnabled;
+
 /**
  *  The FCM token is used to identify this device so that FCM can send notifications to it.
  *  It is associated with your APNS token when the APNS token is supplied, so that sending