feat: Introduce strongly-typed Relic Address (#24)

README.md

@@ -35,7 +35,11 @@ void main() async {
   var handler =
       const Pipeline().addMiddleware(logRequests()).addHandler(_echoRequest);
 
-  var server = await serve(handler, 'localhost', 8080);
+  var server = await serve(
+    handler,
+    RelicAddress.fromHostname('localhost'),
+    8080,
+  );
 
   // Enable content compression
   server.autoCompress = true;

analysis_options.yaml

@@ -1 +1,6 @@
 include: package:lints/recommended.yaml
+
+linter:
+  rules:
+      - avoid_dynamic_calls
+      - unawaited_futures

example/example.dart

@@ -4,7 +4,11 @@ void main() async {
   var handler =
       const Pipeline().addMiddleware(logRequests()).addHandler(_echoRequest);
 
-  var server = await serve(handler, 'localhost', 8080);
+  var server = await serve(
+    handler,
+    RelicAddress.fromHostname('localhost'),
+    8080,
+  );
 
   // Enable content compression
   server.autoCompress = true;

lib/relic.dart

@@ -28,6 +28,8 @@ export 'src/middleware/middleware.dart' show Middleware, createMiddleware;
 export 'src/middleware/middleware_extensions.dart' show MiddlewareExtensions;
 
 /// Relic server related exports
+export 'src/address/relic_address.dart' show RelicAddress;
+export 'dart:io' show InternetAddress;
 export 'src/relic_server.dart' show RelicServer;
 export 'src/relic_server_serve.dart' show serve;
 

lib/src/address/relic_address.dart

@@ -0,0 +1,54 @@
+import 'dart:io';
+
+/// A class that represents an address.
+abstract final class RelicAddress<T> {
+  /// Returns the address as an [Object].
+  T get address;
+
+  /// Creates a [RelicAddress] from a [String].
+  static RelicAddress<String> fromHostname(String hostname) {
+    return _RelicHostnameAddress(hostname: hostname);
+  }
+
+  /// Creates a [RelicAddress] from an [InternetAddress].
+  static RelicAddress<InternetAddress> fromInternetAddress(
+    InternetAddress address,
+  ) {
+    return _RelicInternetAddress(internetAddress: address);
+  }
+}
+
+/// A class that represents a hostname address.
+final class _RelicHostnameAddress implements RelicAddress<String> {
+  /// The hostname of the address.
+  final String hostname;
+
+  _RelicHostnameAddress({
+    required this.hostname,
+  });
+
+  /// Returns the address as a [String].
+  @override
+  String get address => hostname;
+
+  @override
+  String toString() => 'RelicHostnameAddress(hostname: $hostname)';
+}
+
+/// A class that represents an internet address.
+final class _RelicInternetAddress implements RelicAddress<InternetAddress> {
+  /// The internet address of the address.
+  final InternetAddress internetAddress;
+
+  _RelicInternetAddress({
+    required this.internetAddress,
+  });
+
+  /// Returns the address as an [InternetAddress].
+  @override
+  InternetAddress get address => internetAddress;
+
+  @override
+  String toString() =>
+      'RelicInternetAddress(internetAddress: $internetAddress)';
+}

lib/src/headers/headers.dart

@@ -1389,7 +1389,7 @@ final class _HeadersImpl extends Headers {
     return map;
   }
 
-  /// Date-related headers
+  /// Date related headers
   Map<String, DateTime?> get _dateHeadersMap => {
         Headers.dateHeader: date ?? DateTime.now().toUtc(),
         Headers.expiresHeader: expires,
@@ -1413,7 +1413,7 @@ final class _HeadersImpl extends Headers {
             accessControlRequestMethod?.value,
       };
 
-  /// List<String>-related headers
+  /// String list related headers
   Map<String, List<String>?> get _listStringHeadersMap =>
       <String, List<String>?>{
         Headers.viaHeader: via,
@@ -1422,7 +1422,7 @@ final class _HeadersImpl extends Headers {
         Headers.trailerHeader: trailer,
       };
 
-  /// Uri-related headers
+  /// Uri related headers
   Map<String, Uri?> get _uriHeadersMap => <String, Uri?>{
         Headers.locationHeader: location,
         Headers.refererHeader: referer,
@@ -1431,7 +1431,7 @@ final class _HeadersImpl extends Headers {
         Headers.hostHeader: host,
       };
 
-  /// TypedHeader-related headers
+  /// TypedHeader related headers
   Map<String, TypedHeader?> get _typedHeadersMap => <String, TypedHeader?>{
         Headers.fromHeader: from,
         Headers.acceptEncodingHeader: acceptEncoding,

lib/src/relic_server.dart

@@ -1,6 +1,7 @@
 import 'dart:async';
 import 'dart:io';
 
+import 'package:relic/src/address/relic_address.dart';
 import 'package:relic/src/body/body.dart';
 import 'package:relic/src/hijack/exception/hijack_exception.dart';
 import 'package:relic/src/headers/exception/invalid_header_exception.dart';
@@ -50,7 +51,7 @@ class RelicServer {
 
   /// Creates a server with the given parameters.
   static Future<RelicServer> createServer(
-    Object address,
+    RelicAddress address,
     int port, {
     SecurityContext? securityContext,
     int? backlog,
@@ -59,21 +60,21 @@ class RelicServer {
     String? poweredByHeader,
   }) async {
     backlog ??= 0;
-    var server = switch (securityContext == null) {
-      true => await HttpServer.bind(
-          address,
-          port,
-          backlog: backlog,
-          shared: shared,
-        ),
-      false => await HttpServer.bindSecure(
-          address,
-          port,
-          securityContext!,
-          backlog: backlog,
-          shared: shared,
-        ),
-    };
+    var server = securityContext == null
+        ? await HttpServer.bind(
+            address.address,
+            port,
+            backlog: backlog,
+            shared: shared,
+          )
+        : await HttpServer.bindSecure(
+            address.address,
+            port,
+            securityContext,
+            backlog: backlog,
+            shared: shared,
+          );
+
     return RelicServer._(
       server,
       strictHeaders: strictHeaders,

lib/src/relic_server_serve.dart

@@ -20,6 +20,7 @@ library;
 import 'dart:async';
 import 'dart:io' as io;
 
+import 'package:relic/src/address/relic_address.dart';
 import 'package:relic/src/relic_server.dart';
 
 import 'handler/handler.dart';
@@ -43,7 +44,7 @@ import 'message/response.dart';
 /// {@endtemplate}
 Future<io.HttpServer> serve(
   Handler handler,
-  Object address,
+  RelicAddress address,
   int port, {
   io.SecurityContext? securityContext,
   int? backlog,

pubspec.yaml

@@ -17,7 +17,7 @@ dependencies:
   convert: ^3.1.1
 
 dev_dependencies:
-  dart_flutter_team_lints: ^3.0.0
+  lints: '>=3.0.0 <5.0.0'
   http: '>=1.0.0 <2.0.0'
   test: ^1.24.2
   test_descriptor: ^2.0.1

test/headers/basic/access_control_allow_credentials_header_test.dart

@@ -1,4 +1,3 @@
-import 'dart:io';
 import 'package:test/test.dart';
 import 'package:relic/src/headers/headers.dart';
 import 'package:relic/src/relic_server.dart';
@@ -21,19 +20,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: true,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: true,
-        );
-      }
+      server = await createServer(strictHeaders: true);
     });
 
     tearDown(() => server.close());
@@ -132,19 +119,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: false,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: false,
-        );
-      }
+      server = await createServer(strictHeaders: false);
     });
 
     tearDown(() => server.close());

test/headers/basic/access_control_max_age_header_test.dart

@@ -1,4 +1,3 @@
-import 'dart:io';
 import 'package:test/test.dart';
 import 'package:relic/src/headers/headers.dart';
 import 'package:relic/src/relic_server.dart';
@@ -13,19 +12,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: true,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: true,
-        );
-      }
+      server = await createServer(strictHeaders: true);
     });
 
     tearDown(() => server.close());
@@ -113,19 +100,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: false,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: false,
-        );
-      }
+      server = await createServer(strictHeaders: false);
     });
 
     tearDown(() => server.close());

test/headers/basic/access_control_request_headers_heder_test.dart

@@ -1,4 +1,3 @@
-import 'dart:io';
 import 'package:test/test.dart';
 import 'package:relic/src/headers/headers.dart';
 import 'package:relic/src/relic_server.dart';
@@ -15,19 +14,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: true,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: true,
-        );
-      }
+      server = await createServer(strictHeaders: true);
     });
 
     tearDown(() => server.close());
@@ -130,19 +117,7 @@ void main() {
     late RelicServer server;
 
     setUp(() async {
-      try {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv6,
-          0,
-          strictHeaders: false,
-        );
-      } on SocketException catch (_) {
-        server = await RelicServer.createServer(
-          InternetAddress.loopbackIPv4,
-          0,
-          strictHeaders: false,
-        );
-      }
+      server = await createServer(strictHeaders: false);
     });
 
     tearDown(() => server.close());