Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ci/builders/linux_unopt.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
"name": "test:format_and_dart_test",
"script": "flutter/ci/format.sh"
},
{
"nane": "test:GeneratedPluginRegistant.java omitted",
"script": "flutter/ci/test/format_no_generated_java.sh"
},
{
"language": "python3",
"name": "test: Host_Tests_for_host_debug_unopt",
Expand Down
14 changes: 14 additions & 0 deletions ci/format.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,20 @@ SRC_DIR="$(cd "$SCRIPT_DIR/../.."; pwd -P)"
DART_SDK_DIR="${SRC_DIR}/third_party/dart/tools/sdks/dart-sdk"
DART="${DART_SDK_DIR}/bin/dart"

# Check if a file named **/GeneratedPluginRegistrant.java exists in the project.
# If it does, fail the build and print a message to the user pointing them to
# the file and instructing them to remove it.
#
# See: https://github.com/flutter/flutter/issues/143782.
GENERATED_PLUGIN_REGISTRANT_PATH=$(find "$SRC_DIR/flutter" -name "GeneratedPluginRegistrant.java")
if [[ -n "$GENERATED_PLUGIN_REGISTRANT_PATH" ]]; then
echo "GeneratedPluginRegistrant.java found in the project."
echo "This file is generated by Flutter tooling and should not exist in the engine repository."
echo "Please remove it from the project and try again."
echo "Path: $GENERATED_PLUGIN_REGISTRANT_PATH"
exit 1
fi

cd "$SCRIPT_DIR"
"$DART" \
--disable-dart-dev \
Expand Down
55 changes: 55 additions & 0 deletions ci/test/format_no_generated_java_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That configuration causes this test to run in ci?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NVM, you added it in ci/builders/linux_unopt.json

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this script have the execute bit set?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I just typed it wrong in the CI configuration. PTAL.

#
# Copyright 2013 The Flutter Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

set -e

# Needed because if it is set, cd may print the path it changed to.
unset CDPATH

# On Mac OS, readlink -f doesn't work, so follow_links traverses the path one
# link at a time, and then cds into the link destination and find out where it
# ends up.
#
# The function is enclosed in a subshell to avoid changing the working directory
# of the caller.
function follow_links() (
cd -P "$(dirname -- "$1")"
file="$PWD/$(basename -- "$1")"
while [[ -h "$file" ]]; do
cd -P "$(dirname -- "$file")"
file="$(readlink -- "$file")"
cd -P "$(dirname -- "$file")"
file="$PWD/$(basename -- "$file")"
done
echo "$file"
)

SCRIPT_DIR=$(follow_links "$(dirname -- "${BASH_SOURCE[0]}")")
SRC_DIR="$(
cd "$SCRIPT_DIR/../../.."
pwd -P
)"
FLUTTER_DIR="$SRC_DIR/flutter"

# Creates a file named `GeneratedPluginRegistrant.java` in the project.
# This file is generated by Flutter tooling and should not be checked in.
touch "$FLUTTER_DIR/GeneratedPluginRegistrant.java"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Consider putting this in a subdirectory given that this file would likely be deeper in the file tree.


# Create a trap that, on exit, removes the file.
function cleanup() {
rm -f "$FLUTTER_DIR/GeneratedPluginRegistrant.java"
}
trap cleanup EXIT

# Runs ../format.sh and verifies that it fails with the expected error message.
# If it fails, the script prints an error message and exits with a non-zero status.
"$FLUTTER_DIR/ci/format.sh" || {
echo "PASS: analyze.sh failed as expected"
exit 0
}

echo "FAIL: format.sh did not fail as expected"
exit 1
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import io.flutter.embedding.engine.plugins.activity.ActivityAware;
import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding.OnSaveInstanceStateListener;
import io.flutter.plugins.GeneratedPluginRegistrant;
import io.flutter.plugins.FakeGeneratedPluginRegistrant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
Expand All @@ -59,7 +59,7 @@ public class FlutterActivityTest {
@Before
public void setUp() {
FlutterInjector.reset();
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
FlutterJNI mockFlutterJNI = mock(FlutterJNI.class);
when(mockFlutterJNI.isAttached()).thenReturn(true);
FlutterJNI.Factory mockFlutterJNIFactory = mock(FlutterJNI.Factory.class);
Expand All @@ -70,7 +70,7 @@ public void setUp() {

@After
public void tearDown() {
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
FlutterInjector.reset();
}

Expand Down Expand Up @@ -310,7 +310,7 @@ public void itRegistersPluginsAtConfigurationTime() {
// configureFlutterEngine which registers the plugins.
activity.onCreate(null);

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertEquals(1, registeredEngines.size());
assertEquals(activity.getFlutterEngine(), registeredEngines.get(0));
}
Expand Down Expand Up @@ -423,7 +423,7 @@ public void itDoesNotRegisterPluginsTwiceWhenUsingACachedEngine() {
FlutterActivityWithProvidedEngine flutterActivity = activityController.get();
flutterActivity.configureFlutterEngine(flutterActivity.getFlutterEngine());

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
// This might cause the plugins to be registered twice, once by the FlutterEngine constructor,
// and once by the default FlutterActivity.configureFlutterEngine implementation.
// Test that it doesn't happen.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import io.flutter.embedding.engine.FlutterEngine;
import io.flutter.embedding.engine.FlutterJNI;
import io.flutter.embedding.engine.loader.FlutterLoader;
import io.flutter.plugins.GeneratedPluginRegistrant;
import io.flutter.plugins.FakeGeneratedPluginRegistrant;
import java.util.List;
import org.junit.After;
import org.junit.Before;
Expand All @@ -43,7 +43,7 @@ public class FlutterFragmentActivityTest {
@Before
public void setUp() {
FlutterInjector.reset();
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
FlutterJNI mockFlutterJNI = mock(FlutterJNI.class);
when(mockFlutterJNI.isAttached()).thenReturn(true);
FlutterJNI.Factory mockFlutterJNIFactory = mock(FlutterJNI.Factory.class);
Expand All @@ -54,7 +54,7 @@ public void setUp() {

@After
public void tearDown() {
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
FlutterInjector.reset();
}

Expand Down Expand Up @@ -117,7 +117,7 @@ public void itRegistersPluginsAtConfigurationTime() {
scenario.onActivity(
activity -> {
List<FlutterEngine> registeredEngines =
GeneratedPluginRegistrant.getRegisteredEngines();
FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertEquals(1, registeredEngines.size());
assertEquals(activity.getFlutterEngine(), registeredEngines.get(0));
});
Expand All @@ -131,13 +131,13 @@ public void itDoesNotRegisterPluginsTwiceWhenUsingACachedEngine() {
scenario.onActivity(
activity -> {
List<FlutterEngine> registeredEngines =
GeneratedPluginRegistrant.getRegisteredEngines();
FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertEquals(1, registeredEngines.size());
assertEquals(activity.getFlutterEngine(), registeredEngines.get(0));
});
}

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
// This might cause the plugins to be registered twice, once by the FlutterEngine constructor,
// and once by the default FlutterFragmentActivity.configureFlutterEngine implementation.
// Test that it doesn't happen.
Expand All @@ -149,7 +149,7 @@ public void itReturnsValueFromMetaDataWhenCallsShouldHandleDeepLinkingCase1()
throws PackageManager.NameNotFoundException {
FlutterFragmentActivity activity =
Robolectric.buildActivity(FlutterFragmentActivityWithProvidedEngine.class).get();
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
Bundle bundle = new Bundle();
bundle.putBoolean(HANDLE_DEEPLINKING_META_DATA_KEY, true);
FlutterFragmentActivity spyFlutterActivity = spy(activity);
Expand All @@ -162,7 +162,7 @@ public void itReturnsValueFromMetaDataWhenCallsShouldHandleDeepLinkingCase2()
throws PackageManager.NameNotFoundException {
FlutterFragmentActivity activity =
Robolectric.buildActivity(FlutterFragmentActivityWithProvidedEngine.class).get();
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
Bundle bundle = new Bundle();
bundle.putBoolean(HANDLE_DEEPLINKING_META_DATA_KEY, false);
FlutterFragmentActivity spyFlutterActivity = spy(activity);
Expand All @@ -175,7 +175,7 @@ public void itReturnsValueFromMetaDataWhenCallsShouldHandleDeepLinkingCase3()
throws PackageManager.NameNotFoundException {
FlutterFragmentActivity activity =
Robolectric.buildActivity(FlutterFragmentActivityWithProvidedEngine.class).get();
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
// Creates an empty bundle.
Bundle bundle = new Bundle();
FlutterFragmentActivity spyFlutterActivity = spy(activity);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import io.flutter.embedding.engine.loader.FlutterLoader;
import io.flutter.embedding.engine.systemchannels.NavigationChannel;
import io.flutter.plugin.platform.PlatformViewsController;
import io.flutter.plugins.GeneratedPluginRegistrant;
import io.flutter.plugins.FakeGeneratedPluginRegistrant;
import java.util.ArrayList;
import java.util.List;
import org.junit.After;
Expand Down Expand Up @@ -58,7 +58,7 @@ public void setUp() {
jniAttached = false;
when(mockFlutterJNI.isAttached()).thenAnswer(invocation -> jniAttached);
doAnswer(invocation -> jniAttached = true).when(mockFlutterJNI).attachToNative();
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();

when(mockFlutterLoader.findAppBundlePath()).thenReturn("some/path/to/flutter_assets");

Expand Down Expand Up @@ -103,7 +103,7 @@ FlutterEngine createEngine(

@After
public void tearDown() {
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
engineGroupUnderTest = null;
firstEngineUnderTest = null;
}
Expand Down Expand Up @@ -281,7 +281,7 @@ public void createEngineSupportMoreParams() {
when(FlutterInjector.instance().flutterLoader().automaticallyRegisterPlugins())
.thenReturn(true);
assertTrue(FlutterInjector.instance().flutterLoader().automaticallyRegisterPlugins());
assertEquals(0, GeneratedPluginRegistrant.getRegisteredEngines().size());
assertEquals(0, FakeGeneratedPluginRegistrant.getRegisteredEngines().size());

FlutterEngine firstEngine =
engineGroup.createAndRunEngine(
Expand All @@ -291,7 +291,7 @@ public void createEngineSupportMoreParams() {
.setWaitForRestorationData(waitForRestorationData)
.setAutomaticallyRegisterPlugins(automaticallyRegisterPlugins));

assertEquals(1, GeneratedPluginRegistrant.getRegisteredEngines().size());
assertEquals(1, FakeGeneratedPluginRegistrant.getRegisteredEngines().size());
assertEquals(controller, firstEngine.getPlatformViewsController());
assertEquals(
waitForRestorationData, firstEngine.getRestorationChannel().waitForRestorationData);
Expand Down Expand Up @@ -331,7 +331,7 @@ public void spawnEngineSupportMoreParams() {
when(FlutterInjector.instance().flutterLoader().automaticallyRegisterPlugins())
.thenReturn(true);
assertTrue(FlutterInjector.instance().flutterLoader().automaticallyRegisterPlugins());
assertEquals(0, GeneratedPluginRegistrant.getRegisteredEngines().size());
assertEquals(0, FakeGeneratedPluginRegistrant.getRegisteredEngines().size());

FlutterEngine secondEngine =
engineGroupUnderTest.createAndRunEngine(
Expand All @@ -344,6 +344,6 @@ public void spawnEngineSupportMoreParams() {
assertEquals(
waitForRestorationData, secondEngine.getRestorationChannel().waitForRestorationData);
assertEquals(controller, secondEngine.getPlatformViewsController());
assertEquals(0, GeneratedPluginRegistrant.getRegisteredEngines().size());
assertEquals(0, FakeGeneratedPluginRegistrant.getRegisteredEngines().size());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import io.flutter.embedding.engine.plugins.FlutterPlugin;
import io.flutter.embedding.engine.plugins.PluginRegistry;
import io.flutter.plugin.platform.PlatformViewsController;
import io.flutter.plugins.GeneratedPluginRegistrant;
import io.flutter.plugins.FakeGeneratedPluginRegistrant;
import java.util.List;
import org.junit.After;
import org.junit.Before;
Expand Down Expand Up @@ -78,25 +78,25 @@ public Object answer(InvocationOnMock invocation) throws Throwable {
})
.when(flutterJNI)
.attachToNative();
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
}

@After
public void tearDown() {
GeneratedPluginRegistrant.clearRegisteredEngines();
FakeGeneratedPluginRegistrant.clearRegisteredEngines();
// Make sure to not forget to remove the mock exception in the generated plugin registration
// mock, or everything subsequent will break.
GeneratedPluginRegistrant.pluginRegistrationException = null;
FakeGeneratedPluginRegistrant.pluginRegistrationException = null;
}

@Test
public void itAutomaticallyRegistersPluginsByDefault() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertEquals(1, registeredEngines.size());
assertEquals(flutterEngine, registeredEngines.get(0));
}
Expand All @@ -121,7 +121,7 @@ public void itSendLocalesOnEngineInit() {
FlutterJNI mockFlutterJNI = mock(FlutterJNI.class);
when(mockFlutterJNI.isAttached()).thenReturn(true);

assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, mockFlutterJNI);
Expand All @@ -134,14 +134,14 @@ public void itSendLocalesOnEngineInit() {
// https://github.com/flutter/flutter/issues/78625.
@Test
public void itCatchesAndDisplaysRegistrationExceptions() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
GeneratedPluginRegistrant.pluginRegistrationException =
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FakeGeneratedPluginRegistrant.pluginRegistrationException =
new RuntimeException("I'm a bug in the plugin");
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
// When it crashes, it doesn't end up registering anything.
assertEquals(0, registeredEngines.size());

Expand All @@ -153,26 +153,26 @@ public void itCatchesAndDisplaysRegistrationExceptions() {
.msg
.contains("Tried to automatically register plugins"));
assertEquals(
GeneratedPluginRegistrant.pluginRegistrationException,
FakeGeneratedPluginRegistrant.pluginRegistrationException,
ShadowLog.getLogsForTag("GeneratedPluginsRegister").get(1).throwable.getCause());

GeneratedPluginRegistrant.pluginRegistrationException = null;
FakeGeneratedPluginRegistrant.pluginRegistrationException = null;
}

@Test
public void itDoesNotAutomaticallyRegistersPluginsWhenFlutterLoaderDisablesIt() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(false);
new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertTrue(registeredEngines.isEmpty());
}

@Test
public void itDoesNotAutomaticallyRegistersPluginsWhenFlutterEngineDisablesIt() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
assertTrue(FakeGeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
new FlutterEngine(
Expand All @@ -182,7 +182,7 @@ public void itDoesNotAutomaticallyRegistersPluginsWhenFlutterEngineDisablesIt()
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);

List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
List<FlutterEngine> registeredEngines = FakeGeneratedPluginRegistrant.getRegisteredEngines();
assertTrue(registeredEngines.isEmpty());
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* <p>Used to test engine logic which interacts with the generated class.
*/
@VisibleForTesting
public class GeneratedPluginRegistrant {
public class FakeGeneratedPluginRegistrant {
private static final List<FlutterEngine> registeredEngines = new ArrayList<>();
public static @Nullable RuntimeException pluginRegistrationException;

Expand Down