GCP2.0 Device: Instant AccessToken update on AuthFailed.

cloud_print/gcp20/prototype/printer.cc

 // Copyright 2013 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 "cloud_print/gcp20/prototype/printer.h"
 
 #include <stdio.h>
 #include <string>
 #include <vector>
 
@@ skipping 21 matching lines @@
 
 const char kServiceType[] = "_privet._tcp.local";
 const char kServiceNamePrefixDefault[] = "first_gcp20_device";
 const char kServiceDomainNameDefault[] = "my-privet-device.local";
 
 const char kPrinterName[] = "Google GCP2.0 Prototype";
 const char kPrinterDescription[] = "Printer emulator";
 
 const char kUserConfirmationTitle[] = "Confirm registration: type 'y' if you "
                                       "agree and any other to discard\n";
-const int64 kUserConfirmationTimeout = 30;  // in seconds
-
-const uint32 kReconnectTimeout = 5;  // in seconds
+const int kUserConfirmationTimeout = 30;  // in seconds
+const int kRegistrationTimeout = 60;  // in seconds
+const int kReconnectTimeout = 5;  // in seconds
 
 const double kTimeToNextAccessTokenUpdate = 0.8;  // relatively to living time.
 
 const char kCdd[] =
 "{\n"
 " 'version': '1.0',\n"
 "  'printer': {\n"
 "    'vendor_capability': [\n"
 "      {\n"
 "        'id': 'psk:MediaType',\n"
@@ skipping 122 matching lines @@
 void Printer::Stop() {
   dns_server_.Shutdown();
   http_server_.Shutdown();
   requester_.reset();
   print_job_handler_.reset();
   xmpp_listener_.reset();
 }
 
 void Printer::OnAuthError() {
   LOG(ERROR) << "Auth error occurred";
-  access_token_update_ = base::Time::Now();
-  ChangeState(OFFLINE);
-  // TODO(maksymb): Implement *instant* updating of access_token.
+  access_token_update_ = base::Time::UnixEpoch();

[Vitaly Buka (NO REVIEWS), 2013/08/15 17:48:06]

Why not now?

[maksymb, 2013/08/15 18:39:13]

UnixEpoch() is definitely in the past, Now() is only now and when we check
whether we need to update |access_token| in TryConnect():
    if (access_token_update_ < base::Time::Now()) {
      requester_->UpdateAccesstoken(reg_info_.refresh_token);
it may be called /*in theory*/ in the same microsecond and won't be updated.
Another solution is to change comparison from < to <=. Is this solution more
readable? UnixEpoch() variant is stable enough and reader doesn't have to know
exact implementation of comparison (< or <=) to be sure it will work.

[Vitaly Buka (NO REVIEWS), 2013/08/15 20:17:06]

= base::Time::Time();

On 2013/08/15 18:39:13, maksymb wrote:

[maksymb, 2013/08/15 20:23:00]

Done.

+  FallOffline(true);
 }
 
 std::string Printer::GetAccessToken() {
   return access_token_;
 }
 
 PrivetHttpServer::RegistrationErrorStatus Printer::RegistrationStart(
     const std::string& user) {
+  CheckRegistrationExpiration();
+
+  RegistrationInfo::ConfirmationState conf_state = reg_info_.confirmation_state;
+  if (reg_info_.state == RegistrationInfo::DEV_REG_REGISTRATION_ERROR ||
+      conf_state == RegistrationInfo::CONFIRMATION_TIMEOUT ||
+      conf_state == RegistrationInfo::CONFIRMATION_DISCARDED) {
+    reg_info_ = RegistrationInfo();
+  }
+
   PrivetHttpServer::RegistrationErrorStatus status = CheckCommonRegErrors(user);
   if (status != PrivetHttpServer::REG_ERROR_OK)
     return status;
 
   if (reg_info_.state != RegistrationInfo::DEV_REG_UNREGISTERED)
     return PrivetHttpServer::REG_ERROR_INVALID_ACTION;
 
+  UpdateRegistrationExpiration();
+
   reg_info_ = RegistrationInfo();
   reg_info_.user = user;
   reg_info_.state = RegistrationInfo::DEV_REG_REGISTRATION_STARTED;
 
   if (CommandLine::ForCurrentProcess()->HasSwitch("disable-confirmation")) {
     reg_info_.confirmation_state = RegistrationInfo::CONFIRMATION_CONFIRMED;
     LOG(INFO) << "Registration confirmed by default.";
   } else {
     printf("%s", kUserConfirmationTitle);
     base::Time valid_until = base::Time::Now() +
@@ skipping 20 matching lines @@
   if (reg_info_.state != RegistrationInfo::DEV_REG_REGISTRATION_STARTED &&
       reg_info_.state !=
           RegistrationInfo::DEV_REG_REGISTRATION_CLAIM_TOKEN_READY)
     return PrivetHttpServer::REG_ERROR_INVALID_ACTION;
 
   // If |action=getClaimToken| is valid in this state (was checked above) then
   // check confirmation status.
   if (reg_info_.confirmation_state != RegistrationInfo::CONFIRMATION_CONFIRMED)
     return ConfirmationToRegistrationError(reg_info_.confirmation_state);
 
+  UpdateRegistrationExpiration();
+
   // If reply wasn't received yet, reply with |pending_user_action| error.
   if (reg_info_.state == RegistrationInfo::DEV_REG_REGISTRATION_STARTED)
     return PrivetHttpServer::REG_ERROR_PENDING_USER_ACTION;
 
   DCHECK_EQ(reg_info_.state,
             RegistrationInfo::DEV_REG_REGISTRATION_CLAIM_TOKEN_READY);
   DCHECK_EQ(reg_info_.confirmation_state,
             RegistrationInfo::CONFIRMATION_CONFIRMED);
 
   *token = reg_info_.registration_token;
   *claim_url = reg_info_.complete_invite_url;
   return PrivetHttpServer::REG_ERROR_OK;
 }
 
 PrivetHttpServer::RegistrationErrorStatus Printer::RegistrationComplete(
     const std::string& user,
     std::string* device_id) {
   PrivetHttpServer::RegistrationErrorStatus status = CheckCommonRegErrors(user);
   if (status != PrivetHttpServer::REG_ERROR_OK)
     return status;
 
   if (reg_info_.state !=
       RegistrationInfo::DEV_REG_REGISTRATION_CLAIM_TOKEN_READY) {
     return PrivetHttpServer::REG_ERROR_INVALID_ACTION;
   }
 
+  UpdateRegistrationExpiration();
+
   if (reg_info_.confirmation_state != RegistrationInfo::CONFIRMATION_CONFIRMED)
     return ConfirmationToRegistrationError(reg_info_.confirmation_state);
 
   reg_info_.state = RegistrationInfo::DEV_REG_REGISTRATION_COMPLETING;
   requester_->CompleteRegistration();
   *device_id = reg_info_.device_id;
 
   return PrivetHttpServer::REG_ERROR_OK;
 }
 
 PrivetHttpServer::RegistrationErrorStatus Printer::RegistrationCancel(
     const std::string& user) {
   PrivetHttpServer::RegistrationErrorStatus status = CheckCommonRegErrors(user);
   if (status != PrivetHttpServer::REG_ERROR_OK &&
       status != PrivetHttpServer::REG_ERROR_SERVER_ERROR) {
     return status;
   }
 
   if (reg_info_.state == RegistrationInfo::DEV_REG_UNREGISTERED)
     return PrivetHttpServer::REG_ERROR_INVALID_ACTION;
 
+  InvalidateRegistrationExpiration();
+
   reg_info_ = RegistrationInfo();
   requester_.reset(new CloudPrintRequester(GetTaskRunner(), this));
 
   return PrivetHttpServer::REG_ERROR_OK;
 }
 
 void Printer::GetRegistrationServerError(std::string* description) {
-  DCHECK_EQ(reg_info_.state, RegistrationInfo::DEV_REG_REGISTRATION_ERROR) <<
-      "Method shouldn't be called when not needed.";
+  DCHECK_EQ(reg_info_.state, RegistrationInfo::DEV_REG_REGISTRATION_ERROR)
+      << "Method shouldn't be called when not needed.";
 
   *description = reg_info_.error_description;
 }
 
 void Printer::CreateInfo(PrivetHttpServer::DeviceInfo* info) {
+  CheckRegistrationExpiration();
+
   // TODO(maksymb): Replace "text" with constants.
 
   *info = PrivetHttpServer::DeviceInfo();
   info->version = "1.0";
   info->name = kPrinterName;
   info->description = kPrinterDescription;
   info->url = kCloudPrintUrl;
   info->id = reg_info_.device_id;
   info->device_state = "idle";
   info->connection_state = ConnectionStateToString(connection_state_);
@@ skipping 22 matching lines @@
 void Printer::OnRegistrationStartResponseParsed(
     const std::string& registration_token,
     const std::string& complete_invite_url,
     const std::string& device_id) {
   reg_info_.state = RegistrationInfo::DEV_REG_REGISTRATION_CLAIM_TOKEN_READY;
   reg_info_.device_id = device_id;
   reg_info_.registration_token = registration_token;
   reg_info_.complete_invite_url = complete_invite_url;
 }
 
-void Printer::OnGetAuthCodeResponseParsed(const std::string& refresh_token,
-                                          const std::string& access_token,
-                                          int access_token_expires_in_seconds) {
+void Printer::OnRegistrationFinished(const std::string& refresh_token,
+                                     const std::string& access_token,
+                                     int access_token_expires_in_seconds) {
+  InvalidateRegistrationExpiration();
+
   reg_info_.state = RegistrationInfo::DEV_REG_REGISTERED;
   reg_info_.refresh_token = refresh_token;
   RememberAccessToken(access_token, access_token_expires_in_seconds);
   TryConnect();
 }
 
 void Printer::OnAccesstokenReceviced(const std::string& access_token,
                                      int expires_in_seconds) {
   VLOG(3) << "Function: " << __FUNCTION__;
   RememberAccessToken(access_token, expires_in_seconds);
@@ skipping 12 matching lines @@
 }
 
 void Printer::OnXmppJidReceived(const std::string& xmpp_jid) {
   reg_info_.xmpp_jid = xmpp_jid;
 }
 
 void Printer::OnRegistrationError(const std::string& description) {
   LOG(ERROR) << "server_error: " << description;
 
   // TODO(maksymb): Implement waiting after error and timeout of registration.
-  reg_info_.state = RegistrationInfo::DEV_REG_REGISTRATION_ERROR;
-  reg_info_.error_description = description;
+  SetRegistrationError(description);
 }
 
 void Printer::OnNetworkError() {
   VLOG(3) << "Function: " << __FUNCTION__;
-  ChangeState(OFFLINE);
+  FallOffline(false);
 }
 
 void Printer::OnServerError(const std::string& description) {
   VLOG(3) << "Function: " << __FUNCTION__;
   LOG(ERROR) << "Server error: " << description;
 
-  ChangeState(OFFLINE);
+  FallOffline(false);
 }
 
 void Printer::OnPrintJobsAvailable(const std::vector<Job>& jobs) {
   VLOG(3) << "Function: " << __FUNCTION__;
 
   LOG(INFO) << "Available printjobs: " << jobs.size();
 
   if (jobs.empty()) {
     pending_print_jobs_check_ = false;
     PostOnIdle();
@@ skipping 25 matching lines @@
   pending_print_jobs_check_ = true;
   ChangeState(ONLINE);
   PostOnIdle();
 }
 
 void Printer::OnXmppAuthError() {
   OnAuthError();
 }
 
 void Printer::OnXmppNetworkError() {
-  ChangeState(OFFLINE);
+  FallOffline(false);
 }
 
 void Printer::OnXmppNewPrintJob(const std::string& device_id) {
   DCHECK_EQ(reg_info_.device_id, device_id) << "Data should contain printer_id";
   pending_print_jobs_check_ = true;
 }
 
 void Printer::OnXmppNewLocalSettings(const std::string& device_id) {
   DCHECK_EQ(reg_info_.device_id, device_id) << "Data should contain printer_id";
   NOTIMPLEMENTED();
@@ skipping 82 matching lines @@
   using base::Time;
   using base::TimeDelta;
   access_token_ = access_token;
   int64 time_to_update = static_cast<int64>(expires_in_seconds *
                                             kTimeToNextAccessTokenUpdate);
   access_token_update_ = Time::Now() + TimeDelta::FromSeconds(time_to_update);
   VLOG(1) << "Current access_token: " << access_token;
   SaveToFile();
 }
 
+void Printer::SetRegistrationError(const std::string& description) {
+  DCHECK(!IsRegistered());
+  reg_info_.state = RegistrationInfo::DEV_REG_REGISTRATION_ERROR;
+  reg_info_.error_description = description;
+}
+
 PrivetHttpServer::RegistrationErrorStatus Printer::CheckCommonRegErrors(
-    const std::string& user) const {
+    const std::string& user) {
+  CheckRegistrationExpiration();
   DCHECK(!IsRegistered());
+  DCHECK(connection_state_ == ONLINE);
 
   if (reg_info_.state != RegistrationInfo::DEV_REG_UNREGISTERED &&
       user != reg_info_.user) {
     return PrivetHttpServer::REG_ERROR_DEVICE_BUSY;
   }
 
   if (reg_info_.state == RegistrationInfo::DEV_REG_REGISTRATION_ERROR)
     return PrivetHttpServer::REG_ERROR_SERVER_ERROR;
 
+  DCHECK(connection_state_ == ONLINE);
+
   return PrivetHttpServer::REG_ERROR_OK;
 }
 
 void Printer::WaitUserConfirmation(base::Time valid_until) {
+  // TODO(maksymb): Move to separate class.
+
   if (base::Time::Now() > valid_until) {
     reg_info_.confirmation_state = RegistrationInfo::CONFIRMATION_TIMEOUT;
     LOG(INFO) << "Confirmation timeout reached.";
     return;
   }
 
   if (_kbhit()) {
     int c = _getche();
     if (c == 'y' || c == 'Y') {
       reg_info_.confirmation_state = RegistrationInfo::CONFIRMATION_CONFIRMED;
@@ skipping 145 matching lines @@
 void Printer::PostOnIdle() {
   VLOG(3) << "Function: " << __FUNCTION__;
   DCHECK(!on_idle_posted_) << "Only one instance can be posted.";
   on_idle_posted_ = true;
 
   base::MessageLoop::current()->PostTask(
       FROM_HERE,
       base::Bind(&Printer::OnIdle, AsWeakPtr()));
 }
 
+void Printer::CheckRegistrationExpiration() {
+  if (!registration_expiration_.is_null() &&
+      registration_expiration_ < base::Time::Now()) {
+    reg_info_ = RegistrationInfo();
+    InvalidateRegistrationExpiration();
+    if (connection_state_ != ONLINE)
+      TryConnect();
+  }
+}
+
+void Printer::UpdateRegistrationExpiration() {
+  registration_expiration_ =
+      base::Time::Now() + base::TimeDelta::FromSeconds(kRegistrationTimeout);
+}
+
+void Printer::InvalidateRegistrationExpiration() {
+  registration_expiration_ = base::Time();
+}
+
 PrivetHttpServer::RegistrationErrorStatus
-    Printer::ConfirmationToRegistrationError(
-        RegistrationInfo::ConfirmationState state) {
+Printer::ConfirmationToRegistrationError(
+    RegistrationInfo::ConfirmationState state) {
   switch (state) {
     case RegistrationInfo::CONFIRMATION_PENDING:
       return PrivetHttpServer::REG_ERROR_PENDING_USER_ACTION;
     case RegistrationInfo::CONFIRMATION_DISCARDED:
       return PrivetHttpServer::REG_ERROR_USER_CANCEL;
     case RegistrationInfo::CONFIRMATION_CONFIRMED:
       NOTREACHED();
       return PrivetHttpServer::REG_ERROR_OK;
     case RegistrationInfo::CONFIRMATION_TIMEOUT:
       return PrivetHttpServer::REG_ERROR_CONFIRMATION_TIMEOUT;
@@ skipping 13 matching lines @@
       return "connecting";
     case NOT_CONFIGURED:
       return "not-configured";
 
     default:
       NOTREACHED();
       return "";
   }
 }
 
+void Printer::FallOffline(bool instant_reconnect) {

[Vitaly Buka (NO REVIEWS), 2013/08/15 17:48:06]

I guess you can remove argument and use TryConnect() where FallOffline(true) is
used

[maksymb, 2013/08/15 18:39:13]

1. In this case ChangeState(OFFLINE) won't be called and   |requester_| and
|xmpp_listener_| won't be reset.
2. Also, I want to block registration and set ERROR if I receive server or
network error.

[Vitaly Buka (NO REVIEWS), 2013/08/15 20:17:06]

It won't be called anyway
DCHECK is debug only.

On 2013/08/15 18:39:13, maksymb wrote:

[maksymb, 2013/08/15 20:23:00]

Moved outside of DCHECK.

+  DCHECK(ChangeState(OFFLINE));
+
+  if (!IsRegistered()) {
+    SetRegistrationError("Cannot access server during registration process");
+    TryConnect();  // For registration errors reconnection is instant, because
+                   // we don't need to do anything when Printer will become
+                   // connected: we will be waiting for new HTTP requests.
+    return;
+  }
+
+  if (instant_reconnect) {
+    TryConnect();
+  } else {
+    base::MessageLoop::current()->PostDelayedTask(
+        FROM_HERE,
+        base::Bind(&Printer::TryConnect, AsWeakPtr()),
+        base::TimeDelta::FromSeconds(kReconnectTimeout));

[Vitaly Buka (NO REVIEWS), 2013/08/15 17:48:06]

Fix alignment

+  }
+}
+
 bool Printer::ChangeState(ConnectionState new_state) {
   if (connection_state_ == new_state)
     return false;
 
   connection_state_ = new_state;
   LOG(INFO) << base::StringPrintf(
       "Printer is now %s (%s)",
       ConnectionStateToString(connection_state_).c_str(),
       IsRegistered() ? "registered" : "unregistered");
 
   dns_server_.UpdateMetadata(CreateTxt());
 
-  switch (connection_state_) {
-    case CONNECTING:
-      break;
-
-    case ONLINE:
-      break;
-
-    case OFFLINE:
-      requester_.reset();
-      xmpp_listener_.reset();
-      base::MessageLoop::current()->PostDelayedTask(
-          FROM_HERE,
-          base::Bind(&Printer::TryConnect, AsWeakPtr()),
-          base::TimeDelta::FromSeconds(kReconnectTimeout));
-
-    case NOT_CONFIGURED:
-      break;
-
-    default:
-      NOTREACHED();
+  if (connection_state_ == OFFLINE) {
+    requester_.reset();
+    xmpp_listener_.reset();
   }
 
   return true;
 }