Update fix/analytics data export cleanup

[NicholasTurner23]

Description

[Provide a brief description of the changes made in this PR]

This PR creates a more readable response when the wrong data filter is posted for the data download.

Summary by CodeRabbit

• New Features

  • Enhanced error handling for invalid filter requests in data export and summary functionalities.
  • Improved consistency in API responses, including structured error messages.

• Bug Fixes

  • Refined exception handling to omit sensitive details in error messages for security.

• Documentation

  • Updated method signatures to reflect changes in error handling and response structure.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing error handling and response consistency in the DataExportResource and DataSummaryResource classes within the src/analytics/api/views/data.py file. Key updates include structured error responses, refined exception handling, and improved clarity in variable initialization. The modifications aim to provide uniform feedback for invalid requests and ensure a consistent API response structure.

Changes

File Path	Change Summary
src/analytics/api/views/data.py	- Updated post method in DataExportResource for structured error handling and response.
	- Refined exception handling in DataExportResource to omit exception details for security.
	- Altered _get_validated_filter method in DataExportResource to return error messages instead of raising exceptions.
	- Updated post method in DataSummaryResource for structured error handling and modified response for no data found.

Possibly related PRs

• Update fix/analytics data export cleanup #3816: Modifies the DataExportResource class, enhancing error handling and response structure, directly related to this PR.
• Update fix/analytics data export cleanup #3819: Updates the DataExportResource class, focusing on error handling and preparing for query builder updates, aligning with this PR's changes.
• Update fix/analytics data export cleanup #3927: Modifies the EventsModel class, relevant for SQL query construction that may interact with the data export functionality.
• Update fix/analytics data export cleanup #3871: Introduces a _get_validated_filter method in the D3ChartDataResource class, similar in purpose to the new method in DataExportResource.
• Update/integration iqair devices #3962: Updates the extract_devices_data method in AirQoDataUtils, potentially relating to data handling aspects of this PR.

Suggested reviewers

• OchiengPaul442
• Baalmart

In the code where logic flows,
Error handling now brightly glows.
Responses structured, clear as day,
For clients' needs, we pave the way.
With filters checked and data fine,
Our API's strong, a true design! 🌟

---

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 (2)

src/analytics/api/views/data.py (2)

215-217: Consider enhancing type hints and variable initialization

The type hints and variable initialization could be improved for better clarity and type safety.

Consider this improvement:

-        filter_type: str = None
-        validated_data: List[str] = None
-        error_message: str = ""
+        filter_type: str | None = None
+        validated_data: List[str] | None = None
+        error_message: str = ""

---

195-195: Remove unnecessary f-string prefix

The error message is static and doesn't contain any placeholders.

Apply this change:

-                    f"An Error occurred while processing your request. Please contact support.",
+                    "An Error occurred while processing your request. Please contact support.",

🧰 Tools

🪛 Ruff (0.8.0)

195-195: f-string without any placeholders

Remove extraneous f prefix

(F541)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d0770c3 and 931d18d.

📒 Files selected for processing (1)

• src/analytics/api/views/data.py (5 hunks)

🧰 Additional context used

🪛 Ruff (0.8.0)

src/analytics/api/views/data.py

195-195: f-string without any placeholders

Remove extraneous f prefix

(F541)

🔇 Additional comments (3)

src/analytics/api/views/data.py (3)

234-236: LGTM: Clear error message for filter validation

The error message clearly explains the requirement to specify exactly one filter type, which aligns well with the PR's objective of improving error message readability.

---

253-255: LGTM: Consistent error message handling

Good use of fallback message when specific validation error is not available.

---

195-198: LGTM: Improved security in error handling

Good practice to avoid exposing internal error details in the response while maintaining logging for debugging purposes.

🧰 Tools

🪛 Ruff (0.8.0)

195-195: f-string without any placeholders

Remove extraneous f prefix

(F541)

[Baalmart]

thanks @NicholasTurner23 , I am now waiting for the deploy preview to confirm that all is working well. @Codebmk

[NicholasTurner23]

@Baalmart I think we have talked about the google auth issue in the preview about 3 or so times. That is what is causing the failure.

[Baalmart]

@Baalmart I think we have talked about the google auth issue in the preview about 3 or so times. That is what is causing the failure.

alright @NicholasTurner23 I had forgotten