SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI #2685

sfc-gh-svishnu · 2025-11-04T14:33:14Z

SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI

Summary

Changes the default Streamlit deployment mode from ROOT_LOCATION to versioned stages

Motivation

Modern architecture: Versioned stages is the recommended approach for new Streamlit apps
SPCS enablement: Runtime v2 (compute pools) requires versioned deployment
Feature parity: Other entity types (Native Apps) use versioned stages by default

Changes

CLI Behavior

# Before
snow streamlit deploy                  # ROOT_LOCATION (old)
snow streamlit deploy --experimental   # Versioned (new)

# After
snow streamlit deploy                  # Versioned (new) ✨
snow streamlit deploy --legacy         # ROOT_LOCATION (old)
snow streamlit deploy --experimental   # Versioned + deprecation warning

Implementation

Added --legacy flag for ROOT_LOCATION deployment
Inverted deployment logic (if legacy vs if not legacy)
Renamed _deploy_experimental() → _deploy_versioned() + extracted _deploy_legacy()
Removed ENABLE_STREAMLIT_VERSIONED_STAGE feature flag
SPCS runtime v2 remains exclusive to versioned mode

Test Updates

Updated 12 unit tests requiring ROOT_LOCATION to use --legacy
Removed --experimental from tests expecting default behavior
Updated integration tests for new default

Deployment Behavior Change

Default mode changes: The snow streamlit deploy command now uses versioned stages by default instead of ROOT_LOCATION.

Impact

Existing deployed apps: Continue to work unchanged. No action required.
New deployments: Will automatically use versioned stages
Re-deployments: When re-deploying an existing app, the CLI shows warnings if the deployment mode changes

Using ROOT_LOCATION (Legacy Mode)

Users who need ROOT_LOCATION deployment can use the --legacy flag:

snow streamlit deploy --legacy

Or in CI/CD:

- run: snow streamlit deploy --legacy

Backward Compatibility

--experimental flag still works (shows deprecation warning)
Both deployment modes create functionally equivalent Streamlit apps
The difference is only in internal stage file organization
All existing functionality preserved
Zero API changes

Testing

All unit tests pass with updated flags
Integration tests updated and verified
Manual testing: both deployment modes work as expected

Pre-review checklist

I've confirmed that instructions included in README.md are still correct after my changes in the codebase.
I've added or updated automated unit tests to verify correctness of my new code.
I've added or updated integration tests to verify correctness of my new code.
I've confirmed that my changes are working by executing CLI's commands manually on MacOS.
I've confirmed that my changes are working by executing CLI's commands manually on Windows.
I've confirmed that my changes are up-to-date with the target branch.
I've described my changes in the release notes.
I've described my changes in the section below.
I've described my changes in the documentation.
...

src/snowflake/cli/_plugins/streamlit/commands.py

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py

sfc-gh-jwilkowski

Thanks for your contribution! For the most part it looks really good, I'd only like to ask to pay attention to repetitive comments bloat and making user-facing messages clear to them. I don't think that all of that terminology is a common knowledge so it would be better to explain those in a different way. Please also take a look at failing tests

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py

sfc-gh-jwilkowski

A couple of comments:

Please add an entry in RELEASE-NOTES.md in Unreleased version section describing briefly this change
please edit the description of PR and remove the part about a breaking change - I don't think it's a BCR since we're changing internals of created streamlit, so I don't want to confuse people reading this PR
There's one case that I'm not sure about - it's possible to deploy a streamlit with --replace flag. If that app existed before, there's a chance that we'd replace old-style streamlit app with new style one. I'm not sure if there would be any negative consequences of that, but feels like something we should handle.

tests/streamlit/test_streamlit_entity.py

sfc-gh-svishnu · 2025-11-12T19:09:13Z

A couple of comments:

Please add an entry in RELEASE-NOTES.md in Unreleased version section describing briefly this change

please edit the description of PR and remove the part about a breaking change - I don't think it's a BCR since we're changing internals of created streamlit, so I don't want to confuse people reading this PR

There's one case that I'm not sure about - it's possible to deploy a streamlit with --replace flag. If that app existed before, there's a chance that we'd replace old-style streamlit app with new style one. I'm not sure if there would be any negative consequences of that, but feels like something we should handle.

Addressed

## Changes ### CLI Behavior - `snow streamlit deploy` now uses versioned deployment (FROM syntax) by default - Added `--legacy` flag to use old ROOT_LOCATION deployment - `--experimental` flag is now deprecated but still works (shows warning) ### Code Changes - Added `--legacy` flag to streamlit deploy command - Inverted deployment logic: `if experimental` → `if not legacy` - Renamed `_deploy_experimental()` → `_deploy_versioned()` - Removed `ENABLE_STREAMLIT_VERSIONED_STAGE` feature flag - Updated `_is_spcs_runtime_v2_mode()` to not require experimental flag - SPCS runtime v2 (compute pools) only available in versioned mode ### Test Updates - Added `--legacy` flag to 12 unit tests expecting ROOT_LOCATION behavior - Removed `--experimental` flag from tests now using default behavior - Removed `with_feature_flags` wrapper and parametrization - Updated integration tests to reflect new default ## Breaking Change The default deployment mode changes from ROOT_LOCATION to versioned deployment. Users who want the old behavior must use `--legacy` flag.

For consistency with _deploy_versioned(), extracted the else block's deployment logic into a dedicated _deploy_legacy() method. This improves code organization and makes the deploy() method cleaner.

Changed from 'if not legacy' to 'if legacy' for better readability. The positive condition directly maps to the flag name and avoids mental negation.

- Split long comment in _deploy_legacy() method - Break deprecation warning string across multiple lines - Format long test invocation call - Fix typo: elswhere → elsewhere

…ming

Update test_streamlit_flow and test_streamlit_deploy_prune_flag to work with versioned Streamlit deployment (now the default behavior). Changes: - test_streamlit_flow: Update stage paths from legacy app_1_stage to versioned snow://streamlit/{DB}.{SCHEMA}.app_1/versions/live/ - test_streamlit_deploy_prune_flag: Rewrite to use managed versioned stages instead of user-created stages Files are now uploaded to managed stages at versions/live/ path instead of user-specified ROOT_LOCATION stages.

- Add mock for describe() method to return versioned stage path - Update test_deploy to use legacy=True for testing old behavior - Replace experimental parameter with legacy parameter in SPCS runtime v2 tests - Fix test_deploy_with_spcs_runtime_v2_and_legacy_flag_raises_error invalid parameters Changes reflect that versioned deployment is now the default, and the experimental flag has been replaced with a legacy flag to opt into old behavior.

- Add --legacy flag to streamlit deploy help text - Remove oauth-token-request-url parameter (deprecated) These changes reflect the new default versioned deployment behavior.

…commands except streamlit The previous commit incorrectly removed oauth-token-request-url from ALL commands. This parameter should only be excluded from streamlit.deploy command, but remain in all other commands' help text.

This parameter is a standard connection option that applies to all commands including streamlit. Cannot be removed from just streamlit.deploy.

…lit stage Snowflake requires overwrite=true when uploading to streamlit versioned stages. The test was failing because stage copy needs --overwrite flag when uploading to snow://streamlit/ managed stages.

Versioned stages are managed by Snowflake's FBE and have different file lifecycle behavior. The prune flag functionality is primarily for legacy ROOT_LOCATION stages where the CLI has full control over file management. Changed the test to use --legacy flag to properly test the prune functionality on legacy stages instead of versioned stages.

…uce comment bloat

…void file errors

…ross platforms

…ophes

…s to top, add deployment style change warnings

…ent database context

…t deploy commands

…test_database fixture env var

sfc-gh-svishnu requested review from sfc-gh-jwilkowski and sfc-gh-wschmitt November 4, 2025 14:33

sfc-gh-svishnu requested a review from a team as a code owner November 4, 2025 14:33

sfc-gh-svishnu force-pushed the make-versioned-streamlit-default branch from 18ef70d to 97f75ad Compare November 4, 2025 14:49

sfc-gh-jwilkowski reviewed Nov 5, 2025

View reviewed changes

src/snowflake/cli/_plugins/streamlit/commands.py Outdated Show resolved Hide resolved

sfc-gh-jwilkowski reviewed Nov 5, 2025

View reviewed changes

src/snowflake/cli/_plugins/streamlit/commands.py Outdated Show resolved Hide resolved

sfc-gh-jwilkowski reviewed Nov 5, 2025

View reviewed changes

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py Outdated Show resolved Hide resolved

sfc-gh-jwilkowski reviewed Nov 5, 2025

View reviewed changes

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py Outdated Show resolved Hide resolved

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py Outdated Show resolved Hide resolved

src/snowflake/cli/_plugins/streamlit/streamlit_entity.py Outdated Show resolved Hide resolved

sfc-gh-svishnu requested a review from sfc-gh-jwilkowski November 6, 2025 06:50

sfc-gh-jwilkowski reviewed Nov 7, 2025

View reviewed changes

tests/streamlit/test_streamlit_entity.py Outdated Show resolved Hide resolved

sfc-gh-svishnu added 19 commits November 12, 2025 11:10

Update --legacy flag help text: deployment → stages

1309439

Refactor: Extract legacy deployment logic into _deploy_legacy() method

2b149b9

For consistency with _deploy_versioned(), extracted the else block's deployment logic into a dedicated _deploy_legacy() method. This improves code organization and makes the deploy() method cleaner.

Use positive condition for legacy flag check

740cffd

Changed from 'if not legacy' to 'if legacy' for better readability. The positive condition directly maps to the flag name and avoids mental negation.

Fix lint: Break long lines to comply with 88 char limit

7c8c298

- Split long comment in _deploy_legacy() method - Break deprecation warning string across multiple lines - Format long test invocation call - Fix typo: elswhere → elsewhere

Fix black formatting

4f56d88

Add validation to prevent SPCS runtime v2 usage with --legacy flag

fec02b3

Add documentation for deprecated --experimental flag and parameter na…

0754b83

…ming

Fix test_artifacts.py tests to use --legacy flag for artifact tests

da1fbdf

Update help message snapshots for streamlit deploy

3ba38ed

- Add --legacy flag to streamlit deploy help text - Remove oauth-token-request-url parameter (deprecated) These changes reflect the new default versioned deployment behavior.

Restore oauth-token-request-url to streamlit.deploy help message

c14eadd

This parameter is a standard connection option that applies to all commands including streamlit. Cannot be removed from just streamlit.deploy.

Fix test_streamlit_deploy_prune_flag: add --overwrite flag for stream…

50600d8

…lit stage Snowflake requires overwrite=true when uploading to streamlit versioned stages. The test was failing because stage copy needs --overwrite flag when uploading to snow://streamlit/ managed stages.

Address PR review comments: simplify help text, use CliError, and red…

f6ac72f

…uce comment bloat

Fix test_streamlit_deploy_prune_flag database context mismatch

53e9220

Fix unit test: update exception type to CliError and mock bundle to a…

158030d

…void file errors

sfc-gh-svishnu added 4 commits November 12, 2025 11:10

Update help message snapshot for --legacy flag text change

6ba62e8

Add gitattributes to ensure snapshot files use consistent encoding ac…

58e55c2

…ross platforms

Fix Unicode smart quotes in snapshot file - replace with ASCII apostr…

7893253

…ophes

Address PR review comments: add RELEASE-NOTES entry, move test import…

731b0da

…s to top, add deployment style change warnings

sfc-gh-svishnu force-pushed the make-versioned-streamlit-default branch from f4cfb7f to 731b0da Compare November 12, 2025 19:10

sfc-gh-svishnu added 3 commits November 12, 2025 13:57

Fix integration test: use fully qualified stage name to match deploym…

6b82bac

…ent database context

Fix integration test: explicitly set database and schema for streamli…

a31d6ce

…t deploy commands

Fix integration test: remove explicit database/schema flags, rely on …

4635b8a

…test_database fixture env var

sfc-gh-svishnu force-pushed the make-versioned-streamlit-default branch from 1f5027a to 81a480e Compare November 13, 2025 06:30

sfc-gh-svishnu requested a review from sfc-gh-jwilkowski November 13, 2025 06:55

Fix integration test

78d7301

sfc-gh-svishnu force-pushed the make-versioned-streamlit-default branch from 81a480e to 78d7301 Compare November 13, 2025 07:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI #2685

SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI #2685

sfc-gh-svishnu commented Nov 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfc-gh-jwilkowski left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfc-gh-jwilkowski left a comment

Uh oh!

Uh oh!

sfc-gh-svishnu commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI #2685

Are you sure you want to change the base?

SNOW-2665953: Make Streamlit Deployment with Versioned Stages as Default in Snow CLI #2685

Conversation

sfc-gh-svishnu commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Changes

CLI Behavior

Implementation

Test Updates

Deployment Behavior Change

Impact

Using ROOT_LOCATION (Legacy Mode)

Backward Compatibility

Testing

Pre-review checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfc-gh-jwilkowski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfc-gh-jwilkowski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sfc-gh-svishnu commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sfc-gh-svishnu commented Nov 4, 2025 •

edited

Loading