Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[talker_riverpod_logger] add family arguments to the logs #377

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jun 13, 2025
Merged

[talker_riverpod_logger] add family arguments to the logs #377

merged 5 commits into from
Jun 13, 2025

Conversation

@lucavenir
Copy link
Contributor

@lucavenir lucavenir commented May 31, 2025 •
edited
Loading

Changes description

Logging which provider of a family actually initialized, updated, disposed or failed is so much useful!
This helps both in development mode and in any analytics / crashlytics tools.

I noticed talker does a lot of effort to print provider base info, and forgets to print a provider's arguments.
That's why I chose to simply exploit riverpod's provider.toString() - logging utilities in riverpod are ready made!

(yes' I've added a test included ofc)

Summary by Sourcery

Enhance the riverpod logger to include family provider arguments in log messages across all provider lifecycle events.

New Features:

  • Log family provider arguments alongside provider names in lifecycle events

Enhancements:

  • Update default log message builder to append the provider.argument suffix when present

Tests:

  • Add unit tests verifying that family provider logs include arguments for add, update, dispose, and failure events

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 31, 2025 •
edited
Loading

Reviewer's Guide

This PR enhances the Riverpod logger to append family-argument suffixes to provider log messages and adds corresponding tests verifying the new behavior.

File-Level Changes

Change Details Files
Include family-argument suffix in log output
  • Refactored _defaultMessage to accumulate output string
  • Preserve provider.name and runtimeType formatting
  • Check and append provider.argument as '(argument)' before suffix
 riverpod_logs.dart
Add tests covering providers with family arguments
  • Imported dart:async and defined FamilyTestNotifier extending FamilyNotifier
  • Declared familyProvider and familyErrorProvider for both sync and error cases
  • Added 'with arguments' test group for didAdd, didUpdate, didDispose, and providerDidFail scenarios
 observer_test.dart
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

sourcery-ai[bot]
sourcery-ai bot reviewed May 31, 2025
View reviewed changes
Copy link
Contributor

@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 @lucavenir - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@lucavenir lucavenir mentioned this pull request Jun 7, 2025
Merged
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5e6705e) to head (c4e7cd2).
Report is 20 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@             Coverage Diff             @@
##           master      #377      +/-   ##
===========================================
+ Coverage   98.61%   100.00%   +1.38%     
===========================================
  Files           3         3              
  Lines         144        82      -62     
===========================================
- Hits          142        82      -60     
+ Misses          2         0       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Frezyx Frezyx merged commit 85c685c into Frezyx:master Jun 13, 2025
1 check passed
@lucavenir lucavenir mentioned this pull request Sep 1, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@Frezyx Frezyx Frezyx approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lucavenir @codecov-commenter @Frezyx