dart-sdk/tests/corelib/weak_reference_test.dart
Alexander Markov 73783847fd [gardening] Fix corelib/weak_reference_test
This test incorrectly expects that WeakReference.target should be
cleared for a weakly reachable object. WeakReference specification
doesn't guarantee that:

a9f684e624/sdk/lib/core/weak.dart (L75-L76)

This change fixes the test to give up after certain number of
iterations instead of hanging forever.

Issue: https://github.com/dart-lang/sdk/issues/55518
Change-Id: Ief0ebe1452c83058a35fc1ba87e5a83924d43919
TEST=corelib/weak_reference_test
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/363960
Reviewed-by: Siva Annamalai <asiva@google.com>
Commit-Queue: Siva Annamalai <asiva@google.com>
Reviewed-by: Ryan Macnak <rmacnak@google.com>
Auto-Submit: Alexander Markov <alexmarkov@google.com>
2024-04-22 18:00:19 +00:00

59 lines
1.7 KiB
Dart

// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'dart:async';
import 'package:async_helper/async_helper.dart';
import 'package:expect/expect.dart';
import 'package:expect/config.dart';
import 'finalizer_test.dart' show invalidObjects, produceGarbage, Foo;
main() async {
testWeakReferenceArgumentValidation();
// This test doesn't work reliably on the web yet as it's hard to trigger GC
// that will run finalizer and weak reference processing.
if (isVmConfiguration) {
asyncStart();
await testWeakReferenceWeakness();
asyncEnd();
}
}
void testWeakReferenceArgumentValidation() {
final foo = Foo();
final weakRef = WeakReference(foo);
Expect.equals(weakRef.target, foo);
for (final invalid in invalidObjects) {
Expect.throws(() => WeakReference(invalid));
}
}
Future testWeakReferenceWeakness() async {
late final WeakReference<Foo> weakReference;
{
Foo? foo = Foo();
weakReference = WeakReference<Foo>(foo);
Expect.equals(weakReference.target, foo);
foo = null;
}
asyncStart();
// According to the WeakReference specification:
//
// There are no guarantees that a weak reference will ever be cleared
// even if all references to its target are weak references.
//
// Wait a few iterations and give up if target is not cleared.
const int numIterations = 10;
int i = 0;
for (; weakReference.target != null && i < numIterations; ++i) {
produceGarbage();
await Future.delayed(const Duration(milliseconds: 10));
}
Expect.isTrue(i == numIterations || weakReference.target == null);
asyncEnd();
}