feat(mason_api): add close (felangel#481)

.github/workflows/mason_cli.yaml

@@ -87,4 +87,4 @@ jobs:
           dart pub global activate pana
 
       - name: Verify Pub Score
-        run: ../../tool/verify_pub_score.sh
+        run: ../../tool/verify_pub_score.sh 90

packages/mason_api/example/main.dart

@@ -11,4 +11,6 @@ Future<void> main() async {
 
   masonApi.logout();
   print('Logged out!');
+
+  masonApi.close();
 }

packages/mason_api/lib/src/mason_api.dart

@@ -235,6 +235,11 @@ class MasonApi {
     }
   }
 
+  /// Closes the client and cleans up any resources associated with it.
+  /// It's important to close each client when it's done being used;
+  /// failing to do so can cause the Dart process to hang.
+  void close() => _httpClient.close();
+
   /// Attempt to refresh the current credentials and return
   /// refreshed credentials.
   Future<Credentials> _refresh() async {

packages/mason_api/test/src/mason_api_test.dart

@@ -87,6 +87,13 @@ void main() {
       });
     });
 
+    group('close', () {
+      test('closes the underlying httpClient', () {
+        MasonApi(httpClient: httpClient).close();
+        verify(() => httpClient.close()).called(1);
+      });
+    });
+
     group('logout', () {
       test('clears credentials and user', () {
         final credentials = Credentials(

packages/mason_cli/lib/src/command_runner.dart

@@ -25,8 +25,8 @@ class MasonCommandRunner extends CommandRunner<int> {
     MasonApi? masonApi,
   })  : _logger = logger ?? Logger(),
         _pubUpdater = pubUpdater ?? PubUpdater(),
+        _masonApi = masonApi ?? MasonApi(hostedUri: BricksJson.hostedUri),
         super(executableName, '🧱  mason \u{2022} lay the foundation!') {
-    final _masonApi = masonApi ?? MasonApi(hostedUri: BricksJson.hostedUri);
     argParser.addFlags();
     addCommand(AddCommand(logger: _logger));
     addCommand(CacheCommand(logger: _logger));
@@ -47,6 +47,7 @@ class MasonCommandRunner extends CommandRunner<int> {
   }
 
   final Logger _logger;
+  final MasonApi _masonApi;
   final PubUpdater _pubUpdater;
 
   @override
@@ -74,6 +75,8 @@ class MasonCommandRunner extends CommandRunner<int> {
     } catch (error) {
       _logger.err('$error');
       return ExitCode.software.code;
+    } finally {
+      _masonApi.close();
     }
   }
 

packages/mason_cli/test/src/command_runner_test.dart

@@ -1,6 +1,7 @@
 // ignore_for_file: no_adjacent_strings_in_list
 import 'package:args/command_runner.dart';
 import 'package:mason/mason.dart' hide packageVersion;
+import 'package:mason_api/mason_api.dart';
 import 'package:mason_cli/src/command_runner.dart';
 import 'package:mason_cli/src/version.dart';
 import 'package:mocktail/mocktail.dart';
@@ -9,6 +10,8 @@ import 'package:test/test.dart';
 
 import '../helpers/helpers.dart';
 
+class MockMasonApi extends Mock implements MasonApi {}
+
 class MockLogger extends Mock implements Logger {}
 
 class MockPubUpdater extends Mock implements PubUpdater {}
@@ -53,12 +56,14 @@ Run ${cyan.wrap('mason update')} to update''';
 void main() {
   group('MasonCommandRunner', () {
     late Logger logger;
+    late MasonApi masonApi;
     late PubUpdater pubUpdater;
     late MasonCommandRunner commandRunner;
 
     setUp(() {
       printLogs = [];
       logger = MockLogger();
+      masonApi = MockMasonApi();
       pubUpdater = MockPubUpdater();
 
       when(
@@ -67,6 +72,7 @@ void main() {
 
       commandRunner = MasonCommandRunner(
         logger: logger,
+        masonApi: masonApi,
         pubUpdater: pubUpdater,
       );
     });
@@ -135,6 +141,11 @@ void main() {
         }),
       );
 
+      test('closes MasonApi', () async {
+        await commandRunner.run(['--version']);
+        verify(() => masonApi.close()).called(1);
+      });
+
       group('--help', () {
         test(
           'outputs usage',