internal_logger.dart

// Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2019-2022 Datadog, Inc.

import 'package:flutter/foundation.dart';

import 'datadog_configuration.dart';
import 'datadog_sdk_platform_interface.dart';
import 'helpers.dart';

/// This class is used internally by the SDK to log issues to the client
/// developers. Note that all logging from the Flutter portions of the SDK are
/// disabled if kDebugMode is not set.
class InternalLogger {
  bool useEmoji = true;
  Verbosity sdkVerbosity = Verbosity.info;

  static const _emojiMap = {
    Verbosity.debug: '🐞',
    Verbosity.info: 'ℹ️',
    Verbosity.warn: '⚠️',
    Verbosity.error: '💥'
  };

  void debug(String message) => log(Verbosity.debug, message);
  void info(String message) => log(Verbosity.info, message);
  void warn(String message) => log(Verbosity.warn, message);
  void error(String message) => log(Verbosity.error, message);

  void log(Verbosity verbosity, String message) {
    if (kDebugMode && verbosity.index >= sdkVerbosity.index) {
      final prefixString = useEmoji
          ? '[Datadog 🐶${_emojiMap[verbosity]} ]'
          : '[Datadog - ${verbosity.name}]';
      // ignore: avoid_print
      print('$prefixString $message');
    }
  }

  /// Send a log to the Datadog org, not to the customer's org. This feature is
  /// used mostly to track potential issues in the Datadog SDK. The rate at which
  /// data is sent to Datadog is set by [DdSdkConfiguration.telemetrySampleRate]
  void sendToDatadog(String message, StackTrace? stack, String? kind) {
    DatadogSdkPlatform.instance
        .sendTelemetryError(message, stack.toString(), kind);
  }

  // Standard error strings
  static String argumentWarning(String methodName, ArgumentError e,
      Map<String, Object?>? serializedAttributes) {
    var warning =
        'ArgumentError when calling $methodName: parameter ${e.message}.';
    if (serializedAttributes != null) {
      final badAttribute = findInvalidAttribute(serializedAttributes);
      if (badAttribute != null) {
        warning +=
            ' It looks like ${badAttribute.propertyName} is of type ${badAttribute.propertyType}, which is not supported.';
      }
    }
    return warning;
  }
}