Add account_type into AccountId

components/signin/core/account_id/account_id.cc

 // Copyright 2015 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 "components/signin/core/account_id/account_id.h"
 
 #include <functional>
 #include <memory>
 
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/memory/singleton.h"
 #include "base/strings/string_util.h"
 #include "base/values.h"
 #include "google_apis/gaia/gaia_auth_util.h"
 
 namespace {
 
-// Known account types.
-const char kGoogle[] = "google";
-
 // Serialization keys
 const char kGaiaIdKey[] = "gaia_id";
 const char kEmailKey[] = "email";
+const char kAccountTypeKey[] = "account_type";
+
+// Serialization values for account type.
+const std::string kGoogle = "google";
+const std::string kAd = "ad";
 
 // Prefix for GetAccountIdKey().
 const char kKeyGaiaIdPrefix[] = "g-";
-
-struct GoogleStringSingleton {
-  GoogleStringSingleton() : google(kGoogle) {}
-
-  static GoogleStringSingleton* GetInstance() {
-    return base::Singleton<GoogleStringSingleton>::get();
-  }
-
-  const std::string google;
-};
+const char kKeyAdIdPrefix[] = "a-";
 
 }  // anonymous namespace
 
 struct AccountId::EmptyAccountId {
   EmptyAccountId() : user_id() {}
   const AccountId user_id;
 
   static EmptyAccountId* GetInstance() {
     return base::Singleton<EmptyAccountId>::get();
   }
 };
 
 AccountId::AccountId() {}
 
 AccountId::AccountId(const std::string& gaia_id, const std::string& user_email)
     : gaia_id_(gaia_id), user_email_(user_email) {
   // Fail if e-mail looks similar to GaiaIdKey.
   LOG_ASSERT(!base::StartsWith(user_email, kKeyGaiaIdPrefix,
                                base::CompareCase::SENSITIVE) ||
              user_email.find('@') != std::string::npos)
       << "Bad e-mail: '" << user_email << "' with gaia_id='" << gaia_id << "'";
 
   // TODO(alemate): DCHECK(!email.empty());
   // TODO(alemate): check gaia_id is not empty once it is required.
 }
 
+AccountId::AccountId(const std::string& gaia_id,
+                     const std::string& user_email,
+                     const AccountType& account_type)
+    : gaia_id_(gaia_id), user_email_(user_email), account_type_(account_type) {
+  DCHECK(account_type != AccountType::UNKNOWN);
+}
+
 AccountId::AccountId(const AccountId& other)
-    : gaia_id_(other.gaia_id_), user_email_(other.user_email_) {}
+    : gaia_id_(other.gaia_id_),
+      user_email_(other.user_email_),
+      account_type_(other.account_type_) {}
 
 bool AccountId::operator==(const AccountId& other) const {
   return (this == &other) ||
          (gaia_id_ == other.gaia_id_ && user_email_ == other.user_email_) ||
          (!gaia_id_.empty() && gaia_id_ == other.gaia_id_) ||
          (!user_email_.empty() && user_email_ == other.user_email_);
 }
 
 bool AccountId::operator!=(const AccountId& other) const {
   return !operator==(other);
@@ skipping 10 matching lines @@
 
 bool AccountId::is_valid() const {
   return /* !gaia_id_.empty() && */ !user_email_.empty();
 }
 
 void AccountId::clear() {
   gaia_id_.clear();
   user_email_.clear();
 }
 
-const std::string& AccountId::GetAccountType() const {
-  return GoogleStringSingleton::GetInstance()->google;
+const AccountType& AccountId::GetAccountType() const {
+  return account_type_;
 }
 
 const std::string& AccountId::GetGaiaId() const {
   return gaia_id_;
 }
 
 const std::string& AccountId::GetUserEmail() const {
   return user_email_;
 }
 
 const std::string AccountId::GetAccountIdKey() const {
 #ifdef NDEBUG
   if (gaia_id_.empty())
     LOG(FATAL) << "GetAccountIdKey(): no gaia id for " << Serialize();
 
 #else
   CHECK(!gaia_id_.empty());
 #endif
 
-  return std::string(kKeyGaiaIdPrefix) + gaia_id_;
+  if (GetAccountType() == AccountType::GOOGLE)
+    return std::string(kKeyGaiaIdPrefix) + gaia_id_;
+  if (GetAccountType() == AccountType::ACTIVE_DIRECTORY)
+    return std::string(kKeyAdIdPrefix) + gaia_id_;

[Roger Tawa OOO till Jul 10th, 2016/12/05 16:34:31]

Will there be a later pass to change |gaia_id_| to something more generic?

[Alexander Alekseev, 2016/12/06 02:21:14]

Uuuups, I missed this. Thank you.

I thought of having other account types extend AccountId and make particular
ones have only special "account-specific" fiedls.

For now I think we should add another member like "string uuid_" (or what it
actually is), and check that AD accounts have empty gaia_id_ .

WDYT?

[Roger Tawa OOO till Jul 10th, 2016/12/07 22:09:37]

Since |gaia_id_| is a private member, seems easier to just rename it to like
|id_| and then store the appropriate id there.  Not sure adding a new member is
easier.

+  NOTREACHED() << "Unknown account type";
+  return std::string();

[Roger Tawa OOO till Jul 10th, 2016/12/05 16:34:31]

Nit: use a switch() statement.  Also line 173.

[Roman Sorokin (ftl), 2016/12/13 13:45:59]

Done.

 }
 
 void AccountId::SetGaiaId(const std::string& gaia_id) {
   DCHECK(!gaia_id.empty());
   gaia_id_ = gaia_id;
 }
 
 void AccountId::SetUserEmail(const std::string& email) {
   DCHECK(!email.empty());
   user_email_ = email;
 }
 
+void AccountId::SetAccountType(const AccountType& account_type) {
+  DCHECK(account_type != AccountType::UNKNOWN);
+  account_type_ = account_type;
+}
+
 // static
 AccountId AccountId::FromUserEmail(const std::string& email) {
   // TODO(alemate): DCHECK(!email.empty());
   return AccountId(std::string() /* gaia_id */, email);
 }
 
 AccountId AccountId::FromGaiaId(const std::string& gaia_id) {
   DCHECK(!gaia_id.empty());
   return AccountId(gaia_id, std::string() /* email */);
 }
 
 // static
 AccountId AccountId::FromUserEmailGaiaId(const std::string& email,
                                          const std::string& gaia_id) {
   DCHECK(!(email.empty() && gaia_id.empty()));
   return AccountId(gaia_id, email);
 }
 
+// static
+AccountType AccountId::StringToAccountType(
+    const std::string& account_type_string) {
+  if (account_type_string == kGoogle)
+    return AccountType::GOOGLE;
+  if (account_type_string == kAd)
+    return AccountType::ACTIVE_DIRECTORY;
+  NOTREACHED() << "Unknown account type " << account_type_string;
+  return AccountType::UNKNOWN;
+}
+
+// static
+std::string AccountId::AccountTypeToString(const AccountType& account_type) {
+  if (account_type == AccountType::GOOGLE)
+    return kGoogle;
+  if (account_type == AccountType::ACTIVE_DIRECTORY)
+    return kAd;
+  NOTREACHED() << "Unknown account type";
+  return std::string();
+}
+
+AccountId AccountId::FromUserEmailGaiaIdAccountType(
+    const std::string& email,
+    const std::string& gaia_id,
+    const AccountType& account_type) {
+  DCHECK(!(email.empty() && gaia_id.empty()));
+  return AccountId(gaia_id, email, account_type);
+}
+
+AccountId AccountId::FromGaiaIdAccountType(const std::string& gaia_id,
+                                           const AccountType& account_type) {
+  return FromUserEmailGaiaIdAccountType(std::string() /* email */, gaia_id,
+                                        account_type);
+}

[Roger Tawa OOO till Jul 10th, 2016/12/05 16:34:31]

Since these are new methods, maybe not use "Gaia" in the name?  So something
like:

FromUserEmailIdAccountType()
FromIdAccountType()

[Alexander Alekseev, 2016/12/06 02:21:14]

Or, probably, we should create AccountId::ADFromUserEmailUUID(), and
AccountId::GoogleFromUserEmailGaiaId(). WDYT?

To somplify this Cl we can add AccountId::ADFromUserEmailUUID() and TODO at
AccountId::FromUserEmailGaiaId() to rename it to
AccountId::GoogleFromUserEmailGaiaId() .

[Roger Tawa OOO till Jul 10th, 2016/12/07 22:09:37]

Acknowledged.

+

[Roger Tawa OOO till Jul 10th, 2016/12/05 16:34:31]

These two new methods should have "// static" comment.

[Roman Sorokin (ftl), 2016/12/13 13:45:59]

Done.

 std::string AccountId::Serialize() const {
   base::DictionaryValue value;
   value.SetString(kGaiaIdKey, gaia_id_);
   value.SetString(kEmailKey, user_email_);
+  value.SetString(kAccountTypeKey, AccountTypeToString(account_type_));
 
   std::string serialized;
   base::JSONWriter::Write(value, &serialized);
   return serialized;
 }
 
 // static
 bool AccountId::Deserialize(const std::string& serialized,
                             AccountId* account_id) {
   base::JSONReader reader;
   std::unique_ptr<const base::Value> value(reader.Read(serialized));
   const base::DictionaryValue* dictionary_value = NULL;
 
   if (!value || !value->GetAsDictionary(&dictionary_value))
     return false;
 
   std::string gaia_id;
   std::string user_email;
+  AccountType account_type = AccountType::GOOGLE;
 
   const bool found_gaia_id = dictionary_value->GetString(kGaiaIdKey, &gaia_id);
   const bool found_user_email =
       dictionary_value->GetString(kEmailKey, &user_email);
 
   if (!found_gaia_id)
     LOG(ERROR) << "gaia_id is not found in '" << serialized << "'";
 
   if (!found_user_email)
     LOG(ERROR) << "user_email is not found in '" << serialized << "'";
 
   if (!found_gaia_id && !found_user_email)
     return false;
 
-  *account_id = FromUserEmailGaiaId(user_email, gaia_id);
+  std::string account_type_string;
+  if (dictionary_value->GetString(kAccountTypeKey, &account_type_string))
+    account_type = StringToAccountType(account_type_string);

[Roger Tawa OOO till Jul 10th, 2016/12/05 16:34:31]

I think you should do some error checking here since the serialized source is
external.  Probably OK not to do error checking at line 199 above.

[Alexander Alekseev, 2016/12/06 02:21:14]

Totally agree.

[Roman Sorokin (ftl), 2016/12/13 13:45:58]

done

+
+  *account_id =
+      FromUserEmailGaiaIdAccountType(user_email, gaia_id, account_type);
 
   return true;
 }
 
 const AccountId& EmptyAccountId() {
   return AccountId::EmptyAccountId::GetInstance()->user_id;
 }
 
 namespace BASE_HASH_NAMESPACE {
 
 std::size_t hash<AccountId>::operator()(const AccountId& user_id) const {
   return hash<std::string>()(user_id.GetUserEmail());
 }
 
 }  // namespace BASE_HASH_NAMESPACE