Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug daps 1243 datafed web logging #1251

Merged
merged 4 commits into from
Jan 23, 2025
Merged

Conversation

t-ramz
Copy link
Collaborator

@t-ramz t-ramz commented Jan 22, 2025

Closes #1243

PR Description

Quick fix for the first part of linked ticket

Tasks

  • - A description of the PR has been provided, and a diagram included if it is a new feature.
  • - Formatter has been run
  • - CHANGELOG comment has been added
  • - Labels have been assigned to the pr
  • - A reviwer has been added
  • - A user has been assigned to work on the pr
  • - If new feature a unit test has been added

Summary by Sourcery

Bug Fixes:

  • Correct the numeric values assigned to the log levels.

@t-ramz t-ramz added Type: Bug Something isn't working Component: Web API Relates to web service / API Component: Web UI Relates to web appp user interface labels Jan 22, 2025
@t-ramz t-ramz self-assigned this Jan 22, 2025
Copy link

sourcery-ai bot commented Jan 22, 2025

Reviewer's Guide by Sourcery

This pull request reverses the order of the LogLevel enum to match the severity of the log levels, with CRITICAL being the most severe and TRACE being the least severe.

Class diagram showing updated LogLevel enumeration

classDiagram
    class LogLevel {
        <<enumeration>>
        CRITICAL: 0
        ERROR: 1
        WARNING: 2
        INFO: 3
        DEBUG: 4
        TRACE: 5
    }
    note for LogLevel "Log levels reordered by severity:
CRITICAL (most severe) = 0
TRACE (least severe) = 5"
Loading

File-Level Changes

Change Details Files
Reversed the order of the LogLevel enum.
  • The order of the LogLevel enum was changed to have CRITICAL as the first element and TRACE as the last element.
web/datafed-ws.js

Assessment against linked issues

Issue Objective Addressed Explanation
#1243 Error and critical logs take precedence over info and debug
#1243 Line numbers should be correct on logs, with a visual artifact The PR does not modify the getCurrentLineNumber function or address line number accuracy

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @t-ramz - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Reversing the numeric values of log levels is a breaking change that could cause silent failures (link)

Overall Comments:

  • Please provide justification for reordering the LogLevel enum values. This could break any code that depends on the numeric values. Have you verified there are no such dependencies?
  • Several PR checklist items are incomplete, including the changelog entry. Please complete these before requesting review.
Here's what I looked at during the review
  • 🔴 General issues: 1 blocking issue
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +85 to +90
CRITICAL: 0,
ERROR: 1,
WARNING: 2,
INFO: 3,
DEBUG: 4,
TRACE: 5,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Reversing the numeric values of log levels is a breaking change that could cause silent failures

While aligning with Unix conventions (lower numbers for higher severity), this change could break existing code that relies on numeric comparisons or persisted log levels. Consider either keeping the original values or implementing a migration strategy that ensures backward compatibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the immediately following logic, the logging was already broken. This is a bug fix.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your feedback, we will generate fewer comments like this in the future.

@t-ramz t-ramz linked an issue Jan 23, 2025 that may be closed by this pull request
2 tasks
@t-ramz t-ramz merged commit fcf4780 into devel Jan 23, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Web API Relates to web service / API Component: Web UI Relates to web appp user interface Type: Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug, Web, Logs] Fix logging settings in datafed-ws.js
2 participants