ServiceWorker: DB functions should return status code instead of boolean (2)

content/browser/service_worker/service_worker_database.cc

 // Copyright 2014 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.
 
 #include "content/browser/service_worker/service_worker_database.h"
 
 #include <string>
 
 #include "base/file_util.h"
 #include "base/location.h"
@@ skipping 242 matching lines @@
 
 ServiceWorkerStatusCode ServiceWorkerDatabase::GetNextAvailableIds(
     int64* next_avail_registration_id,
     int64* next_avail_version_id,
     int64* next_avail_resource_id) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(next_avail_registration_id);
   DCHECK(next_avail_version_id);
   DCHECK(next_avail_resource_id);
 
-  if (!LazyOpen(false)) {
-    if (is_disabled_)
-      return SERVICE_WORKER_ERROR_FAILED;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
     *next_avail_registration_id = 0;
     *next_avail_version_id = 0;
     *next_avail_resource_id = 0;
     return SERVICE_WORKER_OK;
   }
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
-  ServiceWorkerStatusCode status =
-      ReadNextAvailableId(kNextRegIdKey, &next_avail_registration_id_);
+  status = ReadNextAvailableId(kNextRegIdKey, &next_avail_registration_id_);
   if (status != SERVICE_WORKER_OK)
     return status;
   status = ReadNextAvailableId(kNextVerIdKey, &next_avail_version_id_);
   if (status != SERVICE_WORKER_OK)
     return status;
   status = ReadNextAvailableId(kNextResIdKey, &next_avail_resource_id_);
   if (status != SERVICE_WORKER_OK)
     return status;
 
   *next_avail_registration_id = next_avail_registration_id_;
   *next_avail_version_id = next_avail_version_id_;
   *next_avail_resource_id = next_avail_resource_id_;
   return SERVICE_WORKER_OK;
 }
 
 ServiceWorkerStatusCode ServiceWorkerDatabase::GetOriginsWithRegistrations(
     std::set<GURL>* origins) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(origins);
 
-  if (!LazyOpen(false)) {
-    if (is_disabled_)
-      return SERVICE_WORKER_ERROR_FAILED;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
     origins->clear();

[michaeln, 2014/05/15 19:59:30]

if origins needs to be cleared here, then it also needs to be cleared in the
case below prior to reading from the db

i think we could just DCHECK(origins->empty()) up top

[nhiroki, 2014/05/16 02:11:11]

Done.

     return SERVICE_WORKER_OK;
   }
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   scoped_ptr<leveldb::Iterator> itr(db_->NewIterator(leveldb::ReadOptions()));
   for (itr->Seek(kUniqueOriginKey); itr->Valid(); itr->Next()) {
     if (!itr->status().ok()) {
       HandleError(FROM_HERE, itr->status());
       origins->clear();
       return LevelDBStatusToServiceWorkerStatusCode(itr->status());
     }
 
     std::string origin;
     if (!RemovePrefix(itr->key().ToString(), kUniqueOriginKey, &origin))
       break;
     origins->insert(GURL(origin));
   }
   return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::GetRegistrationsForOrigin(
+ServiceWorkerStatusCode ServiceWorkerDatabase::GetRegistrationsForOrigin(
     const GURL& origin,
     std::vector<RegistrationData>* registrations) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(registrations);
 
-  if (!LazyOpen(false)) {
-    if (is_disabled_)
-      return false;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
     registrations->clear();

[michaeln, 2014/05/15 19:59:30]

ditto clearing the collection

[nhiroki, 2014/05/16 02:11:11]

Done.

-    return true;
+    return SERVICE_WORKER_OK;
   }
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   // Create a key prefix for registrations.
   std::string prefix = base::StringPrintf(
       "%s%s%c", kRegKeyPrefix, origin.spec().c_str(), kKeySeparator);
 
   scoped_ptr<leveldb::Iterator> itr(db_->NewIterator(leveldb::ReadOptions()));
   for (itr->Seek(prefix); itr->Valid(); itr->Next()) {
     if (!itr->status().ok()) {
       HandleError(FROM_HERE, itr->status());
       registrations->clear();
-      return false;
+      return LevelDBStatusToServiceWorkerStatusCode(itr->status());
     }
 
     if (!RemovePrefix(itr->key().ToString(), prefix, NULL))
       break;
 
     RegistrationData registration;
     if (!ParseRegistrationData(itr->value().ToString(), &registration)) {
       HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
       registrations->clear();
-      return false;
+      return SERVICE_WORKER_ERROR_DB_CORRUPTED;
     }
     registrations->push_back(registration);
   }
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::GetAllRegistrations(
+ServiceWorkerStatusCode ServiceWorkerDatabase::GetAllRegistrations(
     std::vector<RegistrationData>* registrations) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(registrations);
 
-  if (!LazyOpen(false)) {
-    if (is_disabled_)
-      return false;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
     registrations->clear();

[michaeln, 2014/05/15 19:59:30]

ditt

[nhiroki, 2014/05/16 02:11:11]

Done.

-    return true;
+    return SERVICE_WORKER_OK;
   }
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   scoped_ptr<leveldb::Iterator> itr(db_->NewIterator(leveldb::ReadOptions()));
   for (itr->Seek(kRegKeyPrefix); itr->Valid(); itr->Next()) {
     if (!itr->status().ok()) {
       HandleError(FROM_HERE, itr->status());
       registrations->clear();
-      return false;
+      return LevelDBStatusToServiceWorkerStatusCode(itr->status());
     }
 
     if (!RemovePrefix(itr->key().ToString(), kRegKeyPrefix, NULL))
       break;
 
     RegistrationData registration;
     if (!ParseRegistrationData(itr->value().ToString(), &registration)) {
       HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
       registrations->clear();
-      return false;
+      return SERVICE_WORKER_ERROR_DB_CORRUPTED;
     }
     registrations->push_back(registration);
   }
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
 bool ServiceWorkerDatabase::ReadRegistration(
     int64 registration_id,
     const GURL& origin,
     RegistrationData* registration,
     std::vector<ResourceRecord>* resources) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(registration);
   DCHECK(resources);
 
-  if (!LazyOpen(false) || is_disabled_)
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status != SERVICE_WORKER_OK || !is_initialized_)
     return false;
 
   RegistrationData value;
   if (!ReadRegistrationData(registration_id, origin, &value))
     return false;
 
   if (!ReadResourceRecords(value.version_id, resources))
     return false;
 
   *registration = value;
   return true;
 }
 
 bool ServiceWorkerDatabase::WriteRegistration(
     const RegistrationData& registration,
     const std::vector<ResourceRecord>& resources) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (!LazyOpen(true) || is_disabled_)
+  if (LazyOpen(true) != SERVICE_WORKER_OK)
     return false;
 
   leveldb::WriteBatch batch;
   BumpNextRegistrationIdIfNeeded(registration.registration_id, &batch);
   BumpNextVersionIdIfNeeded(registration.version_id, &batch);
 
   // TODO(nhiroki): Skip to add the origin into the unique origin list if it
   // has already been added.
   PutUniqueOriginToBatch(registration.scope.GetOrigin(), &batch);
 
@@ skipping 35 matching lines @@
     batch.Delete(CreateResourceIdKey(
         kUncommittedResIdKeyPrefix, itr->resource_id));
   }
 
   return WriteBatch(&batch);
 }
 
 bool ServiceWorkerDatabase::UpdateVersionToActive(int64 registration_id,
                                                   const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (!LazyOpen(false) || is_disabled_)
+  if (LazyOpen(false) != SERVICE_WORKER_OK || !is_initialized_)
     return false;
 
   RegistrationData registration;
   if (!ReadRegistrationData(registration_id, origin, &registration))
     return false;
 
   registration.is_active = true;
 
   leveldb::WriteBatch batch;
   PutRegistrationDataToBatch(registration, &batch);
   return WriteBatch(&batch);
 }
 
 bool ServiceWorkerDatabase::UpdateLastCheckTime(int64 registration_id,
                                                 const GURL& origin,
                                                 const base::Time& time) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (!LazyOpen(false) || is_disabled_)
+  if (LazyOpen(false) != SERVICE_WORKER_OK || !is_initialized_)
     return false;
 
   RegistrationData registration;
   if (!ReadRegistrationData(registration_id, origin, &registration))
     return false;
 
   registration.last_update_check = time;
 
   leveldb::WriteBatch batch;
   PutRegistrationDataToBatch(registration, &batch);
   return WriteBatch(&batch);
 }
 
 bool ServiceWorkerDatabase::DeleteRegistration(int64 registration_id,
                                                const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (!LazyOpen(false) || is_disabled_)
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    // Database has never been used.
+    return true;
+  }
+  if (status != SERVICE_WORKER_OK || !origin.is_valid())
     return false;
 
   leveldb::WriteBatch batch;
 
   // Remove |origin| from unique origins if a registration specified by
   // |registration_id| is the only one for |origin|.
   // TODO(nhiroki): Check the uniqueness by more efficient way.
   std::vector<RegistrationData> registrations;
-  if (!GetRegistrationsForOrigin(origin, &registrations))
+  if (GetRegistrationsForOrigin(origin, &registrations) != SERVICE_WORKER_OK)
     return false;
   if (registrations.size() == 1 &&
       registrations[0].registration_id == registration_id) {
     batch.Delete(CreateUniqueOriginKey(origin));
   }
 
   // Delete a registration specified by |registration_id|.
   batch.Delete(CreateRegistrationKey(registration_id, origin));
 
   // Delete resource records associated with the registration.
@@ skipping 32 matching lines @@
   return WriteResourceIds(kPurgeableResIdKeyPrefix, ids);
 }
 
 bool ServiceWorkerDatabase::ClearPurgeableResourceIds(
     const std::set<int64>& ids) {
   return DeleteResourceIds(kPurgeableResIdKeyPrefix, ids);
 }
 
 bool ServiceWorkerDatabase::DeleteAllDataForOrigin(const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (!LazyOpen(true) || is_disabled_ || !origin.is_valid())
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    // Database has never been used.
+    return true;
+  }
+  if (status != SERVICE_WORKER_OK || !origin.is_valid())
     return false;
 
   leveldb::WriteBatch batch;
 
   // Delete from the unique origin list.
   batch.Delete(CreateUniqueOriginKey(origin));
 
   std::vector<RegistrationData> registrations;
-  if (!GetRegistrationsForOrigin(origin, &registrations))
+  if (GetRegistrationsForOrigin(origin, &registrations) != SERVICE_WORKER_OK)
     return false;
 
   // Delete registrations and resource records.
   for (std::vector<RegistrationData>::const_iterator itr =
            registrations.begin(); itr != registrations.end(); ++itr) {
     batch.Delete(CreateRegistrationKey(itr->registration_id, origin));
     if (!DeleteResourceRecords(itr->version_id, &batch))
       return false;
   }
 
   return WriteBatch(&batch);
 }
 
-bool ServiceWorkerDatabase::LazyOpen(bool create_if_needed) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::LazyOpen(
+    bool create_if_missing) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (IsOpen())
-    return true;
 
   // Do not try to open a database if we tried and failed once.
   if (is_disabled_)
-    return false;
+    return SERVICE_WORKER_ERROR_FAILED;
+  if (IsOpen())
+    return SERVICE_WORKER_OK;
 
   // When |path_| is empty, open a database in-memory.
   bool use_in_memory_db = path_.empty();
 
-  if (!create_if_needed) {
+  if (!create_if_missing) {
     // Avoid opening a database if it does not exist at the |path_|.
     if (use_in_memory_db ||
         !base::PathExists(path_) ||
         base::IsDirectoryEmpty(path_)) {
-      return false;
+      return SERVICE_WORKER_ERROR_NOT_FOUND;
     }
   }
 
   leveldb::Options options;
-  options.create_if_missing = create_if_needed;
+  options.create_if_missing = create_if_missing;
   if (use_in_memory_db) {
     env_.reset(leveldb::NewMemEnv(leveldb::Env::Default()));
     options.env = env_.get();
   }
 
   leveldb::DB* db = NULL;
-  leveldb::Status status =
+  leveldb::Status db_status =
       leveldb::DB::Open(options, path_.AsUTF8Unsafe(), &db);
-  if (!status.ok()) {
+  if (!db_status.ok()) {
     DCHECK(!db);
     // TODO(nhiroki): Should we retry to open the database?
-    HandleError(FROM_HERE, status);
-    return false;
+    HandleError(FROM_HERE, db_status);
+    return LevelDBStatusToServiceWorkerStatusCode(db_status);
   }
   db_.reset(db);
 
   int64 db_version;
-  if (!ReadDatabaseVersion(&db_version))
-    return false;
+  ServiceWorkerStatusCode status = ReadDatabaseVersion(&db_version);
+  if (status != SERVICE_WORKER_OK)
+    return status;
+  DCHECK_LE(0, db_version);
   if (db_version > 0)
     is_initialized_ = true;
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
 ServiceWorkerStatusCode ServiceWorkerDatabase::ReadNextAvailableId(
     const char* id_key,
     int64* next_avail_id) {
   DCHECK(id_key);
   DCHECK(next_avail_id);
 
   std::string value;
   leveldb::Status status = db_->Get(leveldb::ReadOptions(), id_key, &value);
@@ skipping 105 matching lines @@
   }
   return true;
 }
 
 bool ServiceWorkerDatabase::ReadResourceIds(const char* id_key_prefix,
                                             std::set<int64>* ids) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(id_key_prefix);
   DCHECK(ids);
 
-  if (!LazyOpen(false) || is_disabled_)
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    // Database has never been used.
+    ids->clear();

[michaeln, 2014/05/15 19:59:30]

ditto clearing collection

[nhiroki, 2014/05/16 02:11:11]

Done.

+    return true;
+  }
+  if (status != SERVICE_WORKER_OK)
     return false;
 
   scoped_ptr<leveldb::Iterator> itr(db_->NewIterator(leveldb::ReadOptions()));
   for (itr->Seek(id_key_prefix); itr->Valid(); itr->Next()) {
     if (!itr->status().ok()) {
       HandleError(FROM_HERE, itr->status());
       ids->clear();
       return false;
     }
 
@@ skipping 10 matching lines @@
     ids->insert(resource_id);
   }
   return true;
 }
 
 bool ServiceWorkerDatabase::WriteResourceIds(const char* id_key_prefix,
                                              const std::set<int64>& ids) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(id_key_prefix);
 
-  if (!LazyOpen(true) || is_disabled_)
+  if (LazyOpen(true) != SERVICE_WORKER_OK)
     return false;
   if (ids.empty())
     return true;
 
   leveldb::WriteBatch batch;
   for (std::set<int64>::const_iterator itr = ids.begin();
        itr != ids.end(); ++itr) {
     // Value should be empty.
     batch.Put(CreateResourceIdKey(id_key_prefix, *itr), "");
   }
   return WriteBatch(&batch);
 }
 
 bool ServiceWorkerDatabase::DeleteResourceIds(const char* id_key_prefix,
                                               const std::set<int64>& ids) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(id_key_prefix);
 
-  if (!LazyOpen(true) || is_disabled_)
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    // Database has never been used.
+    return true;
+  }
+  if (status != SERVICE_WORKER_OK)
     return false;
+
   if (ids.empty())
     return true;
 
   leveldb::WriteBatch batch;
   for (std::set<int64>::const_iterator itr = ids.begin();
        itr != ids.end(); ++itr) {
     batch.Delete(CreateResourceIdKey(id_key_prefix, *itr));
   }
   return WriteBatch(&batch);
 }
 
-bool ServiceWorkerDatabase::ReadDatabaseVersion(int64* db_version) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::ReadDatabaseVersion(
+    int64* db_version) {
   std::string value;
   leveldb::Status status =
       db_->Get(leveldb::ReadOptions(), kDatabaseVersionKey, &value);
   if (status.IsNotFound()) {
     // The database hasn't been initialized yet.
     *db_version = 0;
-    return true;
+    return SERVICE_WORKER_OK;
   }
   if (!status.ok()) {
     HandleError(FROM_HERE, status);
-    return false;
+    return LevelDBStatusToServiceWorkerStatusCode(status);
   }
 
   int64 parsed;
   if (!base::StringToInt64(value, &parsed)) {
     HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
-    return false;
+    return SERVICE_WORKER_ERROR_DB_CORRUPTED;
   }
 
   const int kFirstValidVersion = 1;
   if (parsed < kFirstValidVersion || kCurrentSchemaVersion < parsed) {
     HandleError(FROM_HERE, leveldb::Status::Corruption("invalid DB version"));
-    return false;
+    return SERVICE_WORKER_ERROR_DB_CORRUPTED;
   }
 
   *db_version = parsed;
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
 bool ServiceWorkerDatabase::WriteBatch(leveldb::WriteBatch* batch) {
   DCHECK(batch);
   DCHECK(!is_disabled_);
 
   if (!is_initialized_) {
     // Write the database schema version.
     batch->Put(kDatabaseVersionKey, base::Int64ToString(kCurrentSchemaVersion));
     is_initialized_ = true;
@@ skipping 35 matching lines @@
   // TODO(nhiroki): Add an UMA histogram.
   DLOG(ERROR) << "Failed at: " << from_here.ToString()
               << " with error: " << status.ToString();
   is_disabled_ = true;
   if (status.IsCorruption())
     was_corruption_detected_ = true;
   db_.reset();
 }
 
 }  // namespace content