Fix ArcSessionManager state machine, part 1.

chrome/browser/chromeos/arc/arc_session_manager.h

 // Copyright 2016 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.
 
 #ifndef CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_
 #define CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_
 
 #include <memory>
 #include <ostream>
 #include <string>
@@ skipping 24 matching lines @@
 // This class proxies the request from the client to fetch an auth code from
 // LSO. It lives on the UI thread.
 class ArcSessionManager : public ArcSessionRunner::Observer,
                           public ArcSupportHost::Observer {
  public:
   // Represents each State of ARC session.
   // NOT_INITIALIZED: represents the state that the Profile is not yet ready
   //   so that this service is not yet initialized, or Chrome is being shut
   //   down so that this is destroyed.
   // STOPPED: ARC session is not running, or being terminated.
-  // SHOWING_TERMS_OF_SERVICE: "Terms Of Service" page is shown on ARC support
-  //   Chrome app.
+  // NEGOTIATING_TERMS_OF_SERVICE: Negotiating Google Play Store "Terms of
+  //   Service" with a user. There are several ways for the negotiation,
+  //   including opt-in flow, which shows "Terms of Service" page on ARC
+  //   support app, and OOBE flow, which shows "Terms of Service" page as a
+  //   part of Chrome OOBE flow.
+  //   If user does not accept the Terms of Service, disables Google Play
+  //   Store, which triggers RequestDisable() and the state will be set to
+  //   STOPPED, then.
   // CHECKING_ANDROID_MANAGEMENT: Checking Android management status. Note that
   //   the status is checked for each ARC session starting, but this is the
   //   state only for the first boot case (= opt-in case). The second time and
   //   later the management check is running in parallel with ARC session
   //   starting, and in such a case, State is ACTIVE, instead.
   // REMOVING_DATA_DIR: When ARC is disabled, the data directory is removed.
   //   While removing is processed, ARC cannot be started. This is the state.
   // ACTIVE: ARC is running.
   //
   // State transition should be as follows:
   //
   // NOT_INITIALIZED -> STOPPED: when the primary Profile gets ready.
   // ...(any)... -> NOT_INITIALIZED: when the Chrome is being shutdown.
   // ...(any)... -> STOPPED: on error.
   //
   // In the first boot case:
-  //   STOPPED -> SHOWING_TERMS_OF_SERVICE: when arc.enabled preference is set.
-  //   SHOWING_TERMS_OF_SERVICE -> CHECKING_ANDROID_MANAGEMENT: when a user
-  //     agree with "Terms Of Service"
+  //   STOPPED -> NEGOTIATING_TERMS_OF_SERVICE: On request to enable.

[hidehiko, 2017/03/06 13:38:39]

Note: More detailed comment will come as a part of TODO at L79.

+  //   NEGOTIATING_TERMS_OF_SERVICE -> CHECKING_ANDROID_MANAGEMENT: when a user
+  //     accepts with "Terms Of Service"

[Yusuke Sato, 2017/03/06 20:52:16]

s/with//

[hidehiko, 2017/03/07 14:52:20]

Done.

   //   CHECKING_ANDROID_MANAGEMENT -> ACTIVE: when the auth token is
   //     successfully fetched.
   //
   // In the second (or later) boot case:
   //   STOPPED -> ACTIVE: when arc.enabled preference is checked that it is
   //     true. Practically, this is when the primary Profile gets ready.
   //
   // TODO(hidehiko): Fix the state machine, and update the comment including
   // relationship with |enable_requested_|.
   enum class State {
     NOT_INITIALIZED,
     STOPPED,
-    SHOWING_TERMS_OF_SERVICE,
+    NEGOTIATING_TERMS_OF_SERVICE,
     CHECKING_ANDROID_MANAGEMENT,
     REMOVING_DATA_DIR,
     ACTIVE,
   };
 
   // Observer for those services outside of ARC which want to know ARC events.
   class Observer {
    public:
     // Called to notify that whether Google Play Store is enabled or not, which
     // is represented by "arc.enabled" preference, is updated.
@@ skipping 134 matching lines @@
 
  private:
   // RequestEnable() has a check in order not to trigger starting procedure
   // twice. This method can be called to bypass that check when restarting.
   void RequestEnableImpl();
 
   // Negotiates the terms of service to user.
   void StartTermsOfServiceNegotiation();
   void OnTermsOfServiceNegotiated(bool accepted);
 
+  // Returns true if Terms of Service negotiation is needed. Otherwise false.
+  // TODO(crbug.com/698418): Write unittest for this utility after extracting
+  //   ToS related code from ArcSessionManager into a dedicated class.
+  bool IsArcTermsOfServiceNegotiationNeeded() const;
+
   // Returns whether ARC is managed and all ARC related OptIn preferences are
   // managed too.
   bool AreArcAllOptInPreferencesManaged() const;
 
   void SetState(State state);
   void ShutdownSession();
   void OnAndroidManagementPassed();
   void OnArcDataRemoved(bool success);
   void OnArcSignInTimeout();
 
@@ skipping 60 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(ArcSessionManager);
 };
 
 // Outputs the stringified |state| to |os|. This is only for logging purposes.
 std::ostream& operator<<(std::ostream& os,
                          const ArcSessionManager::State& state);
 
 }  // namespace arc
 
 #endif  // CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_