Skip to content

Commit b84f89b

Browse files
authored
Allow embedders to add callbacks for responses to platform messages from the framework. (flutter#9655)
Fixes flutter#18852
1 parent 8dac2e9 commit b84f89b

12 files changed

Lines changed: 294 additions & 9 deletions

‎ci/licenses_golden/licenses_flutter‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -768,6 +768,8 @@ FILE: ../../../flutter/shell/platform/embedder/embedder_engine.h
768768
FILE: ../../../flutter/shell/platform/embedder/embedder_external_texture_gl.cc
769769
FILE: ../../../flutter/shell/platform/embedder/embedder_external_texture_gl.h
770770
FILE: ../../../flutter/shell/platform/embedder/embedder_include.c
771+
FILE: ../../../flutter/shell/platform/embedder/embedder_platform_message_response.cc
772+
FILE: ../../../flutter/shell/platform/embedder/embedder_platform_message_response.h
771773
FILE: ../../../flutter/shell/platform/embedder/embedder_safe_access.h
772774
FILE: ../../../flutter/shell/platform/embedder/embedder_surface.cc
773775
FILE: ../../../flutter/shell/platform/embedder/embedder_surface.h

‎shell/platform/embedder/BUILD.gn‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ source_set("embedder") {
2323
"embedder_external_texture_gl.cc",
2424
"embedder_external_texture_gl.h",
2525
"embedder_include.c",
26+
"embedder_platform_message_response.cc",
27+
"embedder_platform_message_response.h",
2628
"embedder_safe_access.h",
2729
"embedder_surface.cc",
2830
"embedder_surface.h",
@@ -46,6 +48,7 @@ source_set("embedder") {
4648
"$flutter_root/common",
4749
"$flutter_root/flow",
4850
"$flutter_root/fml",
51+
"$flutter_root/lib/ui",
4952
"$flutter_root/runtime:libdart",
5053
"$flutter_root/shell/common",
5154
"//third_party/dart/runtime/bin:dart_io_api",

‎shell/platform/embedder/embedder.cc‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ extern const intptr_t kPlatformStrongDillSize;
3434
#include "flutter/shell/common/switches.h"
3535
#include "flutter/shell/platform/embedder/embedder.h"
3636
#include "flutter/shell/platform/embedder/embedder_engine.h"
37+
#include "flutter/shell/platform/embedder/embedder_platform_message_response.h"
3738
#include "flutter/shell/platform/embedder/embedder_safe_access.h"
3839
#include "flutter/shell/platform/embedder/embedder_task_runner.h"
3940
#include "flutter/shell/platform/embedder/embedder_thread_host.h"
@@ -818,19 +819,68 @@ FlutterEngineResult FlutterEngineSendPlatformMessage(
818819
return LOG_EMBEDDER_ERROR(kInvalidArguments);
819820
}
820821

822+
const FlutterPlatformMessageResponseHandle* response_handle =
823+
SAFE_ACCESS(flutter_message, response_handle, nullptr);
824+
825+
fml::RefPtr<flutter::PlatformMessageResponse> response;
826+
if (response_handle->message) {
827+
response = response_handle->message->response();
828+
}
829+
821830
auto message = fml::MakeRefCounted<flutter::PlatformMessage>(
822831
flutter_message->channel,
823832
std::vector<uint8_t>(
824833
flutter_message->message,
825834
flutter_message->message + flutter_message->message_size),
826-
nullptr);
835+
response);
827836

828837
return reinterpret_cast<flutter::EmbedderEngine*>(engine)
829838
->SendPlatformMessage(std::move(message))
830839
? kSuccess
831840
: LOG_EMBEDDER_ERROR(kInvalidArguments);
832841
}
833842

843+
FlutterEngineResult FlutterPlatformMessageCreateResponseHandle(
844+
FlutterEngine engine,
845+
FlutterDataCallback data_callback,
846+
void* user_data,
847+
FlutterPlatformMessageResponseHandle** response_out) {
848+
if (engine == nullptr || data_callback == nullptr ||
849+
response_out == nullptr) {
850+
return LOG_EMBEDDER_ERROR(kInvalidArguments);
851+
}
852+
853+
flutter::EmbedderPlatformMessageResponse::Callback response_callback =
854+
[user_data, data_callback](const uint8_t* data, size_t size) {
855+
data_callback(data, size, user_data);
856+
};
857+
858+
auto platform_task_runner = reinterpret_cast<flutter::EmbedderEngine*>(engine)
859+
->GetTaskRunners()
860+
.GetPlatformTaskRunner();
861+
862+
auto handle = new FlutterPlatformMessageResponseHandle();
863+
864+
handle->message = fml::MakeRefCounted<flutter::PlatformMessage>(
865+
"", // The channel is empty and unused as the response handle is going to
866+
// referenced directly in the |FlutterEngineSendPlatformMessage| with
867+
// the container message discarded.
868+
fml::MakeRefCounted<flutter::EmbedderPlatformMessageResponse>(
869+
std::move(platform_task_runner), response_callback));
870+
*response_out = handle;
871+
return kSuccess;
872+
}
873+
874+
FlutterEngineResult FlutterPlatformMessageReleaseResponseHandle(
875+
FlutterEngine engine,
876+
FlutterPlatformMessageResponseHandle* response) {
877+
if (engine == nullptr || response == nullptr) {
878+
return LOG_EMBEDDER_ERROR(kInvalidArguments);
879+
}
880+
delete response;
881+
return kSuccess;
882+
}
883+
834884
FlutterEngineResult FlutterEngineSendPlatformMessageResponse(
835885
FlutterEngine engine,
836886
const FlutterPlatformMessageResponseHandle* handle,

‎shell/platform/embedder/embedder.h‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -373,12 +373,11 @@ typedef struct {
373373
size_t struct_size;
374374
const char* channel;
375375
const uint8_t* message;
376-
const size_t message_size;
376+
size_t message_size;
377377
// The response handle on which to invoke
378-
// |FlutterEngineSendPlatformMessageResponse| when the response is ready. This
379-
// field is ignored for messages being sent from the embedder to the
380-
// framework. |FlutterEngineSendPlatformMessageResponse| must be called for
381-
// all messages received by the embedder. Failure to call
378+
// |FlutterEngineSendPlatformMessageResponse| when the response is ready.
379+
// |FlutterEngineSendPlatformMessageResponse| must be called for all messages
380+
// received by the embedder. Failure to call
382381
// |FlutterEngineSendPlatformMessageResponse| will cause a memory leak. It is
383382
// not safe to send multiple responses on a single response object.
384383
const FlutterPlatformMessageResponseHandle* response_handle;
@@ -388,6 +387,10 @@ typedef void (*FlutterPlatformMessageCallback)(
388387
const FlutterPlatformMessage* /* message*/,
389388
void* /* user data */);
390389

390+
typedef void (*FlutterDataCallback)(const uint8_t* /* data */,
391+
size_t /* size */,
392+
void* /* user data */);
393+
391394
typedef struct {
392395
double left;
393396
double top;
@@ -707,6 +710,33 @@ FlutterEngineResult FlutterEngineSendPlatformMessage(
707710
FlutterEngine engine,
708711
const FlutterPlatformMessage* message);
709712

713+
// Creates a platform message response handle that allows the embedder to set a
714+
// native callback for a response to a message. This handle may be set on the
715+
// |response_handle| field of any |FlutterPlatformMessage| sent to the engine.
716+
//
717+
// The handle must be collected via a call to
718+
// |FlutterPlatformMessageReleaseResponseHandle|. This may be done immediately
719+
// after a call to |FlutterEngineSendPlatformMessage| with a platform message
720+
// whose response handle contains the handle created using this call. In case a
721+
// handle is created but never sent in a message, the release call must still be
722+
// made. Not calling release on the handle results in a small memory leak.
723+
//
724+
// The user data baton passed to the data callback is the one specified in this
725+
// call as the third argument.
726+
FLUTTER_EXPORT
727+
FlutterEngineResult FlutterPlatformMessageCreateResponseHandle(
728+
FlutterEngine engine,
729+
FlutterDataCallback data_callback,
730+
void* user_data,
731+
FlutterPlatformMessageResponseHandle** response_out);
732+
733+
// Collects the handle created using
734+
// |FlutterPlatformMessageCreateResponseHandle|.
735+
FLUTTER_EXPORT
736+
FlutterEngineResult FlutterPlatformMessageReleaseResponseHandle(
737+
FlutterEngine engine,
738+
FlutterPlatformMessageResponseHandle* response);
739+
710740
FLUTTER_EXPORT
711741
FlutterEngineResult FlutterEngineSendPlatformMessageResponse(
712742
FlutterEngine engine,

‎shell/platform/embedder/embedder_engine.cc‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ EmbedderEngine::EmbedderEngine(
1818
EmbedderExternalTextureGL::ExternalTextureCallback
1919
external_texture_callback)
2020
: thread_host_(std::move(thread_host)),
21-
shell_(Shell::Create(std::move(task_runners),
21+
task_runners_(task_runners),
22+
shell_(Shell::Create(task_runners_,
2223
std::move(settings),
2324
on_create_platform_view,
2425
on_create_rasterizer)),
@@ -36,6 +37,10 @@ bool EmbedderEngine::IsValid() const {
3637
return is_valid_;
3738
}
3839

40+
const TaskRunners& EmbedderEngine::GetTaskRunners() const {
41+
return task_runners_;
42+
}
43+
3944
bool EmbedderEngine::NotifyCreated() {
4045
if (!IsValid()) {
4146
return false;

‎shell/platform/embedder/embedder_engine.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ class EmbedderEngine {
3232

3333
~EmbedderEngine();
3434

35+
const TaskRunners& GetTaskRunners() const;
36+
3537
bool NotifyCreated();
3638

3739
bool NotifyDestroyed();
@@ -71,6 +73,7 @@ class EmbedderEngine {
7173

7274
private:
7375
const std::unique_ptr<EmbedderThreadHost> thread_host_;
76+
TaskRunners task_runners_;
7477
std::unique_ptr<Shell> shell_;
7578
const EmbedderExternalTextureGL::ExternalTextureCallback
7679
external_texture_callback_;
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
#include "flutter/shell/platform/embedder/embedder_platform_message_response.h"
6+
7+
#include "flutter/fml/make_copyable.h"
8+
9+
namespace flutter {
10+
11+
EmbedderPlatformMessageResponse::EmbedderPlatformMessageResponse(
12+
fml::RefPtr<fml::TaskRunner> runner,
13+
Callback callback)
14+
: runner_(std::move(runner)), callback_(callback) {}
15+
16+
EmbedderPlatformMessageResponse::~EmbedderPlatformMessageResponse() = default;
17+
18+
// |PlatformMessageResponse|
19+
void EmbedderPlatformMessageResponse::Complete(
20+
std::unique_ptr<fml::Mapping> data) {
21+
if (!data) {
22+
CompleteEmpty();
23+
return;
24+
}
25+
26+
runner_->PostTask(
27+
fml::MakeCopyable([data = std::move(data), callback = callback_]() {
28+
callback(data->GetMapping(), data->GetSize());
29+
}));
30+
}
31+
32+
// |PlatformMessageResponse|
33+
void EmbedderPlatformMessageResponse::CompleteEmpty() {
34+
Complete(std::make_unique<fml::NonOwnedMapping>(nullptr, 0u));
35+
}
36+
37+
} // namespace flutter
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
#ifndef FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_PLATFORM_MESSAGE_RESPONSE_H_
6+
#define FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_PLATFORM_MESSAGE_RESPONSE_H_
7+
8+
#include "flutter/fml/macros.h"
9+
#include "flutter/fml/task_runner.h"
10+
#include "flutter/lib/ui/window/platform_message_response.h"
11+
12+
namespace flutter {
13+
14+
//------------------------------------------------------------------------------
15+
/// @brief The platform message response subclass for responses to messages
16+
/// from the embedder to the framework. Message responses are
17+
/// fulfilled by the framework.
18+
class EmbedderPlatformMessageResponse : public PlatformMessageResponse {
19+
public:
20+
using Callback = std::function<void(const uint8_t* data, size_t size)>;
21+
22+
//----------------------------------------------------------------------------
23+
/// @param[in] runner The task runner on which to execute the callback.
24+
/// The response will be initiated by the framework on
25+
/// the UI thread.
26+
/// @param[in] callback The callback that communicates to the embedder the
27+
/// contents of the response sent by the framework back
28+
/// to the emebder.
29+
EmbedderPlatformMessageResponse(fml::RefPtr<fml::TaskRunner> runner,
30+
Callback callback);
31+
32+
//----------------------------------------------------------------------------
33+
/// @brief Destroys the message response. Can be called on any thread.
34+
/// Does not execute unfulfilled callbacks.
35+
///
36+
~EmbedderPlatformMessageResponse() override;
37+
38+
private:
39+
fml::RefPtr<fml::TaskRunner> runner_;
40+
Callback callback_;
41+
42+
// |PlatformMessageResponse|
43+
void Complete(std::unique_ptr<fml::Mapping> data) override;
44+
45+
// |PlatformMessageResponse|
46+
void CompleteEmpty() override;
47+
48+
FML_DISALLOW_COPY_AND_ASSIGN(EmbedderPlatformMessageResponse);
49+
};
50+
51+
} // namespace flutter
52+
53+
#endif // FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_PLATFORM_MESSAGE_RESPONSE_H_

‎shell/platform/embedder/fixtures/main.dart‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,12 @@ void a11y_main() async { // ignore: non_constant_identifier_names
144144
await semanticsChanged;
145145
notifySemanticsEnabled(window.semanticsEnabled);
146146
}
147+
148+
149+
@pragma('vm:entry-point')
150+
void platform_messages_response() {
151+
window.onPlatformMessage = (String name, ByteData data, PlatformMessageResponseCallback callback) {
152+
callback(data);
153+
};
154+
signalNativeTest();
155+
}

‎shell/platform/embedder/tests/embedder_test.cc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,13 @@ EmbedderContext& EmbedderTest::GetEmbedderContext() {
2727

2828
// |testing::Test|
2929
void EmbedderTest::SetUp() {
30-
// Nothing to do here since we will lazily setup the context when asked.
30+
ThreadTest::SetUp();
3131
}
3232

3333
// |testing::Test|
3434
void EmbedderTest::TearDown() {
3535
embedder_context_.reset();
36+
ThreadTest::TearDown();
3637
}
3738

3839
} // namespace testing

0 commit comments

Comments
 (0)