Remote Dev Plugin Part 2 - Add basic remote commands by sfc-gh-zzhu · Pull Request #2546 · snowflakedb/snowflake-cli

sfc-gh-zzhu · 2025-08-16T18:19:24Z

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.

Changes description

This PR adds several new basic commands to remote plugin, to create, manage, and connect to remote development environments running on SPCS Services. The plugin provides the following commands:

snow remote start: Creates a new VS Code Server remote development environment or resumes an existing one
snow remote list: Lists all remote development environments
snow remote stop: Suspends a remote development environment
snow remote delete: Deletes a remote development environment

The remote environments are deployed as SPCS Services with a web-based VS Code Server interface, allowing users to develop directly in Snowflake without local setup requirements. More details can be found in https://docs.google.com/document/d/1M0gV7soTy3dOadwgaUQrdKdkgR6YEUiwmBgMPlj_h5I/edit?usp=sharing

sfc-gh-zzhu · 2025-08-16T18:19:37Z

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

graphite-app · 2025-08-16T20:08:01Z

src/snowflake/cli/_plugins/remote/manager.py

+        # If it already starts with SNOW_REMOTE_, use as-is
+        if name_input.startswith(f"{SERVICE_NAME_PREFIX}_"):
+            return name_input


The prefix check should be case-insensitive since service names are converted to uppercase later in the code. Consider modifying this to:

if name_input.upper().startswith(f"{SERVICE_NAME_PREFIX}_"):

This ensures consistent handling regardless of the input case, matching the uppercase conversion applied in the else branch.

Suggested change

# If it already starts with SNOW_REMOTE_, use as-is

if name_input.startswith(f"{SERVICE_NAME_PREFIX}_"):

return name_input

# If it already starts with SNOW_REMOTE_, use as-is (case-insensitive)

if name_input.upper().startswith(f"{SERVICE_NAME_PREFIX}_"):

return name_input

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

+1, also consider resolving snowflake identifier rules (e.g. stripping quotes, etc)

sfc-gh-dhung

brb

sfc-gh-dhung · 2025-08-20T17:55:24Z

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

+    stage: Optional[str] = typer.Option(
+        None,
+        "--stage",
+        help="Internal Snowflake stage to mount (e.g., @my_stage or @my_stage/folder). Maximum 5 stage volumes per service.",


What do you mean by Maximum 5 stage volumes? The Optional[str] type implies this is at most max 1?

That's inherited from SPCS doc but it doesn't make sense here. I will remove it.

sfc-gh-dhung · 2025-08-20T17:55:47Z

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

+    image_tag: Optional[str] = typer.Option(
+        None,
+        "--image-tag",
+        help="Custom image tag to use for the remote development environment",


Is this limited to image tag or can it be full image path override?

This is just for image tag for now. Given that we will have custom image, I will change it to allow the full image path

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

src/snowflake/cli/_plugins/remote/constants.py

sfc-gh-dhung · 2025-08-20T21:48:02Z

src/snowflake/cli/_plugins/remote/manager.py

+        result = self.execute_query("SELECT CURRENT_USER()").fetchone()
+        return result[0] if result else "unknown"


Will fetchone() throw if somehow the query result is empty?

It will return None if the result is empty

sfc-gh-dhung · 2025-08-20T21:49:33Z

src/snowflake/cli/_plugins/remote/manager.py

+                            "Current status for %s: %s", service_name, current_status
+                        )
+                        return True, current_status
+                    else:


is status_json ever a dict?

It shouldn't be. The check here is just to make sure the output we get is in the expected format.

sfc-gh-dhung · 2025-08-20T21:50:14Z

src/snowflake/cli/_plugins/remote/manager.py

+        except Exception as e:
+            log.debug("Error checking service status for %s: %s", service_name, e)
+
+        return False, None


Should this be SERVICE_STATUS_UNKNOWN instead of None?

I feel both could work here. I prefer to use None here to clear indicate no status information available.

sfc-gh-dhung · 2025-08-20T21:51:40Z

src/snowflake/cli/_plugins/remote/manager.py

+            services = list_cursor.fetchall()
+
+            for service_row in services:
+                if len(service_row) > 0 and service_row[0] == service_name:


Does the Row have column names? May be better to use those instead of plain indexes

sfc-gh-dhung · 2025-08-20T21:52:40Z

src/snowflake/cli/_plugins/remote/manager.py

+        # If it already starts with SNOW_REMOTE_, use as-is
+        if name_input.startswith(f"{SERVICE_NAME_PREFIX}_"):
+            return name_input


+1, also consider resolving snowflake identifier rules (e.g. stripping quotes, etc)

src/snowflake/cli/_plugins/remote/manager.py

sfc-gh-dhung · 2025-08-20T21:59:40Z

src/snowflake/cli/_plugins/remote/manager.py

+            # Assuming the row format is [name, port, public, protocol, host, url]
+            if len(row) >= 6 and row[0] == SERVER_UI_ENDPOINT_NAME:
+                return row[5]  # Return the URL


Does the Row provide column names?

Addressed in the next pr

src/snowflake/cli/_plugins/remote/container_spec.py

graphite-app · 2025-09-05T00:49:06Z

src/snowflake/cli/_plugins/remote/manager.py

+
+            # Use DESC SERVICE to get service information
+            # This returns exactly one row with service details, or none if service doesn't exist
+            desc_query = f"DESC SERVICE {service_name}"


Security Concern: There's a potential SQL injection vulnerability in this line. The service_name parameter is directly interpolated into the SQL query using an f-string without proper escaping or parameterization.

Consider using parameterized queries or proper SQL escaping instead. For example:

desc_query = "DESC SERVICE ?" cursor = self.execute_query(desc_query, params=[service_name])

This would ensure that any special characters in the service name are properly handled and prevent potential SQL injection attacks.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

sfc-gh-zzhu mentioned this pull request Aug 16, 2025

Remote Dev Plugin Part 1 - Register the remote dev plugin and add utils #2545

Open

8 tasks

sfc-gh-zzhu marked this pull request as ready for review August 16, 2025 18:25

sfc-gh-zzhu requested a review from a team as a code owner August 16, 2025 18:25

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from 98046df to 62e1d62 Compare August 16, 2025 20:06

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from f6da57b to 2ff889f Compare August 16, 2025 20:06

graphite-app bot reviewed Aug 16, 2025

View reviewed changes

sfc-gh-zzhu changed the title ~~Add basic remote commands~~ Remote Dev Plugin Part 2 - Add basic remote commands Aug 16, 2025

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from 2ff889f to ecd97e7 Compare August 17, 2025 20:18

sfc-gh-zzhu requested a review from a team as a code owner August 17, 2025 20:18

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch 2 times, most recently from 8edd47b to d8a093f Compare August 17, 2025 22:05

sfc-gh-zzhu mentioned this pull request Aug 17, 2025

Remote Dev Plugin Part 3 - Enable remote ssh connection #2547

Open

8 tasks

sfc-gh-zzhu requested a review from sfc-gh-dhung August 18, 2025 17:31

sfc-gh-dhung reviewed Aug 20, 2025

View reviewed changes

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from ecd97e7 to c970827 Compare August 22, 2025 23:02

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from d8a093f to 78b3491 Compare August 22, 2025 23:02

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from c970827 to d974a63 Compare August 25, 2025 18:16

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch 2 times, most recently from 1bba2fd to e1581b0 Compare August 25, 2025 22:06

graphite-app bot reviewed Aug 25, 2025

View reviewed changes

src/snowflake/cli/_plugins/remote/container_spec.py Show resolved Hide resolved

sfc-gh-zzhu mentioned this pull request Aug 28, 2025

Remote Dev Plugin Part 4 - bug fix and feature improvement #2569

Open

9 tasks

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from e1581b0 to 9f4cced Compare September 5, 2025 00:47

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from d974a63 to 440fe61 Compare September 5, 2025 00:47

graphite-app bot reviewed Sep 5, 2025

View reviewed changes

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from 9f4cced to 777824b Compare September 15, 2025 05:30

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from 440fe61 to 5a2e34a Compare September 15, 2025 05:30

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from 777824b to 564142b Compare September 19, 2025 19:18

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from 5a2e34a to 3137229 Compare September 19, 2025 19:18

sfc-gh-zzhu mentioned this pull request Sep 29, 2025

Address feedbacks #2636

Draft

9 tasks

Add basic remote commands

a794fed

sfc-gh-zzhu force-pushed the 08-16-add_basic_remote_commands branch from 564142b to a794fed Compare October 17, 2025 18:42

sfc-gh-zzhu force-pushed the 08-16-add_remote_dev_plugin_register_the_remote_dev_plugin_and_add_remote_dev_container_spec branch from 3137229 to 2f06000 Compare October 17, 2025 18:42

sfc-gh-zzhu mentioned this pull request Oct 17, 2025

Add default block volume for persistent storage #2660

Draft

9 tasks

		result = self.execute_query("SELECT CURRENT_USER()").fetchone()
		return result[0] if result else "unknown"

Comments

Conversation

sfc-gh-zzhu commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-review checklist

Changes description

Uh oh!

sfc-gh-zzhu commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graphite-app bot Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfc-gh-dhung left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

graphite-app bot Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sfc-gh-zzhu commented Aug 16, 2025 •

edited

Loading

sfc-gh-zzhu commented Aug 16, 2025 •

edited

Loading