[sync] Add autofill sync metadata to the web db

components/autofill/core/browser/webdata/autofill_table.h

 // Copyright 2013 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.
 
 #ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_
 #define COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_
 
 #include <stddef.h>
 
 #include <memory>
 #include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/strings/string16.h"
+#include "components/sync/base/model_type.h"
+#include "components/sync/model/metadata_batch.h"
 #include "components/webdata/common/web_database_table.h"
 
 class WebDatabase;
 
 namespace base {
 class Time;
 }
 
+namespace sync_pb {
+class EntityMetadata;
+class ModelTypeState;
+}
+
 namespace autofill {
 
 class AutofillChange;
 class AutofillEntry;
 class AutofillProfile;
 class AutofillTableTest;
 class CreditCard;
 
 struct FormFieldData;
 
@@ skipping 187 matching lines @@
 // server_address_metadata
 //                      Metadata (currently, usage data) about server addresses.
 //                      This will be synced.
 //
 //   id                 The server ID, which matches an ID from the
 //                      server_addresses table.
 //   use_count          The number of times this address has been used to fill
 //                      a form.
 //   use_date           The date this address was last used to fill a form,
 //                      in internal t.
+// autofill_sync_metadata
+//                      Sync-specific metadata for autofill records.
+//
+//   storage_key        A string that uniquely identifies the metadata record
+//                      as well as the corresponding autofill record.
+//   value              The serialized EntityMetadata record.
+//
+// autofill_model_type_state
+//                      Single row table that contains the sync ModelTypeState
+//                      for the autofill model type.
+//
+//   value              The serialized ModelTypeState record.
 
 class AutofillTable : public WebDatabaseTable {
  public:
   AutofillTable();
   ~AutofillTable() override;
 
   // Retrieves the AutofillTable* owned by |db|.
   static AutofillTable* FromWebDatabase(WebDatabase* db);
 
   // WebDatabaseTable:
@@ skipping 155 matching lines @@
   // Empties the Autofill profiles "trash can".
   bool EmptyAutofillProfilesTrash();
 
   // Retrieves all profiles in the database that have been deleted since last
   // "empty" of the trash.
   bool AddAutofillGUIDToTrash(const std::string& guid);
 
   // Clear all profiles.
   bool ClearAutofillProfiles();
 
+  // Read all the stored metadata of |model_type| and fill |metadata_records|
+  // with it.
+  bool GetAllSyncMetadata(syncer::ModelType model_type,
+                          syncer::EntityMetadataMap* metadata_records);

[pavely, 2016/12/08 23:34:45]

Since you are accumulating metadata records in EntityMetadataMap we'll need
additional method in MetadataBatch to take prepopulated EntityMetadataMap in
addition to setting metadata record by record. This can be done in separate CL.

[Patrick Noland, 2016/12/10 00:39:35]

I've added a todo for this.

+
+  // Update the metadata row for |model_type|, keyed by |storage_key|, to
+  // contain the contents of |metadata|.
+  bool UpdateSyncMetadata(syncer::ModelType model_type,
+                          const std::string& storage_key,
+                          const sync_pb::EntityMetadata& metadata);
+
+  // Remove the metadata row of type |model_type| keyed by |storage|key|.
+  bool ClearSyncMetadata(syncer::ModelType model_type,
+                         const std::string& storage_key);
+
+  // Retrieve the stored sync state for the |model_type|.
+  bool GetModelTypeState(syncer::ModelType model_type,
+                         sync_pb::ModelTypeState* state);
+
+  // Update the stored sync state for the |model_type|.
+  bool UpdateModelTypeState(syncer::ModelType model_type,
+                            sync_pb::ModelTypeState& model_type_state);

[maxbogue, 2016/12/08 21:14:05]

const

[Patrick Noland, 2016/12/10 00:39:35]

Done.

+
+  // Clear the stored sync state for |model_type|.
+  bool ClearModelTypeState(syncer::ModelType model_type);
+
   // Table migration functions. NB: These do not and should not rely on other
   // functions in this class. The implementation of a function such as
   // GetCreditCard may change over time, but MigrateToVersionXX should never
   // change.
   bool MigrateToVersion54AddI18nFieldsAndRemoveDeprecatedFields();
   bool MigrateToVersion55MergeAutofillDatesTable();
   bool MigrateToVersion56AddProfileLanguageCodeForFormatting();
   bool MigrateToVersion57AddFullNameField();
   bool MigrateToVersion60AddServerCards();
   bool MigrateToVersion61AddUsageStats();
   bool MigrateToVersion62AddUsageStatsForUnmaskedCards();
   bool MigrateToVersion63AddServerRecipientName();
   bool MigrateToVersion64AddUnmaskDate();
   bool MigrateToVersion65AddServerMetadataTables();
   bool MigrateToVersion66AddCardBillingAddress();
   bool MigrateToVersion67AddMaskedCardBillingAddress();
+  bool MigrateToVersion70AddSyncMetadata();
 
   // Max data length saved in the table, AKA the maximum length allowed for
   // form data.
   // Copied to components/autofill/ios/browser/resources/autofill_controller.js.
   static const size_t kMaxDataLength;
 
  private:
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill);
   FRIEND_TEST_ALL_PREFIXES(AutofillTableTest, Autofill_AddChanges);
   FRIEND_TEST_ALL_PREFIXES(
@@ skipping 57 matching lines @@
   bool InitProfilesTable();
   bool InitProfileNamesTable();
   bool InitProfileEmailsTable();
   bool InitProfilePhonesTable();
   bool InitProfileTrashTable();
   bool InitMaskedCreditCardsTable();
   bool InitUnmaskedCreditCardsTable();
   bool InitServerCardMetadataTable();
   bool InitServerAddressesTable();
   bool InitServerAddressMetadataTable();
+  bool InitAutofillSyncMetadataTable();
+  bool InitModelTypeStateTable();
 
   DISALLOW_COPY_AND_ASSIGN(AutofillTable);
 };
 
 }  // namespace autofill
 
 #endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_WEBDATA_AUTOFILL_TABLE_H_