Add global data collection switch. #1219

ryanwilson · 2018-05-03T17:56:16Z

NOTE: This shouldn't be public until all SDKs conform to the setting.

This allows developers to enable/disable all collection at compile time and override it at runtime.

Also formatted code.

charlotteliang · 2018-05-09T18:02:44Z

Firebase/Messaging/FIRMessaging.m

-  return YES;
+
+  // If none of above exists, we default to the global switch that comes from FIRApp.
+  return self.isGlobalAutomaticDataCollectionEnabled;


Before we make sure it's default true if no special action happened on the user side, so we make sure we are not breaking app's existing behavior on fetching instanceID, and other activities.

Is this global boolean value also serves the same purpose, that if developer doesn't do anything, it will be default ture?

Yep, if nothing is set in the plist or at runtime, the default is true and we have unit tests to confirm that.

baolocdo · 2018-05-09T22:04:33Z

Firebase/Core/FIRApp.m

@@ -227,6 +232,7 @@ - (void)deleteApp:(FIRAppVoidBoolCallback)completion {
    if (sAllApps && sAllApps[self.name]) {


self.name can be nil. We should check it before accessing the dictionary.

We throw an exception if a user tries to configure the app with a nil or empty name, which should catch this. If you're still concerned, we can add it in a separate PR since it's unrelated to this change.

ok. I think we should be careful of accessing dictionary when the provided key is nil. I'm concerned that self.name might be nil at some point during the entire app life cycle.

baolocdo · 2018-05-09T22:07:47Z

Firebase/Core/FIRApp.m

+  NSNumber *collectionEnabledPlistValue = [[self class] readDataCollectionSwitchFromPlist];
+  if (collectionEnabledPlistValue) {
+    return [collectionEnabledPlistValue boolValue];
+  } else {


nit: no need for else

baolocdo · 2018-05-09T22:08:42Z

Firebase/Core/FIRApp.m

+#pragma mark - Reading From Plist & User Defaults
+
+/**
+ * A wrapper to clear the data collection switch from the standard NSUserDefaults for easier testing


nit: Clears the data collection ...

baolocdo · 2018-05-09T22:09:10Z

Firebase/Core/FIRApp.m

+}
+
+/**
+ * A wrapper to read the data collection switch from the standard NSUserDefaults for easier testing


nit: Reads the data collection...
Please remove "A wrapper to" here and below

baolocdo · 2018-05-09T22:09:29Z

Firebase/Core/FIRApp.m

+  id collectionEnabledDefaultsObject = [[NSUserDefaults standardUserDefaults] objectForKey:key];
+  if ([collectionEnabledDefaultsObject isKindOfClass:[NSNumber class]]) {
+    return collectionEnabledDefaultsObject;
+  } else {


nit: no need for else

baolocdo · 2018-05-09T22:11:14Z

Firebase/Core/FIRApp.m

+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    // Read the data from the `Info.plist`, only assign it if it's there and an NSNumber.
+    id plistValue = [[NSBundle mainBundle] objectForInfoDictionaryKey:kFIRGlobalAppDataCollectionEnabledPlistKey];


ident +4 from previous line

Not sure what happened here but I think this was out of date - it's split onto two lines now, even indenting +4 leaves it over 100 chars.

baolocdo · 2018-05-09T22:15:08Z

Firebase/Core/Public/FIRApp.h

+ * your app's Info.plist. This value is persisted across runs of the app so that it
+ * can be set once when users have consented to collection.
+ */
+@property(nonatomic, readwrite, getter=isAutomaticDataCollectionEnabled) BOOL automaticDataCollectionEnabled;


nit: ident +4

baolocdo · 2018-05-09T22:15:44Z

Firebase/Core/Public/FIRApp.h

+/**
+ * Gets or sets whether automatic data collection is enabled for all products.
+ * Defaults to YES unless FirebaseAutomaticDataCollectionEnabled is set to NO in
+ * your app's Info.plist. This value is persisted across runs of the app so that it


nit: fits previous line. Please fill the whole row up to 100 chars per line.

ryanwilson

Addressed the comments, @baolocdo there were a few you added on an old iteration, apologies if I sent you the wrong link. Everything should be properly formatted now.

ryanwilson · 2018-05-10T00:40:42Z

Firebase/Core/FIRApp.m

@@ -227,6 +232,7 @@ - (void)deleteApp:(FIRAppVoidBoolCallback)completion {
    if (sAllApps && sAllApps[self.name]) {


We throw an exception if a user tries to configure the app with a nil or empty name, which should catch this. If you're still concerned, we can add it in a separate PR since it's unrelated to this change.

ryanwilson · 2018-05-10T00:41:10Z

Firebase/Core/FIRApp.m

+  NSNumber *collectionEnabledPlistValue = [[self class] readDataCollectionSwitchFromPlist];
+  if (collectionEnabledPlistValue) {
+    return [collectionEnabledPlistValue boolValue];
+  } else {


ryanwilson · 2018-05-10T00:41:46Z

Firebase/Core/FIRApp.m

+#pragma mark - Reading From Plist & User Defaults
+
+/**
+ * A wrapper to clear the data collection switch from the standard NSUserDefaults for easier testing


ryanwilson · 2018-05-10T00:41:53Z

Firebase/Core/FIRApp.m

+}
+
+/**
+ * A wrapper to read the data collection switch from the standard NSUserDefaults for easier testing


ryanwilson · 2018-05-10T00:42:32Z

Firebase/Core/FIRApp.m

+  id collectionEnabledDefaultsObject = [[NSUserDefaults standardUserDefaults] objectForKey:key];
+  if ([collectionEnabledDefaultsObject isKindOfClass:[NSNumber class]]) {
+    return collectionEnabledDefaultsObject;
+  } else {


ryanwilson · 2018-05-10T00:43:40Z

Firebase/Messaging/FIRMessaging.m

-  return YES;
+
+  // If none of above exists, we default to the global switch that comes from FIRApp.
+  return self.isGlobalAutomaticDataCollectionEnabled;


Yep, if nothing is set in the plist or at runtime, the default is true and we have unit tests to confirm that.

ryanwilson · 2018-05-10T00:56:22Z

Firebase/Core/FIRApp.m

+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    // Read the data from the `Info.plist`, only assign it if it's there and an NSNumber.
+    id plistValue = [[NSBundle mainBundle] objectForInfoDictionaryKey:kFIRGlobalAppDataCollectionEnabledPlistKey];


Not sure what happened here but I think this was out of date - it's split onto two lines now, even indenting +4 leaves it over 100 chars.

* Addition of global data collection switch. * Added Messaging conformance to data switch. Also formatted code. * Move data collection flag internal until all SDKs conform to it. * Formatting in response to code review.

ryanwilson added 3 commits May 3, 2018 13:53

Addition of global data collection switch.

8728d20

Added Messaging conformance to data switch.

d98a71f

Also formatted code.

Move data collection flag internal until all SDKs conform to it.

99c4e0c

ryanwilson requested review from paulb777 and charlotteliang May 3, 2018 17:56

googlebot added the cla: yes label May 3, 2018

paulb777 approved these changes May 4, 2018

View reviewed changes

charlotteliang reviewed May 9, 2018

View reviewed changes

baolocdo reviewed May 9, 2018

View reviewed changes

Formatting in response to code review.

9423978

ryanwilson commented May 10, 2018

View reviewed changes

ryanwilson merged commit 08f447c into master May 14, 2018

ryanwilson deleted the rw-data-collection-switch branch May 18, 2018 01:59

charlotteliang mentioned this pull request May 22, 2018

Update release log and remove extra deprecate warning #1314

Merged

firebase locked and limited conversation to collaborators Nov 3, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add global data collection switch. #1219

Add global data collection switch. #1219

ryanwilson commented May 3, 2018

charlotteliang May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

ryanwilson May 10, 2018

baolocdo May 9, 2018

baolocdo May 9, 2018

ryanwilson left a comment

ryanwilson May 10, 2018

ryanwilson May 10, 2018

ryanwilson May 10, 2018

ryanwilson May 10, 2018

ryanwilson May 10, 2018

ryanwilson May 10, 2018

ryanwilson May 10, 2018

		@@ -227,6 +232,7 @@ - (void)deleteApp:(FIRAppVoidBoolCallback)completion {
		if (sAllApps && sAllApps[self.name]) {

Add global data collection switch. #1219

Add global data collection switch. #1219

Conversation

ryanwilson commented May 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryanwilson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment