[OSDEV-OSDEV-1467] Fix blocking API facility create endpoint for 1.25

[Innavin369]

OSDEV-1467 Implemented disabling endpoint POST /api/facilities/ during the release process. It is raising an error message with status code 503.

[barecheck]

React App | Jest test suite - Code coverage report

Total: 27.8%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

This pull request introduces several updates for version 1.25.0 of the Open Supply Hub project, encompassing database migrations, new API endpoints, architectural changes, and bug fixes. Key changes include the addition of new API methods for moderation events and modifications to existing endpoints. The database schema is updated with new migrations, and the infrastructure is enhanced by upgrading RDS instance types and increasing memory allocation. Additionally, a new error handling mechanism is implemented to manage facility uploads during maintenance.

Changes

File Path	Change Summary
doc/release/RELEASE-NOTES.md	Updated release notes for version 1.25.0 detailing database migrations, new API endpoints, architectural changes, and bug fixes.
src/django/api/views/facility/facilities_view_set.py	Added exception handling in the create method to raise a ServiceUnavailableException if disable_list_uploading is active. Imported ServiceUnavailableException.

Possibly related PRs

• [OSDEV-1332] Moderation. Implement PATCH api/v1/moderation-events/{moderation_id} #393: Implements the PATCH api/v1/moderation-events/{moderation_id} endpoint, directly related to the changes in the main PR.
• [OSDEV-1411] Django admin: Fix editing of contributor list #418: Updates RELEASE-NOTES.md to include the new PATCH endpoint for moderation events, aligning with the documentation updates in the main PR.

Suggested reviewers

• vladsha-dev
• roman-stolar
• mazursasha1990
• VadimKovalenkoSNF

---

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

🧹 Outside diff range and nitpick comments (5)

src/django/api/views/facility/facilities_view_set.py (1)

580-584: LGTM: Clean implementation of maintenance mode toggle.

The implementation correctly uses waffle's feature toggle to disable facility creation during maintenance. The error message is clear and user-friendly.

Consider these minor improvements:

1. Extract the maintenance message to a constant or settings to make it configurable
2. Add a logging statement to track when requests are blocked

+# At the top with other constants
+MAINTENANCE_MODE_MESSAGE = ('Open Supply Hub is undergoing maintenance and '
+                          'not accepting new data at the moment. Please '
+                          'try again in a few minutes.')

 if switch_is_active('disable_list_uploading'):
+    log.info('[Maintenance Mode] Blocking facility creation request')
-    block_message = ('Open Supply Hub is undergoing maintenance and '
-                      'not accepting new data at the moment. Please '
-                      'try again in a few minutes.')
-    raise ServiceUnavailableException(block_message)
+    raise ServiceUnavailableException(MAINTENANCE_MODE_MESSAGE)

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

31-31: Consider adding the release status.

For better tracking, consider adding a status indicator (e.g., "Released", "In Progress", "Planned") at the beginning of the release notes.

-* [OSDEV-1467](https://opensupplyhub.atlassian.net/browse/OSDEV-1467) - Implemented disabling endpoint `POST /api/facilities/?public=true&create=true` during the release process . It is raising an error message with status code 503.
+Status: In Progress
+
+* [OSDEV-1467](https://opensupplyhub.atlassian.net/browse/OSDEV-1467) - Implemented disabling endpoint `POST /api/facilities/?public=true&create=true` during the release process. It is raising an error message with status code 503.

---

Line range hint 13-24: Enhance database migration documentation.

The database migrations section could benefit from more detailed descriptions of the changes and their impact:

 ### Database changes
 #### Migrations:
-* 0159_alter_status_of_moderation_events_table.py - This migration alters status of api_moderationevent table.
-* 0160_allow_null_parsing_errors_in_facilitylist.py - This migration allows empty parsing_errors in api_facilitylist.
-* 0161_create_disable_list_uploading_switch.py - This migration creates disable_list_uploading switch in the Django admin panel and record in the waffle_switch table.
+* 0159_alter_status_of_moderation_events_table.py
+  - Modifies the status field in api_moderationevent table
+  - Impact: Affects how moderation event statuses are stored and processed
+
+* 0160_allow_null_parsing_errors_in_facilitylist.py
+  - Allows null values for parsing_errors in api_facilitylist
+  - Impact: Improves error handling flexibility during facility list processing
+
+* 0161_create_disable_list_uploading_switch.py
+  - Creates disable_list_uploading switch in Django admin panel
+  - Adds corresponding record in waffle_switch table
+  - Impact: Enables feature flag control for list upload functionality during releases

---

Line range hint 47-48: Enhance release instructions with verification steps.

The release instructions should include steps to verify the successful application of changes.

 ### Release instructions:
-* Ensure that the following commands are included in the `post_deployment` command:
+### Release instructions:
+
+1. Pre-deployment checks:
+   * Verify database backup is available
+   * Ensure maintenance mode is enabled if needed
+
+2. Deployment steps:
+   * Ensure that the following commands are included in the `post_deployment` command:
     * `migrate`
     * `reindex_database`
+
+3. Post-deployment verification:
+   * Verify migrations completed successfully
+   * Check logs for any errors
+   * Test the new disable_list_uploading feature
+   * Verify moderation event functionality
+   * Confirm RDS instance upgrades completed
+
+4. Rollback plan:
+   * Document steps to revert migrations if needed
+   * Include commands to restore previous state

---

Line range hint 26-45: Improve organization of API and architecture changes.

The code/API changes and architecture changes sections could be better organized for clarity.

 ### Code/API changes
+#### New Endpoints
 * [OSDEV-1346](https://opensupplyhub.atlassian.net/browse/OSDEV-1346) - Create GET request for `v1/moderation-events` endpoint.
 * [OSDEV-1429](https://opensupplyhub.atlassian.net/browse/OSDEV-1429) - The list upload switcher has been created to disable the `Submit` button on the List Contribute page through the Switch page in the Django admin panel during the release process. Implemented a check on the list upload endpoint.
+
+#### Modified Endpoints
 * [OSDEV-1332](https://opensupplyhub.atlassian.net/browse/OSDEV-1332) - Introduced new `PATCH api/v1/moderation-events/{moderation_id}` endpoint
 to modify moderation event `status`.
 * [OSDEV-1347](https://opensupplyhub.atlassian.net/browse/OSDEV-1347) - Create GET request for `v1/moderation-events/{moderation_id}` endpoint.
 * Update `/v1/production-locations/{os_id}` endpoint to return a single object instead of multiple objects. Also, add unit tests for the `ProductionLocationsViewSet`.

 ### Architecture/Environment changes
+#### Infrastructure Updates
 * The RDS instance has been upgraded as follows: for `production` and `preprod`, it is now `db.m6in.8xlarge`, and for `test`, it has been upgraded to `db.t3.xlarge`.
+
+#### Performance Improvements
 * Increased the memory for the Dedupe Hub instance from 8GB to 12GB in the `production` and `pre-prod` environments to reduce the risk of container overload and minimize the need for reindexing in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9885c44 and e776c55.

📒 Files selected for processing (2)

• doc/release/RELEASE-NOTES.md (1 hunks)
• src/django/api/views/facility/facilities_view_set.py (2 hunks)

🔇 Additional comments (2)

src/django/api/views/facility/facilities_view_set.py (2)

580-580: Verify feature toggle configuration.

Ensure the feature toggle 'disable_list_uploading' is properly configured in Django settings and consistently named across the codebase.

✅ Verification successful

Based on the results, I can generate the final response as we have comprehensive information about the feature toggle implementation.

Feature toggle 'disable_list_uploading' is properly configured and consistently used

The feature toggle is:

• Properly created through migration 0161_create_bdisable_list_uploading.py
• Consistently named across both React and Django codebases
• Used in appropriate test cases with proper overrides
• Managed via Django's Waffle framework as evidenced by the migration and management command
• Has a default state of 'off' as set in the enable_switches management command

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check feature toggle configuration and usage

# Check for feature toggle configuration in settings files
echo "Checking feature toggle configuration..."
rg -l "disable_list_uploading" "src/django/*/settings*.py"

# Check for consistent feature toggle naming across codebase
echo "Checking feature toggle usage..."
rg "disable_list_uploading"

Length of output: 2153

---

14-14: Verify error handling implementation.

The ServiceUnavailableException import is correctly added. Let's verify its implementation and usage pattern.

✅ Verification successful

Error handling implementation is properly integrated

The verification shows:

• ServiceUnavailableException is correctly implemented as a Django APIException with HTTP 503 status code
• The exception is used consistently in facility-related views for maintenance scenarios:
  • facility_list_view_set.py: Used during maintenance to block new data submissions
  • facilities_view_set.py: Used with a configurable block message

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check ServiceUnavailableException implementation and usage

# Check ServiceUnavailableException implementation
echo "Checking ServiceUnavailableException implementation..."
rg -A 5 "class ServiceUnavailableException"

# Check for consistent error handling patterns
echo "Checking error handling patterns..."
ast-grep --pattern 'raise ServiceUnavailableException($$$)'

Length of output: 3183

[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]

Django App | Unittest test suite - Code coverage report

Total: 79.16%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[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

[mazursasha1990]

LGTM

[VadimKovalenkoSNF]

Looks good, approved.