Persist sessionStorage on disk.

webkit/dom_storage/dom_storage_area.cc

 // Copyright (c) 2012 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 "webkit/dom_storage/dom_storage_area.h"
 
 #include "base/bind.h"
-#include "base/file_util.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/time.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
 #include "webkit/database/database_util.h"
+#include "webkit/dom_storage/dom_storage_database.h"
 #include "webkit/dom_storage/dom_storage_map.h"
 #include "webkit/dom_storage/dom_storage_namespace.h"
 #include "webkit/dom_storage/dom_storage_task_runner.h"
 #include "webkit/dom_storage/dom_storage_types.h"
+#include "webkit/dom_storage/local_storage_database_adapter.h"
+#include "webkit/dom_storage/session_storage_database.h"
+#include "webkit/dom_storage/session_storage_database_adapter.h"
 #include "webkit/fileapi/file_system_util.h"
 #include "webkit/glue/webkit_glue.h"
 
 using webkit_database::DatabaseUtil;
 
 namespace dom_storage {
 
 static const int kCommitTimerSeconds = 1;
 
 DomStorageArea::CommitBatch::CommitBatch()
-  : clear_all_first(false) {
+    : clear_all_first(false),
+      clear_all_after_deep_copy(false) {
 }
 DomStorageArea::CommitBatch::~CommitBatch() {}
 
 
 // static
 const FilePath::CharType DomStorageArea::kDatabaseFileExtension[] =
     FILE_PATH_LITERAL(".localstorage");
 
 // static
 FilePath DomStorageArea::DatabaseFileNameFromOrigin(const GURL& origin) {
@@ skipping 13 matching lines @@
   return DatabaseUtil::GetOriginFromIdentifier(origin_id);
 }
 
 DomStorageArea::DomStorageArea(
     int64 namespace_id, const GURL& origin,
     const FilePath& directory, DomStorageTaskRunner* task_runner)
     : namespace_id_(namespace_id), origin_(origin),
       directory_(directory),
       task_runner_(task_runner),
       map_(new DomStorageMap(kPerAreaQuota)),
+      is_initial_import_done_(false),
+      is_shutdown_(false),
+      is_shallow_copy_(false) {
+  DCHECK(!directory.empty());
+  DCHECK_EQ(kLocalStorageNamespaceId, namespace_id);
+  FilePath path = directory.Append(DatabaseFileNameFromOrigin(origin_));
+  backing_.reset(new LocalStorageDatabaseAdapter(new DomStorageDatabase(path)));
+}
+
+DomStorageArea::DomStorageArea(
+    int64 namespace_id, const GURL& origin,
+    SessionStorageDatabase* session_storage_backing,
+    DomStorageTaskRunner* task_runner)
+    : namespace_id_(namespace_id), origin_(origin),
+      task_runner_(task_runner),
+      map_(new DomStorageMap(kPerAreaQuota)),
+      session_storage_backing_(session_storage_backing),
+      is_initial_import_done_(false),
+      is_shutdown_(false),
+      is_shallow_copy_(false) {
+  DCHECK(namespace_id != kLocalStorageNamespaceId);
+  backing_.reset(new SessionStorageDatabaseAdapter(
+      session_storage_backing, namespace_id, origin));
+}
+
+DomStorageArea::DomStorageArea(int64 namespace_id,
+                               const GURL& origin,
+                               DomStorageTaskRunner* task_runner)
+    : namespace_id_(namespace_id), origin_(origin),
+      task_runner_(task_runner),
+      map_(new DomStorageMap(kPerAreaQuota)),
       is_initial_import_done_(true),
-      is_shutdown_(false) {
-  if (namespace_id == kLocalStorageNamespaceId && !directory.empty()) {
-    FilePath path = directory.Append(DatabaseFileNameFromOrigin(origin_));
-    backing_.reset(new DomStorageDatabase(path));
-    is_initial_import_done_ = false;
-  }
+      is_shutdown_(false),
+      is_shallow_copy_(false) {
 }
 
 DomStorageArea::~DomStorageArea() {
 }
 
 unsigned DomStorageArea::Length() {
   if (is_shutdown_)
     return 0;
   InitialImportIfNeeded();
   return map_->Length();
@@ skipping 12 matching lines @@
   InitialImportIfNeeded();
   return map_->GetItem(key);
 }
 
 bool DomStorageArea::SetItem(const string16& key,
                              const string16& value,
                              NullableString16* old_value) {
   if (is_shutdown_)
     return false;
   InitialImportIfNeeded();
-  if (!map_->HasOneRef())
-    map_ = map_->DeepCopy();
+  bool was_shallow_copy = is_shallow_copy_;
+  if (is_shallow_copy_) {
+    // It's possible that the other DomStorageAreas referring to the same map
+    // already made a deep copy. If that's the case, we don't need to do
+    // anything.

[michaeln, 2012/04/22 21:43:35]

i'd rather depend on HasOneRef() for this and nix the new data member

[marja, 2012/05/11 12:18:32]

Done.

+    if (!map_->HasOneRef())
+      map_ = map_->DeepCopy();
+    is_shallow_copy_ = false;
+  }
   bool success = map_->SetItem(key, value, old_value);
   if (success && backing_.get()) {
     CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
-    commit_batch->changed_values[key] = NullableString16(value, false);
+    // If this area was a shallow copy, the existing changes in the commit batch
+    // should be committed before doing a deep copy. This change, and all the
+    // changes after this, should be committed after the deep copy. The database
+    // takes care of not doing a deep copy of a map which is only referred to
+    // once.

[michaeln, 2012/04/22 21:43:35]

It might be a simplification to flush pending changes prior to deep copying?
Could keep the commit batch structure simpler and the logic to set them up
simpler. I think we'd need a queue of in_flight_commit_batches_ instead of just
one.

bool DomStorageArea::MutatorOfSomeKind() {
  if (is_shutdown_)
    return false;
  InitialImportIfNeeded();

  bool needs_deep_copy = !map_->HasOneRef();
  if (needs_deep_copy ) {
    map_ = map_->DeepCopy();
    if (HasUncommittedChanges())
      OnCommitTimer();  // flushes pending changes
    DCHECK(!commit_batch_);
  }

  // mutate map_ as needed

  if ((success || needs_deep_copy) && backing_get()) {
    CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
    commit_batch->needs_deep_copy = needs_deep_copy;
    if (success) {
      // mutate batch->changed_values as needed
    }
  }
}

wdyt?

[michaeln, 2012/04/22 23:48:02]

or maybe a pattern like this that factors out more of the boiler plate

bool DomStorageArea::MutatorOfSomeKind() {
  if (is_shutdown_)
    return false;
  InitialImportIfNeeded();
  DeepCopyIfNeeded();

  // mutate map_ as needed, code stays the same as before

  if (success && backing_get()) {
    CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
    // code stays the same as before
  }
}

void DomStorageArea::DeepCopyIfNeeded() {
  if (!map_->HasOneRef()) {
    map_ = map_->DeepCopy();
    if (HasUncommittedChanges())
      OnCommitTimer();  // flushes pending changes
    DCHECK(!commit_batch_);
    CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
    commit_batch->needs_deep_copy = true;
  }
}

[marja, 2012/05/11 12:18:32]

- The deep copy problem was solved by http://codereview.chromium.org/10378066/
- The "multiple commits in flight at the same time" possibility was added by
http://codereview.chromium.org/10389061/
- And I modified this CL to queue the things in the right order: When
ShallowCopy() is called, we queue committing whatever is in commit_batch_, then
the upper layer (Namespace) schedules making the clone, and if changes happen
after these, they'll be committed after the clone.

[michaeln, 2012/05/16 08:10:55]

sgtm!

+    if (was_shallow_copy ||
+        !commit_batch->changed_values_after_deep_copy.empty() ||
+        commit_batch->clear_all_after_deep_copy) {
+      commit_batch->changed_values_after_deep_copy[key] =
+          NullableString16(value, false);
+    }
+    else {
+      commit_batch->changed_values[key] = NullableString16(value, false);
+    }
   }
   return success;
 }
 
 bool DomStorageArea::RemoveItem(const string16& key, string16* old_value) {
   if (is_shutdown_)
     return false;
   InitialImportIfNeeded();
-  if (!map_->HasOneRef())
-    map_ = map_->DeepCopy();
+  // See comments in SetItem.
+  bool was_shallow_copy = is_shallow_copy_;
+  if (is_shallow_copy_) {
+    if (!map_->HasOneRef())
+      map_ = map_->DeepCopy();
+    is_shallow_copy_ = false;
+  }
   bool success = map_->RemoveItem(key, old_value);
   if (success && backing_.get()) {
     CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
-    commit_batch->changed_values[key] = NullableString16(true);
+    if (was_shallow_copy ||
+        !commit_batch->changed_values_after_deep_copy.empty() ||
+        commit_batch->clear_all_after_deep_copy) {
+      commit_batch->changed_values_after_deep_copy[key] =
+          NullableString16(true);
+    } else {
+      commit_batch->changed_values[key] = NullableString16(true);
+    }
   }
   return success;
 }
 
 bool DomStorageArea::Clear() {
   if (is_shutdown_)
     return false;
   InitialImportIfNeeded();
   if (map_->Length() == 0)
     return false;
 
+  // See comments in SetItem.
+  bool was_shallow_copy = is_shallow_copy_;
+  is_shallow_copy_ = false;
   map_ = new DomStorageMap(kPerAreaQuota);
 
   if (backing_.get()) {
     CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
-    commit_batch->clear_all_first = true;
-    commit_batch->changed_values.clear();
+    if (was_shallow_copy ||
+        !commit_batch->changed_values_after_deep_copy.empty() ||
+        commit_batch->clear_all_after_deep_copy) {
+      commit_batch->clear_all_after_deep_copy = true;
+      commit_batch->changed_values_after_deep_copy.clear();
+    } else {
+      commit_batch->clear_all_first = true;
+      commit_batch->changed_values.clear();
+    }
   }
 
   return true;
 }
 
 DomStorageArea* DomStorageArea::ShallowCopy(int64 destination_namespace_id) {
   DCHECK_NE(kLocalStorageNamespaceId, namespace_id_);
   DCHECK_NE(kLocalStorageNamespaceId, destination_namespace_id);
-  DCHECK(!backing_.get());  // SessionNamespaces aren't stored on disk.
+  DCHECK(session_storage_backing_.get());
 
-  DomStorageArea* copy = new DomStorageArea(destination_namespace_id, origin_,
-                                            FilePath(), task_runner_);
+  DomStorageArea* copy = new DomStorageArea(
+      destination_namespace_id, origin_, session_storage_backing_,
+      task_runner_);
+  copy->is_shallow_copy_ = true;
   copy->map_ = map_;
   copy->is_shutdown_ = is_shutdown_;
+
+  // Also this area is now a shallow copy; changes to either of these 2 areas
+  // will initiate deep copying.
+  is_shallow_copy_ = true;
+
+  if (session_storage_backing_.get()) {
+    // If this area has uncommitted changes, they need to happen before
+    // DomStorageNamespace does the shallow-copying of the database. Also, if
+    // the area is empty, we need to ensure that a placeholder for it exists in
+    // the database. An empty commit batch achieves this.

[michaeln, 2012/04/22 21:43:35]

Does the empty placeholder really need to be there? Could this be conditional...

    if (HasUncommittedChanges())
      OnCommitTimer();  // flushes pending changes

[marja, 2012/05/11 12:18:32]

Done. Empty placeholder is not needed any more.

+    CreateCommitBatchIfNeeded();
+    OnCommitTimer();
+  }
   return copy;
 }
 
 bool DomStorageArea::HasUncommittedChanges() const {
   DCHECK(!is_shutdown_);
   return commit_batch_.get() || in_flight_commit_batch_.get();
 }
 
 void DomStorageArea::DeleteOrigin() {
   DCHECK(!is_shutdown_);
   if (HasUncommittedChanges()) {
     // TODO(michaeln): This logically deletes the data immediately,
     // and in a matter of a second, deletes the rows from the backing
     // database file, but the file itself will linger until shutdown
     // or purge time. Ideally, this should delete the file more
     // quickly.
     Clear();
     return;
   }
   map_ = new DomStorageMap(kPerAreaQuota);
-  if (backing_.get()) {
+  if (backing_.get() && !session_storage_backing_.get()) {
+    // This is localStorage.
     is_initial_import_done_ = false;
-    backing_.reset(new DomStorageDatabase(backing_->file_path()));
-    file_util::Delete(backing_->file_path(), false);
-    file_util::Delete(
-        DomStorageDatabase::GetJournalFilePath(backing_->file_path()), false);
+    backing_->Reset();
+    backing_->DeleteFiles();
+  } else if (session_storage_backing_.get()) {
+    // Delete the origin from the session storage by creating an empty commit
+    // batch.
+    CommitBatch* commit_batch = CreateCommitBatchIfNeeded();
+    if (is_shallow_copy_)
+      commit_batch->clear_all_after_deep_copy = true;
+    else
+      commit_batch->clear_all_first = true;
   }
 }
 
 void DomStorageArea::PurgeMemory() {
   DCHECK(!is_shutdown_);
   if (!is_initial_import_done_ ||  // We're not using any memory.
       !backing_.get() ||  // We can't purge anything.
       HasUncommittedChanges())  // We leave things alone with changes pending.
     return;
 
   // Drop the in memory cache, we'll reload when needed.
   is_initial_import_done_ = false;
   map_ = new DomStorageMap(kPerAreaQuota);
 
   // Recreate the database object, this frees up the open sqlite connection
   // and its page cache.
-  backing_.reset(new DomStorageDatabase(backing_->file_path()));
+  backing_->Reset();
 }
 
 void DomStorageArea::Shutdown() {
   DCHECK(!is_shutdown_);
   is_shutdown_ = true;
   map_ = NULL;
   if (!backing_.get())
     return;
 
   bool success = task_runner_->PostShutdownBlockingTask(
       FROM_HERE,
       DomStorageTaskRunner::COMMIT_SEQUENCE,
       base::Bind(&DomStorageArea::ShutdownInCommitSequence, this));
   DCHECK(success);
 }
 
 void DomStorageArea::InitialImportIfNeeded() {
   if (is_initial_import_done_)
     return;
 
-  DCHECK_EQ(kLocalStorageNamespaceId, namespace_id_);
   DCHECK(backing_.get());
 
   ValuesMap initial_values;
   backing_->ReadAllValues(&initial_values);
   map_->SwapValues(&initial_values);
   is_initial_import_done_ = true;
 }
 
 DomStorageArea::CommitBatch* DomStorageArea::CreateCommitBatchIfNeeded() {
   DCHECK(!is_shutdown_);
   if (!commit_batch_.get()) {
     commit_batch_.reset(new CommitBatch());
 
     // Start a timer to commit any changes that accrue in the batch,
     // but only if a commit is not currently in flight. In that case
     // the timer will be started after the current commit has happened.
     if (!in_flight_commit_batch_.get()) {
       task_runner_->PostDelayedTask(
           FROM_HERE,
           base::Bind(&DomStorageArea::OnCommitTimer, this),
           base::TimeDelta::FromSeconds(kCommitTimerSeconds));
     }
   }
   return commit_batch_.get();
 }
 
 void DomStorageArea::OnCommitTimer() {
-  DCHECK_EQ(kLocalStorageNamespaceId, namespace_id_);
   if (is_shutdown_)
     return;
 
   DCHECK(backing_.get());
-  DCHECK(commit_batch_.get());
+  // It's possible that there is nothing to commit, since a shallow copy occured
+  // before the timer fired.
+  if (!commit_batch_.get())
+    return;
+
   DCHECK(!in_flight_commit_batch_.get());
 
   // This method executes on the primary sequence, we schedule
   // a task for immediate execution on the commit sequence.
   DCHECK(task_runner_->IsRunningOnPrimarySequence());
   in_flight_commit_batch_ = commit_batch_.Pass();
   bool success = task_runner_->PostShutdownBlockingTask(
       FROM_HERE,
       DomStorageTaskRunner::COMMIT_SEQUENCE,
       base::Bind(&DomStorageArea::CommitChanges, this));
   DCHECK(success);
 }
 
 void DomStorageArea::CommitChanges() {
   // This method executes on the commit sequence.
   DCHECK(task_runner_->IsRunningOnCommitSequence());
   DCHECK(in_flight_commit_batch_.get());
   bool success = backing_->CommitChanges(
       in_flight_commit_batch_->clear_all_first,
       in_flight_commit_batch_->changed_values);
   DCHECK(success);  // TODO(michaeln): what if it fails?
+  if (session_storage_backing_.get() &&
+      (in_flight_commit_batch_->clear_all_after_deep_copy ||
+       !in_flight_commit_batch_->changed_values_after_deep_copy.empty())) {
+    if (in_flight_commit_batch_->clear_all_after_deep_copy) {
+      // Shortcut: If we're going to make a deep copy and clear the area, no
+      // need to create the deep copy first. We will just break the association
+      // to the existing map. A new map will be created when data is inserted
+      // into it.
+      session_storage_backing_->DisassociateMap(namespace_id_, origin_);
+    } else {
+      session_storage_backing_->DeepCopy(namespace_id_, origin_);
+    }
+    bool success = backing_->CommitChanges(
+        false, in_flight_commit_batch_->changed_values_after_deep_copy);
+    DCHECK(success);  // TODO(michaeln): what if it fails?
+  }
+
   task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&DomStorageArea::OnCommitComplete, this));
 }
 
 void DomStorageArea::OnCommitComplete() {
   // We're back on the primary sequence in this method.
   DCHECK(task_runner_->IsRunningOnPrimarySequence());
   if (is_shutdown_)
     return;
@@ skipping 14 matching lines @@
   if (commit_batch_.get()) {
     // Commit any changes that accrued prior to the timer firing.
     bool success = backing_->CommitChanges(
         commit_batch_->clear_all_first,
         commit_batch_->changed_values);
     DCHECK(success);
   }
   commit_batch_.reset();
   in_flight_commit_batch_.reset();
   backing_.reset();
+  session_storage_backing_ = NULL;
 }
 
 }  // namespace dom_storage