Support delegate methods for WebSocketTask (#958)

dart-lang · Jun 9, 2023 · 1746017 · 1746017
1 parent 5312366
commit 1746017
Show file tree

Hide file tree

Showing 8 changed files with 749 additions and 61 deletions.
diff --git a/pkgs/cupertino_http/example/integration_test/url_session_delegate_test.dart b/pkgs/cupertino_http/example/integration_test/url_session_delegate_test.dart
@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:cupertino_http/cupertino_http.dart';
@@ -435,6 +436,235 @@ void testOnRedirect(URLSessionConfiguration config) {
   });
 }
 
+void testOnWebSocketTaskOpened(URLSessionConfiguration config) {
+  group('onWebSocketTaskOpened', () {
+    late HttpServer server;
+
+    setUp(() async {
+      server = (await HttpServer.bind('localhost', 0))
+        ..listen((request) async {
+          if (request.requestedUri.queryParameters.containsKey('error')) {
+            request.response.statusCode = 500;
+            unawaited(request.response.close());
+            return;
+          }
+          final webSocket = await WebSocketTransformer.upgrade(
+            request,
+            protocolSelector: (l) => 'myprotocol',
+          );
+          await webSocket.close();
+        });
+    });
+    tearDown(() {
+      server.close();
+    });
+
+    test('with protocol', () async {
+      final c = Completer<void>();
+      late String? actualProtocol;
+      late URLSession actualSession;
+      late URLSessionWebSocketTask actualTask;
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (s, t, p) {
+        actualSession = s;
+        actualTask = t;
+        actualProtocol = p;
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}'))
+        ..setValueForHttpHeaderField('Sec-WebSocket-Protocol', 'myprotocol');
+
+      final task = session.webSocketTaskWithRequest(request)..resume();
+      await c.future;
+      expect(actualSession, session);
+      expect(actualTask, task);
+      expect(actualProtocol, 'myprotocol');
+    });
+
+    test('without protocol', () async {
+      final c = Completer<void>();
+      late String? actualProtocol;
+      late URLSession actualSession;
+      late URLSessionWebSocketTask actualTask;
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (s, t, p) {
+        actualSession = s;
+        actualTask = t;
+        actualProtocol = p;
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}'));
+      final task = session.webSocketTaskWithRequest(request)..resume();
+      await c.future;
+      expect(actualSession, session);
+      expect(actualTask, task);
+      expect(actualProtocol, null);
+    });
+
+    test('server failure', () async {
+      final c = Completer<void>();
+      var onWebSocketTaskOpenedCalled = false;
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (s, t, p) {
+        onWebSocketTaskOpenedCalled = true;
+      }, onComplete: (s, t, e) {
+        expect(e, isNotNull);
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}?error=1'));
+      session.webSocketTaskWithRequest(request).resume();
+      await c.future;
+      expect(onWebSocketTaskOpenedCalled, false);
+    });
+  });
+}
+
+void testOnWebSocketTaskClosed(URLSessionConfiguration config) {
+  group('testOnWebSocketTaskClosed', () {
+    late HttpServer server;
+    late int? serverCode;
+    late String? serverReason;
+
+    setUp(() async {
+      server = (await HttpServer.bind('localhost', 0))
+        ..listen((request) async {
+          if (request.requestedUri.queryParameters.containsKey('error')) {
+            request.response.statusCode = 500;
+            unawaited(request.response.close());
+            return;
+          }
+          final webSocket = await WebSocketTransformer.upgrade(
+            request,
+          );
+          await webSocket.close(serverCode, serverReason);
+        });
+    });
+    tearDown(() {
+      server.close();
+    });
+
+    test('close no code', () async {
+      final c = Completer<void>();
+      late int actualCloseCode;
+      late String? actualReason;
+      late URLSession actualSession;
+      late URLSessionWebSocketTask actualTask;
+
+      serverCode = null;
+      serverReason = null;
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (session, task, protocol) {},
+          onWebSocketTaskClosed: (session, task, closeCode, reason) {
+        actualSession = session;
+        actualTask = task;
+        actualCloseCode = closeCode!;
+        actualReason = utf8.decode(reason!.bytes);
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}'));
+
+      final task = session.webSocketTaskWithRequest(request)..resume();
+
+      expect(
+          task.receiveMessage(),
+          throwsA(isA<Error>()
+              .having((e) => e.code, 'code', 57 // Socket is not connected.
+                  )));
+      await c.future;
+      expect(actualSession, session);
+      expect(actualTask, task);
+      expect(actualCloseCode, 1005);
+      expect(actualReason, '');
+    });
+
+    test('close code', () async {
+      final c = Completer<void>();
+      late int actualCloseCode;
+      late String? actualReason;
+      late URLSession actualSession;
+      late URLSessionWebSocketTask actualTask;
+
+      serverCode = 4000;
+      serverReason = null;
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (session, task, protocol) {},
+          onWebSocketTaskClosed: (session, task, closeCode, reason) {
+        actualSession = session;
+        actualTask = task;
+        actualCloseCode = closeCode!;
+        actualReason = utf8.decode(reason!.bytes);
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}'));
+
+      final task = session.webSocketTaskWithRequest(request)..resume();
+
+      expect(
+          task.receiveMessage(),
+          throwsA(isA<Error>()
+              .having((e) => e.code, 'code', 57 // Socket is not connected.
+                  )));
+      await c.future;
+      expect(actualSession, session);
+      expect(actualTask, task);
+      expect(actualCloseCode, serverCode);
+      expect(actualReason, '');
+    });
+
+    test('close code and reason', () async {
+      final c = Completer<void>();
+      late int actualCloseCode;
+      late String? actualReason;
+      late URLSession actualSession;
+      late URLSessionWebSocketTask actualTask;
+
+      serverCode = 4000;
+      serverReason = 'no real reason';
+
+      final session = URLSession.sessionWithConfiguration(config,
+          onWebSocketTaskOpened: (session, task, protocol) {},
+          onWebSocketTaskClosed: (session, task, closeCode, reason) {
+        actualSession = session;
+        actualTask = task;
+        actualCloseCode = closeCode!;
+        actualReason = utf8.decode(reason!.bytes);
+        c.complete();
+      });
+
+      final request = MutableURLRequest.fromUrl(
+          Uri.parse('http://localhost:${server.port}'));
+
+      final task = session.webSocketTaskWithRequest(request)..resume();
+
+      expect(
+          task.receiveMessage(),
+          throwsA(isA<Error>()
+              .having((e) => e.code, 'code', 57 // Socket is not connected.
+                  )));
+      await c.future;
+      expect(actualSession, session);
+      expect(actualTask, task);
+      expect(actualCloseCode, serverCode);
+      expect(actualReason, serverReason);
+    });
+  });
+}
+
 void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
@@ -446,6 +676,7 @@ void main() {
     testOnData(config);
     // onRedirect is not called for background sessions.
     testOnFinishedDownloading(config);
+    // WebSocket tasks are not supported in background sessions.
   });
 
   group('defaultSessionConfiguration', () {
@@ -455,6 +686,8 @@ void main() {
     testOnData(config);
     testOnRedirect(config);
     testOnFinishedDownloading(config);
+    testOnWebSocketTaskOpened(config);
+    testOnWebSocketTaskClosed(config);
   });
 
   group('ephemeralSessionConfiguration', () {
@@ -464,5 +697,7 @@ void main() {
     testOnData(config);
     testOnRedirect(config);
     testOnFinishedDownloading(config);
+    testOnWebSocketTaskOpened(config);
+    testOnWebSocketTaskClosed(config);
   });
 }
diff --git a/pkgs/cupertino_http/example/integration_test/url_session_task_test.dart b/pkgs/cupertino_http/example/integration_test/url_session_task_test.dart
@@ -46,6 +46,15 @@ void testWebSocketTask() {
       await server.close();
     });
 
+    test('background session', () {
+      final session = URLSession.sessionWithConfiguration(
+          URLSessionConfiguration.backgroundSession('background'));
+      expect(
+          () => session.webSocketTaskWithRequest(URLRequest.fromUrl(
+              Uri.parse('ws://localhost:${server.port}/?noclose'))),
+          throwsUnsupportedError);
+    });
+
     test('client code and reason', () async {
       final session = URLSession.sharedSession();
       final task = session.webSocketTaskWithRequest(URLRequest.fromUrl(