From 8d0c9f52117309b59d40fbb8fde9a2d46dfbf711 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romain=20Vimont=20=28=C2=AEom=29?= <rom@rom1v.com>
Date: Mon, 10 Jun 2013 13:53:53 +0200
Subject: [PATCH] Serialized @Background task cancellation bugfix

If a serialized @Background task was cancelled after it had been
submitted to the executor but before its run() method was called, then
the following tasks with the same serial identifier were not executed.

Issue reported here:
https://github.com/excilys/androidannotations/pull/579#issuecomment-19173978

Detected by ThreadActivityTest#cancellableSerializedBackgroundTasks()
(but not always due to the race condition)
---
 .../api/BackgroundExecutor.java               | 32 ++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/api/BackgroundExecutor.java b/AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/api/BackgroundExecutor.java
index f757ffc656..fd17d09583 100644
--- a/AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/api/BackgroundExecutor.java
+++ b/AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/api/BackgroundExecutor.java
@@ -23,6 +23,7 @@
 import java.util.concurrent.Future;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 import android.util.Log;
 
@@ -197,11 +198,21 @@ public static synchronized void cancelAll(String id, boolean mayInterruptIfRunni
 		for (int i = tasks.size() - 1; i >= 0; i--) {
 			Task task = tasks.get(i);
 			if (id.equals(task.id)) {
-				tasks.remove(i);
 				if (task.future != null) {
 					task.future.cancel(mayInterruptIfRunning);
+					if (!task.managed.getAndSet(true)) {
+						/*
+						 * the task has been submitted to the executor, but its
+						 * execution has not started yet, so that its run()
+						 * method will never call postExecute()
+						 */
+						task.postExecute();
+					}
 				} else if (task.executionAsked) {
 					Log.w(TAG, "A task with id " + task.id + " cannot be cancelled (the executor set does not support it)");
+				} else {
+					/* this task has not been submitted to the executor */
+					tasks.remove(i);
 				}
 			}
 		}
@@ -252,6 +263,20 @@ public static abstract class Task implements Runnable {
 		private boolean executionAsked;
 		private Future<?> future;
 
+		/*
+		 * A task can be cancelled after it has been submitted to the executor
+		 * but before its run() method is called. In that case, run() will never
+		 * be called, hence neither will postExecute(): the tasks with the same
+		 * serial identifier (if any) will never be submitted.
+		 * 
+		 * Therefore, cancelAll() *must* call postExecute() if run() is not
+		 * started.
+		 * 
+		 * This flag guarantees that either cancelAll() or run() manages this
+		 * task post execution, but not both.
+		 */
+		private AtomicBoolean managed = new AtomicBoolean();
+
 		public Task(String id, int delay, String serial) {
 			if (!"".equals(id)) {
 				this.id = id;
@@ -267,6 +292,11 @@ public Task(String id, int delay, String serial) {
 
 		@Override
 		public void run() {
+			if (managed.getAndSet(true)) {
+				/* cancelled and postExecute() already called */
+				return;
+			}
+
 			try {
 				execute();
 			} finally {