[ Edit ] exposed logging functionality fot full responses, moved the web enabling to be set dynamically without user interaction

Author: anasfik

example/lib/log_response_bodies.dart

@@ -0,0 +1,12 @@
+import 'package:dart_openai/dart_openai.dart';
+import 'package:example/env/env.dart';
+
+void main() {
+  OpenAI.showLogs = true;
+  OpenAI.showResponsesLogs = true;
+  OpenAI.apiKey = Env.apiKey;
+
+  final models = OpenAI.instance.model.list();
+
+  print(models);
+}

example/lib/setting_for_web_env.dart

@@ -1,7 +1,7 @@
-import 'package:dart_openai/dart_openai.dart';
+// import 'package:dart_openai/dart_openai.dart';
 
-void main() {
-  OpenAI.isWeb = true;
+// void main() {
+//   OpenAI.isWeb = true;
 
-  print(OpenAI.isWeb);
-}
+//   print(OpenAI.isWeb);
+// }

example/pubspec.lock

@@ -159,7 +159,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "4.0.0"
+    version: "4.1.4"
   dart_style:
     dependency: transitive
     description:

lib/src/core/constants/config.dart

@@ -21,10 +21,10 @@ abstract class OpenAIConfig {
   /// {@endtemplate}
   static String? _baseUrl;
 
-  /// {@template openai_config_is_web}
-  /// This is a flag that indicates if the library is running on the web or not.
-  /// {@endtemplate}
-  static bool _isWeb = false;
+  // /// {@template openai_config_is_web}
+  // /// This is a flag that indicates if the library is running on the web or not.
+  // /// {@endtemplate}
+  // static bool _isWeb = false;
 
   /// This is the version of the API.
   static String get version => OpenAIStrings.version;
@@ -35,18 +35,18 @@ abstract class OpenAIConfig {
     return _baseUrl ?? OpenAIStrings.defaultBaseUrl;
   }
 
-  /// {@macro openai_config_is_web}
-  static bool get isWeb => _isWeb;
+  // /// {@macro openai_config_is_web}
+  // static bool get isWeb => _isWeb;
 
   @internal
   static set baseUrl(String? baseUrl) {
     _baseUrl = baseUrl;
     OpenAILogger.logBaseUrl(_baseUrl);
   }
 
-  @internal
-  static set isWeb(bool isWeb) {
-    _isWeb = isWeb;
-    OpenAILogger.logIsWeb(_isWeb);
-  }
+  // @internal
+  // static set isWeb(bool isWeb) {
+  //   _isWeb = isWeb;
+  //   OpenAILogger.logIsWeb(_isWeb);
+  // }
 }

lib/src/core/networking/client.dart

@@ -11,7 +11,10 @@ import "package:http/http.dart" as http;
 import "package:meta/meta.dart";
 
 import '../constants/strings.dart';
-import "../utils/streaming_http_client.dart";
+
+import "../utils/streaming_http_client_default.dart"
+    if (dart.library.js) 'package:dart_openai/src/core/utils/streaming_http_client_web.dart'
+    if (dart.library.io) 'package:dart_openai/src/core/utils/streaming_http_client_io.dart';
 
 /// Handling exceptions returned by OpenAI Stream API.
 final class _OpenAIChatStreamSink implements EventSink<String> {
@@ -99,6 +102,8 @@ abstract class OpenAINetworkingClient {
             .timeout(OpenAIConfig.requestsTimeOut)
         : await client.get(uri, headers: headers);
 
+    OpenAILogger.logResponseBody(response);
+
     if (returnRawResponse) {
       return response.body as T;
     }
@@ -295,6 +300,8 @@ abstract class OpenAINetworkingClient {
             .timeout(OpenAIConfig.requestsTimeOut)
         : await client.post(uri, headers: headers, body: handledBody);
 
+    OpenAILogger.logResponseBody(response);
+
     OpenAILogger.requestToWithStatusCode(to, response.statusCode);
 
     OpenAILogger.startingDecoding();
@@ -467,6 +474,8 @@ abstract class OpenAINetworkingClient {
 
     final String encodedBody = await response.stream.bytesToString();
 
+    OpenAILogger.logResponseBody(response);
+
     final Map<String, dynamic> decodedBody = decodeToMap(encodedBody);
 
     OpenAILogger.decodedSuccessfully();
@@ -518,6 +527,8 @@ abstract class OpenAINetworkingClient {
 
     final String encodedBody = await response.stream.bytesToString();
 
+    OpenAILogger.logResponseBody(response);
+
     final Map<String, dynamic> decodedBody = decodeToMap(encodedBody);
 
     OpenAILogger.decodedSuccessfully();
@@ -564,6 +575,8 @@ abstract class OpenAINetworkingClient {
     final http.StreamedResponse response =
         await request.send().timeout(OpenAIConfig.requestsTimeOut);
 
+    OpenAILogger.logResponseBody(response);
+
     OpenAILogger.requestToWithStatusCode(to, response.statusCode);
 
     OpenAILogger.startingDecoding();
@@ -612,6 +625,8 @@ abstract class OpenAINetworkingClient {
             .timeout(OpenAIConfig.requestsTimeOut)
         : await client.delete(uri, headers: headers);
 
+    OpenAILogger.logResponseBody(response);
+
     OpenAILogger.requestToWithStatusCode(from, response.statusCode);
 
     OpenAILogger.startingDecoding();
@@ -660,10 +675,6 @@ abstract class OpenAINetworkingClient {
   }
 
   static http.Client _streamingHttpClient() {
-    if (OpenAIConfig.isWeb) {
-      return createWebClient();
-    } else {
-      return createIoClient();
-    }
+    return createClient();
   }
 }

lib/src/core/utils/logger.dart

@@ -1,5 +1,6 @@
 import 'dart:developer' as dev;
 
+import 'package:http/http.dart';
 import 'package:meta/meta.dart';
 
 import '../constants/strings.dart';
@@ -8,28 +9,65 @@ import '../constants/strings.dart';
 @immutable
 @internal
 abstract final class OpenAILogger {
-  /// This represents the default value of the logger active state.
+  /// {@template openai_logger_is_active}
+  /// Wether the to show operations flow logger is active or not.
+  /// {@endtemplate}
   static bool _isActive = true;
 
+  /// {@template openai_logger_show_responses_logs}
+  /// Wether to show operations response bodies in logs or not.
+  /// {@endtemplate}
+  static bool _showResponsesLogs = false;
+
+  /// {@macro openai_logger_is_active}
   static bool get isActive => _isActive;
 
+  /// {@macro openai_logger_show_responses_logs}
+  static bool get showResponsesLogs => _showResponsesLogs;
+
   /// Changes the logger active state.
   ///
   /// if true, the logger will log messages.
   /// If false, the logger will not log messages.
   ///
-  /// The default value is [_isActive].
+  /// The default value is [true].
   static set isActive(bool newValue) {
     _isActive = newValue;
   }
 
+  /// Changes the logger show responses logs state.
+  ///
+  /// if true, the logger will log responses bodies.
+  /// If false, the logger will not log responses bodies.
+  ///
+  /// The default value is [false].
+  static set showResponsesLogs(bool newValue) {
+    _showResponsesLogs = newValue;
+  }
+
   /// Logs a message, if the logger is active.
   static void log(String message, [Object? error]) {
     if (_isActive) {
       dev.log(message, name: OpenAIStrings.openai, error: error);
     }
   }
 
+  /// Logs the response of a request, if the logger is active.
+  static Future<void> logResponseBody(response) async {
+    if (_isActive && _showResponsesLogs) {
+      if (response is Response) {
+        dev.log(response.body.toString(), name: OpenAIStrings.openai);
+      } else if (response is StreamedResponse) {
+        final asString = await response.stream.bytesToString();
+
+        dev.log(
+          asString,
+          name: OpenAIStrings.openai,
+        );
+      }
+    }
+  }
+
   /// Logs that a request to an [endpoint] is being made, if the logger is active.
   static void logEndpoint(String endpoint) {
     log("accessing endpoint: $endpoint");

lib/src/core/utils/streaming_http_client.dart

@@ -0,0 +1,2 @@
+createClient() =>
+    UnsupportedError('Cannot create a client without dart:html or dart:io.');

lib/src/core/utils/streaming_http_client_default.dart

@@ -0,0 +1,3 @@
+import 'package:http/http.dart' as http;
+
+http.Client createClient() => http.Client();

lib/src/core/utils/streaming_http_client_io.dart

@@ -0,0 +1,4 @@
+import 'package:fetch_client/fetch_client.dart' as fetch;
+
+fetch.FetchClient createClient() =>
+    fetch.FetchClient(mode: fetch.RequestMode.cors);