Profile_Metrics integration with Keystone

chrome/browser/mac/keystone_glue.mm

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/mac/keystone_glue.h"
 
 #include <sys/mount.h>
 #include <sys/param.h>
 #include <sys/stat.h>
 
 #include <vector>
 
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/mac/authorization_util.h"
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_logging.h"
 #include "base/mac/mac_util.h"
 #include "base/mac/scoped_nsautorelease_pool.h"
 #include "base/mac/scoped_nsexception_enabler.h"
 #include "base/memory/ref_counted.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/threading/worker_pool.h"
 #include "build/build_config.h"
 #import "chrome/browser/mac/keystone_registration.h"
+#import "chrome/browser/mac/keystone_reporting_attribute.h"
 #include "chrome/browser/mac/obsolete_system.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_version_info.h"
 #include "chrome/grit/chromium_strings.h"
 #include "chrome/grit/generated_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 
 namespace {
 
@@ skipping 75 matching lines @@
 // outer application bundle's Info.plist, not the framework's Info.plist.
 - (NSString*)appInfoPlistPath;
 
 // Returns a dictionary containing parameters to be used for a KSRegistration
 // -registerWithParameters: or -promoteWithParameters:authorization: call.
 - (NSDictionary*)keystoneParameters;
 
 // Called when Keystone registration completes.
 - (void)registrationComplete:(NSNotification*)notification;
 
+// Set the registration active passing profile count parameters.
+- (void)setRegistrationActive:(KSRegistration*)ksr;

[Mark Mentovai, 2014/10/02 16:07:23]

Why is this taking ksr as a parameter when registration_ is already available?

[Mike Lerman, 2014/10/06 16:49:08]

when it's called from markActive (when the timer triggers), don't I need to get
the ksr from the timer's userInfo?

[Mark Mentovai, 2014/10/06 18:35:13]

Mike Lerman wrote:
-markActive: is called on the KeystoneGlue instance, so why wouldn’t
registration_ be valid?

I don’t think we need to supply registration_ to the timer as userInfo at all.
If you’re going to supply it, all you should do is DCHECK that it’s the same as
registration_ in the -markActive: timer callback. But what’s the point?

I see no reason that -setRegistrationActive: needs to accept a KSRegistration*
argument at all.

[Mike Lerman, 2014/10/09 20:41:01]

Ok, removed it, now referencing the object's registration_.

+
 // Called periodically to announce activity by pinging the Keystone server.
 - (void)markActive:(NSTimer*)timer;
 
 // Called when an update check or update installation is complete.  Posts the
 // kAutoupdateStatusNotification notification to the default notification
 // center.
 - (void)updateStatus:(AutoupdateStatus)status version:(NSString*)version;
 
 // Returns the version of the currently-installed application on disk.
 - (NSString*)currentlyInstalledVersion;
@@ skipping 352 matching lines @@
              url_, ksr::KSRegistrationServerURLStringKey,
              preserveTTToken, ksr::KSRegistrationPreserveTrustedTesterTokenKey,
              tagValue, ksr::KSRegistrationTagKey,
              appInfoPlistPath, ksr::KSRegistrationTagPathKey,
              tagKey, ksr::KSRegistrationTagKeyKey,
              brandPath, ksr::KSRegistrationBrandPathKey,
              brandKey, ksr::KSRegistrationBrandKeyKey,
              nil];
 }
 
+- (void)setRegistrationActive:(KSRegistration*)ksr {
+  if (numProfiles_ == 0) {
+    [ksr setActive];
+    return;

[Boris Vidolov, 2014/09/26 20:57:00]

This will break in the following case:
1. User A (first user) signs in. numProfiles_ becomes equal to 1 and Keystone
remembers to report numProfiles_=1 for 28 days.
2. The user signs out, goes to privacy settings and clears all history.
numProfiles_ becomes 0, so Keystone is never updated.
3. Keystone will continue to report incorrectly numProfiles_ = 1 for 28 more
days.
I'd suggest that you remove this check for 0 altogether and always report the
number.

[Mike Lerman, 2014/10/06 16:49:08]

In step 2 here, after signing out, numAccounts will become 0, but numProfiles
will continue to be 1. You always have 1 profile - having 0 would be an error
condition for the profiles code.

+  }
+
+  NSError* reportingAttributeError = nil;
+  KSUnsignedReportingAttribute* numProfilesAttribute =
+      [KSUnsignedReportingAttribute
+          reportingAttributeWithValue:numProfiles_
+                                 name:@"_NumAccounts"
+                      aggregationType:kKSReportingAggregationSum
+                                error:&reportingAttributeError];
+  if (reportingAttributeError != nil) {
+    LOG(ERROR) << [reportingAttributeError localizedDescription];
+    [ksr setActive];
+    return;
+  }
+
+  KSUnsignedReportingAttribute* numSignedInProfilesAttribute =
+      [KSUnsignedReportingAttribute
+          reportingAttributeWithValue:numSignedInProfiles_
+                                 name:@"_NumSignedIn"
+                      aggregationType:kKSReportingAggregationSum
+                                error:&reportingAttributeError];
+  if (reportingAttributeError != nil) {
+    LOG(ERROR) << [reportingAttributeError localizedDescription];
+    [ksr setActive];
+    return;
+  }
+
+  NSArray* profileCountsInformation =
+      [NSArray arrayWithObjects:numProfilesAttribute,
+                                numSignedInProfilesAttribute,
+                                nil];
+
+  NSError* setActiveError = nil;
+  if (![ksr setActiveWithReportingAttributes:profileCountsInformation
+                                       error:&setActiveError])
+    LOG(ERROR) << [setActiveError localizedDescription];
+    [ksr setActive];
+  }
+}
+
 - (void)registerWithKeystone {
   [self updateStatus:kAutoupdateRegistering version:nil];
 
   NSDictionary* parameters = [self keystoneParameters];
   BOOL result;
   {
     // TODO(shess): Allows Keystone to throw an exception when
     // /usr/bin/python does not exist (really!).
     // http://crbug.com/86221 and http://crbug.com/87931
     base::mac::ScopedNSExceptionEnabler enabler;
     result = [registration_ registerWithParameters:parameters];
   }
   if (!result) {
     [self updateStatus:kAutoupdateRegisterFailed version:nil];
     return;
   }
 
   // Upon completion, ksr::KSRegistrationDidCompleteNotification will be
   // posted, and -registrationComplete: will be called.
 
   // Mark an active RIGHT NOW; don't wait an hour for the first one.
-  [registration_ setActive];
+  [self setRegistrationActive:registration_];
 
   // Set up hourly activity pings.
   timer_ = [NSTimer scheduledTimerWithTimeInterval:60 * 60  // One hour
                                             target:self
                                           selector:@selector(markActive:)
                                           userInfo:registration_
                                            repeats:YES];
 }
 
 - (void)registrationComplete:(NSNotification*)notification {
   NSDictionary* userInfo = [notification userInfo];
   if ([[userInfo objectForKey:ksr::KSRegistrationStatusKey] boolValue]) {
     if ([self isSystemTicketDoomed]) {
       [self updateStatus:kAutoupdateNeedsPromotion version:nil];
     } else {
       [self updateStatus:kAutoupdateRegistered version:nil];
     }
   } else {
     // Dump registration_?
     [self updateStatus:kAutoupdateRegisterFailed version:nil];
   }
 }
 
 - (void)stopTimer {
   [timer_ invalidate];
 }
 
 - (void)markActive:(NSTimer*)timer {
-  KSRegistration* ksr = [timer userInfo];
-  [ksr setActive];
+  [self setRegistrationActive:[timer userInfo]];
 }
 
 - (void)checkForUpdate {
   DCHECK(![self asyncOperationPending]);
 
   if (!registration_) {
     [self updateStatus:kAutoupdateCheckFailed version:nil];
     return;
   }
 
@@ skipping 482 matching lines @@
   NSString* tagSuffix = @"";
   if (ObsoleteSystemMac::Has32BitOnlyCPU()) {
     tagSuffix = [tagSuffix stringByAppendingString:@"-32bit"];
   }
   if ([self wantsFullInstaller]) {
     tagSuffix = [tagSuffix stringByAppendingString:@"-full"];
   }
   return tagSuffix;
 }
 
+
+- (void)updateProfileCountsWithNumProfiles:(size_t)numProfiles
+                       numSignedInProfiles:(size_t)numSignedInProfiles {
+  numProfiles_ = numProfiles;
+  numSignedInProfiles_ = numSignedInProfiles;
+}
+
 @end  // @implementation KeystoneGlue
 
 namespace {
 
 std::string BrandCodeInternal() {
   KeystoneGlue* keystone_glue = [KeystoneGlue defaultKeystoneGlue];
   NSString* brand_path = [keystone_glue brandFilePath];
 
   if (![brand_path length])
     return std::string();
@@ skipping 22 matching lines @@
   return [KeystoneGlue defaultKeystoneGlue] != nil;
 }
 
 base::string16 CurrentlyInstalledVersion() {
   KeystoneGlue* keystoneGlue = [KeystoneGlue defaultKeystoneGlue];
   NSString* version = [keystoneGlue currentlyInstalledVersion];
   return base::SysNSStringToUTF16(version);
 }
 
 }  // namespace keystone_glue