Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed the problem of when cancel Unhandled Exception: Instance of 'QueueCancelledException' #17

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all 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
35 changes: 22 additions & 13 deletions example/queue_example.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,36 @@ Future<void> main() async {
print(message);
}

unawaited(queue.add(() async {
await asyncMessage("Message 1");
}).then((result) => print("Message 1 complete")));
unawaited(queue
.add(() async {
await asyncMessage("Message 1");
})
.then((result) => print("Message 1 complete"))
.catchError((e) => print("Message 1 error: $e")));

await queue.add(() async {
unawaited(queue.add(() async {
await asyncMessage("Message 2");
});
}).catchError((e) => print("Message 2 error: $e")));

await Future.delayed(const Duration(milliseconds: 500));
// await Future.delayed(const Duration(milliseconds: 500));

print('Message 2 complete');
// print('Message 2 complete');

unawaited(queue.add(() async {
await asyncMessage("Message 3");
print("awaited message");
throw Exception("Error");
}).then((result) => print("Message 3 complete")));
queue.cancel();

unawaited(queue
.add(() async {
await asyncMessage("Message 3");
print("awaited message");
// throw Exception("Error");
})
.then((result) => print("Message 3 complete"))
.catchError((e) => print("Message 3 error: $e")));

unawaited(queue
.add(() async => asyncMessage("Message 4"))
.then((result) => print("Message 4 complete")));
.then((result) => print("Message 4 complete"))
.catchError((e) => print("Message 3 error: $e")));
}

void unawaited(Future<void> future) {}
8 changes: 1 addition & 7 deletions lib/src/dart_queue_base.dart
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@ class Queue {
/// Can be edited mid processing
int parallel;
int _lastProcessId = 0;
bool _isCancelled = false;

bool get isCancelled => _isCancelled;
StreamController<int>? _remainingItemsController;

Stream<int> get remainingItems {
Expand Down Expand Up @@ -93,7 +91,6 @@ class Queue {
item.completer.completeError(QueueCancelledException());
}
_nextCycle.removeWhere((item) => item.completer.isCompleted);
_isCancelled = true;
}

/// Dispose of the queue
Expand All @@ -115,7 +112,6 @@ class Queue {
///
/// Will throw an exception if the queue has been cancelled.
Future<T> add<T>(Future<T> Function() closure) {
if (isCancelled) throw QueueCancelledException();
final completer = Completer<T>();
_nextCycle.add(_QueuedFuture<T>(closure, completer, timeout));
_updateRemainingItems();
Expand Down Expand Up @@ -145,9 +141,7 @@ class Queue {
}

void _queueUpNext() {
if (_nextCycle.isNotEmpty &&
!isCancelled &&
activeItems.length <= parallel) {
if (_nextCycle.isNotEmpty && activeItems.length <= parallel) {
final processId = _lastProcessId;
activeItems.add(processId);
final item = _nextCycle.first;
Expand Down
47 changes: 47 additions & 0 deletions test/queue_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -255,4 +255,51 @@ void main() {
final result = await queue.add(() async => null);
expect(result, null);
});

test("cancel result 2 and continue next result3", () async {
final queue = Queue(delay: const Duration(milliseconds: 100));
final results = <String?>[];
final errors = <Exception>[];
final errorResults = <String?>[];

unawaited(queue
.add(() async {
await Future.delayed(const Duration(milliseconds: 10));
return "result 1";
})
.then((result) => results.add(result))
.catchError((err) {
errors.add(err);
errorResults.add('error 1');
}));

unawaited(queue
.add(() async {
await Future.delayed(const Duration(milliseconds: 10));
return "result 2";
})
.then((result) => results.add(result))
.catchError((err) {
errors.add(err);
errorResults.add('error 2');
}));

queue.cancel();

await queue
.add(() async {
await Future.delayed(const Duration(milliseconds: 10));
return "result 3";
})
.then((result) => results.add(result))
.catchError((err) {
errors.add(err);
errorResults.add('error 3');
});

expect(results.length, 2);
expect(errors.length, 1);
expect(errorResults.length, 1);
expect(errorResults.first, 'error 2');
});
}