Add log timestamp option to Dio logger settings

[azaderdogan]

• Introduced logTimestamp setting in TalkerDioLoggerSettings to control timestamp logging.
• Updated DioRequestLog, DioResponseLog, and DioErrorLog to include timestamp in log messages when logTimestamp is enabled.

Thanks a lot for contributing!

Provide a description of your changes below
#412

Summary by Sourcery

New Features:

• Add logTimestamp option to TalkerDioLoggerSettings to toggle timestamp inclusion in logs

[sourcery-ai]

Reviewer's Guide

This PR adds an optional timestamp feature to the Dio logger by introducing a new logTimestamp setting and updating all log types to include the timestamp when enabled.

Sequence diagram for logging with timestamp option

sequenceDiagram
    participant App
    participant Logger
    participant Settings
    App->>Logger: Log request/response/error
    Logger->>Settings: Check logTimestamp
    alt logTimestamp enabled
        Logger->>Logger: Add timestamp to log message
    else logTimestamp disabled
        Logger->>Logger: Log message without timestamp
    end

Loading

Class diagram for updated TalkerDioLoggerSettings and log classes

classDiagram
    class TalkerDioLoggerSettings {
      +bool printRequestData
      +bool printRequestHeaders
      +bool printRequestExtra
      +bool logTimestamp
      +Set<String> hiddenHeaders
      +Function? responseDataConverter
      +AnsiPen? requestPen
      +AnsiPen? responsePen
      +AnsiPen? errorPen
      +copyWith(...)
    }
    class DioRequestLog {
      +DioRequestLog(...)
      +displayTime(...)
    }
    class DioResponseLog {
      +DioResponseLog(...)
      +displayTime(...)
    }
    class DioErrorLog {
      +DioErrorLog(...)
      +displayTime(...)
    }
    TalkerDioLoggerSettings <|-- DioRequestLog
    TalkerDioLoggerSettings <|-- DioResponseLog
    TalkerDioLoggerSettings <|-- DioErrorLog

Loading

File-Level Changes

Change	Details	Files
Introduce logTimestamp setting in TalkerDioLoggerSettings	Add logTimestamp field with default false Document the new logTimestamp option Include logTimestamp parameter in constructor Support logTimestamp in the copyWith method	talker_dio_logger_settings.dart
Conditionally include timestamps in generated log messages	Wrap log message formatting in if (settings.logTimestamp) Append timestamp using displayTime(TimeFormat.yearMonthDayAndTime) Apply to request, response, and error logs	dio_logs.dart

Possibly linked issues

• Adding the timestamp to the Dio Logs #412: The PR adds a logTimestamp setting and updates DioRequestLog, DioResponseLog, and DioErrorLog to include timestamps.
• Adding the timestamp to the Dio Logs #412: The PR adds a log timestamp option to talker_dio_logger settings, which utilizes the new TimeFormat functionality as required by the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Consider refactoring the timestamp-appending logic into a shared helper method to reduce duplication across request, response, and error logs.
• It might be helpful to allow customizing the timestamp format or its label via settings to make the logger more flexible and consistent with other fields.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider refactoring the timestamp-appending logic into a shared helper method to reduce duplication across request, response, and error logs.
- It might be helpful to allow customizing the timestamp format or its label via settings to make the logger more flexible and consistent with other fields.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}