Update fix/clean up

[NicholasTurner23]

Description

[Provide a brief description of the changes made in this PR]
Track changes using a timestamp field.

Related Issues

• JIRA cards:
  • OPS-324

Summary by CodeRabbit

• New Features

  • The extract_devices_from_api method now returns a DataFrame with an additional last_updated column containing the current UTC datetime.

• Bug Fixes

  • Removed unnecessary parameters from the extract_devices_from_api method for a simplified interface.

• Schema Changes

  • Updated device JSON schema by removing the "tenant", "approximate_latitude", and "approximate_longitude" fields.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces changes to the MetaDataUtils class in the meta_data_utils.py file, specifically modifying the extract_devices_from_api method by removing its network parameter and adding a last_updated timestamp to the returned DataFrame. Additionally, the JSON schema for devices in devices.json has been updated to remove the "tenant," "approximate_latitude," and "approximate_longitude" fields, while retaining the overall structure and other existing fields.

Changes

File Path	Change Summary
src/workflows/airqo_etl_utils/meta_data_utils.py	- Updated method signature: extract_devices_from_api now has no network parameter. - Added last_updated column with current UTC datetime to the DataFrame.
src/workflows/airqo_etl_utils/schema/devices.json	- Removed fields: "tenant", "approximate_latitude", and "approximate_longitude".

Possibly related PRs

• Update fix/reduce redundant device data called[wip] #3526: Modifies the get_devices method, related to device data handling.
• Update fix/clean up #3539: Involves changes to the extract_devices_data function, directly related to device data extraction.
• Update/integration iqair devices #3952: Updates the get_devices_by_network method, relevant to device handling.
• Update/integration iqair devices #3962: Modifications to the extract_devices_data method, closely related to device data extraction.
• Update/integration iqair devices #3964: Changes to the clean_low_cost_sensor_data method, relating to device data processing.
• Update/integration iqair devices #3988: Involves a shift from tenant to network parameters in the get_devices method.
• Update/integration iqair devices #3993: Focuses on incorporating network functionality into device data handling.
• Update/integration iqair devices #3995: Changes in the extract_devices_deployment_logs method, relating to device data extraction.
• Update/integration iqair devices #4015: Involves cleanup related to BAM data, relevant to overall data handling improvements.
• Update fix/clean up #4050: Focuses on correcting updates to the devices and sites tables, directly related to device data changes.

Suggested reviewers

• Baalmart
• BenjaminSsempala

🌟 In the code's embrace, changes take flight,
With last_updated shining, a new insight.
Fields trimmed away, like leaves in the breeze,
Simplifying the flow, aiming to please.
In the realm of data, clarity reigns,
As we refine our methods, breaking the chains! 🌟

---

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. (Experiment)
• @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 (1)

src/workflows/airqo_etl_utils/meta_data_utils.py (1)

30-30: Consider using device-specific update times

While adding a timestamp is good practice, using the current time might not accurately reflect when each device was last updated. Consider these improvements:

1. Check if the API response includes device-specific update timestamps
2. If available, use those timestamps instead of the current time
3. Fall back to current time only if device timestamps are unavailable

Example implementation:

# If API provides last_updated in devices response
dataframe["last_updated"] = dataframe["last_updated"].fillna(datetime.now(timezone.utc))

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2df1eac and 67f4eb4.

📒 Files selected for processing (2)

• src/workflows/airqo_etl_utils/meta_data_utils.py (2 hunks)
• src/workflows/airqo_etl_utils/schema/devices.json (0 hunks)

💤 Files with no reviewable changes (1)

• src/workflows/airqo_etl_utils/schema/devices.json

🔇 Additional comments (3)

src/workflows/airqo_etl_utils/meta_data_utils.py (3)

8-8: Well-structured datetime import addition

Good choice using timezone for UTC standardization. This ensures consistent timestamp handling across different deployment environments.

---

Line range hint 156-157: Review usage of deprecated fields

The AI summary indicates that approximate_latitude and approximate_longitude fields were removed from the devices schema. However, these fields are still being used in methods like update_nearest_weather_stations. Please verify if these fields should be updated to use the non-approximate coordinates instead.

Also applies to: 158-159

---

13-13: Verify impact of removing the network parameter

The removal of the network parameter is a breaking change that could affect existing code. Let's verify all callers of this method.