Reviewer's Guide

Adjusts general log settings validation and UI to allow zero values for several numeric fields while preventing an invalid combination for archive settings when archiving is enabled.

Sequence diagram for updated log archive validation when zero values are allowed

sequenceDiagram
  actor User
  participant LogSettingsForm
  participant GeneralSettingsComponent

  User->>LogSettingsForm: Enter values for archiveRetainedCount and archiveTimeLimitHours
  LogSettingsForm->>GeneralSettingsComponent: Update logArchiveRetainedCount
  GeneralSettingsComponent->>GeneralSettingsComponent: compute logArchiveRetainedError()
  alt retainedCount < 0
    GeneralSettingsComponent-->>LogSettingsForm: error Minimum value is 0
  else retainedCount > 100
    GeneralSettingsComponent-->>LogSettingsForm: error Maximum value is 100
  else archiving enabled AND retainedCount == 0 AND archiveTimeLimitHours == 0
    GeneralSettingsComponent-->>LogSettingsForm: error Retained count and time limit cannot both be 0 when archiving is enabled
  else
    GeneralSettingsComponent-->>LogSettingsForm: no error
  end

  LogSettingsForm->>GeneralSettingsComponent: Update logArchiveTimeLimitHours
  GeneralSettingsComponent->>GeneralSettingsComponent: compute logArchiveTimeLimitError()
  alt timeLimit < 0
    GeneralSettingsComponent-->>LogSettingsForm: error Minimum value is 0
  else timeLimit > 1440
    GeneralSettingsComponent-->>LogSettingsForm: error Maximum value is 1440 hours (60 days)
  else archiving enabled AND timeLimit == 0 AND archiveRetainedCount == 0
    GeneralSettingsComponent-->>LogSettingsForm: error Retained count and time limit cannot both be 0 when archiving is enabled
  else
    GeneralSettingsComponent-->>LogSettingsForm: no error
  end

  LogSettingsForm-->>User: Show updated validation messages and allow zero where valid

File-Level Changes

Possibly linked issues

• [BUG] Can't disable time limit for log files #569: The PR updates log time-limit inputs to accept 0 as unlimited, which directly fixes the reported bug.

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.