File: sync_internals_util.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (94 lines) | stat: -rw-r--r-- 4,009 bytes parent folder | download | duplicates (3)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SYNC_SERVICE_SYNC_INTERNALS_UTIL_H_
#define COMPONENTS_SYNC_SERVICE_SYNC_INTERNALS_UTIL_H_

#include <memory>
#include <string>

#include "base/types/strong_alias.h"
#include "base/values.h"
#include "components/signin/public/identity_manager/account_info.h"
#include "components/sync/service/sync_service.h"

namespace syncer {

namespace sync_ui_util {

// These strings are used from logs to pull out specific data from sync; we
// don't want these to ever go out of sync between the logs and sync util.
inline constexpr char kIdentityTitle[] = "Identity";
inline constexpr char kDetailsKey[] = "details";

// Resource paths.
// Must match the resource file names.
inline constexpr char kAboutJS[] = "about.js";
inline constexpr char kChromeSyncJS[] = "chrome_sync.js";
inline constexpr char kDataJS[] = "data.js";
inline constexpr char kEventsJS[] = "events.js";
inline constexpr char kSearchJS[] = "search.js";
inline constexpr char kSyncIndexJS[] = "sync_index.js";
inline constexpr char kSyncLogJS[] = "sync_log.js";
inline constexpr char kSyncNodeBrowserJS[] = "sync_node_browser.js";
inline constexpr char kSyncSearchJS[] = "sync_search.js";
inline constexpr char kUserEventsJS[] = "user_events.js";
inline constexpr char kTrafficLogJS[] = "traffic_log.js";
inline constexpr char kInvalidationsJS[] = "invalidations.js";

// Message handlers.
// Must match the constants used in the resource files.
inline constexpr char kGetAllNodes[] = "getAllNodes";
inline constexpr char kRequestDataAndRegisterForUpdates[] =
    "requestDataAndRegisterForUpdates";
inline constexpr char kRequestIncludeSpecificsInitialState[] =
    "requestIncludeSpecificsInitialState";
inline constexpr char kRequestListOfTypes[] = "requestListOfTypes";
inline constexpr char kRequestStart[] = "requestStart";
inline constexpr char kSetIncludeSpecifics[] = "setIncludeSpecifics";
inline constexpr char kTriggerRefresh[] = "triggerRefresh";
inline constexpr char kWriteUserEvent[] = "writeUserEvent";

// Other strings.
// WARNING: Must match the property names used in the resource files.
inline constexpr char kEntityCounts[] = "entityCounts";
inline constexpr char kEntities[] = "entities";
inline constexpr char kNonTombstoneEntities[] = "nonTombstoneEntities";
inline constexpr char kIncludeSpecifics[] = "includeSpecifics";
inline constexpr char kDataType[] = "dataType";
inline constexpr char kOnAboutInfoUpdated[] = "onAboutInfoUpdated";
inline constexpr char kOnEntityCountsUpdated[] = "onEntityCountsUpdated";
inline constexpr char kOnProtocolEvent[] = "onProtocolEvent";
inline constexpr char kOnReceivedIncludeSpecificsInitialState[] =
    "onReceivedIncludeSpecificsInitialState";
inline constexpr char kOnReceivedListOfTypes[] = "onReceivedListOfTypes";
inline constexpr char kTypes[] = "types";
inline constexpr char kOnInvalidationReceived[] = "onInvalidationReceived";

using IncludeSensitiveData =
    base::StrongAlias<class IncludeSensitiveDataTag, bool>;

// Returns a human-readable string representation of a DisableReasonSet.
std::string GetDisableReasonsDebugString(
    SyncService::DisableReasonSet disable_reasons);

// Returns a human-readable string representation for `state`.
std::string TransportStateStringToDebugString(
    SyncService::TransportState state);

// This function returns a base::Value::Dict which contains all the information
// required to populate the 'About' tab of chrome://sync-internals.
// Note that `service` may be null.
// If `include_sensitive_data` is false, Personally Identifiable Information
// won't be included in the return value.
base::Value::Dict ConstructAboutInformation(
    IncludeSensitiveData include_sensitive_data,
    SyncService* service,
    const std::string& channel);

}  // namespace sync_ui_util

}  // namespace syncer

#endif  // COMPONENTS_SYNC_SERVICE_SYNC_INTERNALS_UTIL_H_