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

Fix: Properly Handle Internet Connectivity in CustomProgressDialog Widget #2736

Conversation

may-tas
Copy link
Contributor

@may-tas may-tas commented Feb 8, 2025

What kind of change does this PR introduce?

  • Fix CustomProgressDialog offline state verification

Issue Number:

Fixes #2735

Did you add tests for your changes?

  • Yes

  • Tests are written for all changes made in this PR.

  • Test coverage meets or exceeds the current coverage (~90/95%).

Snapshots/Videos:

Screenshot 2025-02-08 at 2 09 15 PM

Summary

  • This PR fixes an issue where the CustomProgressDialog widget was not properly handling internet connectivity. Previously, it always displayed a loading indicator, even when there was no internet connection. Now, it correctly displays a "No Internet" image and text when connectivity is absent, as per the documentation.
  • Added additional tests to increase code coverage.

Does this PR introduce a breaking change?

  • No

Checklist for Repository Standards

  • Have you reviewed and implemented all applicable coderaabbitai review suggestions?
  • Have you ensured that the PR aligns with the repository’s contribution guidelines?

Have you read the contributing guide?

  • Yes

Summary by CodeRabbit

  • New Features

    • The progress dialog now adapts to connectivity changes, displaying a loading indicator when online and a tailored image with a “No Internet” message when offline for improved user feedback.
    • Introduced a new index property in the CustomListTile widget for enhanced functionality.
    • Added a build method for the CustomCarouselScrollerState and PostContainerState classes to improve the rendering of carousel and post widgets.
  • Tests

    • Expanded test coverage for the progress dialog to ensure it reliably reflects both connectivity and offline states.

Copy link
Contributor

coderabbitai bot commented Feb 8, 2025

Walkthrough

The changes update the CustomProgressDialog widget to conditionally render its UI based on connectivity status. When connectivity is available, the widget displays a CupertinoActivityIndicator. In the absence of connectivity, it now shows a Column containing a no-internet image and a localized "No Internet" message. The corresponding test file has been updated to validate these behaviors and check styling properties. Additionally, required imports for localization and connectivity view model support have been added.

Changes

File Change Summary
lib/.../custom_progress_dialog.dart Modified widget to check connectivity: displays CupertinoActivityIndicator if online, otherwise shows a Column with no-internet image and localized text; added app_localization import.
test/.../custom_progress_dialog_test.dart Updated tests to verify UI styling and conditional rendering based on connectivity; added connectivity_view_model import; introduced tests for both connectivity and non-connectivity states.
docs/.../widgets_custom_list_tile/CustomListTile/index.md Added documentation for a new index property in CustomListTile.
docs/.../widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md Introduced a new build method for CustomCarouselScrollerState.
docs/.../widgets_post_widget/PostContainerState/build.md Introduced a new build method for PostContainerState.

Assessment against linked issues

Objective Addressed Explanation
Display "No Internet" image and text when offline (#2735)
Validate connectivity based UI rendering in tests (#2735)

Suggested reviewers

  • noman2002
  • palisadoes

Poem

Hop along, I code with flair,
Through connectivity highs and lows I dare,
When signals fade, I paint the view,
"No Internet" pops, fresh and new.
With bytes and binkies, my changes gleam—
A bunny’s code, a digitized dream!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a57f284 and 94db3ca.

📒 Files selected for processing (1)
  • docs/docs/auto-docs/widgets_custom_list_tile/CustomListTile/index.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/docs/auto-docs/widgets_custom_list_tile/CustomListTile/index.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Checking codebase

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Feb 8, 2025

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
lib/widgets/custom_progress_dialog.dart (1)

28-56: LGTM! Proper implementation of connectivity-based UI states.

The implementation correctly:

  • Uses model.connectivityPresent for conditional rendering
  • Shows CupertinoActivityIndicator when online
  • Shows no-internet image and localized text when offline

A few suggestions to enhance the implementation:

  1. Consider extracting the no-internet UI into a separate widget for better maintainability
  2. Consider adding a fade transition between states for better UX
+ // Extract to a separate widget
+ class NoInternetContent extends StatelessWidget {
+   @override
+   Widget build(BuildContext context) {
+     return Column(
+       children: [
+         Container(
+           alignment: Alignment.bottomCenter,
+           height: SizeConfig.screenWidth! * 0.4,
+           width: SizeConfig.screenWidth! * 0.4,
+           padding: const EdgeInsets.only(bottom: 10),
+           decoration: const BoxDecoration(
+             image: DecorationImage(
+               image: AssetImage('assets/images/no_internet.png'),
+               fit: BoxFit.scaleDown,
+             ),
+           ),
+         ),
+         Text(
+           '${AppLocalizations.of(context)!.strictTranslate("No Internet")}!',
+           style: Theme.of(context).textTheme.headlineSmall,
+         ),
+       ],
+     );
+   }
+ }

  // In CustomProgressDialog
  child: AnimatedSwitcher(
    duration: const Duration(milliseconds: 300),
    child: model.connectivityPresent
        ? Center(
            child: CupertinoActivityIndicator(
              radius: SizeConfig.screenWidth! * 0.065,
            ),
          )
        : const NoInternetContent(),
  ),
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a21769 and ab2871b.

📒 Files selected for processing (2)
  • lib/widgets/custom_progress_dialog.dart (2 hunks)
  • test/widget_tests/widgets/custom_progress_dialog_test.dart (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Checking codebase
🔇 Additional comments (6)
lib/widgets/custom_progress_dialog.dart (1)

8-10: LGTM! Documentation accurately reflects the widget's behavior.

The documentation has been updated to correctly describe the widget's behavior for both online and offline states.

test/widget_tests/widgets/custom_progress_dialog_test.dart (5)

50-74: LGTM! Comprehensive styling and layout tests.

The test properly verifies:

  • Container border radius
  • Container margins based on screen dimensions

75-84: LGTM! Online state verification.

The test correctly verifies the presence of CupertinoActivityIndicator when online.


86-98: LGTM! Activity indicator size verification.

The test properly verifies the size of the activity indicator based on screen width.


100-121: LGTM! Offline state verification.

The test correctly verifies:

  • Absence of activity indicator
  • Presence of Column layout
  • Display of "No Internet!" message

123-150: LGTM! No-internet image properties verification.

The test thoroughly verifies:

  • Container alignment
  • Image dimensions
  • Correct asset path

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 8, 2025
Copy link

codecov bot commented Feb 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.38%. Comparing base (7a21769) to head (94db3ca).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                Coverage Diff                @@
##           develop-postgres    #2736   +/-   ##
=================================================
  Coverage             96.37%   96.38%           
=================================================
  Files                   189      189           
  Lines                 10020    10029    +9     
=================================================
+ Hits                   9657     9666    +9     
  Misses                  363      363           

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

@may-tas
Copy link
Contributor Author

may-tas commented Feb 8, 2025

@palisadoes There is some issue in docusaurus deployment.

EDIT :
It found some broken links in documentation so it threw an error.
Its unrelated to my PR, How should I proceed?

@palisadoes
Copy link
Contributor

Yes please fix the broken links

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (5)
docs/docs/auto-docs/widgets_custom_list_tile/CustomListTile/index.md (1)

12-14: Property Information and Usage Explanation

The documentation indicates that the index property is of type int and is marked as "read / write". Consider expanding this section with a brief description of the property's purpose or usage context within the widget. This could provide additional clarity for developers who are new to the widget.

docs/docs/auto-docs/widgets_post_widget/PostContainerState/build.md (2)

12-17: Documentation Annotation Consistency
The file uses two different representations for the override annotation (a linked '@[override]' on line 12 and an HTML span on line 17). Consider unifying these to a single, consistent style for clarity in the documentation.


60-74: Refactor Suggestion: Use Stable Key and Simplify Boolean Assignment
Within the build method, a new key is generated on every build with Key(Random().nextInt(1000).toString()). This approach may lead to unnecessary widget rebuilds. Instead, consider using a stable key that remains consistent across builds. Additionally, the ternary assignment on line 65 can be simplified to:
  inView = info.visibleFraction > 0.5;
This improves readability and conciseness.

docs/docs/auto-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md (2)

12-17: Documentation Annotation Consistency
Similar to the previous file, the override annotation is presented as a linked text on line 12 and as an HTML span on line 17. Unify these to a consistent style throughout the documentation for better clarity.


60-132: UI Enhancement Suggestion: Dynamic Indicators and Text Overflow Handling
In the build method implementation, consider the following improvements:
• Instead of manually truncating the description text by taking a substring (lines 83–85), leverage the Text widget’s built-in overflow property (e.g., TextOverflow.ellipsis) to handle varying text lengths more gracefully.
• The divider indicators are generated with a hard-coded count of 4. If the indicators are meant to reflect the number of pinned posts or should otherwise be configurable, dynamically generating the count from widget.pinnedPosts.length might offer better flexibility.
These adjustments can improve responsiveness and maintainability of the UI.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ab2871b and a57f284.

📒 Files selected for processing (3)
  • docs/docs/auto-docs/widgets_custom_list_tile/CustomListTile/index.md (1 hunks)
  • docs/docs/auto-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md (1 hunks)
  • docs/docs/auto-docs/widgets_post_widget/PostContainerState/build.md (1 hunks)
🔇 Additional comments (1)
docs/docs/auto-docs/widgets_custom_list_tile/CustomListTile/index.md (1)

4-4: Clear and Concise Title

The header "# index property" clearly identifies the document section. This helps users quickly locate the documentation for the index property.

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 9, 2025
@may-tas
Copy link
Contributor Author

may-tas commented Feb 9, 2025

@palisadoes @noman2002 Please review.

@palisadoes palisadoes merged commit 392b929 into PalisadoesFoundation:develop-postgres Feb 9, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants