PPAPI: Support sending browser-hosted resources synchronously

ppapi/tests/test_message_handler.cc

 // Copyright 2014 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 "ppapi/tests/test_message_handler.h"
 
 #include <string.h>
 #include <algorithm>
 #include <map>
 #include <sstream>
+#include <vector>
 
 #include "ppapi/c/pp_var.h"
 #include "ppapi/c/ppb_file_io.h"
 #include "ppapi/c/ppb_messaging.h"
 #include "ppapi/c/ppp_message_handler.h"
 #include "ppapi/cpp/completion_callback.h"
 #include "ppapi/cpp/file_io.h"
 #include "ppapi/cpp/file_ref.h"
 #include "ppapi/cpp/file_system.h"
 #include "ppapi/cpp/instance.h"
@@ skipping 16 matching lines @@
 
 REGISTER_TEST_CASE(MessageHandler);
 
 namespace {
 
 // Created and destroyed on the main thread. All public methods should be called
 // on the main thread. Most data members are only accessed on the main thread.
 // (Though it handles messages on the background thread).
 class MyMessageHandler : public pp::MessageHandler {
  public:
-  explicit MyMessageHandler(TestingInstance* instance,
-                            const pp::MessageLoop& loop)
+  MyMessageHandler(TestingInstance* instance, const pp::MessageLoop& loop)
       : testing_instance_(instance),
         message_handler_loop_(loop),
         is_registered_(false),
         test_finished_event_(instance->pp_instance()),
         destroy_event_(instance->pp_instance()),
-        async_message_received_(instance->pp_instance()) {
+        finished_message_received_(instance->pp_instance()) {
     AssertOnMainThread();
   }
   void Register() {
     AssertOnMainThread();
     assert(!is_registered_);
     int32_t result =
         testing_instance_->RegisterMessageHandler(this, message_handler_loop_);
     if (result == PP_OK) {
       is_registered_ = true;
     } else {
@@ skipping 24 matching lines @@
     assert(!is_registered_);
     destroy_event_.Wait();
     destroy_event_.Reset();
     // Now that we know Destroy() has been called, we know errors_ isn't being
     // written on the MessageHandler thread anymore. So we can safely read it
     // here on the main thread (since destroy_event_ gave us a memory barrier).
     std::string temp_errors;
     errors_.swap(temp_errors);
     return temp_errors;
   }
-  pp::Var WaitForAsyncMessage() {
-    async_message_received_.Wait();
-    pp::Var var_to_return = last_async_message_received_;
-    last_async_message_received_ = pp::Var();
-    async_message_received_.Reset();
-    return var_to_return;
+  void WaitForAsyncMessages(std::vector<pp::Var>* out_vec) {
+    finished_message_received_.Wait();
+    out_vec->swap(async_messages_received_);
+    finished_message_received_.Reset();
   }
  private:
   static void AssertOnMainThread() {
     assert(pp::MessageLoop::GetForMainThread() ==
            pp::MessageLoop::GetCurrent());
   }
   void AddError(const std::string& error) {
     if (!error.empty()) {
       if (!errors_.empty())
         errors_ += "<p>";
       errors_ += error;
     }
   }
   virtual void HandleMessage(pp::InstanceHandle instance, const pp::Var& var) {
     if (pp::MessageLoop::GetCurrent() != message_handler_loop_)
       AddError("HandleMessage was called on the wrong thread!");
     if (instance.pp_instance() != testing_instance_->pp_instance())
       AddError("HandleMessage was passed the wrong instance!");
     if (var.is_string() && var.AsString() == "FINISHED_TEST") {
       test_finished_event_.Signal();
+    } else if (var.is_string() && var.AsString() == "FINISHED_WAITING") {
+      finished_message_received_.Signal();
     } else {
-      // Any client causing a message to arrive must wait for the message
-      // before continuing. See WaitForAsyncMessage().
-      assert(last_async_message_received_.is_undefined());
-      last_async_message_received_ = var;
-      async_message_received_.Signal();
+      async_messages_received_.push_back(var);
     }
   }
 
   virtual pp::Var HandleBlockingMessage(pp::InstanceHandle instance,
                                         const pp::Var& var) {
     if (pp::MessageLoop::GetCurrent() != message_handler_loop_)
       AddError("HandleBlockingMessage was called on the wrong thread!");
     if (instance.pp_instance() != testing_instance_->pp_instance())
       AddError("HandleBlockingMessage was passed the wrong instance!");
 
@@ skipping 30 matching lines @@
   // is_registered_ is only read/written on the main thread.
   bool is_registered_;
 
   // errors_ is written on the MessageHandler thread. When Destroy() is
   // called, we stop writing to errors_ and signal destroy_event_. This causes
   // a memory barrier, so it's safe to read errors_ after that.
   std::string errors_;
   NestedEvent test_finished_event_;
   NestedEvent destroy_event_;
 
-  pp::Var last_async_message_received_;
-  NestedEvent async_message_received_;
+  std::vector<pp::Var> async_messages_received_;
+  NestedEvent finished_message_received_;
 
   // Undefined & private to disallow copy and assign.
   MyMessageHandler(const MyMessageHandler&);
   MyMessageHandler& operator=(const MyMessageHandler&);
 };
 
 void FakeHandleMessage(PP_Instance instance,
                        void* user_data,
                        const PP_Var* message_data) {}
 void FakeHandleBlockingMessage(PP_Instance instance,
@@ skipping 20 matching lines @@
       pp::Module::Get()->GetBrowserInterface(PPB_MESSAGING_INTERFACE_1_2));
   return ppb_messaging_if_ &&
          CheckTestingInterface() &&
          handler_thread_.Start();
 }
 
 void TestMessageHandler::RunTests(const std::string& filter) {
   RUN_TEST(RegisterErrorConditions, filter);
   RUN_TEST(PostMessageAndAwaitResponse, filter);
   RUN_TEST(Exceptions, filter);
+  RUN_TEST(BrowserHostedResources, filter);
 }
 
 void TestMessageHandler::HandleMessage(const pp::Var& message_data) {
   if (instance()->current_test_name() == "Exceptions") {
     // For TestPostMessageAndAwaitResponse(), all messages should go to the
     // background thread message handler.
     assert(false);
   } else {
     // Any subtest causing a message to arrive here must wait for it before
     // continuing. See WaitForMessage().
@@ skipping 66 matching lines @@
   handler.Unregister();
   ASSERT_SUBTEST_SUCCESS(handler.WaitForDestroy());
 
   PASS();
 }
 
 std::string TestMessageHandler::TestExceptions() {
   MyMessageHandler handler(instance(),
                            handler_thread_.message_loop());
   {
-    // First, try sending a blocking message when there is no handler
+    // First try sending a blocking message when there is no handler
     // registered. It should throw an exception.
     std::string js_code(
         "var plugin = document.getElementById('plugin');\n"
         "var caught_exception = false;\n"
         "try {\n"
         "  plugin.postMessageAndAwaitResponse('Hello!');\n"
         "} catch (err) {\n"
         "  caught_exception = true;\n"
         "}\n"
         "plugin.postMessage(caught_exception ? 'SUCCESS' : 'FAIL');\n");
     instance_->EvalScript(js_code);
     // Note that we want to wait for the Instance to get the SUCCESS/FAIL
     // message here. |message_handler| is not yet registered, so the message
     // goes to the instance instead.
     pp::Var msg = WaitForMessage();
     ASSERT_TRUE(msg.is_string());
     ASSERT_EQ("SUCCESS", msg.AsString());
   }
   handler.Register();
   {
-    // Now that a handler is registered, try requesting and sending a
-    // FileSystem. It should throw an exception. The file system is opened
-    // asynchronously. What *should* happen is that it opens successfully, then
-    // we try to send it via postMessageAndAwaitResponse, which fails with an
-    // exception. The test could fail either because the filesystem doesn't
-    // open or because postMessageAndAwaitResponse doesn't throw an exception.
+    // Try passing different numbers of arguments; only 1 argument is allowed.
+    // Other numbers should throw an exception.
+    std::string js_code(
+        "var plugin = document.getElementById('plugin');\n"
+        "var caught_exception = false;\n"
+        "try {\n"
+        "  plugin.postMessageAndAwaitResponse();\n"
+        "} catch (err) {\n"
+        "  caught_exception = true;\n"
+        "}\n"
+        "plugin.postMessage(caught_exception ? 'SUCCESS' : 'FAIL');\n"
+        "try {\n"
+        "  plugin.postMessageAndAwaitResponse('hello', 5);\n"
+        "} catch (err) {\n"
+        "  caught_exception = true;\n"
+        "}\n"
+        "plugin.postMessage(caught_exception ? 'SUCCESS' : 'FAIL');\n"
+        "plugin.postMessage('FINISHED_WAITING');\n");
+    instance_->EvalScript(js_code);
+    std::vector<pp::Var> messages;
+    handler.WaitForAsyncMessages(&messages);
+    ASSERT_EQ(2u, messages.size());
+    ASSERT_EQ("SUCCESS", messages[0].AsString());
+    ASSERT_EQ("SUCCESS", messages[1].AsString());
+  }
+  handler.Unregister();
+  ASSERT_SUBTEST_SUCCESS(handler.WaitForDestroy());
+
+  PASS();
+}
+
+std::string TestMessageHandler::TestBrowserHostedResources() {
+  MyMessageHandler handler(instance(),
+                           handler_thread_.message_loop());
+   handler.Register();
+  {
+    // Try requesting and sending a FileSystem. It should throw an exception.
+    // The file system is opened asynchronously. Once it opens successfully,
+    // then we send it via postMessage and postMessageAndAwaitResponse. We try
+    // both to make sure that the ordering is correct.
     std::string js_code(
         "var plugin = document.getElementById('plugin');\n"
         "function gotFileSystem(fs) {\n"
         "  var caught_exception = false;\n"
         "  try {\n"
-        "    plugin.postMessageAndAwaitResponse(fs);\n"
+        "    plugin.postMessage(fs);"
+        "    plugin.postMessage(fs);"
+        "    plugin.postMessage(fs);"
+        "    plugin.postMessage(fs);"
+        "    var result = plugin.postMessageAndAwaitResponse(fs);\n"
         "  } catch (err) {\n"
         "    caught_exception = true;\n"
-        "  }\n"
-        "  plugin.postMessage(caught_exception ? 'SUCCESS' : 'FAIL');\n"
+        "  }\n" //TODO(dmichael): Really test that the filesystem is right
+                //  ...and FileRef?
+        "  plugin.postMessage(result.toString() == fs.toString() ?"
+        "                     'SUCCESS' : result.toString());\n"
+        "  plugin.postMessage('FINISHED_WAITING');\n"
         "}\n"
         "function fileSystemError() {\n"
         "  plugin.postMessage('Failed to open filesystem');\n"
         "}\n"
         "window.webkitRequestFileSystem(\n"
         "    window.Temporary, 1024, gotFileSystem, fileSystemError)\n");
     instance_->EvalScript(js_code);
-    pp::Var msg = handler.WaitForAsyncMessage();
-    ASSERT_EQ(PP_VARTYPE_STRING, msg.pp_var().type);
-    ASSERT_EQ("SUCCESS", msg.AsString());
+    std::vector<pp::Var> messages;
+    handler.WaitForAsyncMessages(&messages);
+    ASSERT_EQ(5u, messages.size());
+    ASSERT_EQ("SUCCESS", messages.back().AsString());
   }
   handler.Unregister();
   ASSERT_SUBTEST_SUCCESS(handler.WaitForDestroy());
 
   PASS();
 }
 
+
 pp::Var TestMessageHandler::WaitForMessage() {
   message_received_.Wait();
   pp::Var var_to_return = last_message_;
   last_message_ = pp::Var();
   message_received_.Reset();
   return var_to_return;
 }