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

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 380 matching lines @@
     if (!ParseRegistrationData(itr->value().ToString(), &registration)) {
       HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
       registrations->clear();
       return SERVICE_WORKER_ERROR_DB_CORRUPTED;
     }
     registrations->push_back(registration);
   }
   return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::ReadRegistration(
+ServiceWorkerStatusCode ServiceWorkerDatabase::ReadRegistration(
     int64 registration_id,
     const GURL& origin,
     RegistrationData* registration,
     std::vector<ResourceRecord>* resources) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(registration);
   DCHECK(resources);
 
   ServiceWorkerStatusCode status = LazyOpen(false);
-  if (status != SERVICE_WORKER_OK || !is_initialized_)
-    return false;
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    return SERVICE_WORKER_ERROR_NOT_FOUND;
+  }
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   RegistrationData value;
-  if (!ReadRegistrationData(registration_id, origin, &value))
-    return false;
+  status = ReadRegistrationData(registration_id, origin, &value);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
-  if (!ReadResourceRecords(value.version_id, resources))
-    return false;
+  status = ReadResourceRecords(value.version_id, resources);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   *registration = value;
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::WriteRegistration(
+ServiceWorkerStatusCode ServiceWorkerDatabase::WriteRegistration(
     const RegistrationData& registration,
     const std::vector<ResourceRecord>& resources) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (LazyOpen(true) != SERVICE_WORKER_OK)
-    return false;
+  ServiceWorkerStatusCode status = LazyOpen(true);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   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);
 
   PutRegistrationDataToBatch(registration, &batch);
 
   // Retrieve a previous version to sweep purgeable resources.
   RegistrationData old_registration;
-  if (!ReadRegistrationData(registration.registration_id,
-                            registration.scope.GetOrigin(),
-                            &old_registration)) {
-    if (is_disabled_)
-      return false;
-    // Just not found.
+  status = ReadRegistrationData(registration.registration_id,
+                                registration.scope.GetOrigin(),
+                                &old_registration);
+  if (status != SERVICE_WORKER_OK) {
+    if (status != SERVICE_WORKER_ERROR_NOT_FOUND)

[michaeln, 2014/05/15 20:44:58]

nit: could be restructured to only utilize early return instead of the } else {
clause

if (x != 1 && x != b)
  return z;

[nhiroki, 2014/05/19 04:58:04]

Done.

+      return status;
   } else {
     DCHECK_LT(old_registration.version_id, registration.version_id);
     // Currently resource sharing across versions and registrations is not
     // suppported, so resource ids should not be overlapped between
     // |registration| and |old_registration|.
     // TODO(nhiroki): Add DCHECK to make sure the overlap does not exist.
-    if (!DeleteResourceRecords(old_registration.version_id, &batch))
-      return false;
+    status = DeleteResourceRecords(old_registration.version_id, &batch);
+    if (status != SERVICE_WORKER_OK)
+      return status;
   }
 
   // Used for avoiding multiple writes for the same resource id or url.
   std::set<int64> pushed_resources;
   std::set<GURL> pushed_urls;
   for (std::vector<ResourceRecord>::const_iterator itr = resources.begin();
        itr != resources.end(); ++itr) {
     if (!itr->url.is_valid())
-      return false;
+      return SERVICE_WORKER_ERROR_FAILED;
 
     // Duplicated resource id or url should not exist.
     DCHECK(pushed_resources.insert(itr->resource_id).second);
     DCHECK(pushed_urls.insert(itr->url).second);
 
     PutResourceRecordToBatch(*itr, registration.version_id, &batch);
 
     // Delete a resource from the uncommitted list.
     batch.Delete(CreateResourceIdKey(
         kUncommittedResIdKeyPrefix, itr->resource_id));
   }
 
   return WriteBatch(&batch);
 }
 
-bool ServiceWorkerDatabase::UpdateVersionToActive(int64 registration_id,
-                                                  const GURL& origin) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::UpdateVersionToActive(
+    int64 registration_id,
+    const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (LazyOpen(false) != SERVICE_WORKER_OK || !is_initialized_)
-    return false;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {
+    // Database has never been used.
+    return SERVICE_WORKER_ERROR_NOT_FOUND;
+  }
+  if (status != SERVICE_WORKER_OK)
+    return status;
+  if (!origin.is_valid())
+    return SERVICE_WORKER_ERROR_FAILED;
 
   RegistrationData registration;
-  if (!ReadRegistrationData(registration_id, origin, &registration))
-    return false;
+  status = ReadRegistrationData(registration_id, origin, &registration);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   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) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::UpdateLastCheckTime(
+    int64 registration_id,
+    const GURL& origin,
+    const base::Time& time) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
-  if (LazyOpen(false) != SERVICE_WORKER_OK || !is_initialized_)
-    return false;
+  ServiceWorkerStatusCode status = LazyOpen(false);
+  if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
+      (status == SERVICE_WORKER_OK && !is_initialized_)) {

[michaeln, 2014/05/15 20:44:58]

this test is a recurring theme, stuffing it in a helper method might be nice,
not sure what to name such a method?

if (IsNewOrNonexistentDatabase(status))
  return xxx;

[nhiroki, 2014/05/19 04:58:04]

Done.

+    // Database has never been used.
+    return SERVICE_WORKER_ERROR_NOT_FOUND;
+  }
+  if (status != SERVICE_WORKER_OK)
+    return status;
+  if (!origin.is_valid())
+    return SERVICE_WORKER_ERROR_FAILED;
 
   RegistrationData registration;
-  if (!ReadRegistrationData(registration_id, origin, &registration))
-    return false;
+  status = ReadRegistrationData(registration_id, origin, &registration);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   registration.last_update_check = time;
 
   leveldb::WriteBatch batch;
   PutRegistrationDataToBatch(registration, &batch);
   return WriteBatch(&batch);
 }
 
-bool ServiceWorkerDatabase::DeleteRegistration(int64 registration_id,
-                                               const GURL& origin) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::DeleteRegistration(
+    int64 registration_id,
+    const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   ServiceWorkerStatusCode status = LazyOpen(false);
   if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
       (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
-    return true;
+    return SERVICE_WORKER_ERROR_NOT_FOUND;
   }
-  if (status != SERVICE_WORKER_OK || !origin.is_valid())
-    return false;
+  if (status != SERVICE_WORKER_OK)
+    return status;
+  if (!origin.is_valid())
+    return SERVICE_WORKER_ERROR_FAILED;
 
   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) != SERVICE_WORKER_OK)
-    return false;
+  status = GetRegistrationsForOrigin(origin, &registrations);
+  if (status != SERVICE_WORKER_OK)
+    return status;
   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.
   for (std::vector<RegistrationData>::const_iterator itr =
            registrations.begin(); itr != registrations.end(); ++itr) {
     if (itr->registration_id == registration_id) {
-      if (!DeleteResourceRecords(itr->version_id, &batch))
-        return false;
+      status = DeleteResourceRecords(itr->version_id, &batch);
+      if (status != SERVICE_WORKER_OK)
+        return status;
       break;
     }
   }
 
   return WriteBatch(&batch);
 }
 
 bool ServiceWorkerDatabase::GetUncommittedResourceIds(std::set<int64>* ids) {
   return ReadResourceIds(kUncommittedResIdKeyPrefix, ids);
 }
@@ skipping 15 matching lines @@
 bool ServiceWorkerDatabase::WritePurgeableResourceIds(
     const std::set<int64>& ids) {
   return WriteResourceIds(kPurgeableResIdKeyPrefix, ids);
 }
 
 bool ServiceWorkerDatabase::ClearPurgeableResourceIds(
     const std::set<int64>& ids) {
   return DeleteResourceIds(kPurgeableResIdKeyPrefix, ids);
 }
 
-bool ServiceWorkerDatabase::DeleteAllDataForOrigin(const GURL& origin) {
+ServiceWorkerStatusCode ServiceWorkerDatabase::DeleteAllDataForOrigin(
+    const GURL& origin) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   ServiceWorkerStatusCode status = LazyOpen(false);
   if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
       (status == SERVICE_WORKER_OK && !is_initialized_)) {
     // Database has never been used.
-    return true;
+    return SERVICE_WORKER_ERROR_NOT_FOUND;
   }
-  if (status != SERVICE_WORKER_OK || !origin.is_valid())
-    return false;
+  if (status != SERVICE_WORKER_OK)
+    return status;
+  if (!origin.is_valid())
+    return SERVICE_WORKER_ERROR_FAILED;
 
   leveldb::WriteBatch batch;
 
   // Delete from the unique origin list.
   batch.Delete(CreateUniqueOriginKey(origin));
 
   std::vector<RegistrationData> registrations;
-  if (GetRegistrationsForOrigin(origin, &registrations) != SERVICE_WORKER_OK)
-    return false;
+  status = GetRegistrationsForOrigin(origin, &registrations);
+  if (status != SERVICE_WORKER_OK)
+    return status;
 
   // 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;
+    status = DeleteResourceRecords(itr->version_id, &batch);
+    if (status != SERVICE_WORKER_OK)
+      return status;
   }
 
   return WriteBatch(&batch);
 }
 
 ServiceWorkerStatusCode ServiceWorkerDatabase::LazyOpen(
     bool create_if_missing) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
 
   // Do not try to open a database if we tried and failed once.
@@ skipping 64 matching lines @@
   int64 parsed;
   if (!base::StringToInt64(value, &parsed)) {
     HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
     return SERVICE_WORKER_ERROR_DB_CORRUPTED;
   }
 
   *next_avail_id = parsed;
   return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::ReadRegistrationData(
+ServiceWorkerStatusCode ServiceWorkerDatabase::ReadRegistrationData(
     int64 registration_id,
     const GURL& origin,
     RegistrationData* registration) {
   DCHECK(registration);
 
   std::string key = CreateRegistrationKey(registration_id, origin);
 
   std::string value;
   leveldb::Status status = db_->Get(leveldb::ReadOptions(), key, &value);
   if (!status.ok()) {
     if (!status.IsNotFound())
       HandleError(FROM_HERE, status);
-    return false;
+    return LevelDBStatusToServiceWorkerStatusCode(status);
   }
 
   RegistrationData parsed;
   if (!ParseRegistrationData(value, &parsed)) {
     HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
-    return false;
+    return SERVICE_WORKER_ERROR_DB_CORRUPTED;
   }
 
   *registration = parsed;
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::ReadResourceRecords(
+ServiceWorkerStatusCode ServiceWorkerDatabase::ReadResourceRecords(
     int64 version_id,
     std::vector<ResourceRecord>* resources) {
   DCHECK(resources);
 
   std::string prefix = CreateResourceRecordKeyPrefix(version_id);
   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());
       resources->clear();
-      return false;
+      return LevelDBStatusToServiceWorkerStatusCode(itr->status());
     }
 
     if (!RemovePrefix(itr->key().ToString(), prefix, NULL))
       break;
 
     ResourceRecord resource;
     if (!ParseResourceRecord(itr->value().ToString(), &resource)) {
       HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
       resources->clear();
-      return false;
+      return SERVICE_WORKER_ERROR_DB_CORRUPTED;
     }
     resources->push_back(resource);
   }
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::DeleteResourceRecords(
+ServiceWorkerStatusCode ServiceWorkerDatabase::DeleteResourceRecords(
     int64 version_id,
     leveldb::WriteBatch* batch) {
   DCHECK(batch);
 
   std::string prefix = CreateResourceRecordKeyPrefix(version_id);
   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());
-      return false;
+      return LevelDBStatusToServiceWorkerStatusCode(itr->status());
     }
 
     std::string key = itr->key().ToString();
     std::string unprefixed;
     if (!RemovePrefix(key, prefix, &unprefixed))
       break;
 
     int64 resource_id;
     if (!base::StringToInt64(unprefixed, &resource_id)) {
       HandleError(FROM_HERE, leveldb::Status::Corruption("failed to parse"));
-      return false;
+      return SERVICE_WORKER_ERROR_DB_CORRUPTED;
     }
 
     // Remove a resource record.
     batch->Delete(key);
 
     // Currently resource sharing across versions and registrations is not
     // supported, so we can purge this without caring about it.
     PutPurgeableResourceIdToBatch(resource_id, batch);
   }
-  return true;
+  return SERVICE_WORKER_OK;
 }
 
 bool ServiceWorkerDatabase::ReadResourceIds(const char* id_key_prefix,
                                             std::set<int64>* ids) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(id_key_prefix);
   DCHECK(ids);
 
   ServiceWorkerStatusCode status = LazyOpen(false);
   if (status == SERVICE_WORKER_ERROR_NOT_FOUND ||
@@ skipping 37 matching lines @@
     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);
+
+  if (WriteBatch(&batch) != SERVICE_WORKER_OK)
+    return false;
+  return true;

[michaeln, 2014/05/15 20:44:58]

nit: return WriteBatch() == OK;

[nhiroki, 2014/05/19 04:58:04]

Removed this branch.

 }
 
 bool ServiceWorkerDatabase::DeleteResourceIds(const char* id_key_prefix,
                                               const std::set<int64>& ids) {
   DCHECK(sequence_checker_.CalledOnValidSequencedThread());
   DCHECK(id_key_prefix);
 
   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);
+
+  if (WriteBatch(&batch) != SERVICE_WORKER_OK)
+    return false;
+  return true;

[michaeln, 2014/05/15 20:44:58]

ditto

[nhiroki, 2014/05/19 04:58:04]

Done.

 }
 
 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;
@@ skipping 13 matching lines @@
   const int kFirstValidVersion = 1;
   if (parsed < kFirstValidVersion || kCurrentSchemaVersion < parsed) {
     HandleError(FROM_HERE, leveldb::Status::Corruption("invalid DB version"));
     return SERVICE_WORKER_ERROR_DB_CORRUPTED;
   }
 
   *db_version = parsed;
   return SERVICE_WORKER_OK;
 }
 
-bool ServiceWorkerDatabase::WriteBatch(leveldb::WriteBatch* batch) {
+ServiceWorkerStatusCode 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;
   }
 
   leveldb::Status status = db_->Write(leveldb::WriteOptions(), batch);
-  if (!status.ok()) {
+  if (!status.ok())
     HandleError(FROM_HERE, status);
-    return false;
-  }
-  return true;
+  return LevelDBStatusToServiceWorkerStatusCode(status);
 }
 
 void ServiceWorkerDatabase::BumpNextRegistrationIdIfNeeded(
     int64 used_id, leveldb::WriteBatch* batch) {
   DCHECK(batch);
   if (next_avail_registration_id_ <= used_id) {
     next_avail_registration_id_ = used_id + 1;
     batch->Put(kNextRegIdKey, base::Int64ToString(next_avail_registration_id_));
   }
 }
@@ skipping 17 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