pkgs/http_profile/lib/src/http_client_request_profile.dart

// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
// 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.

part of 'http_profile.dart';

/// Describes an event related to an HTTP request.
final class HttpProfileRequestEvent {
  final int _timestamp;
  final String _name;

  DateTime get timestamp => DateTime.fromMicrosecondsSinceEpoch(_timestamp);

  String get name => _name;

  HttpProfileRequestEvent({required DateTime timestamp, required String name})
      : _timestamp = timestamp.microsecondsSinceEpoch,
        _name = name;

  static HttpProfileRequestEvent _fromJson(Map<String, dynamic> json) =>
      HttpProfileRequestEvent(
        timestamp:
            DateTime.fromMicrosecondsSinceEpoch(json['timestamp'] as int),
        name: json['event'] as String,
      );

  Map<String, dynamic> _toJson() => <String, dynamic>{
        'timestamp': _timestamp,
        'event': _name,
      };
}

/// A record of debugging information about an HTTP request.
final class HttpClientRequestProfile {
  /// Whether HTTP profiling is enabled or not.
  ///
  /// The value can be changed programmatically or through the DevTools Network
  /// UX.
  static bool get profilingEnabled => HttpClient.enableTimelineLogging;
  static set profilingEnabled(bool enabled) =>
      HttpClient.enableTimelineLogging = enabled;

  final _data = <String, dynamic>{};

  /// The HTTP request method associated with the request.
  String get requestMethod => _data['requestMethod'] as String;

  /// The URI to which the request was sent.
  String get requestUri => _data['requestUri'] as String;

  /// Records an event related to the request.
  ///
  /// Usage example:
  ///
  /// ```dart
  /// profile.addEvent(
  ///   HttpProfileRequestEvent(
  ///     timestamp: DateTime.now(),
  ///     name: "Connection Established",
  ///   ),
  /// );
  /// profile.addEvent(
  ///   HttpProfileRequestEvent(
  ///     timestamp: DateTime.now(),
  ///     name: "Remote Disconnected",
  ///   ),
  /// );
  /// ```
  void addEvent(HttpProfileRequestEvent event) {
    (_data['events'] as List<Map<String, dynamic>>).add(event._toJson());
    _updated();
  }

  /// An unmodifiable list containing the events related to the request.
  List<HttpProfileRequestEvent> get events =>
      UnmodifiableListView((_data['events'] as List<Map<String, dynamic>>).map(
        HttpProfileRequestEvent._fromJson,
      ));

  /// Information about the networking connection used.
  ///
  /// This information is meant to be used for debugging.
  ///
  /// It can contain any arbitrary data as long as the values are of type
  /// [String] or [int].
  ///
  /// This field can only be modified by assigning a Map to it. That is:
  /// ```dart
  /// // Valid
  /// profile?.connectionInfo = {
  ///   'localPort': 1285,
  ///   'remotePort': 443,
  ///   'connectionPoolId': '21x23',
  /// };
  ///
  /// // Invalid
  /// profile?.connectionInfo?['localPort'] = 1285;
  /// ```
  set connectionInfo(Map<String, dynamic /*String|int*/ >? value) {
    _updated();
    if (value == null) {
      requestData._requestData.remove('connectionInfo');
      responseData._responseData.remove('connectionInfo');
    } else {
      for (final v in value.values) {
        if (!(v is String || v is int)) {
          throw ArgumentError(
            'The values in connectionInfo must be of type String or int.',
          );
        }
      }
      requestData._requestData['connectionInfo'] = {...value};
      responseData._responseData['connectionInfo'] = {...value};
    }
  }

  Map<String, dynamic /*String|int*/ >? get connectionInfo =>
      requestData._requestData['connectionInfo'] == null
          ? null
          : UnmodifiableMapView(
              requestData._requestData['connectionInfo']
                  as Map<String, dynamic>,
            );

  /// Details about the request.
  late final HttpProfileRequestData requestData;

  /// Details about the response.
  late final HttpProfileResponseData responseData;

  void _updated() =>
      _data['_lastUpdateTime'] = DateTime.now().microsecondsSinceEpoch;

  HttpClientRequestProfile._({
    required DateTime requestStartTime,
    required String requestMethod,
    required String requestUri,
  }) {
    _data['isolateId'] = Service.getIsolateId(Isolate.current)!;
    _data['requestStartTimestamp'] = requestStartTime.microsecondsSinceEpoch;
    _data['requestMethod'] = requestMethod;
    _data['requestUri'] = requestUri;
    _data['events'] = <Map<String, dynamic>>[];
    _data['requestData'] = <String, dynamic>{};
    requestData = HttpProfileRequestData._(_data, _updated);
    _data['responseData'] = <String, dynamic>{};
    responseData = HttpProfileResponseData._(_data, _updated);
    _data['requestBodyBytes'] = <int>[];
    requestData._body.stream.listen(
        (final bytes) => (_data['requestBodyBytes'] as List<int>).addAll(bytes),
        onError: (e) {});
    _data['responseBodyBytes'] = <int>[];
    responseData._body.stream.listen(
        (final bytes) =>
            (_data['responseBodyBytes'] as List<int>).addAll(bytes),
        onError: (e) {});
    // This entry is needed to support the updatedSince parameter of
    // ext.dart.io.getHttpProfile.
    _updated();
  }

  /// If HTTP profiling is enabled, returns an [HttpClientRequestProfile],
  /// otherwise returns `null`.
  static HttpClientRequestProfile? profile({
    /// The time at which the request was initiated.
    required DateTime requestStartTime,

    /// The HTTP request method associated with the request.
    required String requestMethod,

    /// The URI to which the request was sent.
    required String requestUri,
  }) {
    // Always return `null` in product mode so that the profiling code can be
    // tree shaken away.
    if (const bool.fromEnvironment('dart.vm.product') || !profilingEnabled) {
      return null;
    }
    final requestProfile = HttpClientRequestProfile._(
      requestStartTime: requestStartTime,
      requestMethod: requestMethod,
      requestUri: requestUri,
    );
    addHttpClientProfilingData(requestProfile._data);
    return requestProfile;
  }
}