Merge pull request #201 from Workiva/revert-198-FEDX-1991

Revert "FEDX-1991: allow a nullable to be managed"
Workiva · Nov 20, 2024 · 348bcfd · 348bcfd
2 parents 8503745 + 0138975
commit 348bcfd
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 40 deletions.
diff --git a/w_common/CHANGELOG.md b/w_common/CHANGELOG.md
@@ -1,13 +1,6 @@
-## [3.3.0](https://github.com/Workiva/w_common/compare/3.2.0...3.3.0)
-- Allow a nullable to be managed via `Disposable.manageDisposable` and 
-`Disposable.manageAndReturnTypedDisposable`.
-
-## [3.2.0](https://github.com/Workiva/w_common/compare/3.1.0...3.2.0)
-
-- Adds JsonMap and JsonMapObject typedefs
-
 ## [3.1.0](https://github.com/Workiva/w_common/compare/3.0.0...3.1.0)
 
+- Adds JsonMap and JsonMapObject typedefs
 - Update SDK minimum to 2.19.0 to support the non-function
  typedef language feature.
 - Raised package versions to their first nullsafe version.

diff --git a/w_common/lib/src/browser/disposable_browser.dart b/w_common/lib/src/browser/disposable_browser.dart
@@ -243,17 +243,16 @@ class Disposable implements disposable_common.Disposable {
           onError: onError, onDone: onDone, cancelOnError: cancelOnError);
 
   @override
-  T manageAndReturnTypedDisposable<T extends disposable_common.Disposable?>(
-      T disposable) {
-    return _disposable.manageAndReturnTypedDisposable<T>(disposable);
-  }
+  T manageAndReturnTypedDisposable<T extends disposable_common.Disposable>(
+          T disposable) =>
+      _disposable.manageAndReturnTypedDisposable(disposable);
 
   @override
   Completer<T> manageCompleter<T>(Completer<T> completer) =>
       _disposable.manageCompleter(completer);
 
   @override
-  void manageDisposable(disposable_common.Disposable? disposable) =>
+  void manageDisposable(disposable_common.Disposable disposable) =>
       _disposable.manageDisposable(disposable);
 
   @override

diff --git a/w_common/lib/src/common/disposable.dart b/w_common/lib/src/common/disposable.dart
@@ -514,13 +514,8 @@ class Disposable implements _Disposable, DisposableManagerV7, LeakFlagger {
 
   @mustCallSuper
   @override
-  T manageAndReturnTypedDisposable<T extends Disposable?>(T disposable) {
-    if (disposable == null) {
-      return disposable;
-    }
-
-    _throwOnInvalidCall(
-        'manageAndReturnTyped Disposable', 'disposable', disposable);
+  T manageAndReturnTypedDisposable<T extends Disposable>(T disposable) {
+    _throwOnInvalidCall('manageAndReturnDisposable', 'disposable', disposable);
     manageDisposable(disposable);
 
     return disposable;
@@ -557,7 +552,8 @@ class Disposable implements _Disposable, DisposableManagerV7, LeakFlagger {
     return completer;
   }
 
-  void manageDisposable(Disposable? disposable) {
+  void manageDisposable(Disposable disposable) {
+    // ignore: unnecessary_null_comparison
     if (disposable == null) {
       return;
     }

diff --git a/w_common/lib/src/common/disposable_manager.dart b/w_common/lib/src/common/disposable_manager.dart
@@ -47,7 +47,7 @@ abstract class DisposableManagerV7 {
   ///      }
   ///
   /// A null parameter will result in a null return value.
-  T manageAndReturnTypedDisposable<T extends Disposable?>(T disposable);
+  T manageAndReturnTypedDisposable<T extends Disposable>(T disposable);
 
   /// Automatically cancel a stream controller when this object is disposed.
   ///

diff --git a/w_common/test/unit/disposable_common.dart b/w_common/test/unit/disposable_common.dart
@@ -212,19 +212,9 @@ void testCommonDisposable(Func<StubDisposable> disposableFactory) {
       expect(disposable.injected!.isDisposed, isFalse);
     });
 
-    test('should not throw if value is null', () async {
-      StubDisposable? nullable;
-      var returnValue;
-      expect(() {
-        returnValue = disposable
-            .manageAndReturnTypedDisposable<StubDisposable?>(nullable);
-      }, returnsNormally);
-      expect(returnValue, isNull);
-    });
-
     testManageMethod(
         'manageAndReturnTypedDisposable',
-        (StubDisposable? argument) =>
+        (StubDisposable argument) =>
             disposable.manageAndReturnTypedDisposable(argument),
         disposableFactory());
   });
@@ -825,13 +815,6 @@ void testCommonDisposable(Func<StubDisposable> disposableFactory) {
   });
 
   group('manageDisposable', () {
-    test('should not throw if value is null', () async {
-      StubDisposable? nullable;
-      expect(() {
-        disposable.manageDisposable(nullable);
-      }, returnsNormally);
-    });
-
     test('should dispose child when parent is disposed', () async {
       var childThing = disposableFactory();
       disposable.manageDisposable(childThing);