Provide API in RequestCoordinator to remove results by client ID.

components/offline_pages/background/request_queue_store_sql.cc

 // Copyright 2016 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 "components/offline_pages/background/request_queue_store_sql.h"
 
 #include "base/bind.h"
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/location.h"
+#include "base/logging.h"
 #include "base/sequenced_task_runner.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "components/offline_pages/background/save_page_request.h"
 #include "sql/connection.h"
 #include "sql/statement.h"
 #include "sql/transaction.h"
 
 namespace offline_pages {
 
 namespace {
@@ skipping 27 matching lines @@
 }
 
 bool DeleteRequestById(sql::Connection* db, int64_t request_id) {
   const char kSql[] =
       "DELETE FROM " REQUEST_QUEUE_TABLE_NAME " WHERE request_id=?";
   sql::Statement statement(db->GetCachedStatement(SQL_FROM_HERE, kSql));
   statement.BindInt64(0, request_id);
   return statement.Run();
 }
 
+bool DeleteRequestByClientId(sql::Connection* db, const ClientId client_id) {
+  const char kSql[] =
+      "DELETE FROM " REQUEST_QUEUE_TABLE_NAME
+      " WHERE client_namespace=? AND client_id=?";
+  sql::Statement statement(db->GetCachedStatement(SQL_FROM_HERE, kSql));
+  statement.BindString(0, client_id.name_space);
+  statement.BindString(1, client_id.id);
+  DVLOG(2) << kSql << " client_namespace " << client_id.name_space
+           << " client_id " << client_id.id;
+  return statement.Run();
+}
+
 bool DeleteRequestsByIds(sql::Connection* db,
                          const std::vector<int64_t>& request_ids,
                          int* count) {
   DCHECK(count);
   // If you create a transaction but don't Commit() it is automatically
   // rolled back by its destructor when it falls out of scope.
   sql::Transaction transaction(db);
   if (!transaction.Begin())
     return false;
 
   *count = 0;
   for (auto request_id : request_ids) {
     if (!DeleteRequestById(db, request_id))
       return false;
     *count += db->GetLastChangeCount();
   }
 
   if (!transaction.Commit())
     return false;
 
   return true;
 }
 
+bool DeleteRequestsByClientIds(sql::Connection* db,
+                         const std::vector<ClientId>& client_ids,
+                         int* count) {
+  DCHECK(count);
+  // If you create a transaction but don't Commit() it is automatically
+  // rolled back by its destructor when it falls out of scope.
+  sql::Transaction transaction(db);
+  if (!transaction.Begin())
+    return false;
+
+  *count = 0;
+  for (auto client_id : client_ids) {
+    if (!DeleteRequestByClientId(db, client_id))
+      return false;
+    *count += db->GetLastChangeCount();
+  }
+
+  if (!transaction.Commit())
+    return false;
+
+  return true;
+}
+
 // Create a save page request from a SQL result.  Expects complete rows with
 // all columns present.  Columns are in order they are defined in select query
 // in |RequestQueueStore::RequestSync| method.
 SavePageRequest MakeSavePageRequest(const sql::Statement& statement) {
   const int64_t id = statement.ColumnInt64(0);
   const base::Time creation_time =
       base::Time::FromInternalValue(statement.ColumnInt64(1));
   const base::Time activation_time =
       base::Time::FromInternalValue(statement.ColumnInt64(2));
   const base::Time last_attempt_time =
       base::Time::FromInternalValue(statement.ColumnInt64(3));
   const int64_t last_attempt_count = statement.ColumnInt64(4);
   const GURL url(statement.ColumnString(5));
   const ClientId client_id(statement.ColumnString(6),
                            statement.ColumnString(7));
 
+  DVLOG(2) << "making save page request - id " << id
+           << " url " << url
+           << " client_id " << client_id.name_space << "-" << client_id.id
+           << " creation time " << creation_time
+           << " user requested " << kUserRequested;
+
   SavePageRequest request(
       id, url, client_id, creation_time, activation_time, kUserRequested);
   request.set_last_attempt_time(last_attempt_time);
   request.set_attempt_count(last_attempt_count);
   return request;
 }
 
 RequestQueueStore::UpdateStatus InsertOrReplace(
     sql::Connection* db,
     const SavePageRequest& request) {
@@ skipping 102 matching lines @@
     const std::vector<int64_t>& request_ids,
     const RemoveCallback& callback) {
   // TODO(fgorski): add UMA metrics here.
   int count = 0;
   if (DeleteRequestsByIds(db, request_ids, &count))
     runner->PostTask(FROM_HERE, base::Bind(callback, true, count));
   else
     runner->PostTask(FROM_HERE, base::Bind(callback, false, 0));
 }
 
+
+// static
+void RequestQueueStoreSQL::RemoveRequestsByClientIdSync(
+    sql::Connection* db,
+    scoped_refptr<base::SingleThreadTaskRunner> runner,
+    const std::vector<ClientId>& client_ids,
+    const RemoveCallback& callback) {
+  // TODO(fgorski): add UMA metrics here.
+  int count = 0;
+  if (DeleteRequestsByClientIds(db, client_ids, &count))

[dougarnett, 2016/08/01 18:28:35]

Some naming inconsistencies here with Remove/Delete and ByClientId/ByClientIds.
I wonder if at least try to make the ByClientId[s] part consistent.

[dougarnett, 2016/08/02 00:12:39]

That is, either never *"ByClientIds" or else make RequestQueue
RemoveRequestsByClientId() => RemoveRequestsByClientIds() to match style here

[Pete Williamson, 2016/08/02 00:35:08]

My plan here is to just remove the "RemoveRequests" in a future checkin.  TODO
added (but I didn't rename it, since it will be going away).

+    runner->PostTask(FROM_HERE, base::Bind(callback, true, count));
+  else
+    runner->PostTask(FROM_HERE, base::Bind(callback, false, 0));
+}
+
 // static
 void RequestQueueStoreSQL::ResetSync(
     sql::Connection* db,
     const base::FilePath& db_file_path,
     scoped_refptr<base::SingleThreadTaskRunner> runner,
     const ResetCallback& callback) {
   // This method deletes the content of the whole store and reinitializes it.
   bool success = db->Raze();
   db->Close();
   if (success)
@@ skipping 44 matching lines @@
         FROM_HERE, base::Bind(callback, false, 0));
     return;
   }
 
   background_task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&RequestQueueStoreSQL::RemoveRequestsSync, db_.get(),
                  base::ThreadTaskRunnerHandle::Get(), request_ids, callback));
 }
 
+void RequestQueueStoreSQL::RemoveRequestsByClientId(
+    const std::vector<ClientId>& client_ids, const RemoveCallback& callback) {
+  DCHECK(db_.get());
+  if (!db_.get()) {
+    // Nothing to do, but post a callback instead of calling directly
+    // to preserve the async style behavior to prevent bugs.
+    base::ThreadTaskRunnerHandle::Get()->PostTask(
+        FROM_HERE, base::Bind(callback, false, 0));
+    return;
+  }
+
+  background_task_runner_->PostTask(
+      FROM_HERE,
+      base::Bind(&RequestQueueStoreSQL::RemoveRequestsByClientIdSync, db_.get(),
+                 base::ThreadTaskRunnerHandle::Get(), client_ids, callback));
+}
+
 void RequestQueueStoreSQL::Reset(const ResetCallback& callback) {
   DCHECK(db_.get());
   if (!db_.get()) {
     // Nothing to do, but post a callback instead of calling directly
     // to preserve the async style behavior to prevent bugs.
     base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
                                                   base::Bind(callback, false));
     return;
   }
 
@@ skipping 25 matching lines @@
 }
 
 void RequestQueueStoreSQL::OnResetDone(const ResetCallback& callback,
                                        bool success) {
   // Complete connection initialization post reset.
   OnOpenConnectionDone(success);
   callback.Run(success);
 }
 
 }  // namespace offline_pages