Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Updated android_alarm_manager to work after engine refactor. #642

Merged
merged 6 commits into from
Aug 7, 2018
Merged

Updated android_alarm_manager to work after engine refactor. #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0808e48
Updated `android_alarm_manager` to work after engine refactor.
bkonyi Jun 28, 2018
e1992ec
Updated to use FlutterRunArguments
bkonyi Jul 17, 2018
e6b6160
Formatting and fixed analyzer issues
bkonyi Jul 18, 2018
cda6d7b
Additional fixes
bkonyi Aug 7, 2018
9c93bd3
Removed extra const
bkonyi Aug 7, 2018
3d736df
Added comments, removed dead code
bkonyi Aug 7, 2018
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
182 changes: 88 additions & 94 deletions ...rm_manager/android/src/main/java/io/flutter/plugins/androidalarmmanager/AlarmService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,81 @@

package io.flutter.plugins.androidalarmmanager;

import android.app.Activity;
import android.app.AlarmManager;
import android.app.Application;
import android.app.PendingIntent;
import android.app.Service;
import android.content.Context;
import android.content.Intent;
import android.os.IBinder;
import android.util.Log;
import io.flutter.app.FlutterActivity;
import io.flutter.app.FlutterApplication;
import io.flutter.plugin.common.MethodChannel;
import io.flutter.plugin.common.PluginRegistry.PluginRegistrantCallback;
import io.flutter.view.FlutterCallbackInformation;
import io.flutter.view.FlutterMain;
import io.flutter.view.FlutterNativeView;
import io.flutter.view.FlutterRunArguments;
import java.util.concurrent.atomic.AtomicBoolean;

public class AlarmService extends Service {
public static final String TAG = "AlarmService";
private static FlutterNativeView sSharedFlutterView;
private static AtomicBoolean sStarted = new AtomicBoolean(false);
private static FlutterNativeView sBackgroundFlutterView;
private static MethodChannel sBackgroundChannel;
private static PluginRegistrantCallback sPluginRegistrantCallback;

private FlutterNativeView mFlutterView;
private String appBundlePath;
private String mAppBundlePath;

public static void onInitialized() {
sStarted.set(true);
}

// Here we start the AlarmService. This method does a few things:
// - Retrieves the callback information for the handle associated with the
// callback dispatcher in the Dart portion of the plugin.
// - Builds the arguments object for running in a new FlutterNativeView.
// - Enters the isolate owned by the FlutterNativeView at the callback
// represented by `callbackHandle` and initializes the callback
// dispatcher.
// - Registers the FlutterNativeView's PluginRegistry to receive
// MethodChannel messages.
public static void startAlarmService(Context context, long callbackHandle) {
FlutterMain.ensureInitializationComplete(context, null);
String mAppBundlePath = FlutterMain.findAppBundlePath(context);
FlutterCallbackInformation cb =
FlutterCallbackInformation.lookupCallbackInformation(callbackHandle);
if (cb == null) {
Log.e(TAG, "Fatal: failed to find callback");
return;
}

// Note that we're passing `true` as the second argument to our
// FlutterNativeView constructor. This specifies the FlutterNativeView
// as a background view and does not create a drawing surface.
sBackgroundFlutterView = new FlutterNativeView(context, true);
if (mAppBundlePath != null && !sStarted.get()) {
Log.i(TAG, "Starting AlarmService...");
FlutterRunArguments args = new FlutterRunArguments();
args.bundlePath = mAppBundlePath;
args.entrypoint = cb.callbackName;
args.libraryPath = cb.callbackLibraryPath;
sBackgroundFlutterView.runFromBundle(args);
sPluginRegistrantCallback.registerWith(sBackgroundFlutterView.getPluginRegistry());
}
}

public static void setBackgroundChannel(MethodChannel channel) {
sBackgroundChannel = channel;
}

public static void setOneShot(
Context context,
int requestCode,
boolean exact,
boolean wakeup,
long startMillis,
String entrypoint) {
long callbackHandle) {
final boolean repeating = false;
scheduleAlarm(context, requestCode, repeating, exact, wakeup, startMillis, 0, entrypoint);
scheduleAlarm(context, requestCode, repeating, exact, wakeup, startMillis, 0, callbackHandle);
}

public static void setPeriodic(
Expand All @@ -45,10 +88,17 @@ public static void setPeriodic(
boolean wakeup,
long startMillis,
long intervalMillis,
String entrypoint) {
long callbackHandle) {
final boolean repeating = true;
scheduleAlarm(
context, requestCode, repeating, exact, wakeup, startMillis, intervalMillis, entrypoint);
context,
requestCode,
repeating,
exact,
wakeup,
startMillis,
intervalMillis,
callbackHandle);
}

public static void cancel(Context context, int requestCode) {
Expand All @@ -64,109 +114,53 @@ public static void cancel(Context context, int requestCode) {
}

public static FlutterNativeView getSharedFlutterView() {
return sSharedFlutterView;
return sBackgroundFlutterView;
}

public static boolean setSharedFlutterView(FlutterNativeView view) {
if (sSharedFlutterView != null && sSharedFlutterView != view) {
Log.i(TAG, "setSharedFlutterView tried to overwrite an existing FlutterNativeView");
public static boolean setBackgroundFlutterView(FlutterNativeView view) {
if (sBackgroundFlutterView != null && sBackgroundFlutterView != view) {
Log.i(TAG, "setBackgroundFlutterView tried to overwrite an existing FlutterNativeView");
return false;
}
Log.i(TAG, "setSharedFlutterView set");
sSharedFlutterView = view;
sBackgroundFlutterView = view;
return true;
}

public static void setPluginRegistrant(PluginRegistrantCallback callback) {
sPluginRegistrantCallback = callback;
}

private void ensureFlutterView() {
if (mFlutterView != null) {
return;
}

if (sSharedFlutterView != null) {
mFlutterView = sSharedFlutterView;
return;
}

// mFlutterView and sSharedFlutterView are both null. That likely means that
// no FlutterView has ever been created in this process before. So, we'll
// make one, and assign it to both mFlutterView and sSharedFlutterView.
mFlutterView = new FlutterNativeView(getApplicationContext());
sSharedFlutterView = mFlutterView;

// If there was no FlutterNativeView before now, then we also must
// initialize the PluginRegistry.
sPluginRegistrantCallback.registerWith(mFlutterView.getPluginRegistry());
return;
}

// This returns the FlutterView for the main FlutterActivity if there is one.
private static FlutterNativeView viewFromAppContext(Context context) {
Application app = (Application) context;
if (!(app instanceof FlutterApplication)) {
Log.i(TAG, "viewFromAppContext app not a FlutterApplication");
return null;
}
FlutterApplication flutterApp = (FlutterApplication) app;
Activity activity = flutterApp.getCurrentActivity();
if (activity == null) {
Log.i(TAG, "viewFromAppContext activity is null");
return null;
}
if (!(activity instanceof FlutterActivity)) {
Log.i(TAG, "viewFromAppContext activity is not a FlutterActivity");
return null;
}
FlutterActivity flutterActivity = (FlutterActivity) activity;
return flutterActivity.getFlutterView().getFlutterNativeView();
}

@Override
public void onCreate() {
super.onCreate();
Context context = getApplicationContext();
mFlutterView = viewFromAppContext(context);
FlutterMain.ensureInitializationComplete(context, null);
if (appBundlePath == null) {
appBundlePath = FlutterMain.findAppBundlePath(context);
}
}

@Override
public void onDestroy() {
// Try to find the native view of the main activity if there is one.
Context context = getApplicationContext();
FlutterNativeView nativeView = viewFromAppContext(context);

// Don't destroy mFlutterView if it is the same as the native view for the
// main activity, or the same as the shared native view.
if (mFlutterView != nativeView && mFlutterView != sSharedFlutterView) {
mFlutterView.destroy();
}
mFlutterView = null;

// Don't destroy the shared native view if it is the same native view as
// for the main activity.
if (sSharedFlutterView != nativeView) {
sSharedFlutterView.destroy();
}
sSharedFlutterView = null;
mAppBundlePath = FlutterMain.findAppBundlePath(context);
}

// This is where we handle alarm events before sending them to our callback
// dispatcher in Dart.
@Override
public int onStartCommand(Intent intent, int flags, int startId) {
ensureFlutterView();
String entrypoint = intent.getStringExtra("entrypoint");
if (entrypoint == null) {
Log.i(TAG, "onStartCommand got a null entrypoint. Bailing out");
if (!sStarted.get()) {
Log.i(TAG, "AlarmService has not yet started.");
// TODO(bkonyi): queue up alarm events.
return START_NOT_STICKY;
}
if (appBundlePath != null) {
mFlutterView.runFromBundle(appBundlePath, null, entrypoint, true);
// Grab the handle for the callback associated with this alarm. Pay close
// attention to the type of the callback handle as storing this value in a
// variable of the wrong size will cause the callback lookup to fail.
long callbackHandle = intent.getLongExtra("callbackHandle", 0);
if (sBackgroundChannel == null) {
Log.e(
TAG,
"setBackgroundChannel was not called before alarms were scheduled." + " Bailing out.");
return START_NOT_STICKY;
}
// Handle the alarm event in Dart. Note that for this plugin, we don't
// care about the method name as we simply lookup and invoke the callback
// provided.
sBackgroundChannel.invokeMethod("", new Object[] {callbackHandle});
return START_NOT_STICKY;
}

Expand All @@ -183,10 +177,10 @@ private static void scheduleAlarm(
boolean wakeup,
long startMillis,
long intervalMillis,
String entrypoint) {
// Create an Intent for the alarm and set the desired Dart entrypoint.
long callbackHandle) {
// Create an Intent for the alarm and set the desired Dart callback handle.
Intent alarm = new Intent(context, AlarmService.class);
alarm.putExtra("entrypoint", entrypoint);
alarm.putExtra("callbackHandle", callbackHandle);
PendingIntent pendingIntent =
PendingIntent.getService(context, requestCode, alarm, PendingIntent.FLAG_UPDATE_CURRENT);

Expand Down
29 changes: 23 additions & 6 deletions ...droid/src/main/java/io/flutter/plugins/androidalarmmanager/AndroidAlarmManagerPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,16 @@ public static void registerWith(Registrar registrar) {
registrar.messenger(),
"plugins.flutter.io/android_alarm_manager",
JSONMethodCodec.INSTANCE);
final MethodChannel backgroundChannel =
new MethodChannel(
registrar.messenger(),
"plugins.flutter.io/android_alarm_manager_background",
JSONMethodCodec.INSTANCE);
AndroidAlarmManagerPlugin plugin = new AndroidAlarmManagerPlugin(registrar.context());
channel.setMethodCallHandler(plugin);
backgroundChannel.setMethodCallHandler(plugin);
registrar.addViewDestroyListener(plugin);
AlarmService.setBackgroundChannel(backgroundChannel);
}

private Context mContext;
Expand All @@ -41,7 +48,12 @@ public void onMethodCall(MethodCall call, Result result) {
String method = call.method;
Object arguments = call.arguments;
try {
if (method.equals("Alarm.periodic")) {
if (method.equals("AlarmService.start")) {
startService((JSONArray) arguments);
result.success(true);
} else if (method.equals("AlarmService.initialized")) {
AlarmService.onInitialized();
Copy link
Contributor

Choose a reason for hiding this comment

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

@bkonyi I think we're missing the invocation of the result callback?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, looks like it. I don't think it causes any problems though, does it? I don't believe the background isolate cares if it gets a response here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm just going through the fun task of auditing all of our invokeMethod calls as part of reviewing #1365 and was confused when looking at this.

I'm guessing it will result in the future here never completing:
https://github.com/flutter/flutter/blob/ecfdd7e1ea96be3c762af6a1bd6be63d9e4d9682/packages/flutter/lib/src/services/platform_channel.dart#L295

Probably best to clean it up anyway.

} else if (method.equals("Alarm.periodic")) {
periodic((JSONArray) arguments);
result.success(true);
} else if (method.equals("Alarm.oneShot")) {
Expand All @@ -58,13 +70,18 @@ public void onMethodCall(MethodCall call, Result result) {
}
}

private void startService(JSONArray arguments) throws JSONException {
long callbackHandle = arguments.getLong(0);
AlarmService.startAlarmService(mContext, callbackHandle);
}

private void oneShot(JSONArray arguments) throws JSONException {
int requestCode = arguments.getInt(0);
boolean exact = arguments.getBoolean(1);
boolean wakeup = arguments.getBoolean(2);
long startMillis = arguments.getLong(3);
String entrypoint = arguments.getString(4);
AlarmService.setOneShot(mContext, requestCode, exact, wakeup, startMillis, entrypoint);
long callbackHandle = arguments.getLong(4);
AlarmService.setOneShot(mContext, requestCode, exact, wakeup, startMillis, callbackHandle);
}

private void periodic(JSONArray arguments) throws JSONException {
Expand All @@ -73,9 +90,9 @@ private void periodic(JSONArray arguments) throws JSONException {
boolean wakeup = arguments.getBoolean(2);
long startMillis = arguments.getLong(3);
long intervalMillis = arguments.getLong(4);
String entrypoint = arguments.getString(5);
long callbackHandle = arguments.getLong(5);
AlarmService.setPeriodic(
mContext, requestCode, exact, wakeup, startMillis, intervalMillis, entrypoint);
mContext, requestCode, exact, wakeup, startMillis, intervalMillis, callbackHandle);
}

private void cancel(JSONArray arguments) throws JSONException {
Expand All @@ -85,6 +102,6 @@ private void cancel(JSONArray arguments) throws JSONException {

@Override
public boolean onViewDestroy(FlutterNativeView nativeView) {
return AlarmService.setSharedFlutterView(nativeView);
return AlarmService.setBackgroundFlutterView(nativeView);
}
}
13 changes: 9 additions & 4 deletions packages/android_alarm_manager/example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,20 @@ Future<Null> main() async {
final int helloAlarmID = 0;
final int goodbyeAlarmID = 1;
final int oneShotID = 2;

// Start the AlarmManager service.
await AndroidAlarmManager.initialize();

printHelloMessage("Hello, main()!");
runApp(const Center(
child: Text('Hello, world!', textDirection: TextDirection.ltr)));
await AndroidAlarmManager.periodic(
const Duration(minutes: 1), helloAlarmID, printHello);
await AndroidAlarmManager.periodic(
const Duration(minutes: 1), goodbyeAlarmID, printGoodbye);
const Duration(seconds: 5), helloAlarmID, printHello,
wakeup: true);
await AndroidAlarmManager.oneShot(
const Duration(seconds: 5), goodbyeAlarmID, printGoodbye);
if (!oneShotFired) {
await AndroidAlarmManager.oneShot(
const Duration(minutes: 1), oneShotID, printOneShot);
const Duration(seconds: 5), oneShotID, printOneShot);
}
}
Loading