[OSDEV-1696] Add loader to the production location info

[VadimKovalenkoSNF]

Fix OSDEV-1696

1. Add loader on single production location fetch.
2. Add error handling using toastify component.
3. Add cleanup hook to clear production location data on component unmount.

[barecheck]

React App | Jest test suite - Code coverage report

Total: 29.54%

Your code coverage diff: -0.02% ▾

✅ All code changes are covered

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request documents the Release 2.0.0 update for the Open Supply Hub project. The release notes now detail the addition of the action_perform_by field in the api_moderationevent table with an associated migration script. Other documented changes include new geo-bounding box query support for the production locations endpoint, Logstash mapping updates, architectural modifications (such as Terraform variable removals and container restructuring), and a production location bugfix. Additionally, the ProductionLocationInfo React component now features a loading indicator, enhanced error handling, and state cleanup logic.

Changes

File(s)	Change Summary
doc/release/RELEASE-NOTES.md, 0166_add_moderationevent_action_perform_by.py	Updated release notes for Release 2.0.0. Added a new migration script to incorporate the action_perform_by field in api_moderationevent. Also documents geo-bounding box query support for the production locations endpoint, Logstash mapping changes, Terraform variable removals, Django container restructuring, and a bugfix for production location data retrieval.
src/react/src/components/Contribute/ProductionLocationInfo.jsx	Introduced a CircularProgress loading indicator and enhanced error handling via toast notifications. Updated component props and state mappings by adding singleProductionLocationFetching and singleProductionLocationError, and included a reset method (handleResetSingleProductionLocation) for cleanup on unmount.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant PLInfo as ProductionLocationInfo Component
    participant API as API Service

    User->>PLInfo: Mount component
    PLInfo->>PLInfo: Set fetching state (show CircularProgress)
    PLInfo->>API: Request production location data
    alt Successful Response
        API-->>PLInfo: Return data
        PLInfo->>PLInfo: Update display with data
    else Error Response
        API-->>PLInfo: Return error
        PLInfo->>PLInfo: Trigger error toast notification
    end
    PLInfo->>PLInfo: Invoke cleanup (handleResetSingleProductionLocation) on unmount

Loading

Possibly related PRs

• [OSDEV-1589] [FE] Layout issue on "contribute" page #513: The changes regarding the addition of the action_perform_by field and geo-bounding box query support are directly related to modifications in this PR.
• [OSDEV-1701] - Refactor Go Back button #506: This PR is directly related to the addition of the action_perform_by field in the api_moderationevent table and its corresponding migration script.
• [OSDEV-1558] Described that the action_type field was added to the moderation_events OpenSearch index. #499: Involves modifications to the api_moderationevent table with the addition of the action_type field, impacting the same table schema.

Suggested reviewers

• Innavin369
• roman-stolar
• mazursasha1990

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5919edd and 7899039.

📒 Files selected for processing (1)

• doc/release/RELEASE-NOTES.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (10)

• GitHub Check: run-integration-test-code-quality
• GitHub Check: run-flake8-linter
• GitHub Check: run-django-code-quality
• GitHub Check: run-dd-code-quality
• GitHub Check: run-contricleaner-code-quality
• GitHub Check: run-countries-code-quality
• GitHub Check: get-base-branch-countries-cov
• GitHub Check: get-base-branch-dd-cov
• GitHub Check: get-base-branch-django-cov
• GitHub Check: get-base-branch-contricleaner-cov

🔇 Additional comments (4)

doc/release/RELEASE-NOTES.md (4)

6-7: LGTM! The release version and header are properly formatted.

The release version follows semantic versioning (2.0.0) and includes a clear header.

---

8-11: LGTM! The introduction section provides essential release metadata.

The introduction section properly includes:

• Product name
• Release date

---

70-70: Verify that the loader implementation is properly documented.

The bugfix entry for OSDEV-1696 matches the PR objectives about adding a loader, but could be more detailed about the error handling and cleanup hook mentioned in the PR objectives.

Consider expanding the entry to include:

-* [OSDEV-1696](https://opensupplyhub.atlassian.net/browse/OSDEV-1696) - Added loader on single production location fetch; added error handling; added cleanup hook to clear production location data on component unmount.
+* [OSDEV-1696](https://opensupplyhub.atlassian.net/browse/OSDEV-1696) - Added loader during single production location fetch to enhance user experience. Implemented error handling using Toastify for notifications. Added cleanup hook to clear production location data when component unmounts to prevent memory leaks.

---

77-82: LGTM! The release instructions are clear and complete.

The release instructions properly specify:

1. Required migrations
2. Database reindexing

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

77-77: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

79-79: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

80-80: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/react/src/components/Contribute/ProductionLocationInfo.jsx (3)

370-374: Consider improving error message formatting.

While the error handling is functional, consider formatting the error message for better user experience. The current implementation directly displays the raw error array's first element.

-            toast(singleProductionLocationError[0]);
+            const errorMessage = Array.isArray(singleProductionLocationError) 
+              ? singleProductionLocationError[0]
+              : 'An error occurred while fetching production location data';
+            toast(errorMessage);

---

376-376: Consider making cleanup effect more explicit.

The cleanup effect is good but could be more explicit about its purpose with a comment.

-    useEffect(() => () => handleResetSingleProductionLocation(), []);
+    // Cleanup production location data when component unmounts
+    useEffect(() => {
+      return () => handleResetSingleProductionLocation();
+    }, [handleResetSingleProductionLocation]);

---

388-390: Consider improving loader positioning.

The CircularProgress component could benefit from proper centering and sizing for better user experience.

-                    <CircularProgress />
+                    <div style={{ display: 'flex', justifyContent: 'center', padding: '2rem' }}>
+                        <CircularProgress size={40} />
+                    </div>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f175e94 and 9905e77.

📒 Files selected for processing (2)

• doc/release/RELEASE-NOTES.md (1 hunks)
• src/react/src/components/Contribute/ProductionLocationInfo.jsx (10 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (10)

• GitHub Check: run-integration-test-code-quality
• GitHub Check: run-flake8-linter
• GitHub Check: run-dd-code-quality
• GitHub Check: run-contricleaner-code-quality
• GitHub Check: get-base-branch-dd-cov
• GitHub Check: run-django-code-quality
• GitHub Check: run-countries-code-quality
• GitHub Check: get-base-branch-contricleaner-cov
• GitHub Check: get-base-branch-django-cov
• GitHub Check: get-base-branch-countries-cov

🔇 Additional comments (2)

src/react/src/components/Contribute/ProductionLocationInfo.jsx (1)

1-15: LGTM! Well-structured loading state implementation.

The changes properly introduce loading state management with Material-UI's CircularProgress component and appropriate prop types.

Also applies to: 74-75, 79-79, 821-822, 841-842, 848-848, 888-890

🧰 Tools

🪛 Biome (1.9.4)

[error] 7-7: Do not shadow the global "toString" property.

Consider renaming this variable. It's easy to confuse the origin of variables when they're named after a known global.

(lint/suspicious/noShadowRestrictedNames)

doc/release/RELEASE-NOTES.md (1)

70-70: LGTM! Clear and accurate release notes entry.

The release notes entry properly documents the loader implementation, error handling, and cleanup hook additions.

[barecheck]

Dedupe Hub App | Unittest test suite - Code coverage report

Total: 56.14%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[barecheck]

Countries App | Unittest test suite - Code coverage report

Total: 100%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[barecheck]

Contricleaner App | Unittest test suite - Code coverage report

Total: 98.91%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

doc/release/RELEASE-NOTES.md (1)

63-70: Consider moving the loader addition to the "What's new" section.

The loader addition (OSDEV-1696) appears to be a new feature rather than a bugfix, as it enhances the user experience by adding loading states, error handling, and cleanup functionality. Consider moving it to the "What's new" section to better reflect its nature as a feature enhancement.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9905e77 and 5919edd.

📒 Files selected for processing (1)

• doc/release/RELEASE-NOTES.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (13)

• GitHub Check: run-integration-test-code-quality
• GitHub Check: run-flake8-linter
• GitHub Check: run-fe-code-quality
• GitHub Check: run-eslint-linter-and-prettier-formatter
• GitHub Check: run-django-code-quality
• GitHub Check: run-dd-code-quality
• GitHub Check: run-countries-code-quality
• GitHub Check: run-contricleaner-code-quality
• GitHub Check: get-base-branch-fe-cov
• GitHub Check: get-base-branch-django-cov
• GitHub Check: get-base-branch-contricleaner-cov
• GitHub Check: get-base-branch-dd-cov
• GitHub Check: get-base-branch-countries-cov

🔇 Additional comments (1)

doc/release/RELEASE-NOTES.md (1)

70-70: LGTM! The loader addition is well documented.

The change description clearly captures all key aspects - loader addition, error handling implementation, and cleanup hook for unmounting.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud