services/identity/public/cpp/accounts_cookie_mutator.h

// Copyright 2019 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 SERVICES_IDENTITY_PUBLIC_CPP_ACCOUNTS_COOKIE_MUTATOR_H_
#define SERVICES_IDENTITY_PUBLIC_CPP_ACCOUNTS_COOKIE_MUTATOR_H_

#include <string>
#include <vector>

#include "base/macros.h"
#include "google_apis/gaia/gaia_auth_fetcher.h"
#include "google_apis/gaia/google_service_auth_error.h"

namespace identity {

// AccountsCookieMutator is the interface to support merging known local Google
// accounts into the cookie jar tracking the list of logged-in Google sessions.
class AccountsCookieMutator {
 public:
  AccountsCookieMutator() = default;
  virtual ~AccountsCookieMutator() = default;

  // Adds an account identified by |account_id| to the cookie responsible for
  // tracking the list of logged-in Google sessions across the web.
  virtual void AddAccountToCookie(const std::string& account_id,
                                  gaia::GaiaSource source) = 0;

  // Adds an account identified by |account_id| and with |access_token| to the
  // cookie responsible for tracking the list of logged-in Google sessions
  // across the web.
  virtual void AddAccountToCookieWithToken(const std::string& account_id,
                                           const std::string& access_token,
                                           gaia::GaiaSource source) = 0;

  // Updates the state of the Gaia cookie to contain |account_ids|, including
  // removal of any accounts that are currently present in the cookie but not
  // contained in |account_ids|. |set_accounts_in_cookies_completed_callback|
  // will be invoked with the result of the operation: if the error is equal to
  // GoogleServiceAuthError::AuthErrorNone() then the operation succeeded.
  // Notably, if there are accounts being added for which IdentityManager does
  // not have refresh tokens, the operation will fail with a
  // GoogleServiceAuthError::USER_NOT_SIGNED_UP error.
  virtual void SetAccountsInCookie(
      const std::vector<std::string>& account_ids,
      gaia::GaiaSource source,
      base::OnceCallback<void(const GoogleServiceAuthError& error)>
          set_accounts_in_cookies_completed_callback) = 0;

  // Triggers a ListAccounts fetch. Can be used in circumstances where clients
  // know that the contents of the Gaia cookie might have changed.
  virtual void TriggerCookieJarUpdate() = 0;

  // Notifies observers that |account_id| has been added to the Gaia cookie.
  // Should only be invoked manually in cases where clients have detected that
  // an account is in the Gaia cookie and want to ensure that observers are
  // notified.
  virtual void ForceTriggerOnAddAccountToCookieCompleted(
      const std::string& account_id,
      const GoogleServiceAuthError& error) = 0;

 private:
  DISALLOW_COPY_AND_ASSIGN(AccountsCookieMutator);
};

}  // namespace identity

#endif  // SERVICES_IDENTITY_PUBLIC_CPP_ACCOUNTS_COOKIE_MUTATOR_H_