Merge pull request dart-archive/sse#2 from dart-lang/cleanup

Cleanup

Author: grouma

pkgs/sse/.travis.yml

@@ -40,3 +40,8 @@ script:
 cache:
  directories:
    - $HOME/.pub-cache
+
+# Only building master means that we don't run two builds for each pull request.
+branches:
+  only:
+    - master

pkgs/sse/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.0
+
+- Internal cleanup.
+
+
+## 0.0.1
+
+- Initial commit.

pkgs/sse/example/index.dart

@@ -0,0 +1,15 @@
+// Copyright (c) 2019, 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 'package:sse/client/sse_client.dart';
+
+/// A basic example which should be used in a browser that supports SSE.
+void main() {
+  var channel = SseClient('/sseHandler');
+
+  channel.stream.listen((s) {
+    // Listen for messages and send the back.
+    channel.sink.add(s);
+  });
+}

pkgs/sse/example/server.dart

@@ -0,0 +1,21 @@
+// Copyright (c) 2019, 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 'package:shelf/shelf_io.dart' as io;
+import 'package:sse/server/sse_handler.dart';
+
+/// A basic server which sets up an SSE handler.
+///
+/// When a client connnects it will send a simple message and print the
+/// response.
+void main() async {
+  var handler = SseHandler(Uri.parse('/sseHandler'));
+  await io.serve(handler.handler, 'localhost', 0);
+  var connections = handler.connections;
+  while (await connections.hasNext) {
+    var connection = await connections.next;
+    connection.sink.add('foo');
+    connection.stream.listen(print);
+  }
+}

pkgs/sse/lib/client/sse_client.dart

@@ -1,8 +1,13 @@
+// Copyright (c) 2019, 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 'dart:convert';
 import 'dart:html';
 
 import 'package:http/browser_client.dart';
+import 'package:logging/logging.dart';
 import 'package:stream_channel/stream_channel.dart';
 import 'package:uuid/uuid.dart';
 
@@ -17,6 +22,8 @@ class SseClient extends StreamChannelMixin<String> {
 
   final _client = new BrowserClient()..withCredentials = true;
 
+  final _logger = Logger('SseClient');
+
   EventSource _eventSource;
 
   String _serverUrl;
@@ -39,7 +46,8 @@ class SseClient extends StreamChannelMixin<String> {
 
   /// Add messages to this [StreamSink] to send them to the server.
   ///
-  /// The message added to the sink has to be JSON encodable.
+  /// The message added to the sink has to be JSON encodable. Messages that fail
+  /// to encode will be logged through a [Logger].
   @override
   StreamSink<String> get sink => _outgoingController.sink;
 
@@ -79,8 +87,8 @@ class SseClient extends StreamChannelMixin<String> {
     var encoded = jsonEncode(message);
     try {
       await _client.post(_serverUrl, body: encoded);
-    } catch (_) {
-      // Ignore any error
+    } catch (e) {
+      _logger.warning('Unable to encode outgoing message: $e');
     }
   }
 }

pkgs/sse/lib/server/sse_handler.dart

@@ -1,3 +1,7 @@
+// Copyright (c) 2019, 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 'dart:convert';
 
@@ -26,6 +30,7 @@ class SseConnection extends StreamChannelMixin<String> {
   SseConnection(this._sink, this._clientId) {
     _outgoingController.stream.listen((data) {
       if (!_closeCompleter.isCompleted) {
+        // JSON encode the message to escape new lines.
         _sink.add('data: ${json.encode(data)}\n');
         _sink.add('\n');
       }
@@ -34,12 +39,11 @@ class SseConnection extends StreamChannelMixin<String> {
 
   Future get onClose => _closeCompleter.future;
 
-  ///
   /// The message added to the sink has to be JSON encodable.
   @override
   StreamSink<String> get sink => _outgoingController.sink;
 
-// Add messages to this [StreamSink] to send them to the server.
+  // Add messages to this [StreamSink] to send them to the server.
   /// [Stream] of messages sent from the server to this client.
   ///
   /// A message is a decoded JSON object.

pkgs/sse/pubspec.yaml

@@ -1,5 +1,5 @@
 name: sse 
-version: 0.0.1 
+version: 1.0.0
 author: Dart Team <[email protected]>
 homepage: https://github.com/dart-lang/sse
 description: >-

pkgs/sse/test/sse_test.dart

@@ -1,3 +1,7 @@
+// Copyright (c) 2019, 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.
+
 @TestOn('vm')
 import 'dart:async';
 import 'dart:io';
@@ -40,15 +44,15 @@ void main() {
   });
 
   test('Multiple clients can connect', () async {
-    var connections = await handler.connections;
+    var connections = handler.connections;
     await webdriver.get('http://localhost:${server.port}');
     await connections.next;
     await webdriver.get('http://localhost:${server.port}');
     await connections.next;
   });
 
   test('Routes data correctly', () async {
-    var connections = await handler.connections;
+    var connections = handler.connections;
     await webdriver.get('http://localhost:${server.port}');
     var connectionA = await connections.next;
     await webdriver.get('http://localhost:${server.port}');

pkgs/sse/test/web/index.dart

@@ -1,8 +1,12 @@
+// Copyright (c) 2019, 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:html';
 
 import 'package:sse/client/sse_client.dart';
 
-main() {
+void main() {
   var channel = SseClient('/test');
 
   document.querySelector('button').onClick.listen((_) {