Geolocation request for Google Now

chrome/browser/ui/google_now/google_now_service.cc

 // 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.
 
 #include "chrome/browser/ui/google_now/google_now_service.h"
+#include "content/public/browser/geolocation.h"
 #include "content/public/common/geoposition.h"
 
+using base::Bind;
 using base::TimeDelta;
 using content::Geoposition;
 using net::URLRequest;
 
 namespace {
+// TODO(vadimt): Figure out the values of the constants.
+
 // Period for polling for Google Now cards to use when the period from the
 // server is not available.
-// TODO(vadimt): Figure out the value.
 // TODO(vadimt): Figure out the consequences for LBS.
 // TODO(vadimt): Consider triggers other than the timer for refreshing the
 // position, such as waking from sleep.
 const int kDefaultPollingPeriodMs = 300000; // 5 minutes
+// Time allocated to a geolocation request.
+const int kGeolocationRequestTimeoutMs = 60000; // 1 min

[skare_, 2012/12/07 23:39:00]

nit here and above: 2 spaces between code and comments, 1 min->1 minute just for
consistency

[vadimt, 2012/12/08 00:04:23]

Done.

 }  // namespace
 
 struct GoogleNowService::ServerResponse {
   // TODO(vadimt): Populate this structure with real fields.
   int next_request_delay_ms;
 };
 
 GoogleNowService::GoogleNowService(Profile* profile)
-    : profile_(profile) {
+    : profile_(profile),
+      ALLOW_THIS_IN_INITIALIZER_LIST(geolocation_request_weak_factory_(this)) {
   DCHECK(profile_);
 }
 
 GoogleNowService::~GoogleNowService() {
 }
 
 void GoogleNowService::Init() {
   // If Google Now integration is enabled for the profile, start the first cards
   // update.
   if (IsGoogleNowEnabled())
     UpdateCards();
 }
 
 void GoogleNowService::StartWaitingForNextUpdate(int64 delay_ms) {
   DCHECK(!next_update_timer_.IsRunning());
 
   next_update_timer_.Start(FROM_HERE, TimeDelta::FromMilliseconds(delay_ms),
                            this, &GoogleNowService::OnWaitingForNextUpdateEnds);
 }
 
 void GoogleNowService::OnWaitingForNextUpdateEnds() {
   DCHECK(IsGoogleNowEnabled());
   DCHECK(!next_update_timer_.IsRunning());
+  DCHECK(!geolocation_request_timer_.IsRunning());
+  DCHECK(!geolocation_request_weak_factory_.HasWeakPtrs());
 
   UpdateCards();
 }
 
 bool GoogleNowService::IsGoogleNowEnabled() const {
   // TODO(vadimt): Return a value indicating whether Google Now integration is
   // enabled for 'profile_'.
   // TODO(vadimt): Process enabling and disabling Google Now integration while
   // the service is running.
   return true;
 }
 
 void GoogleNowService::UpdateCards() {
   // Start obtaining geolocation for the server's request.
   StartObtainingGeolocation();
 }
 
 void GoogleNowService::StartObtainingGeolocation() {
-  // TODO(vadimt): Implement via making a geolocation request.
-  OnLocationObtained(Geoposition());
+  DCHECK(!geolocation_request_weak_factory_.HasWeakPtrs());
+  content::RequestLocationUpdate(Bind(
+      &GoogleNowService::OnLocationObtained,
+      geolocation_request_weak_factory_.GetWeakPtr()));
+
+  DCHECK(!geolocation_request_timer_.IsRunning());
+  geolocation_request_timer_.Start(FROM_HERE,
+      TimeDelta::FromMilliseconds(kGeolocationRequestTimeoutMs),
+      this, &GoogleNowService::OnLocationRequestTimeout);
 }
 
 void GoogleNowService::OnLocationObtained(const Geoposition& position) {
   DCHECK(IsGoogleNowEnabled());
   DCHECK(!next_update_timer_.IsRunning());
+  DCHECK(geolocation_request_timer_.IsRunning());
+  DCHECK(geolocation_request_weak_factory_.HasWeakPtrs());
 
+  geolocation_request_weak_factory_.InvalidateWeakPtrs();
+  geolocation_request_timer_.Stop();
   StartServerRequest(position);
 }
 
+void GoogleNowService::OnLocationRequestTimeout() {
+  DCHECK(IsGoogleNowEnabled());
+  DCHECK(!next_update_timer_.IsRunning());
+  DCHECK(!geolocation_request_timer_.IsRunning());
+  DCHECK(geolocation_request_weak_factory_.HasWeakPtrs());
+
+  geolocation_request_weak_factory_.InvalidateWeakPtrs();
+  StartServerRequest(Geoposition());
+}
+
 void GoogleNowService::StartServerRequest(
     const content::Geoposition& position) {
   // TODO(vadimt): Implement via making URLRequest to the server.

[skare_, 2012/12/07 23:39:00]

should this be implemented in the same CL? or are reviewers ok with this
granularity?

[vadimt, 2012/12/08 00:04:23]

It's recommended to make reviews small in Chrome. So, I'd say, we can implement
geolocation request separately from the server request.

   OnServerRequestCompleted(NULL, 0);
 }
 
 void GoogleNowService::OnServerRequestCompleted(URLRequest* request,
                                                 int num_bytes) {
   DCHECK(IsGoogleNowEnabled());
   DCHECK(!next_update_timer_.IsRunning());
+  DCHECK(!geolocation_request_timer_.IsRunning());
+  // TODO(vadimt): Uncomment the check below once OnServerRequestCompleted is
+  // called asynchronously.
+  // DCHECK(!geolocation_request_weak_factory_.HasWeakPtrs());
 
   ServerResponse server_response;
   // TODO(vadimt): Check request's status.
   if (ParseServerResponse(request, num_bytes, &server_response)) {
     ShowNotifications(server_response);
     // Once the cards are shown, schedule next cards update after the delay
     // suggested by the server.
     StartWaitingForNextUpdate(server_response.next_request_delay_ms);
   } else {
     // If the server response is bad, schedule next cards update after the
     // default delay.
     // TODO(vadimt): Consider exponential backoff with randomized jitter.
     StartWaitingForNextUpdate(kDefaultPollingPeriodMs);
   }
 }
 
 bool GoogleNowService::ParseServerResponse(const URLRequest* request,
     int num_bytes, ServerResponse* server_response) {
   // TODO(vadimt): Do real parsing.
   server_response->next_request_delay_ms = kDefaultPollingPeriodMs;
   return true;
 }
 
 void GoogleNowService::ShowNotifications(
     const ServerResponse& server_response) {
   // TODO(vadimt): Implement using Chrome Notifications.
 }