🧑‍💻 Move logs out from the adapter (#2260)

Resolves #2255
cfug · Jul 1, 2024 · eb1684e · eb1684e
1 parent 224db94
commit eb1684e
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 18 deletions.
diff --git a/dio/CHANGELOG.md b/dio/CHANGELOG.md
@@ -16,6 +16,7 @@ See the [Migration Guide][] for the complete breaking changes list.**
 - If the `CancelToken` got canceled before making requests,
   throws the exception directly rather than cut actual HTTP requests afterward.
 - Catch `MediaType` parse exception in `Transformer.isJsonMimeType`.
+- Improves warning logs on the Web platform.
 
 ## 5.4.3+1
 

diff --git a/dio/lib/src/interceptors/imply_content_type.dart b/dio/lib/src/interceptors/imply_content_type.dart
@@ -26,7 +26,7 @@ class ImplyContentTypeInterceptor extends Interceptor {
       } else if (data is List<Map> || data is Map || data is String) {
         contentType = Headers.jsonContentType;
       } else {
-        debugLog(
+        warningLog(
           '${data.runtimeType} cannot be used '
           'to imply a default content-type, '
           'please set a proper content-type in the request.',

diff --git a/dio/lib/src/options.dart b/dio/lib/src/options.dart
@@ -309,6 +309,20 @@ class Options {
     ProgressCallback? onReceiveProgress,
     StackTrace? sourceStackTrace,
   }) {
+    if (data != null && kIsWeb) {
+      if (sendTimeout != null && sendTimeout! > Duration.zero) {
+        warningLog(
+          'sendTimeout cannot be used without a request body to send on Web',
+          StackTrace.current,
+        );
+      }
+      if (onSendProgress != null) {
+        warningLog(
+          'onSendProgress cannot be used without a request body to send on Web',
+          StackTrace.current,
+        );
+      }
+    }
     final query = <String, dynamic>{};
     query.addAll(baseOpt.queryParameters);
     if (queryParameters != null) {

diff --git a/dio/lib/src/transformer.dart b/dio/lib/src/transformer.dart
@@ -84,7 +84,7 @@ abstract class Transformer {
           mediaType.mimeType == 'text/json' ||
           mediaType.subtype.endsWith('+json');
     } catch (e, s) {
-      debugLog(
+      warningLog(
         'Failed to parse the media type: $contentType, '
         'thus it is not a JSON MIME type.',
         s,
@@ -104,7 +104,7 @@ abstract class Transformer {
       if (data is Map<String, dynamic>) {
         return Transformer.urlEncodeMap(data, options.listFormat);
       }
-      debugLog(
+      warningLog(
         'The data is a type of `Map` (${data.runtimeType}), '
         'but the transformer can only encode `Map<String, dynamic>`.\n'
         'If you are writing maps using `{}`, '

diff --git a/dio/lib/src/utils.dart b/dio/lib/src/utils.dart
@@ -154,7 +154,7 @@ Map<String, V> caseInsensitiveKeyMap<V>([Map<String, V>? value]) {
 }
 
 // TODO(Alex): Provide a configurable property on the Dio class once https://github.com/cfug/dio/discussions/1982 has made some progress.
-void debugLog(String message, StackTrace stackTrace) {
+void warningLog(String message, StackTrace stackTrace) {
   if (!kReleaseMode) {
     dev.log(
       message,

diff --git a/plugins/web_adapter/lib/src/html/adapter.dart b/plugins/web_adapter/lib/src/html/adapter.dart
@@ -144,19 +144,6 @@ class BrowserHttpClientAdapter implements HttpClientAdapter {
           }
         });
       }
-    } else {
-      if (sendTimeout > Duration.zero) {
-        debugLog(
-          'sendTimeout cannot be used without a request body to send',
-          StackTrace.current,
-        );
-      }
-      if (options.onSendProgress != null) {
-        debugLog(
-          'onSendProgress cannot be used without a request body to send',
-          StackTrace.current,
-        );
-      }
     }
 
     final receiveStopwatch = Stopwatch();
@@ -268,7 +255,7 @@ class BrowserHttpClientAdapter implements HttpClientAdapter {
 
     if (requestStream != null) {
       if (options.method == 'GET') {
-        debugLog(
+        warningLog(
           'GET request with a body data are not support on the '
           'web platform. Use POST/PUT instead.',
           StackTrace.current,