[DeviceSync v2] Do not bundle metadata-syncer results

To conform with the style of other DeviceSync v2 helper classes, send
the ResultCode and the new ClientDirective (if one was sent) as
individual callback arguments instead of bundling them in a
CryptAuthDeviceSyncResult. We reserve the CryptAuthDeviceSyncResult
to express the *final* result of the v2 DeviceSync flow.

This is a stylistic clean-up; no logic is affected.

Bug: 951969
Change-Id: I9cf32d1d2692c04721ccdb98da890db54b833739
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1778807Reviewed-by: Kyle Horimoto <khorimoto@chromium.org>
Commit-Queue: Josh Nohle <nohle@chromium.org>
Cr-Commit-Position: refs/heads/master@{#692267}

chromeos/services/device_sync/cryptauth_device_syncer_impl.cc

@@ -259,12 +259,13 @@ void CryptAuthDeviceSyncerImpl::OnSyncMetadataFinished(
     std::unique_ptr<CryptAuthKey> new_group_key,
     const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
         encrypted_group_private_key,
-    const CryptAuthDeviceSyncResult& device_sync_result) {
+    const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+    CryptAuthDeviceSyncResult::ResultCode device_sync_result_code) {
   DCHECK_EQ(State::kWaitingForMetadataSync, state_);
 
   id_to_device_metadata_packet_map_ = id_to_device_metadata_packet_map;
   encrypted_group_private_key_ = encrypted_group_private_key;
-  new_client_directive_ = device_sync_result.client_directive();
+  new_client_directive_ = new_client_directive;
 
   // If a new group key pair was created or if CryptAuth returned a new group
   // public key during the metadata sync, add the new group key to the key
@@ -272,7 +273,7 @@ void CryptAuthDeviceSyncerImpl::OnSyncMetadataFinished(
   if (new_group_key)
     SetGroupKey(*new_group_key);
 
-  switch (device_sync_result.GetResultType()) {
+  switch (CryptAuthDeviceSyncResult::GetResultType(device_sync_result_code)) {
     case CryptAuthDeviceSyncResult::ResultType::kNonFatalError:
       did_non_fatal_error_occur_ = true;
       FALLTHROUGH;
@@ -289,7 +290,7 @@ void CryptAuthDeviceSyncerImpl::OnSyncMetadataFinished(
       AttemptNextStep();
       return;
     case CryptAuthDeviceSyncResult::ResultType::kFatalError:
-      FinishAttempt(device_sync_result.result_code());
+      FinishAttempt(device_sync_result_code);
       return;
   }
 }

chromeos/services/device_sync/cryptauth_device_syncer_impl.h

@@ -119,7 +119,8 @@ class CryptAuthDeviceSyncerImpl : public CryptAuthDeviceSyncer {
       std::unique_ptr<CryptAuthKey> new_group_key,
       const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
           encrypted_group_private_key,
-      const CryptAuthDeviceSyncResult& device_sync_result);
+      const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+      CryptAuthDeviceSyncResult::ResultCode device_sync_result_code);
 
   void SetGroupKey(const CryptAuthKey& new_group_key);
 

chromeos/services/device_sync/cryptauth_device_syncer_impl_unittest.cc

@@ -239,10 +239,7 @@ class DeviceSyncCryptAuthDeviceSyncerImplTest : public testing::Test {
                       : nullptr;
     metadata_syncer()->FinishAttempt(
         id_to_device_metadata_packet_map, std::move(new_group_key_ptr),
-        private_key,
-        CryptAuthDeviceSyncResult(device_sync_result_code,
-                                  false /* did_device_registry_change */,
-                                  new_client_directive));
+        private_key, new_client_directive, device_sync_result_code);
   }
 
   void VerifyFeatureStatusGetterInput(

chromeos/services/device_sync/cryptauth_metadata_syncer.cc

@@ -6,8 +6,6 @@
 
 #include <utility>
 
-#include "chromeos/services/device_sync/cryptauth_device_sync_result.h"
-
 namespace chromeos {
 
 namespace device_sync {
@@ -35,11 +33,13 @@ void CryptAuthMetadataSyncer::OnAttemptFinished(
     std::unique_ptr<CryptAuthKey> new_group_key,
     const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
         encrypted_group_private_key,
-    const CryptAuthDeviceSyncResult& device_sync_result) {
+    const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+    CryptAuthDeviceSyncResult::ResultCode device_sync_result_code) {
   DCHECK(callback_);
   std::move(callback_).Run(id_to_device_metadata_packet_map,
                            std::move(new_group_key),
-                           encrypted_group_private_key, device_sync_result);
+                           encrypted_group_private_key, new_client_directive,
+                           device_sync_result_code);
 }
 
 }  // namespace device_sync

chromeos/services/device_sync/cryptauth_metadata_syncer.h

@@ -11,8 +11,10 @@
 #include "base/containers/flat_map.h"
 #include "base/macros.h"
 #include "base/optional.h"
+#include "chromeos/services/device_sync/cryptauth_device_sync_result.h"
 #include "chromeos/services/device_sync/cryptauth_key.h"
 #include "chromeos/services/device_sync/proto/cryptauth_devicesync.pb.h"
+#include "chromeos/services/device_sync/proto/cryptauth_directive.pb.h"
 
 namespace cryptauthv2 {
 class BetterTogetherDeviceMetadata;
@@ -22,8 +24,6 @@ namespace chromeos {
 
 namespace device_sync {
 
-class CryptAuthDeviceSyncResult;
-
 // Handles the SyncMetadata portion of the CryptAuth v2 DeviceSync protocol,
 // which consists of one or two SyncMetadata request/response interactions with
 // the CryptAuth servers:
@@ -63,6 +63,7 @@ class CryptAuthDeviceSyncResult;
 //   created.
 // - (Optional) A group private key, encrypted with this device's
 //   CryptAuthKeyBunde::kDeviceSyncBetterTogether public key.
+// - (Optional) A new ClientDirective sent from the CryptAuth server.
 //
 // A CryptAuthMetadataSyncer object is designed to be used for only one
 // SyncMetadata() call. For a new DeviceSync attempt, a new object should be
@@ -75,7 +76,8 @@ class CryptAuthMetadataSyncer {
       const IdToDeviceMetadataPacketMap&,
       std::unique_ptr<CryptAuthKey>,
       const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&,
-      const CryptAuthDeviceSyncResult&)>;
+      const base::Optional<cryptauthv2::ClientDirective>&,
+      CryptAuthDeviceSyncResult::ResultCode)>;
 
   virtual ~CryptAuthMetadataSyncer();
 
@@ -99,7 +101,8 @@ class CryptAuthMetadataSyncer {
       std::unique_ptr<CryptAuthKey> new_group_key,
       const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
           encrypted_group_private_key,
-      const CryptAuthDeviceSyncResult& device_sync_result);
+      const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+      CryptAuthDeviceSyncResult::ResultCode device_sync_result_code);
 
  private:
   SyncMetadataAttemptFinishedCallback callback_;

chromeos/services/device_sync/cryptauth_metadata_syncer_impl.cc

@@ -533,9 +533,7 @@ void CryptAuthMetadataSyncerImpl::FinishAttempt(
 
   OnAttemptFinished(id_to_device_metadata_packet_map_,
                     std::move(new_group_key_), encrypted_group_private_key,
-                    CryptAuthDeviceSyncResult(
-                        result_code, false /* did_device_registry_change */,
-                        new_client_directive));
+                    new_client_directive, result_code);
 }
 
 std::ostream& operator<<(std::ostream& stream,

chromeos/services/device_sync/fake_cryptauth_metadata_syncer.cc

@@ -17,13 +17,15 @@ void FakeCryptAuthMetadataSyncer::FinishAttempt(
     std::unique_ptr<CryptAuthKey> new_group_key,
     const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
         encrypted_group_private_key,
-    const CryptAuthDeviceSyncResult& device_sync_result) {
+    const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+    CryptAuthDeviceSyncResult::ResultCode device_sync_result_code) {
   DCHECK(request_context_);
   DCHECK(local_device_metadata_);
   DCHECK(initial_group_key_);
 
   OnAttemptFinished(id_to_device_metadata_packet_map, std::move(new_group_key),
-                    encrypted_group_private_key, device_sync_result);
+                    encrypted_group_private_key, new_client_directive,
+                    device_sync_result_code);
 }
 
 void FakeCryptAuthMetadataSyncer::OnAttemptStarted(

chromeos/services/device_sync/fake_cryptauth_metadata_syncer.h

@@ -11,17 +11,18 @@
 #include "base/macros.h"
 #include "base/optional.h"
 #include "base/timer/timer.h"
+#include "chromeos/services/device_sync/cryptauth_device_sync_result.h"
 #include "chromeos/services/device_sync/cryptauth_metadata_syncer.h"
 #include "chromeos/services/device_sync/cryptauth_metadata_syncer_impl.h"
 #include "chromeos/services/device_sync/proto/cryptauth_better_together_device_metadata.pb.h"
 #include "chromeos/services/device_sync/proto/cryptauth_devicesync.pb.h"
+#include "chromeos/services/device_sync/proto/cryptauth_directive.pb.h"
 
 namespace chromeos {
 
 namespace device_sync {
 
 class CryptAuthClientFactory;
-class CryptAuthDeviceSyncResult;
 class CryptAuthKey;
 
 class FakeCryptAuthMetadataSyncer : public CryptAuthMetadataSyncer {
@@ -53,7 +54,8 @@ class FakeCryptAuthMetadataSyncer : public CryptAuthMetadataSyncer {
       std::unique_ptr<CryptAuthKey> new_group_key,
       const base::Optional<cryptauthv2::EncryptedGroupPrivateKey>&
           encrypted_group_private_key,
-      const CryptAuthDeviceSyncResult& device_sync_result);
+      const base::Optional<cryptauthv2::ClientDirective>& new_client_directive,
+      CryptAuthDeviceSyncResult::ResultCode device_sync_result_code);
 
  private:
   // CryptAuthMetadataSyncer: