File: event_storage_migration.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 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-- 3,491 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 2025 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_FEATURE_ENGAGEMENT_INTERNAL_EVENT_STORAGE_MIGRATION_H_
#define COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_EVENT_STORAGE_MIGRATION_H_

#include "base/memory/weak_ptr.h"
#include "components/feature_engagement/internal/proto/feature_event.pb.h"
#include "components/leveldb_proto/public/proto_database.h"

namespace feature_engagement {

// A EventStorageMigration provides the ability to migrate the event storage
// from the profile db to the device db.
// TODO(crbug.com/426624087): Remove this and all the calls related to it once
// the migration is completed.
class EventStorageMigration {
 public:
  // Represents the status of the profile to device migration.
  // These enums are persisted as histogram entries, so this enum should be
  // treated as append-only and kept in sync with
  // InProductHelpEventStorageMigrationStatus in enums.xml.
  enum class EventStorageMigrationStatus : int {
    // The migration is not required.
    kNotRequired = 0,
    // The migration has started.
    kStarted = 1,
    // The migration has completed successfully.
    kCompleted = 2,
    // The migration failed to initialize.
    kFailedToInitialize = 3,
    // The migration failed to load.
    kFailedToLoad = 4,
    // The migration failed to write.
    kFailedToWrite = 5,
    // The maximum value of the enum.
    kMaxValue = kFailedToWrite
  };

  explicit EventStorageMigration(
      raw_ptr<leveldb_proto::ProtoDatabase<Event>> profile_db,
      raw_ptr<leveldb_proto::ProtoDatabase<Event>> device_db);

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

  ~EventStorageMigration();

  static void RecordMigrationStatus(EventStorageMigrationStatus status);

  // Callback for when migration has finished. The |success|
  // argument denotes whether the migration was successful.
  using MigrationCallback = base::OnceCallback<void(bool success)>;

  // Migrate the event storage from the profile db to the device db.
  void Migrate(MigrationCallback callback);

 private:
  // Callback for when an underlying db has been initialized.
  void OnInitializationComplete(leveldb_proto::Enums::InitStatus status);

  // Called when both underlying db have finished their initialization.
  void OnDBsInitializationCompleted();

  // Called when the profile db has finished loading.
  void OnLoadEntriesComplete(bool success,
                             std::unique_ptr<std::vector<Event>> entries);

  // Called when the device db has finished writing.
  void OnEventWrittenCompleted(bool success);

  // Barrier closure that is run when both db have initialized.
  base::RepeatingClosure initialization_complete_barrier_;

  // Callback to be invoked once overall migration is complete.
  MigrationCallback migration_callback_;

  // Tracks the overall success of the initialization process. True if both
  // underlying db initialize successfully.
  bool initialization_success_ = false;

  // The profile db.
  raw_ptr<leveldb_proto::ProtoDatabase<Event>> profile_db_;

  // The device db.
  raw_ptr<leveldb_proto::ProtoDatabase<Event>> device_db_;

  base::WeakPtrFactory<EventStorageMigration> weak_ptr_factory_{this};
};

}  // namespace feature_engagement

#endif  // COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_EVENT_STORAGE_MIGRATION_H_