Properly check for callback arity in `shelf_web_socket` (#301)
Add argument types to callbacks in test, which would have caught this
bug. The implicit `dynamic` arguments match the `Function(Null, Null)`
check, but a callback with a more realistic non-nullable first argument
would not match.
diff --git a/pkgs/shelf_web_socket/CHANGELOG.md b/pkgs/shelf_web_socket/CHANGELOG.md
index 328a763..17014ba 100644
--- a/pkgs/shelf_web_socket/CHANGELOG.md
+++ b/pkgs/shelf_web_socket/CHANGELOG.md
@@ -1,6 +1,7 @@
## 1.0.3-dev
* Require Dart `2.17`.
+* Fix checking for binary callbacks with strong null safety.
## 1.0.2
diff --git a/pkgs/shelf_web_socket/lib/shelf_web_socket.dart b/pkgs/shelf_web_socket/lib/shelf_web_socket.dart
index 61ae886..c62ca25 100644
--- a/pkgs/shelf_web_socket/lib/shelf_web_socket.dart
+++ b/pkgs/shelf_web_socket/lib/shelf_web_socket.dart
@@ -43,7 +43,7 @@
{Iterable<String>? protocols,
Iterable<String>? allowedOrigins,
Duration? pingInterval}) {
- if (onConnection is! void Function(Null, Null)) {
+ if (onConnection is! void Function(Never, Never)) {
final innerOnConnection = onConnection;
// ignore: inference_failure_on_untyped_parameter
onConnection = (webSocket, _) => innerOnConnection(webSocket);
diff --git a/pkgs/shelf_web_socket/test/web_socket_test.dart b/pkgs/shelf_web_socket/test/web_socket_test.dart
index 5f6b1d8..b519592 100644
--- a/pkgs/shelf_web_socket/test/web_socket_test.dart
+++ b/pkgs/shelf_web_socket/test/web_socket_test.dart
@@ -2,14 +2,13 @@
// 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.
-// ignore_for_file: inference_failure_on_untyped_parameter
-
import 'dart:io';
import 'package:http/http.dart' as http;
import 'package:shelf/shelf_io.dart' as shelf_io;
import 'package:shelf_web_socket/shelf_web_socket.dart';
import 'package:test/test.dart';
+import 'package:web_socket_channel/web_socket_channel.dart';
Map<String, String> get _handshakeHeaders => {
'Upgrade': 'websocket',
@@ -20,7 +19,8 @@
void main() {
test('can communicate with a dart:io WebSocket client', () async {
- final server = await shelf_io.serve(webSocketHandler((webSocket) {
+ final server =
+ await shelf_io.serve(webSocketHandler((WebSocketChannel webSocket) {
webSocket.sink.add('hello!');
webSocket.stream.first.then((request) {
expect(request, equals('ping'));
@@ -53,7 +53,7 @@
test('negotiates the sub-protocol', () async {
final server = await shelf_io.serve(
- webSocketHandler((webSocket, protocol) {
+ webSocketHandler((WebSocketChannel webSocket, String? protocol) {
expect(protocol, equals('two'));
webSocket.sink.close();
}, protocols: ['three', 'two', 'x']),
@@ -71,7 +71,8 @@
});
test('handles protocol header without allowed protocols', () async {
- final server = await shelf_io.serve(webSocketHandler((webSocket) {
+ final server =
+ await shelf_io.serve(webSocketHandler((WebSocketChannel webSocket) {
webSocket.sink.close();
}), 'localhost', 0);
@@ -86,7 +87,8 @@
});
test('allows two argument callbacks without protocols', () async {
- final server = await shelf_io.serve(webSocketHandler((webSocket, protocol) {
+ final server = await shelf_io.serve(
+ webSocketHandler((WebSocketChannel webSocket, String? protocol) {
expect(protocol, isNull);
webSocket.sink.close();
}), 'localhost', 0);
@@ -106,7 +108,7 @@
late Uri url;
setUp(() async {
server = await shelf_io.serve(
- webSocketHandler((webSocket) {
+ webSocketHandler((WebSocketChannel webSocket) {
webSocket.sink.close();
}, allowedOrigins: ['pub.dartlang.org', 'GoOgLe.CoM']),
'localhost',
@@ -147,7 +149,8 @@
// Regression test for issue 21894.
test('allows a Connection header with multiple values', () async {
- final server = await shelf_io.serve(webSocketHandler((webSocket) {
+ final server =
+ await shelf_io.serve(webSocketHandler((WebSocketChannel webSocket) {
webSocket.sink.close();
}), 'localhost', 0);
