fix: Disable Local storage option in Write File component for cloud environments

[HimavarshaVS]

Summary

This PR disables the "Local" storage option in the Write File component when running in Astra cloud environments.

Changes

• Added `is_astra_cloud_environment()` helper function to check if running in cloud without raising errors
• Updated `SaveToFileComponent` to filter out "Local" option from storage location choices when in cloud
• Added validation in `save_to_file()` to prevent saving to local storage when disabled

Summary by CodeRabbit

Release Notes

• Bug Fixes
  • Fixed an issue where Local storage location could be incorrectly selected in Astra cloud environments
  • Added validation to prevent unsupported storage configurations in cloud deployments

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Adds environment-based filtering for storage location options in save_file component. Introduces a new utility function to check for Astra cloud environment, used to dynamically exclude Local storage and enforce runtime validation preventing Local storage usage in Astra cloud deployments.

Changes

Cohort / File(s)	Summary
Environment-aware storage location filtering src/lfx/src/lfx/utils/validate_cloud.py, src/lfx/src/lfx/components/files_and_knowledge/save_file.py	Added is_astra_cloud_environment() utility function to centralize environment checking for Astra cloud detection. Introduced _get_storage_location_options() helper to dynamically filter storage options based on environment. Added runtime validation in save_to_file() to prevent Local storage usage in Astra cloud.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Verify is_astra_cloud_environment() correctly reads and parses the ASTRA_CLOUD_DISABLE_COMPONENT environment variable
• Confirm filtering logic in _get_storage_location_options() properly excludes Local storage when in Astra cloud
• Check runtime validation error message is clear and helpful
• Validate that the refactored raise_error_if_astra_cloud_disable_component() maintains backward compatibility

Pre-merge checks and finishing touches

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 warning, 2 inconclusive)

Check name	Status	Explanation	Resolution
Test Quality And Coverage	⚠️ Warning	PR introduces new cloud validation and storage filtering functions but lacks test coverage for the new is_astra_cloud_environment() function and runtime validation in cloud environments.	Add unit tests for is_astra_cloud_environment(), _get_storage_location_options() behavior across cloud/non-cloud scenarios, and ValueError validation for Local storage in cloud.
Test Coverage For New Implementations	❓ Inconclusive	Source files and test files specified in PR summary could not be located in the repository.	Verify repository setup contains the modified files and locate test files for save_file component and validate_cloud module to assess test coverage.
Excessive Mock Usage Warning	❓ Inconclusive	Repository test files for excessive mock usage assessment are not accessible for evaluation.	Provide access to test files for SaveToFileComponent and validate_cloud module to complete the mock usage analysis.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately reflects the main change: disabling Local storage in the Write File component for cloud environments, which is the core purpose of this changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Test File Naming And Structure	✅ Passed	Test files follow proper naming convention (test_*.py) with descriptive test function names covering both positive and negative scenarios using pytest framework.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/lfx/src/lfx/components/files_and_knowledge/save_file.py (2)

19-29: Good implementation with environment-based filtering.

The helper function correctly filters storage options based on the cloud environment. The logic is sound and the implementation is clean.

However, this is a critical feature that should have unit tests to verify:

• Local option is included when not in Astra cloud
• Local option is excluded when in Astra cloud
• Other options remain available in both cases

Do you want me to generate unit tests for this functionality, or would you like to open an issue to track this testing requirement?

---

262-265: Excellent defense-in-depth validation.

The runtime check ensures Local storage cannot be used in Astra cloud even if bypassed through API calls or existing workflows. The error message is clear and suggests alternatives.

Consider enhancing the error message slightly for users with existing workflows:

-            msg = "Local storage is not available in cloud environment. Please use AWS or Google Drive."
+            msg = "Local storage is not available in Astra cloud environments. Please update your workflow to use AWS or Google Drive storage instead."

This makes it clearer that it's an Astra-specific restriction and explicitly mentions that workflows need updating.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a41259 and 2cde744.

📒 Files selected for processing (2)

• src/lfx/src/lfx/components/files_and_knowledge/save_file.py (3 hunks)
• src/lfx/src/lfx/utils/validate_cloud.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Run Ruff Check and Format
• GitHub Check: Update Component Index
• GitHub Check: Update Starter Projects

🔇 Additional comments (4)

src/lfx/src/lfx/utils/validate_cloud.py (2)

10-21: LGTM! Clean environment detection logic.

The implementation correctly detects the Astra cloud environment by checking the environment variable with appropriate defaults, case-insensitive comparison, and whitespace handling. The bool() wrapper ensures consistent boolean return type.

---

36-36: Good refactoring to centralize the environment check.

Using the new is_astra_cloud_environment() helper eliminates code duplication and ensures consistent behavior across the codebase.

src/lfx/src/lfx/components/files_and_knowledge/save_file.py (2)

16-17: LGTM!

Import is correctly placed and necessary for the environment-based filtering functionality.

---

66-66: LGTM! Dynamic options correctly integrated.

The storage location options are now dynamically generated based on the environment, with real_time_refresh=True ensuring the UI stays in sync.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 33.09%. Comparing base (757ef6c) to head (1356036).
⚠️ Report is 1 commits behind head on main.

❌ Your project status has failed because the head coverage (39.27%) is below the target coverage (60.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11003      +/-   ##
==========================================
+ Coverage   33.07%   33.09%   +0.02%     
==========================================
  Files        1389     1389              
  Lines       65640    65643       +3     
  Branches     9707     9707              
==========================================
+ Hits        21708    21723      +15     
+ Misses      42821    42809      -12     
  Partials     1111     1111              

Flag	Coverage Δ
backend	52.33% <ø> (+0.06%)	⬆️
frontend	15.35% <ø> (ø)
lfx	39.27% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/lfx/src/lfx/utils/validate_cloud.py	100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Frontend Unit Test Coverage Report

Coverage Summary

Lines	Statements	Branches	Functions
	16.65% (4686/28138)	10.02% (2179/21743)	10.93% (676/6180)

Unit Test Results

Tests	Skipped	Failures	Errors	Time
1829	0 💤	0 ❌	0 🔥	24.9s ⏱️