Added exception if you try to reply with a non-direct ByteBuffer. #25952

gaaclarke · 2021-05-05T17:42:12Z

I couldn't find an appropriate place to update the documentation so I decided for an exception. People can run into this problem if they incorrectly implement a channel with a binarycodec.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See testing the engine for instructions on
writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the CLA.
All existing and new tests are passing.
The reviewer has submitted any presubmit flakes in this PR using the engine presubmit flakes form before re-triggering the failure.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

flutter-dashboard · 2021-05-05T17:42:14Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

blasten · 2021-05-05T18:21:16Z

shell/platform/android/io/flutter/embedding/engine/FlutterJNI.java

    ensureRunningOnMainThread();
+    if (!message.isDirect()) {


does it also fix flutter/flutter#81875?

Half of the problem, there were 2. The position problem and the direct buffer problem.

do we want to remove the ability to set null?

Yep, check out where this function is actually used: https://github.com/gaaclarke/engine/blob/7219fc0932a238cee073bb20f19ccd8f8729d022/shell/platform/android/io/flutter/embedding/engine/dart/DartMessenger.java#L160:L161 There is a separate function you are supposed to use if you want to send null.

jason-simmons · 2021-05-05T18:34:41Z

It might also make sense to add an FML_DCHECK() that verifies a non-null address to the GetDirectBufferAddress calls in platform_view_android.cc

blasten · 2021-05-05T18:59:57Z

@gaaclarke for documentation, it already mentions that a direct ByteBuffer is expected. Maybe, it can also say that an exception is thrown. Also, null is supported.

engine/shell/platform/android/io/flutter/plugin/common/BinaryMessenger.java

Line 96 in 138c91c

    
                * @param reply the reply payload, a direct-allocated {@link ByteBuffer} or null. Senders of

gaaclarke · 2021-05-05T19:03:50Z

@gaaclarke for documentation, it already mentions that a direct ByteBuffer is expected. Maybe, it can also say that an exception is thrown. Also, null is supported.

engine/shell/platform/android/io/flutter/plugin/common/BinaryMessenger.java

Line 96 in 138c91c

* @param reply the reply payload, a direct-allocated {@link ByteBuffer} or null. Senders of

Yea, but the problem with that is if you look at the reproduction code, it isn't clear that you are actually using a BinaryMessenger.
From the users perspective you are using a BasicMessageChannel, a DartExecutor, and a BinaryCodec. They'd have to do some digging to actually see that comment. But it would be weird somewhere else too.

gaaclarke · 2021-05-05T20:30:19Z

It might also make sense to add an FML_DCHECK() that verifies a non-null address to the GetDirectBufferAddress calls in platform_view_android.cc

@jason-simmons thanks, done

blasten

LGTM assuming there's a test

fluttergithubbot · 2021-05-05T22:29:01Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Windows Android AOT Engine has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Windows Host Engine has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Windows UWP Engine has failed. Please fix the issues identified (or deflake) before re-applying this label.

fluttergithubbot · 2021-05-12T19:24:01Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite build_and_test_linux_unopt_debug has failed. Please fix the issues identified (or deflake) before re-applying this label.

…fer. (flutter/engine#25952)

* 67b046e Update documentation for embedding SplashScreen (flutter/engine#25943) * a0a7203 Set exitcode to 0 on successful uwptool launch (flutter/engine#26105) * ecb367f Roll Skia from 0270bf5d10be to 4e9d5e2bdf04 (5 revisions) (flutter/engine#26102) * 85bcce7 Roll Dart SDK from 934cc986926d to 171876a4e6cf (2 revisions) (flutter/engine#26101) * b99a362 Roll Fuchsia Mac SDK from GNyjTge9c... to q1qWG9XiN... (flutter/engine#26107) * f7c3e7e Added exception if you try to reply with a non-direct ByteBuffer. (flutter/engine#25952) * 96ec5a5 Roll Skia from 4e9d5e2bdf04 to 84f70136abfb (4 revisions) (flutter/engine#26108) * 2c3c1df Use a comma-separated args string for UWP (flutter/engine#26110) * 25c06a4 Roll Skia from 84f70136abfb to 66441d4ea0fa (2 revisions) (flutter/engine#26111) * d21a04b Roll Skia from 66441d4ea0fa to 537b7508343d (1 revision) (flutter/engine#26113) * aeb98f4 Roll Fuchsia Linux SDK from MoY7UVVro... to WYD7atCH7... (flutter/engine#26116) * 08d9bc0 Revert "Sped up the objc standard message codec (#25998)" (flutter/engine#26117)

flutter-dashboard bot added the platform-android label May 5, 2021

google-cla bot added the cla: yes label May 5, 2021

gaaclarke requested a review from blasten May 5, 2021 17:42

blasten reviewed May 5, 2021

View reviewed changes

blasten approved these changes May 5, 2021

View reviewed changes

gaaclarke added the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label May 5, 2021

fluttergithubbot removed the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label May 5, 2021

gaaclarke added the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label May 12, 2021

gaaclarke added 4 commits May 12, 2021 11:20

Added exception if you try to reply with a non-direct ByteBuffer.

9aed9ab

added dcheck

2981e4d

added a test

49c597d

format

28b214a

gaaclarke force-pushed the direct-buffer-exception branch from c0a15a0 to 28b214a Compare May 12, 2021 18:21

fluttergithubbot removed the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label May 12, 2021

gaaclarke merged commit f7c3e7e into flutter:master May 12, 2021

engine-flutter-autoroll mentioned this pull request May 13, 2021

Roll Engine from a33937429616 to d21a04bda2d3 (10 revisions) flutter/flutter#82410

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request May 13, 2021

f7c3e7e Added exception if you try to reply with a non-direct ByteBuf…

c3c6868

…fer. (flutter/engine#25952)

engine-flutter-autoroll mentioned this pull request May 13, 2021

Roll Engine from a33937429616 to 08d9bc0fdd62 (12 revisions) flutter/flutter#82424

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request May 13, 2021

f7c3e7e Added exception if you try to reply with a non-direct ByteBuf…

6e446ff

…fer. (flutter/engine#25952)

engine-flutter-autoroll mentioned this pull request May 13, 2021

Roll Engine from a33937429616 to 08d9bc0fdd62 (12 revisions) flutter/flutter#82425

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request May 13, 2021

f7c3e7e Added exception if you try to reply with a non-direct ByteBuf…

7956d52

…fer. (flutter/engine#25952)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added exception if you try to reply with a non-direct ByteBuffer. #25952

Added exception if you try to reply with a non-direct ByteBuffer. #25952

Uh oh!

gaaclarke commented May 5, 2021 •

edited

Loading

Uh oh!

flutter-dashboard bot commented May 5, 2021

Uh oh!

blasten May 5, 2021

Uh oh!

gaaclarke May 5, 2021

Uh oh!

blasten May 5, 2021

Uh oh!

gaaclarke May 5, 2021

Uh oh!

blasten May 5, 2021

Uh oh!

jason-simmons commented May 5, 2021

Uh oh!

blasten commented May 5, 2021

Uh oh!

gaaclarke commented May 5, 2021

Uh oh!

gaaclarke commented May 5, 2021 •

edited

Loading

Uh oh!

blasten left a comment

Uh oh!

fluttergithubbot commented May 5, 2021

Uh oh!

fluttergithubbot commented May 12, 2021

Uh oh!

Uh oh!

Added exception if you try to reply with a non-direct ByteBuffer. #25952

Added exception if you try to reply with a non-direct ByteBuffer. #25952

Uh oh!

Conversation

gaaclarke commented May 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented May 5, 2021

Uh oh!

blasten May 5, 2021

Choose a reason for hiding this comment

Uh oh!

gaaclarke May 5, 2021

Choose a reason for hiding this comment

Uh oh!

blasten May 5, 2021

Choose a reason for hiding this comment

Uh oh!

gaaclarke May 5, 2021

Choose a reason for hiding this comment

Uh oh!

blasten May 5, 2021

Choose a reason for hiding this comment

Uh oh!

jason-simmons commented May 5, 2021

Uh oh!

blasten commented May 5, 2021

Uh oh!

gaaclarke commented May 5, 2021

Uh oh!

gaaclarke commented May 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blasten left a comment

Choose a reason for hiding this comment

Uh oh!

fluttergithubbot commented May 5, 2021

Uh oh!

fluttergithubbot commented May 12, 2021

Uh oh!

Uh oh!

gaaclarke commented May 5, 2021 •

edited

Loading

gaaclarke commented May 5, 2021 •

edited

Loading