content/browser/indexed_db/indexed_db_reporting.h

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

#ifndef CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_REPORTING_H_
#define CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_REPORTING_H_

#include <string>

#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/strcat.h"
#include "base/time/time.h"
#include "content/browser/indexed_db/status.h"
#include "third_party/leveldatabase/src/include/leveldb/status.h"

namespace storage {
struct BucketLocator;
}  // namespace storage

namespace content::indexed_db {

constexpr static const char* kBackingStoreActionUmaName =
    "WebCore.IndexedDB.BackingStore.Action";

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum BackingStoreErrorSource {
  // 0 - 2 are no longer used.
  FIND_KEY_IN_INDEX = 3,
  GET_IDBDATABASE_METADATA = 4,
  GET_INDEXES = 5,
  GET_KEY_GENERATOR_CURRENT_NUMBER = 6,
  GET_OBJECT_STORES = 7,
  GET_RECORD = 8,
  KEY_EXISTS_IN_OBJECT_STORE = 9,
  LOAD_CURRENT_ROW = 10,
  SET_UP_METADATA = 11,
  GET_PRIMARY_KEY_VIA_INDEX = 12,
  KEY_EXISTS_IN_INDEX = 13,
  VERSION_EXISTS = 14,
  DELETE_OBJECT_STORE = 15,
  SET_MAX_OBJECT_STORE_ID = 16,
  SET_MAX_INDEX_ID = 17,
  GET_NEW_DATABASE_ID = 18,
  GET_NEW_VERSION_NUMBER = 19,
  CREATE_IDBDATABASE_METADATA = 20,
  DELETE_DATABASE = 21,
  TRANSACTION_COMMIT_METHOD = 22,  // TRANSACTION_COMMIT is a WinNT.h macro
  GET_DATABASE_NAMES = 23,
  DELETE_INDEX = 24,
  CLEAR_OBJECT_STORE = 25,
  READ_BLOB_JOURNAL = 26,
  DECODE_BLOB_JOURNAL = 27,
  GET_BLOB_KEY_GENERATOR_CURRENT_NUMBER = 28,
  GET_BLOB_INFO_FOR_RECORD = 29,
  UPGRADING_SCHEMA_CORRUPTED_BLOBS = 30,
  // REVERT_SCHEMA_TO_V2 = 31,
  CREATE_ITERATOR = 32,
  INTERNAL_ERROR_MAX,
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused. Commented out values are deprecated.
enum BackingStoreOpenResult {
  // INDEXED_DB_BACKING_STORE_OPEN_MEMORY_SUCCESS = 0,
  INDEXED_DB_BACKING_STORE_OPEN_SUCCESS = 1,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_DIRECTORY = 2,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_UNKNOWN_SCHEMA = 3,
  INDEXED_DB_BACKING_STORE_OPEN_CLEANUP_DESTROY_FAILED = 4,
  INDEXED_DB_BACKING_STORE_OPEN_CLEANUP_REOPEN_FAILED = 5,
  INDEXED_DB_BACKING_STORE_OPEN_CLEANUP_REOPEN_SUCCESS = 6,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_IO_ERROR_CHECKING_SCHEMA = 7,
  // INDEXED_DB_BACKING_STORE_OPEN_FAILED_UNKNOWN_ERR_DEPRECATED = 8,
  // INDEXED_DB_BACKING_STORE_OPEN_MEMORY_FAILED = 9,
  INDEXED_DB_BACKING_STORE_OPEN_ATTEMPT_NON_ASCII = 10,
  INDEXED_DB_BACKING_STORE_OPEN_DISK_FULL = 11,
  INDEXED_DB_BACKING_STORE_OPEN_ORIGIN_TOO_LONG = 12,
  INDEXED_DB_BACKING_STORE_OPEN_NO_RECOVERY = 13,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_PRIOR_CORRUPTION = 14,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_CLEANUP_JOURNAL_ERROR = 15,
  INDEXED_DB_BACKING_STORE_OPEN_FAILED_METADATA_SETUP = 16,
  INDEXED_DB_BACKING_STORE_OPEN_MAX,
};

// These values are used for UMA metrics and should never be changed.
enum class IndexedDBAction {
  // This is recorded every time there is an attempt to open an unopened backing
  // store. This can happen during the API calls IDBFactory::Open,
  // GetDatabaseNames, GetDatabaseInfo, and DeleteDatabase.
  kBackingStoreOpenAttempt = 0,
  // This is recorded every time there is an attempt to delete the database
  // using the IDBFactory::DeleteDatabase API.
  kDatabaseDeleteAttempt = 1,
  kMaxValue = kDatabaseDeleteAttempt,
};

void ReportOpenStatus(BackingStoreOpenResult result,
                      const storage::BucketLocator& bucket_locator);

void ReportInternalError(const char* type, BackingStoreErrorSource location);

void ReportLevelDBError(const std::string& histogram_name,
                        const leveldb::Status& s);

inline constexpr static std::string_view ToVariantSuffix(bool in_memory) {
  return in_memory ? ".InMemory" : ".OnDisk";
}

// Logs `duration` to `histogram_name` suffixed with ".Duration" and a variant
// indicating whether the backing store is `in_memory` or on-disk.
inline void LogDuration(const base::TimeDelta& duration,
                        std::string_view histogram_name,
                        bool in_memory) {
  base::UmaHistogramTimes(
      base::StrCat({histogram_name, ".Duration", ToVariantSuffix(in_memory)}),
      duration);
}

// Logs `status` to `histogram_name` suffixed with a variant indicating whether
// the backing store is `in_memory` or on-disk.
inline void LogStatus(const Status& status,
                      std::string_view histogram_name,
                      bool in_memory) {
  status.Log(base::StrCat({histogram_name, ToVariantSuffix(in_memory)}));
}

// Performs `action` and logs its result (expected to be a `StatusOr<>`) to
// `histogram_name` suffixed with a variant indicating whether the backing store
// is `in_memory` or on-disk.
#define LOG_RESULT(action, histogram_name, in_memory)                       \
  [&](std::string_view _histogram_name, bool _in_memory) {                  \
    auto _result = action;                                                  \
    LogStatus(_result.error_or(Status::OK()), _histogram_name, _in_memory); \
    return _result;                                                         \
  }(histogram_name, in_memory)

// Use to signal conditions caused by data corruption.
// A macro is used instead of an inline function so that the assert and log
// report the line number.
#define REPORT_ERROR(type, location)                      \
  do {                                                    \
    LOG(ERROR) << "IndexedDB " type " Error: " #location; \
    ::content::indexed_db::ReportInternalError(           \
        type, ::content::indexed_db::location);           \
  } while (0)

#define INTERNAL_READ_ERROR(location) REPORT_ERROR("Read", location)
#define INTERNAL_CONSISTENCY_ERROR(location) \
  REPORT_ERROR("Consistency", location)
#define INTERNAL_WRITE_ERROR(location) REPORT_ERROR("Write", location)

}  // namespace content::indexed_db

#endif  // CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_REPORTING_H_