Merge pull request #64 from Workiva/expose-debug-transport-url

rmconsole2-wf · web-flow · commit 11cdc7d62511 · 2023-11-02T16:02:27.000-05:00
FEA-2863: Expose debug transport URL when possible
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.3.0
+
+- Add `debugUrl` field to `SockJSOpenEvent`, which will be set to the full
+SockJS URL connected to by the underlying transport when using the unminified
+`sockjs.js` asset.
+
 ## 1.2.0
 
 - Migrate to null safety. SDK constraint raised to 2.12
diff --git a/example/index.html b/example/index.html
@@ -20,7 +20,7 @@
     <title>SockJS Client (Dart)</title>
 </head>
 <body>
-    <script src="/packages/sockjs_client_wrapper/sockjs_prod.js"></script>
+    <script src="/packages/sockjs_client_wrapper/sockjs.js"></script>
     <script defer src="/main.dart.js"></script>
 </body>
 </html>
diff --git a/example/main.dart b/example/main.dart
@@ -18,13 +18,13 @@ import 'package:sockjs_client_wrapper/sockjs_client_wrapper.dart';
 
 Future<Null> main() async {
   print('Starting example');
-  final echoUri = Uri.parse('http://localhost:9999/echo');
+  final echoUri = Uri.parse('http://localhost:9009/echo');
   final options =
       SockJSOptions(transports: ['websocket', 'xhr-streaming', 'xhr-polling']);
   final socket = SockJSClient(echoUri, options: options);
 
   socket.onOpen.listen((event) {
-    print('OPEN: ${event.transport} ${event.url}');
+    print('OPEN: ${event.transport} ${event.url} ${event.debugUrl}');
   });
 
   socket.onMessage.listen((event) {
diff --git a/example/server.js b/example/server.js
@@ -29,4 +29,4 @@ echo.on('connection', function(conn) {
 
 var server = http.createServer();
 echo.installHandlers(server, {prefix:'/echo'});
-server.listen(9999, '0.0.0.0');
+server.listen(9009, '0.0.0.0');
diff --git a/lib/sockjs.js b/lib/sockjs.js
diff --git a/lib/src/client.dart b/lib/src/client.dart
@@ -165,8 +165,11 @@ class SockJSClient extends Disposable {
   }
 
   void _onOpen(_) {
-    _onOpenController
-        .add(SockJSOpenEvent(_jsClient.transport, Uri.parse(_jsClient.url)));
+    _onOpenController.add(SockJSOpenEvent(
+      _jsClient.transport,
+      Uri.parse(_jsClient.url),
+      Uri.parse(_jsClient.transportUrl ?? ''),
+    ));
   }
 }
 
diff --git a/lib/src/events.dart b/lib/src/events.dart
@@ -48,6 +48,9 @@ class SockJSMessageEvent extends SockJSEvent {
 /// Event that represents the opening (successful connection) of a SockJS
 /// Client to the server.
 class SockJSOpenEvent extends SockJSEvent {
+  /// More specific URL used by the underlying transport. For debug use only.
+  final Uri debugUrl;
+
   /// The transport that was used to successfully connect to the server.
   ///
   /// E.g. "websocket" or "xhr-polling".
@@ -57,5 +60,5 @@ class SockJSOpenEvent extends SockJSEvent {
   final Uri url;
 
   /// Constructs a [SockJSOpenEvent].
-  SockJSOpenEvent(this.transport, this.url) : super._('open');
+  SockJSOpenEvent(this.transport, this.url, this.debugUrl) : super._('open');
 }
diff --git a/lib/src/js_interop.dart b/lib/src/js_interop.dart
@@ -41,6 +41,9 @@ class SockJS {
   /// E.g. "websocket" or "xhr-polling".
   external String get transport;
 
+  /// A more specific URL used by the underlying transport. For debug use only.
+  external String? get transportUrl;
+
   /// The URL of the server to which this client connected.
   external String get url;
 

Original file line number	Diff line number	Diff line change
`@@ -165,8 +165,11 @@ class SockJSClient extends Disposable {`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`void _onOpen(_) {`
`168`		`- _onOpenController`
`169`		`- .add(SockJSOpenEvent(_jsClient.transport, Uri.parse(_jsClient.url)));`
	`168`	`+ _onOpenController.add(SockJSOpenEvent(`
	`169`	`+ _jsClient.transport,`
	`170`	`+ Uri.parse(_jsClient.url),`
	`171`	`+ Uri.parse(_jsClient.transportUrl ?? ''),`
	`172`	`+ ));`
`170`	`173`	`}`
`171`	`174`	`}`
`172`	`175`