Merge pull request #54 from Workiva/null_safety

Null safety

Author: rm-astro-wf

lib/src/client.dart

@@ -43,7 +43,7 @@ class SockJSClient extends Disposable {
   String get disposableTypeName => 'SockJSClient';
 
   // The native SockJS client object.
-  js_interop.SockJS _jsClient;
+  late js_interop.SockJS _jsClient;
 
   // Event stream controllers.
   final StreamController<SockJSCloseEvent> _onCloseController =
@@ -70,7 +70,7 @@ class SockJSClient extends Disposable {
   ///     final options = new SockJSOptions(
   ///         transports: ['websocket', 'xhr-streaming', 'xhr-polling']);
   ///     final client = new SockJSClient(uri, options: options);
-  SockJSClient(Uri uri, {SockJSOptions options}) {
+  SockJSClient(Uri uri, {SockJSOptions? options}) {
     try {
       _jsClient = js_interop.SockJS(uri.toString(), null, options?._toJs());
       // ignore: avoid_catches_without_on_clauses
@@ -120,7 +120,7 @@ class SockJSClient extends Disposable {
   /// Close this client.
   ///
   /// Optionally, a [closeCode] and [reason] can be provided.
-  void close([int closeCode, String reason]) {
+  void close([int? closeCode, String? reason]) {
     _jsClient.close(closeCode, reason);
   }
 
@@ -154,21 +154,17 @@ class SockJSClient extends Disposable {
 
   void _onClose(js_interop.SockJSCloseEvent event) {
     _onCloseController.add(SockJSCloseEvent(
-        // ignore: avoid_as
-        event.code,
-        // ignore: avoid_as
-        event.reason,
-        // ignore: avoid_as
-        wasClean: event.wasClean));
+      event.code,
+      event.reason,
+      wasClean: event.wasClean,
+    ));
   }
 
   void _onMessage(js_interop.SockJSMessageEvent event) {
-    // ignore: avoid_as
     _onMessageController.add(SockJSMessageEvent(event.data));
   }
 
-  // ignore: avoid_annotating_with_dynamic
-  void _onOpen(dynamic _) {
+  void _onOpen(_) {
     _onOpenController
         .add(SockJSOpenEvent(_jsClient.transport, Uri.parse(_jsClient.url)));
   }
@@ -179,13 +175,13 @@ class SockJSOptions {
   /// String to append to url for actual data connection.
   ///
   /// Defaults to a random 4 digit number.
-  final String server;
+  final String? server;
 
   /// A list of transports that may be used by SockJS.
   ///
   /// By default, all available transports will be used. Specifying a whitelist
   /// can be useful if you need to disable certain fallback transports.
-  final List<String> transports;
+  final List<String>? transports;
 
   /// Construct a [SockJSOptions] instance to be passed to the [SockJSClient]
   /// constructor.

lib/src/events.dart

@@ -32,7 +32,8 @@ class SockJSCloseEvent extends SockJSEvent {
   final bool wasClean;
 
   /// Constructs a [SockJSCloseEvent].
-  SockJSCloseEvent(this.code, this.reason, {this.wasClean}) : super._('close');
+  SockJSCloseEvent(this.code, this.reason, {required this.wasClean})
+      : super._('close');
 }
 
 /// Event that represents a message received by a SockJS Client from the server.

lib/src/js_interop.dart

@@ -26,7 +26,7 @@ bool get hasSockJS => context['SockJS'] != null;
 @JS()
 class SockJS {
   /// Constructs a SockJS Client.
-  external SockJS(String url, [Null _reserved, SockJSOptions options]);
+  external SockJS(String url, [Null _reserved, SockJSOptions? options]);
 
   /// The state of the client.
   ///
@@ -50,7 +50,7 @@ class SockJS {
   external void addEventListener(String eventName, Function callback);
 
   /// Closes this client.
-  external void close([int closeCode, String reason]);
+  external void close([int? closeCode, String? reason]);
 
   /// Removes an event listener that was registered with [addEventListener].
   external void removeEventListener(String eventName, Function callback);
@@ -93,7 +93,7 @@ class SockJSOptions {
   /// Example:
   ///
   ///     {server: 'foo', transports: ['websocket', 'xhr-polling']}
-  external factory SockJSOptions({String server, List<String> transports});
+  external factory SockJSOptions({String? server, List<String>? transports});
 
   /// String to append to url for actual data connection.
   ///

pubspec.yaml

@@ -4,7 +4,7 @@ description: A Dart wrapper for the `sockjs-client` JS library.
 homepage: https://github.com/Workiva/sockjs_client_wrapper
 
 environment:
-  sdk: ">=2.11.0 <3.0.0"
+  sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
   js: ^0.6.1
@@ -17,4 +17,4 @@ dev_dependencies:
   dart_dev: '>=3.6.5 <5.0.0'
   dependency_validator: ^3.2.0
   test: ^1.15.7
-  workiva_analysis_options: ^1.1.0
+  workiva_analysis_options: ^1.3.0

test/sockjs_client_wrapper_test.dart

@@ -105,74 +105,74 @@ void _integrationSuite(
   SockJSClient createCorClient(),
   SockJSClient create404Client(),
 ) {
-  SockJSClient client;
+  SockJSClient? client;
 
   tearDown(() async {
-    await client.dispose();
+    await client!.dispose();
     client = null;
   });
 
   test('connecting to a SockJS server', () async {
     client = createEchoClient();
-    expect((await client.onOpen.first).transport, equals(expectedTransport));
+    expect((await client!.onOpen.first).transport, equals(expectedTransport));
   });
 
   test('sending and receiving messages', () async {
     client = createEchoClient();
-    await client.onOpen.first;
+    await client!.onOpen.first;
 
     final c = Completer<Null>();
     final echos = <String>[];
-    client.onMessage.listen((message) {
+    client!.onMessage.listen((message) {
       echos.add(message.data);
       if (echos.length == 2) {
         c.complete();
       }
     });
-    client
+    client!
       ..send('message1')
       ..send('message2');
 
     await c.future;
-    client.close();
+    client!.close();
 
     expect(echos, equals(['message1', 'message2']));
   });
 
   test('client closing the connection', () async {
     client = createEchoClient();
-    await client.onOpen.first;
-    client.close();
-    await client.onClose.first;
+    await client!.onOpen.first;
+    client!.close();
+    await client!.onClose.first;
   });
 
   test('client closing the connection with code and reason', () async {
     client = createEchoClient();
-    await client.onOpen.first;
-    client.close(4001, 'Custom close.');
-    final event = await client.onClose.first;
+    await client!.onOpen.first;
+    client!.close(4001, 'Custom close.');
+    final event = await client!.onClose.first;
     expect(event.code, equals(4001));
     expect(event.reason, equals('Custom close.'));
   });
 
   test('server closing the connection', () async {
     client = createCorClient();
-    await client.onOpen.first;
-    client.send('close');
-    await client.onClose.first;
+    await client!.onOpen.first;
+    client!.send('close');
+    await client!.onClose.first;
   });
 
   test('server closing the connection with code and reason', () async {
     client = createCorClient();
-    await client.onOpen.first;
-    client.send('close::4001::Custom close.');
-    final event = await client.onClose.first;
+    await client!.onOpen.first;
+    client!.send('close::4001::Custom close.');
+    final event = await client!.onClose.first;
     expect(event.code, equals(4001));
     expect(event.reason, equals('Custom close.'));
   });
 
   test('handle failed connection', () async {
     client = create404Client();
-    await client.onClose.first;
+    await client!.onClose.first;
   });
 }

tool/dart_dev/config.dart

@@ -30,51 +30,39 @@ final config = {
     ..addTool(DevTool.fromFunction(stopExampleServer), alwaysRun: true),
 };
 
-Process _exampleServer;
-Process _testServer;
+Process? _exampleServer;
+Process? _testServer;
 
 Future<int> startExampleServer(DevToolExecutionContext _) async {
   _exampleServer = await Process.start('node', ['example/server.js'],
       mode: ProcessStartMode.inheritStdio);
-  return firstOf([
+  return Future.any([
     // Exit early if it fails to start,
-    _exampleServer.exitCode,
+    _exampleServer!.exitCode,
     // otherwise just wait a little bit to ensure it starts up completely.
     Future.delayed(Duration(seconds: 2)).then((_) => 0),
   ]);
 }
 
 Future<int> stopExampleServer(DevToolExecutionContext _) async {
   _exampleServer?.kill();
-  await _exampleServer.exitCode;
+  await _exampleServer?.exitCode;
   return 0;
 }
 
 Future<int> startTestServer(DevToolExecutionContext _) async {
   _testServer = await Process.start('node', ['tool/server.js'],
       mode: ProcessStartMode.inheritStdio);
-  return firstOf([
+  return Future.any([
     // Exit early if it fails to start,
-    _testServer.exitCode,
+    _testServer!.exitCode,
     // otherwise just wait a little bit to ensure it starts up completely.
     Future.delayed(Duration(seconds: 2)).then((_) => 0),
   ]);
 }
 
 Future<int> stopTestServer(DevToolExecutionContext _) async {
   _testServer?.kill();
-  await _testServer.exitCode;
+  await _testServer?.exitCode;
   return 0;
 }
-
-Future<T> firstOf<T>(Iterable<Future<T>> futures) {
-  final c = Completer<T>();
-  for (final future in futures) {
-    future.then((v) {
-      if (!c.isCompleted) {
-        c.complete(v);
-      }
-    }).catchError(c.completeError);
-  }
-  return c.future;
-}