Reland "PaymentHandler: Implement PaymentInstruments.keys()."

content/browser/payments/payment_app_database.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 "content/browser/payments/payment_app_database.h"
 
+#include <map>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/optional.h"
+#include "base/time/time.h"
 #include "content/browser/payments/payment_app.pb.h"
 #include "content/browser/payments/payment_app_context_impl.h"
 #include "content/browser/service_worker/service_worker_context_wrapper.h"
 #include "content/browser/service_worker/service_worker_registration.h"
 #include "content/public/browser/browser_thread.h"
 
 namespace content {
 namespace {
 
 using ::payments::mojom::PaymentHandlerStatus;
 using ::payments::mojom::PaymentInstrument;
 using ::payments::mojom::PaymentInstrumentPtr;
 
 const char kPaymentAppManifestDataKey[] = "PaymentAppManifestData";
-const char kPaymentInstrumentKeyPrefix[] = "PaymentInstrument:";
+const char kPaymentInstrumentPrefix[] = "PaymentInstrument:";
+const char kPaymentInstrumentKeyInfoPrefix[] = "PaymentInstrumentKeyInfo:";
 
 std::string CreatePaymentInstrumentKey(const std::string& instrument_key) {
-  return kPaymentInstrumentKeyPrefix + instrument_key;
+  return kPaymentInstrumentPrefix + instrument_key;
+}
+
+std::string CreatePaymentInstrumentKeyInfoKey(
+    const std::string& instrument_key) {
+  return kPaymentInstrumentKeyInfoPrefix + instrument_key;
 }
 
 payments::mojom::PaymentAppManifestPtr DeserializePaymentAppManifest(
     const std::string& input) {
   PaymentAppManifestProto manifest_proto;
   if (!manifest_proto.ParseFromString(input))
     return nullptr;
 
   payments::mojom::PaymentAppManifestPtr manifest =
       payments::mojom::PaymentAppManifest::New();
   manifest->name = manifest_proto.name();
   if (manifest_proto.has_icon())
     manifest->icon = manifest_proto.icon();
   for (const auto& option_proto : manifest_proto.options()) {
     payments::mojom::PaymentAppOptionPtr option =
         payments::mojom::PaymentAppOption::New();
     option->name = option_proto.name();
     if (option_proto.has_icon())
       option->icon = option_proto.icon();
     option->id = option_proto.id();
     for (const auto& method : option_proto.enabled_methods())
       option->enabled_methods.push_back(method);
     manifest->options.push_back(std::move(option));
   }
 
   return manifest;
 }
 
+std::map<uint64_t, std::string> DeserializePaymentInstrumentKeyInfo(
+    const std::vector<std::string>& inputs) {
+  std::map<uint64_t, std::string> key_info;
+  for (const auto& input : inputs) {
+    PaymentInstrumentKeyInfoProto key_info_proto;
+    if (!key_info_proto.ParseFromString(input))
+      return std::map<uint64_t, std::string>();
+
+    key_info.insert(std::pair<uint64_t, std::string>(
+        key_info_proto.insertion_order(), key_info_proto.key()));
+  }
+
+  return key_info;
+}
+
 PaymentInstrumentPtr DeserializePaymentInstrument(const std::string& input) {
   PaymentInstrumentProto instrument_proto;
   if (!instrument_proto.ParseFromString(input))
     return nullptr;
 
   PaymentInstrumentPtr instrument = PaymentInstrument::New();
   instrument->name = instrument_proto.name();
   for (const auto& method : instrument_proto.enabled_methods())
     instrument->enabled_methods.push_back(method);
   instrument->stringified_capabilities =
@@ skipping 66 matching lines @@
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
   service_worker_context_->FindReadyRegistrationForPattern(
       scope,
       base::Bind(
           &PaymentAppDatabase::DidFindRegistrationToReadPaymentInstrument,
           weak_ptr_factory_.GetWeakPtr(), instrument_key,
           base::Passed(std::move(callback))));
 }
 
+void PaymentAppDatabase::KeysOfPaymentInstruments(
+    const GURL& scope,
+    KeysOfPaymentInstrumentsCallback callback) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+
+  service_worker_context_->FindReadyRegistrationForPattern(
+      scope, base::Bind(&PaymentAppDatabase::DidFindRegistrationToGetKeys,
+                        weak_ptr_factory_.GetWeakPtr(),
+                        base::Passed(std::move(callback))));
+}
+
 void PaymentAppDatabase::HasPaymentInstrument(
     const GURL& scope,
     const std::string& instrument_key,
     HasPaymentInstrumentCallback callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
   service_worker_context_->FindReadyRegistrationForPattern(
       scope,
       base::Bind(&PaymentAppDatabase::DidFindRegistrationToHasPaymentInstrument,
                  weak_ptr_factory_.GetWeakPtr(), instrument_key,
@@ skipping 152 matching lines @@
     DeletePaymentInstrumentCallback callback,
     const std::vector<std::string>& data,
     ServiceWorkerStatusCode status) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (status != SERVICE_WORKER_OK || data.size() != 1) {
     std::move(callback).Run(PaymentHandlerStatus::NOT_FOUND);
     return;
   }
 
   service_worker_context_->ClearRegistrationUserData(
-      registration_id, {CreatePaymentInstrumentKey(instrument_key)},
+      registration_id,
+      {CreatePaymentInstrumentKey(instrument_key),
+       CreatePaymentInstrumentKeyInfoKey(instrument_key)},
       base::Bind(&PaymentAppDatabase::DidDeletePaymentInstrument,
                  weak_ptr_factory_.GetWeakPtr(),
                  base::Passed(std::move(callback))));
 }
 
 void PaymentAppDatabase::DidDeletePaymentInstrument(
     DeletePaymentInstrumentCallback callback,
     ServiceWorkerStatusCode status) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   return std::move(callback).Run(status == SERVICE_WORKER_OK
@@ skipping 34 matching lines @@
   PaymentInstrumentPtr instrument = DeserializePaymentInstrument(data[0]);
   if (!instrument) {
     std::move(callback).Run(PaymentInstrument::New(),
                             PaymentHandlerStatus::STORAGE_OPERATION_FAILED);
     return;
   }
 
   std::move(callback).Run(std::move(instrument), PaymentHandlerStatus::SUCCESS);
 }
 
+void PaymentAppDatabase::DidFindRegistrationToGetKeys(
+    KeysOfPaymentInstrumentsCallback callback,
+    ServiceWorkerStatusCode status,
+    scoped_refptr<ServiceWorkerRegistration> registration) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  if (status != SERVICE_WORKER_OK) {
+    std::move(callback).Run(std::vector<std::string>(),
+                            PaymentHandlerStatus::NO_ACTIVE_WORKER);
+    return;
+  }
+
+  service_worker_context_->GetRegistrationUserDataByKeyPrefix(
+      registration->id(), {kPaymentInstrumentKeyInfoPrefix},
+      base::Bind(&PaymentAppDatabase::DidGetKeysOfPaymentInstruments,
+                 weak_ptr_factory_.GetWeakPtr(),
+                 base::Passed(std::move(callback))));
+}
+
+void PaymentAppDatabase::DidGetKeysOfPaymentInstruments(
+    KeysOfPaymentInstrumentsCallback callback,
+    const std::vector<std::string>& data,
+    ServiceWorkerStatusCode status) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  if (status != SERVICE_WORKER_OK) {
+    std::move(callback).Run(std::vector<std::string>(),
+                            PaymentHandlerStatus::NOT_FOUND);
+    return;
+  }
+
+  std::vector<std::string> keys;
+  for (const auto& key_info : DeserializePaymentInstrumentKeyInfo(data)) {
+    keys.push_back(key_info.second);
+  }
+
+  std::move(callback).Run(keys, PaymentHandlerStatus::SUCCESS);
+}
+
 void PaymentAppDatabase::DidFindRegistrationToHasPaymentInstrument(
     const std::string& instrument_key,
     HasPaymentInstrumentCallback callback,
     ServiceWorkerStatusCode status,
     scoped_refptr<ServiceWorkerRegistration> registration) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (status != SERVICE_WORKER_OK) {
     std::move(callback).Run(PaymentHandlerStatus::NO_ACTIVE_WORKER);
     return;
   }
@@ skipping 33 matching lines @@
   }
 
   PaymentInstrumentProto instrument_proto;
   instrument_proto.set_name(instrument->name);
   for (const auto& method : instrument->enabled_methods) {
     instrument_proto.add_enabled_methods(method);
   }
   instrument_proto.set_stringified_capabilities(
       instrument->stringified_capabilities);
 
-  std::string serialized;
-  bool success = instrument_proto.SerializeToString(&serialized);
+  std::string serialized_instrument;
+  bool success = instrument_proto.SerializeToString(&serialized_instrument);

[zino, 2017/05/03 14:30:33]

In the original CL, this line was in DCHECK as follows:
DCHECK(instrument_proto.SerializeToString(&serialized_instrument));

So, the statement wasn't executed in some bots disabling DCHECK.

[please use gerrit instead, 2017/05/03 14:43:30]

DCHECK is disabled in release mode (a.k.a., in production). Good catch!

+  DCHECK(success);
+
+  PaymentInstrumentKeyInfoProto key_info_proto;
+  key_info_proto.set_key(instrument_key);
+  key_info_proto.set_insertion_order(base::Time::Now().ToInternalValue());

[brucedawson, 2017/05/17 21:50:01]

I'm unclear about the purpose of this usage of base::Time::Now(), and I'm
concerned that it may cause errors. I suspect that it is intended to create a
monotonically increasing value, but on some Windows machines it is quite
possible for subsequent calls to base::Time::Now() to return the same value for
a time period up to about 16 ms in length. This may break assumptions and is
causing some tests to fail. Comments? See crbug.com/723225 for more context.

+
+  std::string serialized_key_info;
+  success = key_info_proto.SerializeToString(&serialized_key_info);

[zino, 2017/05/03 14:30:33]

ditto

   DCHECK(success);
 
   service_worker_context_->StoreRegistrationUserData(
       registration->id(), registration->pattern().GetOrigin(),
-      {{CreatePaymentInstrumentKey(instrument_key), serialized}},
+      {{CreatePaymentInstrumentKey(instrument_key), serialized_instrument},
+       {CreatePaymentInstrumentKeyInfoKey(instrument_key),
+        serialized_key_info}},
       base::Bind(&PaymentAppDatabase::DidWritePaymentInstrument,
                  weak_ptr_factory_.GetWeakPtr(),
                  base::Passed(std::move(callback))));
 }
 
 void PaymentAppDatabase::DidWritePaymentInstrument(
     WritePaymentInstrumentCallback callback,
     ServiceWorkerStatusCode status) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   return std::move(callback).Run(
       status == SERVICE_WORKER_OK
           ? PaymentHandlerStatus::SUCCESS
           : PaymentHandlerStatus::STORAGE_OPERATION_FAILED);
 }
 
 }  // namespace content