File: silent_sync_enabler.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (62 lines) | stat: -rw-r--r-- 2,346 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_STARTUP_SILENT_SYNC_ENABLER_H_
#define CHROME_BROWSER_UI_STARTUP_SILENT_SYNC_ENABLER_H_

#include "base/functional/callback_forward.h"
#include "base/scoped_observation.h"
#include "components/signin/public/identity_manager/identity_manager.h"

#if !BUILDFLAG(IS_CHROMEOS_LACROS)
#error This is only supported on lacros.
#endif

class Profile;

// Allows turning on Sync silently by running through the regular flow without
// showing any UI.
// Use it by calling `SilentSyncEnabler::StartAttempt()`, keep the returned
// instance around to make sure multiple attempts are not happening at the same
// time.
// Intended to be used when migrating previously syncing profiles to Lacros.
class SilentSyncEnabler : public signin::IdentityManager::Observer {
 public:
  explicit SilentSyncEnabler(Profile& profile,
                             signin::IdentityManager& identity_manager);
  ~SilentSyncEnabler() override;

  SilentSyncEnabler(const SilentSyncEnabler&) = delete;
  SilentSyncEnabler& operator=(const SilentSyncEnabler&) = delete;

  // Attempts to turn Sync on with `profile_`'s primary account and runs
  // `callback` when the attempts completes, whether it succeeded or not.
  // Notes:
  // - Deleting the returned instance will not cancel the attempt and
  //   `callback` can potentially be executed after this instance has been
  //   deleted. It is the caller's responsibility to ensure that it is safe to
  //   do so.
  // - If this is called while another attempt is happening on the same profile,
  //   the other attempt will be cancelled (per TurnSyncOnHelper's behaviour,
  //   only one can be attached to a profile at a time).
  void StartAttempt(base::OnceClosure callback);

 private:
  void TryEnableSyncSilentlyWithToken();

  // signin::IdentityManager::Observer:
  void OnRefreshTokensLoaded() override;

  const raw_ref<Profile> profile_;
  const raw_ref<signin::IdentityManager> identity_manager_;

  base::OnceClosure callback_;

  base::ScopedObservation<signin::IdentityManager,
                          signin::IdentityManager::Observer>
      scoped_observation_{this};
};

#endif  // CHROME_BROWSER_UI_STARTUP_SILENT_SYNC_ENABLER_H_