Expand aura::PropertyConverter support.

ui/aura/mus/window_tree_client_unittest.cc

 // Copyright 2015 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 "ui/aura/mus/window_tree_client.h"
 
 #include <stdint.h>
 
 #include "base/logging.h"
 #include "base/macros.h"
+#include "base/strings/utf_string_conversions.h"
 #include "mojo/common/common_type_converters.h"
 #include "services/ui/public/cpp/property_type_converters.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/aura/client/aura_constants.h"
 #include "ui/aura/client/capture_client.h"
 #include "ui/aura/client/capture_client_observer.h"
 #include "ui/aura/client/focus_client.h"
 #include "ui/aura/client/transient_window_client.h"
 #include "ui/aura/mus/property_converter.h"
 #include "ui/aura/mus/window_mus.h"
 #include "ui/aura/mus/window_tree_client_delegate.h"
 #include "ui/aura/mus/window_tree_client_observer.h"
 #include "ui/aura/mus/window_tree_host_mus.h"
 #include "ui/aura/test/aura_mus_test_base.h"
 #include "ui/aura/test/mus/test_window_tree.h"
 #include "ui/aura/test/mus/window_tree_client_private.h"
 #include "ui/aura/test/test_window_delegate.h"
 #include "ui/aura/window.h"
 #include "ui/aura/window_property.h"
 #include "ui/aura/window_tracker.h"
 #include "ui/compositor/compositor.h"
 #include "ui/events/event.h"
 #include "ui/events/event_utils.h"
 #include "ui/gfx/geometry/rect.h"
 
-DECLARE_WINDOW_PROPERTY_TYPE(uint8_t)
-
 namespace aura {
 
 namespace {
 
 DEFINE_WINDOW_PROPERTY_KEY(uint8_t, kTestPropertyKey1, 0);
-DEFINE_WINDOW_PROPERTY_KEY(uint8_t, kTestPropertyKey2, 0);
+DEFINE_WINDOW_PROPERTY_KEY(uint16_t, kTestPropertyKey2, 0);
+DEFINE_WINDOW_PROPERTY_KEY(bool, kTestPropertyKey3, false);
+
+const char kTestPropertyServerKey1[] = "test-property-server1";
+const char kTestPropertyServerKey2[] = "test-property-server2";
+const char kTestPropertyServerKey3[] = "test-property-server3";
 
 Id server_id(Window* window) {
   return WindowMus::Get(window)->server_id();
 }
 
 void SetWindowVisibility(Window* window, bool visible) {
   if (visible)
     window->Show();
   else
     window->Hide();
 }
 
 Window* GetFirstRoot(WindowTreeClient* client) {
   return client->GetRoots().empty() ? nullptr : *client->GetRoots().begin();
 }
 
 bool IsWindowHostVisible(Window* window) {
   return window->GetRootWindow()->GetHost()->compositor()->IsVisible();
 }
 
-const char kTestPropertyServerKey1[] = "test-property-server1";
-const char kTestPropertyServerKey2[] = "test-property-server2";
+// Register some test window properties for aura/mus conversion.
+void RegisterTestProperties(PropertyConverter* property_converter) {
+  property_converter->RegisterPrimitiveProperty(
+      kTestPropertyKey1, kTestPropertyKey1->name, kTestPropertyServerKey1);
+  property_converter->RegisterPrimitiveProperty(
+      kTestPropertyKey2, kTestPropertyKey2->name, kTestPropertyServerKey2);
+  property_converter->RegisterPrimitiveProperty(
+      kTestPropertyKey3, kTestPropertyKey3->name, kTestPropertyServerKey3);
+}
 
-class TestPropertyConverter : public PropertyConverter {
- public:
-  TestPropertyConverter() {}
-  ~TestPropertyConverter() override {}
+// Get the primitive aura property value to store for a mus transport value.
+int64_t GetPropertyStorageValue(const std::vector<uint8_t>& data) {
+  CHECK_LE(data.size(), 8u);
+  int64_t value = 0;
+  for (size_t i = data.size(); i > 0; --i)
+    value = (value << 8) + data[i - 1];
+  return value;
+}
 
-  // PropertyConverter:
-  bool ConvertPropertyForTransport(
-      Window* window,
-      const void* key,
-      std::string* server_property_name,
-      std::unique_ptr<std::vector<uint8_t>>* server_property_value) override {
-    if (key == kTestPropertyKey1) {
-      *server_property_name = kTestPropertyServerKey1;
-      *server_property_value = base::MakeUnique<std::vector<uint8_t>>(1);
-      (*server_property_value->get())[0] =
-          window->GetProperty(kTestPropertyKey1);
-      return true;
-    }
-    if (key == kTestPropertyKey2) {
-      *server_property_name = kTestPropertyServerKey2;
-      *server_property_value = base::MakeUnique<std::vector<uint8_t>>(1);
-      (*server_property_value->get())[0] =
-          window->GetProperty(kTestPropertyKey2);
-      return true;
-    }
-    return PropertyConverter::ConvertPropertyForTransport(
-        window, key, server_property_name, server_property_value);
-  }
-
-  std::string GetTransportNameForPropertyKey(const void* key) override {
-    if (key == kTestPropertyKey1)
-      return kTestPropertyServerKey1;
-    if (key == kTestPropertyKey2)
-      return kTestPropertyServerKey2;
-    return PropertyConverter::GetTransportNameForPropertyKey(key);
-  }
-
-  void SetPropertyFromTransportValue(
-      Window* window,
-      const std::string& server_property_name,
-      const std::vector<uint8_t>* data) override {
-    if (server_property_name == kTestPropertyServerKey1) {
-      window->SetProperty(kTestPropertyKey1, (*data)[0]);
-    } else if (server_property_name == kTestPropertyServerKey2) {
-      window->SetProperty(kTestPropertyKey2, (*data)[0]);
-    } else {
-      PropertyConverter::SetPropertyFromTransportValue(
-          window, server_property_name, data);
-    }
-  }
-
- private:
-  DISALLOW_COPY_AND_ASSIGN(TestPropertyConverter);
-};
+// Get the mus transport value to store for a primitive aura property value.
+mojo::Array<uint8_t> GetPropertyTransportValue(int64_t value) {
+  mojo::Array<uint8_t> transport_value(8);
+  transport_value[7] = (value >> 56) & 0xFF;
+  transport_value[6] = (value >> 48) & 0xFF;
+  transport_value[5] = (value >> 40) & 0xFF;
+  transport_value[4] = (value >> 32) & 0xFF;
+  transport_value[3] = (value >> 24) & 0xFF;
+  transport_value[2] = (value >> 16) & 0xFF;
+  transport_value[1] = (value >> 8) & 0xFF;
+  transport_value[0] = value & 0xFF;
+  return transport_value;
+}
 
 }  // namespace
 
-mojo::Array<uint8_t> Uint8ToPropertyTransportValue(uint8_t value) {
-  mojo::Array<uint8_t> transport_value(1);
-  transport_value[0] = value;
-  return transport_value;
-}
-
 using WindowTreeClientWmTest = test::AuraMusWmTestBase;
 using WindowTreeClientClientTest = test::AuraMusClientTestBase;
 
 // Verifies bounds are reverted if the server replied that the change failed.
 TEST_F(WindowTreeClientWmTest, SetBoundsFailed) {
   Window window(nullptr);
   window.Init(ui::LAYER_NOT_DRAWN);
   const gfx::Rect original_bounds(window.bounds());
   const gfx::Rect new_bounds(gfx::Rect(0, 0, 100, 100));
   ASSERT_NE(new_bounds, window.bounds());
@@ skipping 40 matching lines @@
                                                  server_id(&window2), nullptr);
   ASSERT_FALSE(window_tree()->has_change());
   EXPECT_EQ(&window2, window1.parent());
   EXPECT_EQ(root_window(), window2.parent());
   window1.parent()->RemoveChild(&window1);
 }
 
 // Verifies properties passed in OnWindowHierarchyChanged() make there way to
 // the new window.
 TEST_F(WindowTreeClientWmTest, OnWindowHierarchyChangedWithProperties) {
-  SetPropertyConverter(base::MakeUnique<TestPropertyConverter>());
+  RegisterTestProperties(GetPropertyConverter());
   window_tree()->AckAllChanges();
   const Id child_window_id = server_id(root_window()) + 11;
   ui::mojom::WindowDataPtr data = ui::mojom::WindowData::New();
   const uint8_t server_test_property1_value = 91;
   data->properties[kTestPropertyServerKey1] =
-      Uint8ToPropertyTransportValue(server_test_property1_value);
+      GetPropertyTransportValue(server_test_property1_value);
   data->parent_id = server_id(root_window());
   data->window_id = child_window_id;
   data->bounds = gfx::Rect(1, 2, 3, 4);
   data->visible = false;
   mojo::Array<ui::mojom::WindowDataPtr> data_array(1);
   data_array[0] = std::move(data);
   ASSERT_TRUE(root_window()->children().empty());
   window_tree_client()->OnWindowHierarchyChanged(
       child_window_id, 0, server_id(root_window()), std::move(data_array));
   ASSERT_FALSE(window_tree()->has_change());
@@ skipping 94 matching lines @@
 
 // Verifies properties are set if the server replied that the change succeeded.
 TEST_F(WindowTreeClientWmTest, SetPropertySucceeded) {
   ASSERT_FALSE(root_window()->GetProperty(client::kAlwaysOnTopKey));
   root_window()->SetProperty(client::kAlwaysOnTopKey, true);
   EXPECT_TRUE(root_window()->GetProperty(client::kAlwaysOnTopKey));
   mojo::Array<uint8_t> value = window_tree()->GetLastPropertyValue();
   ASSERT_FALSE(value.is_null());
   // PropertyConverter uses int64_t values, even for smaller types, like bool.
   ASSERT_EQ(8u, value.size());
-  std::vector<uint8_t> array = mojo::ConvertTo<std::vector<uint8_t>>(value);
-  EXPECT_EQ(1, mojo::ConvertTo<int64_t>(array));
+  EXPECT_EQ(1, GetPropertyStorageValue(value.PassStorage()));
   ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
       WindowTreeChangeType::PROPERTY, true));
   EXPECT_TRUE(root_window()->GetProperty(client::kAlwaysOnTopKey));
 }
 
 // Verifies properties are reverted if the server replied that the change
 // failed.
 TEST_F(WindowTreeClientWmTest, SetPropertyFailed) {
   ASSERT_FALSE(root_window()->GetProperty(client::kAlwaysOnTopKey));
   root_window()->SetProperty(client::kAlwaysOnTopKey, true);
   EXPECT_TRUE(root_window()->GetProperty(client::kAlwaysOnTopKey));
   mojo::Array<uint8_t> value = window_tree()->GetLastPropertyValue();
   ASSERT_FALSE(value.is_null());
   // PropertyConverter uses int64_t values, even for smaller types, like bool.
   ASSERT_EQ(8u, value.size());
-  std::vector<uint8_t> array = mojo::ConvertTo<std::vector<uint8_t>>(value);
-  EXPECT_EQ(1, mojo::ConvertTo<int64_t>(array));
+  EXPECT_EQ(1, GetPropertyStorageValue(value.PassStorage()));
   ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
       WindowTreeChangeType::PROPERTY, false));
   EXPECT_FALSE(root_window()->GetProperty(client::kAlwaysOnTopKey));
 }
 
 // Simulates a property change, and while the property change is in flight the
 // server replies with a new property and the original property change fails.
 TEST_F(WindowTreeClientWmTest, SetPropertyFailedWithPendingChange) {
-  SetPropertyConverter(base::MakeUnique<TestPropertyConverter>());
+  RegisterTestProperties(GetPropertyConverter());
   const uint8_t value1 = 11;
   root_window()->SetProperty(kTestPropertyKey1, value1);
   EXPECT_EQ(value1, root_window()->GetProperty(kTestPropertyKey1));
 
   // Simulate the server responding with a different value.
   const uint8_t server_value = 12;
   window_tree_client()->OnWindowSharedPropertyChanged(
       server_id(root_window()), kTestPropertyServerKey1,
-      Uint8ToPropertyTransportValue(server_value));
+      GetPropertyTransportValue(server_value));
 
   // This shouldn't trigger the property changing yet.
   EXPECT_EQ(value1, root_window()->GetProperty(kTestPropertyKey1));
 
   // Tell the client the change failed, which should trigger failing to the
   // most recent value from server.
   ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
       WindowTreeChangeType::PROPERTY, false));
   EXPECT_EQ(server_value, root_window()->GetProperty(kTestPropertyKey1));
 
   // Simulate server changing back to value1. Should take immediately.
   window_tree_client()->OnWindowSharedPropertyChanged(
       server_id(root_window()), kTestPropertyServerKey1,
-      Uint8ToPropertyTransportValue(value1));
+      GetPropertyTransportValue(value1));
   EXPECT_EQ(value1, root_window()->GetProperty(kTestPropertyKey1));
 }
 
+// Verifies property setting behavior with failures for primitive properties.
+TEST_F(WindowTreeClientWmTest, SetPrimitiveProperties) {
+  PropertyConverter* property_converter = GetPropertyConverter();
+  RegisterTestProperties(property_converter);
+
+  const uint8_t value1_local = UINT8_MAX / 2;
+  const uint8_t value1_server = UINT8_MAX / 3;
+  root_window()->SetProperty(kTestPropertyKey1, value1_local);
+  EXPECT_EQ(value1_local, root_window()->GetProperty(kTestPropertyKey1));
+  window_tree_client()->OnWindowSharedPropertyChanged(
+      server_id(root_window()), kTestPropertyServerKey1,
+      GetPropertyTransportValue(value1_server));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, false));
+  EXPECT_EQ(value1_server, root_window()->GetProperty(kTestPropertyKey1));
+
+  const uint16_t value2_local = UINT16_MAX / 3;
+  const uint16_t value2_server = UINT16_MAX / 4;
+  root_window()->SetProperty(kTestPropertyKey2, value2_local);
+  EXPECT_EQ(value2_local, root_window()->GetProperty(kTestPropertyKey2));
+  window_tree_client()->OnWindowSharedPropertyChanged(
+      server_id(root_window()), kTestPropertyServerKey2,
+      GetPropertyTransportValue(value2_server));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, false));
+  EXPECT_EQ(value2_server, root_window()->GetProperty(kTestPropertyKey2));
+
+  EXPECT_FALSE(root_window()->GetProperty(kTestPropertyKey3));
+  root_window()->SetProperty(kTestPropertyKey3, true);
+  EXPECT_TRUE(root_window()->GetProperty(kTestPropertyKey3));
+  window_tree_client()->OnWindowSharedPropertyChanged(
+      server_id(root_window()), kTestPropertyServerKey3,
+      GetPropertyTransportValue(false));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, false));
+  EXPECT_FALSE(root_window()->GetProperty(kTestPropertyKey3));
+}
+
+// Verifies property setting behavior for a gfx::Rect* property.
+TEST_F(WindowTreeClientWmTest, SetRectProperty) {
+  gfx::Rect example(1, 2, 3, 4);
+  ASSERT_EQ(nullptr, root_window()->GetProperty(client::kRestoreBoundsKey));
+  root_window()->SetProperty(client::kRestoreBoundsKey, new gfx::Rect(example));
+  EXPECT_TRUE(root_window()->GetProperty(client::kRestoreBoundsKey));
+  mojo::Array<uint8_t> value = window_tree()->GetLastPropertyValue();
+  ASSERT_FALSE(value.is_null());
+  EXPECT_EQ(example, mojo::ConvertTo<gfx::Rect>(value.PassStorage()));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, true));
+  EXPECT_EQ(example, *root_window()->GetProperty(client::kRestoreBoundsKey));
+
+  root_window()->SetProperty(client::kRestoreBoundsKey, new gfx::Rect());
+  EXPECT_EQ(gfx::Rect(),
+            *root_window()->GetProperty(client::kRestoreBoundsKey));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, false));
+  EXPECT_EQ(example, *root_window()->GetProperty(client::kRestoreBoundsKey));
+}
+
+// Verifies property setting behavior for a std::string* property.
+TEST_F(WindowTreeClientWmTest, SetStringProperty) {
+  std::string example = "123";
+  ASSERT_EQ(nullptr, root_window()->GetProperty(client::kAppIdKey));
+  root_window()->SetProperty(client::kAppIdKey, new std::string(example));
+  EXPECT_TRUE(root_window()->GetProperty(client::kAppIdKey));
+  mojo::Array<uint8_t> value = window_tree()->GetLastPropertyValue();
+  ASSERT_FALSE(value.is_null());
+  EXPECT_EQ(example, mojo::ConvertTo<std::string>(value.PassStorage()));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, true));
+  EXPECT_EQ(example, *root_window()->GetProperty(client::kAppIdKey));
+
+  root_window()->SetProperty(client::kAppIdKey, new std::string());
+  EXPECT_EQ(std::string(), *root_window()->GetProperty(client::kAppIdKey));
+  ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
+      WindowTreeChangeType::PROPERTY, false));
+  EXPECT_EQ(example, *root_window()->GetProperty(client::kAppIdKey));
+}
+
 // Verifies visible is reverted if the server replied that the change failed.
 TEST_F(WindowTreeClientWmTest, SetVisibleFailed) {
   const bool original_visible = root_window()->TargetVisibility();
   const bool new_visible = !original_visible;
   SetWindowVisibility(root_window(), new_visible);
   ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
       WindowTreeChangeType::VISIBLE, false));
   EXPECT_EQ(original_visible, root_window()->TargetVisibility());
 }
 
@@ skipping 370 matching lines @@
   // Make sure all the properties took.
   EXPECT_TRUE(IsWindowHostVisible(top_level));
   EXPECT_TRUE(top_level->TargetVisibility());
   // TODO: check display_id.
   EXPECT_EQ(display_id, window_tree_host.display_id());
   EXPECT_EQ(gfx::Rect(0, 0, 3, 4), top_level->bounds());
   EXPECT_EQ(gfx::Rect(1, 2, 3, 4), top_level->GetHost()->GetBounds());
 }
 
 TEST_F(WindowTreeClientClientTest, NewWindowGetsAllChangesInFlight) {
-  SetPropertyConverter(base::MakeUnique<TestPropertyConverter>());
+  RegisterTestProperties(GetPropertyConverter());
 
   WindowTreeHostMus window_tree_host(window_tree_client_impl());
   Window* top_level = window_tree_host.window();
 
   EXPECT_FALSE(top_level->TargetVisibility());
 
   // Make visibility go from false->true->false. Don't ack immediately.
   top_level->Show();
   top_level->Hide();
 
   // Change bounds to 5, 6, 7, 8.
   window_tree_host.SetBounds(gfx::Rect(5, 6, 7, 8));
   EXPECT_EQ(gfx::Rect(0, 0, 7, 8), window_tree_host.window()->bounds());
 
   const uint8_t explicitly_set_test_property1_value = 2;
   top_level->SetProperty(kTestPropertyKey1,
                          explicitly_set_test_property1_value);
 
   // Ack the new window top level top_level Vis and bounds shouldn't change.
   ui::mojom::WindowDataPtr data = ui::mojom::WindowData::New();
   data->window_id = server_id(top_level);
   const gfx::Rect bounds_from_server(1, 2, 3, 4);
   data->bounds = bounds_from_server;
   data->visible = true;
   const uint8_t server_test_property1_value = 3;
   data->properties[kTestPropertyServerKey1] =
-      Uint8ToPropertyTransportValue(server_test_property1_value);
+      GetPropertyTransportValue(server_test_property1_value);
   const uint8_t server_test_property2_value = 4;
   data->properties[kTestPropertyServerKey2] =
-      Uint8ToPropertyTransportValue(server_test_property2_value);
+      GetPropertyTransportValue(server_test_property2_value);
   const int64_t display_id = 1;
   // Get the id of the in flight change for creating the new top_level.
   uint32_t new_window_in_flight_change_id;
   ASSERT_TRUE(window_tree()->GetAndRemoveFirstChangeOfType(
       WindowTreeChangeType::NEW_TOP_LEVEL, &new_window_in_flight_change_id));
   window_tree_client()->OnTopLevelCreated(new_window_in_flight_change_id,
                                           std::move(data), display_id, true);
 
   // The only value that should take effect is the property for 'yy' as it was
   // not in flight.
@@ skipping 21 matching lines @@
             top_level->GetRootWindow()->GetHost()->GetBounds());
   ASSERT_TRUE(window_tree()->AckSingleChangeOfType(
       WindowTreeChangeType::PROPERTY, false));
   EXPECT_EQ(server_test_property1_value,
             top_level->GetProperty(kTestPropertyKey1));
   EXPECT_EQ(server_test_property2_value,
             top_level->GetProperty(kTestPropertyKey2));
 }
 
 TEST_F(WindowTreeClientClientTest, NewWindowGetsProperties) {
-  SetPropertyConverter(base::MakeUnique<TestPropertyConverter>());
+  RegisterTestProperties(GetPropertyConverter());
   Window window(nullptr);
   const uint8_t explicitly_set_test_property1_value = 29;
   window.SetProperty(kTestPropertyKey1, explicitly_set_test_property1_value);
   window.Init(ui::LAYER_NOT_DRAWN);
   mojo::Map<mojo::String, mojo::Array<uint8_t>> transport_properties =
       window_tree()->GetLastNewWindowProperties();
   ASSERT_FALSE(transport_properties.is_null());
   std::map<std::string, std::vector<uint8_t>> properties =
       transport_properties.To<std::map<std::string, std::vector<uint8_t>>>();
   ASSERT_EQ(1u, properties.count(kTestPropertyServerKey1));
@@ skipping 321 matching lines @@
   ASSERT_EQ(1u, root_window()->children().size());
   Window* server_window = root_window()->children()[0];
   EXPECT_EQ(window1->parent(), server_window);
   EXPECT_EQ(window2->parent(), server_window);
   ASSERT_EQ(2u, server_window->children().size());
   EXPECT_EQ(window1, server_window->children()[0]);
   EXPECT_EQ(window2, server_window->children()[1]);
 }
 
 }  // namespace aura