Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions pkgs/pool/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## 1.5.3-wip

* Added an example.
* Fix a resource leak when `PoolResource.allowRelease` callback throws.

## 1.5.2

Expand Down
14 changes: 8 additions & 6 deletions pkgs/pool/lib/pool.dart
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class Pool {
/// allocated.
///
/// See [PoolResource.allowRelease].
final _onReleaseCallbacks = Queue<void Function()>();
final _onReleaseCallbacks = Queue<FutureOr<void> Function()>();

/// Completers that will be completed once `onRelease` callbacks are done
/// running.
Expand Down Expand Up @@ -275,7 +275,7 @@ class Pool {

/// If there are any pending requests, this will fire the oldest one after
/// running [onRelease].
void _onResourceReleaseAllowed(void Function() onRelease) {
void _onResourceReleaseAllowed(FutureOr<void> Function() onRelease) {
_resetTimer();

if (_requestedResources.isNotEmpty) {
Expand All @@ -297,15 +297,17 @@ class Pool {
///
/// Futures returned by [_runOnRelease] always complete in the order they were
/// created, even if earlier [onRelease] callbacks take longer to run.
Future<PoolResource> _runOnRelease(void Function() onRelease) {
Future<PoolResource> _runOnRelease(FutureOr<void> Function() onRelease) {
var completer = Completer<PoolResource>.sync();
_onReleaseCompleters.add(completer);

Future.sync(onRelease).then((value) {
_onReleaseCompleters.removeFirst().complete(PoolResource._(this));
}).catchError((Object error, StackTrace stackTrace) {
}, onError: (Object error, StackTrace stackTrace) {
_onReleaseCompleters.removeFirst().completeError(error, stackTrace);
_onResourceReleased();
Comment thread
kevmoo marked this conversation as resolved.
Resolved
});

var completer = Completer<PoolResource>.sync();
_onReleaseCompleters.add(completer);
return completer.future;
}

Expand Down
126 changes: 126 additions & 0 deletions pkgs/pool/test/pool_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,119 @@ void main() {

await pool.request();
});

test('request() throws if allowRelease callback throws', () async {
var pool = Pool(1);
var resource = await pool.request();

var requestFuture = pool.request();

var completer = Completer<void>();
resource.allowRelease(() => completer.future);

await Future<void>.delayed(Duration.zero);
completer.completeError('oh no!');

await expectLater(requestFuture, throwsA('oh no!'));
});

test('request() does not leak resources when allowRelease throws',
() async {
var pool = Pool(1);
var resource = await pool.request();

var requestFuture = pool.request();

var completer = Completer<void>();
resource.allowRelease(() => completer.future);

await Future<void>.delayed(Duration.zero);
completer.completeError('oh no!');

await expectLater(requestFuture, throwsA('oh no!'));

// Without the fix, this will hang because the slot is leaked.
var nextRequest = pool.request().timeout(
const Duration(milliseconds: 100),
onTimeout: () => throw TimeoutException('Leaked!'));

await expectLater(nextRequest, completes);
});
Comment thread
kevmoo marked this conversation as resolved.
Resolved

test('throwing in request listener does not corrupt state', () async {
var pool = Pool(2);
var resource1 = await pool.request();
var resource2 = await pool.request();

var completer1 = Completer<void>();
resource1.allowRelease(() => completer1.future);
var completer2 = Completer<void>();
resource2.allowRelease(() => completer2.future);

var requestFuture1 = pool.request();
var requestFuture2 = pool.request();

var request1Threw = false;
var requestFuture1WithListener = requestFuture1.then((_) {
request1Threw = true;
throw StateError('Listener 1 threw!');
});

expect(requestFuture1WithListener, throwsA(isA<StateError>()));

var request2Completed = false;
var request2Error = false;
unawaited(requestFuture2.then((_) {
request2Completed = true;
}, onError: (Object e) {
request2Error = true;
}));

await Future<void>.delayed(Duration.zero);

completer1.complete();
await Future<void>.delayed(Duration.zero);

expect(request1Threw, isTrue);
expect(request2Completed, isFalse);
expect(request2Error, isFalse);

completer2.complete();
await Future<void>.delayed(Duration.zero);

expect(request2Completed, isTrue);
expect(request2Error, isFalse);
});
});

group('PoolResource', () {
test('release() throws StateError if called twice', () async {
var pool = Pool(1);
var resource = await pool.request();
resource.release();
expect(resource.release, throwsStateError);
});

test('allowRelease() throws StateError if called twice', () async {
var pool = Pool(1);
var resource = await pool.request();
resource.allowRelease(() {});
expect(() => resource.allowRelease(() {}), throwsStateError);
});

test('allowRelease() throws if called after release()', () async {
var pool = Pool(1);
var resource = await pool.request();
resource.release();
expect(() => resource.allowRelease(() {}), throwsStateError);
});

test('release() throws if called after allowRelease()', () async {
var pool = Pool(1);
var resource = await pool.request();
resource.allowRelease(() {});
expect(resource.release, throwsStateError);
});
});

test("done doesn't complete without close", () async {
Expand All @@ -296,6 +409,19 @@ void main() {
expect(() => pool.withResource(() {}), throwsStateError);
});

test('can be called multiple times', () async {
var pool = Pool(1);
var resource = await pool.request();

var closeFuture1 = pool.close();
var closeFuture2 = pool.close();

expect(closeFuture1, equals(closeFuture2));

resource.release();
await closeFuture1;
});

test('pending requests are fulfilled', () async {
var pool = Pool(1);
var resource1 = await pool.request();
Expand Down
Loading