snowflake-cli 3.2.2__py3-none-any.whl → 3.4.1__py3-none-any.whl

snowflake/cli/_plugins/nativeapp/codegen/compiler.py

@@ -33,23 +33,12 @@ from snowflake.cli._plugins.nativeapp.codegen.snowpark.python_processor import (
 from snowflake.cli._plugins.nativeapp.codegen.templates.templates_processor import (
     TemplatesProcessor,
 )
-from snowflake.cli._plugins.nativeapp.feature_flags import FeatureFlag
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console import cli_console as cc
 from snowflake.cli.api.metrics import CLICounterField
-from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
-    ProcessorMapping,
-)
-
-SNOWPARK_PROCESSOR = "snowpark"
-NA_SETUP_PROCESSOR = "native app setup"
-TEMPLATES_PROCESSOR = "templates"
+from snowflake.cli.api.project.schemas.entities.common import ProcessorMapping
 
-_REGISTERED_PROCESSORS_BY_NAME = {
-    SNOWPARK_PROCESSOR: SnowparkAnnotationProcessor,
-    NA_SETUP_PROCESSOR: NativeAppSetupProcessor,
-    TEMPLATES_PROCESSOR: TemplatesProcessor,
-}
+ProcessorClassType = type[ArtifactProcessor]
 
 
 class NativeAppCompiler:
@@ -66,10 +55,28 @@ class NativeAppCompiler:
         bundle_ctx: BundleContext,
     ):
         self._assert_absolute_paths(bundle_ctx)
+        self._processor_classes_by_name: Dict[str, ProcessorClassType] = {}
         self._bundle_ctx = bundle_ctx
         # dictionary of all processors created and shared between different artifact objects.
         self.cached_processors: Dict[str, ArtifactProcessor] = {}
 
+        self.register(SnowparkAnnotationProcessor)
+        self.register(NativeAppSetupProcessor)
+        self.register(TemplatesProcessor)
+
+    def register(self, processor_cls: ProcessorClassType):
+        """
+        Registers a processor class to enable.
+        """
+
+        name = getattr(processor_cls, "NAME", None)
+        assert name is not None
+
+        if name in self._processor_classes_by_name:
+            raise ValueError(f"Processor {name} is already registered")
+
+        self._processor_classes_by_name[str(name)] = processor_cls
+
     @staticmethod
     def _assert_absolute_paths(bundle_ctx: BundleContext):
         for name in ["Project", "Deploy", "Bundle", "Generated"]:
@@ -88,7 +95,10 @@ class NativeAppCompiler:
         if not self._should_invoke_processors():
             return
 
-        with cc.phase("Invoking artifact processors"):
+        with (
+            cc.phase("Invoking artifact processors"),
+            get_cli_context().metrics.span("artifact_processors"),
+        ):
             if self._bundle_ctx.generated_root.exists():
                 raise ClickException(
                     f"Path {self._bundle_ctx.generated_root} already exists. Please choose a different name for your generated directory in the project definition file."
@@ -125,8 +135,8 @@ class NativeAppCompiler:
         if current_processor is not None:
             return current_processor
 
-        processor_factory = _REGISTERED_PROCESSORS_BY_NAME.get(processor_name)
-        if processor_factory is None:
+        processor_cls = self._processor_classes_by_name.get(processor_name)
+        if processor_cls is None:
             # No registered processor with the specified name
             return None
 
@@ -138,7 +148,7 @@ class NativeAppCompiler:
         processor_ctx.generated_root = (
             self._bundle_ctx.generated_root / processor_subdirectory
         )
-        current_processor = processor_factory(processor_ctx)
+        current_processor = processor_cls(processor_ctx)
         self.cached_processors[processor_name] = current_processor
 
         return current_processor
@@ -151,6 +161,18 @@ class NativeAppCompiler:
         return False
 
     def _is_enabled(self, processor: ProcessorMapping) -> bool:
-        if processor.name.lower() == NA_SETUP_PROCESSOR:
-            return FeatureFlag.ENABLE_NATIVE_APP_PYTHON_SETUP.is_enabled()
-        return True
+        """
+        Determines is a process is enabled. All processors are considered enabled
+        unless they are explicitly disabled, typically via a feature flag.
+        """
+        processor_name = processor.name.lower()
+        processor_cls = self._processor_classes_by_name.get(processor_name)
+        if processor_cls is None:
+            # Unknown processor, consider it enabled, even though trying to
+            # invoke it later will raise an exception
+            return True
+
+        # if the processor class defines a static method named "is_enabled", then
+        # call it. Otherwise, it's considered enabled by default.
+        is_enabled_fn = getattr(processor_cls, "is_enabled", lambda: True)
+        return is_enabled_fn()

snowflake/cli/_plugins/nativeapp/codegen/setup/native_app_setup_processor.py

@@ -23,7 +23,6 @@ from typing import List, Optional
 import yaml
 from click import ClickException
 from snowflake.cli._plugins.nativeapp.artifacts import (
-    BundleMap,
     find_manifest_file,
     find_setup_script_file,
 )
@@ -36,9 +35,11 @@ from snowflake.cli._plugins.nativeapp.codegen.sandbox import (
     SandboxEnvBuilder,
     execute_script_in_sandbox,
 )
+from snowflake.cli._plugins.nativeapp.feature_flags import FeatureFlag
 from snowflake.cli._plugins.stage.diff import to_stage_path
+from snowflake.cli.api.artifacts.bundle_map import BundleMap
 from snowflake.cli.api.console import cli_console as cc
-from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
+from snowflake.cli.api.project.schemas.entities.common import (
     PathMapping,
     ProcessorMapping,
 )
@@ -74,9 +75,15 @@ def safe_set(d: dict, *keys: str, **kwargs) -> None:
 
 
 class NativeAppSetupProcessor(ArtifactProcessor):
+    NAME = "native app setup"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
+    @staticmethod
+    def is_enabled() -> bool:
+        return FeatureFlag.ENABLE_NATIVE_APP_PYTHON_SETUP.is_enabled()
+
     def process(
         self,
         artifact_to_process: PathMapping,

snowflake/cli/_plugins/nativeapp/codegen/snowpark/python_processor.py

@@ -22,7 +22,6 @@ from typing import Any, Dict, List, Optional, Set
 
 from pydantic import ValidationError
 from snowflake.cli._plugins.nativeapp.artifacts import (
-    BundleMap,
     find_setup_script_file,
 )
 from snowflake.cli._plugins.nativeapp.codegen.artifact_processor import (
@@ -48,10 +47,11 @@ from snowflake.cli._plugins.nativeapp.codegen.snowpark.models import (
     NativeAppExtensionFunction,
 )
 from snowflake.cli._plugins.stage.diff import to_stage_path
-from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.artifacts.bundle_map import BundleMap
+from snowflake.cli.api.cli_global_context import get_cli_context, span
 from snowflake.cli.api.console import cli_console as cc
 from snowflake.cli.api.metrics import CLICounterField
-from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
+from snowflake.cli.api.project.schemas.entities.common import (
     PathMapping,
     ProcessorMapping,
 )
@@ -164,9 +164,12 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
     and generate SQL code for creation of extension functions based on those discovered objects.
     """
 
+    NAME = "snowpark"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
+    @span("snowpark_processor")
     def process(
         self,
         artifact_to_process: PathMapping,

snowflake/cli/_plugins/nativeapp/codegen/templates/templates_processor.py

@@ -18,15 +18,15 @@ from pathlib import Path
 from typing import Any, Optional
 
 import jinja2
-from snowflake.cli._plugins.nativeapp.artifacts import BundleMap
 from snowflake.cli._plugins.nativeapp.codegen.artifact_processor import (
     ArtifactProcessor,
 )
 from snowflake.cli._plugins.nativeapp.exceptions import InvalidTemplateInFileError
-from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.artifacts.bundle_map import BundleMap
+from snowflake.cli.api.cli_global_context import get_cli_context, span
 from snowflake.cli.api.console import cli_console as cc
 from snowflake.cli.api.metrics import CLICounterField
-from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
+from snowflake.cli.api.project.schemas.entities.common import (
     PathMapping,
     ProcessorMapping,
 )
@@ -49,6 +49,8 @@ class TemplatesProcessor(ArtifactProcessor):
     Processor class to perform template expansion on all relevant artifacts (specified in the project definition file).
     """
 
+    NAME = "templates"
+
     def expand_templates_in_file(
         self, src: Path, dest: Path, template_context: dict[str, Any] | None = None
     ) -> None:
@@ -58,39 +60,47 @@ class TemplatesProcessor(ArtifactProcessor):
         if src.is_dir():
             return
 
-        with self.edit_file(dest) as file:
-            if not has_client_side_templates(file.contents) and not (
-                _is_sql_file(dest) and has_sql_templates(file.contents)
-            ):
-                return
-
-            src_file_name = src.relative_to(self._bundle_ctx.project_root)
-            cc.step(f"Expanding templates in {src_file_name}")
-            with cc.indented():
-                try:
-                    jinja_env = (
-                        choose_sql_jinja_env_based_on_template_syntax(
-                            file.contents, reference_name=src_file_name
+        src_file_name = src.relative_to(self._bundle_ctx.project_root)
+
+        try:
+            with self.edit_file(dest) as file:
+                if not has_client_side_templates(file.contents) and not (
+                    _is_sql_file(dest) and has_sql_templates(file.contents)
+                ):
+                    return
+                cc.step(f"Expanding templates in {src_file_name}")
+                with cc.indented():
+                    try:
+                        jinja_env = (
+                            choose_sql_jinja_env_based_on_template_syntax(
+                                file.contents, reference_name=src_file_name
+                            )
+                            if _is_sql_file(dest)
+                            else get_client_side_jinja_env()
+                        )
+                        expanded_template = jinja_env.from_string(file.contents).render(
+                            template_context or get_cli_context().template_context
                         )
-                        if _is_sql_file(dest)
-                        else get_client_side_jinja_env()
-                    )
-                    expanded_template = jinja_env.from_string(file.contents).render(
-                        template_context or get_cli_context().template_context
-                    )
-
-                # For now, we are printing the source file path in the error message
-                # instead of the destination file path to make it easier for the user
-                # to identify the file that has the error, and edit the correct file.
-                except jinja2.TemplateSyntaxError as e:
-                    raise InvalidTemplateInFileError(src_file_name, e, e.lineno) from e
-
-                except jinja2.UndefinedError as e:
-                    raise InvalidTemplateInFileError(src_file_name, e) from e
-
-                if expanded_template != file.contents:
-                    file.edited_contents = expanded_template
 
+                    # For now, we are printing the source file path in the error message
+                    # instead of the destination file path to make it easier for the user
+                    # to identify the file that has the error, and edit the correct file.
+                    except jinja2.TemplateSyntaxError as e:
+                        raise InvalidTemplateInFileError(
+                            src_file_name, e, e.lineno
+                        ) from e
+
+                    except jinja2.UndefinedError as e:
+                        raise InvalidTemplateInFileError(src_file_name, e) from e
+
+                    if expanded_template != file.contents:
+                        file.edited_contents = expanded_template
+        except UnicodeDecodeError as err:
+            cc.warning(
+                f"Could not read file {src_file_name}, error: {err.reason}. Skipping this file."
+            )
+
+    @span("templates_processor")
     def process(
         self,
         artifact_to_process: PathMapping,

snowflake/cli/_plugins/nativeapp/commands.py

@@ -22,6 +22,7 @@ from textwrap import dedent
 from typing import Generator, Iterable, List, Optional, cast
 
 import typer
+from snowflake.cli._plugins.nativeapp.artifacts import VersionInfo
 from snowflake.cli._plugins.nativeapp.common_flags import (
     ForceOption,
     InteractiveOption,
@@ -31,23 +32,25 @@ from snowflake.cli._plugins.nativeapp.entities.application import ApplicationEnt
 from snowflake.cli._plugins.nativeapp.entities.application_package import (
     ApplicationPackageEntityModel,
 )
+from snowflake.cli._plugins.nativeapp.release_channel.commands import (
+    app as release_channels_app,
+)
+from snowflake.cli._plugins.nativeapp.release_directive.commands import (
+    app as release_directives_app,
+)
+from snowflake.cli._plugins.nativeapp.sf_facade import get_snowflake_facade
 from snowflake.cli._plugins.nativeapp.v2_conversions.compat import (
     find_entity,
     force_project_definition_v2,
 )
 from snowflake.cli._plugins.nativeapp.version.commands import app as versions_app
-from snowflake.cli._plugins.stage.diff import (
-    DiffResult,
-    compute_stage_diff,
-)
-from snowflake.cli._plugins.stage.utils import print_diff_to_console
 from snowflake.cli._plugins.workspace.manager import WorkspaceManager
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.decorators import (
     with_project_definition,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.entities.common import EntityActions
+from snowflake.cli.api.entities.utils import EntityActions
 from snowflake.cli.api.exceptions import (
     IncompatibleParametersError,
     UnmetParametersError,
@@ -59,6 +62,7 @@ from snowflake.cli.api.output.types import (
     ObjectResult,
     StreamResult,
 )
+from snowflake.cli.api.project.util import same_identifiers
 from typing_extensions import Annotated
 
 app = SnowTyperFactory(
@@ -66,6 +70,8 @@ app = SnowTyperFactory(
     help="Manages a Snowflake Native App",
 )
 app.add_typer(versions_app)
+app.add_typer(release_directives_app)
+app.add_typer(release_channels_app)
 
 log = logging.getLogger(__name__)
 
@@ -108,20 +114,15 @@ def app_diff(
         project_root=cli_context.project_root,
     )
     package_id = options["package_entity_id"]
-    package = cli_context.project_definition.entities[package_id]
-    bundle_map = ws.perform_action(
+    diff = ws.perform_action(
         package_id,
-        EntityActions.BUNDLE,
-    )
-    stage_fqn = f"{package.fqn.name}.{package.stage}"
-    diff: DiffResult = compute_stage_diff(
-        local_root=Path(package.deploy_root), stage_fqn=stage_fqn
+        EntityActions.DIFF,
+        print_to_console=cli_context.output_format != OutputFormat.JSON,
     )
     if cli_context.output_format == OutputFormat.JSON:
         return ObjectResult(diff.to_dict())
-    else:
-        print_diff_to_console(diff, bundle_map)
-        return None  # don't print any output
+
+    return None
 
 
 @app.command("run", requires_connection=True)
@@ -146,6 +147,12 @@ def app_run(
         The command fails if no release directive exists for your Snowflake account for a given application package, which is determined from the project definition file. Default: unset.""",
         is_flag=True,
     ),
+    channel: str = typer.Option(
+        None,
+        show_default=False,
+        help=f"""The name of the release channel to use when creating or upgrading an application instance from a release directive.
+        Requires the `--from-release-directive` flag to be set. If unset, the default channel will be used.""",
+    ),
     interactive: bool = InteractiveOption,
     force: Optional[bool] = ForceOption,
     validate: bool = ValidateOption,
@@ -174,6 +181,7 @@ def app_run(
         paths=[],
         interactive=interactive,
         force=force,
+        release_channel=channel,
     )
     app = ws.get_entity(app_id)
     return MessageResult(
@@ -198,7 +206,7 @@ def app_open(
     )
     app_id = options["app_entity_id"]
     app = ws.get_entity(app_id)
-    if app.get_existing_app_info():
+    if get_snowflake_facade().get_existing_app_info(app.name, app.role):
         typer.launch(app.get_snowsight_url())
         return MessageResult(f"Snowflake Native App opened in browser.")
     else:
@@ -221,7 +229,7 @@ def app_teardown(
     # Same as the param auto-added by @force_project_definition_v2 if single_app_and_package were true
     package_entity_id: Optional[str] = typer.Option(
         default="",
-        help="The ID of the package entity on which to operate when definition_version is 2 or higher.",
+        help="The ID of the package entity on which to operate when the definition_version is 2 or higher.",
     ),
     **options,
 ) -> CommandResult:
@@ -246,11 +254,22 @@ def app_teardown(
         project_definition=cli_context.project_definition,
         project_root=cli_context.project_root,
     )
+
+    # TODO: get all apps created from this application package from snowflake, compare, confirm and drop.
+    # TODO: add messaging/confirmation here for extra apps found as part of above
+    all_packages_with_id = [
+        package_entity.entity_id
+        for package_entity in project.get_entities_by_type(
+            ApplicationPackageEntityModel.get_type()
+        ).values()
+        if same_identifiers(package_entity.fqn.name, app_package_entity.fqn.name)
+    ]
+
     for app_entity in project.get_entities_by_type(
         ApplicationEntityModel.get_type()
     ).values():
         # Drop each app
-        if app_entity.from_.target == app_package_entity.entity_id:
+        if app_entity.from_.target in all_packages_with_id:
             ws.perform_action(
                 app_entity.entity_id,
                 EntityActions.DROP,
@@ -289,7 +308,7 @@ def app_deploy(
         show_default=False,
         help=dedent(
             f"""
-            Paths, relative to the the project root, of files or directories you want to upload to a stage. If a file is
+            Paths, relative to the project root, of files or directories you want to upload to a stage. If a file is
             specified, it must match one of the artifacts src pattern entries in snowflake.yml. If a directory is
             specified, it will be searched for subfolders or files to deploy based on artifacts src pattern entries. If
             unspecified, the command syncs all local changes to the stage."""
@@ -357,7 +376,10 @@ def app_validate(
     if cli_context.output_format == OutputFormat.JSON:
         return ObjectResult(
             package.get_validation_result(
-                use_scratch_stage=True, interactive=False, force=True
+                action_ctx=ws.action_ctx,
+                use_scratch_stage=True,
+                interactive=False,
+                force=True,
             )
         )
 
@@ -513,3 +535,73 @@ class EventResult(ObjectResult, MessageResult):
     @property
     def result(self):
         return self._element
+
+
+@app.command("publish", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def app_publish(
+    version: Optional[str] = typer.Option(
+        default=None,
+        show_default=False,
+        help="The version to publish to the provided release channel and release directive. Version is required to exist unless `--create-version` flag is used.",
+    ),
+    patch: Optional[int] = typer.Option(
+        default=None,
+        show_default=False,
+        help="The patch number under the given version. This will be used when setting the release directive. Patch is required to exist unless `--create-version` flag is used.",
+    ),
+    channel: Optional[str] = typer.Option(
+        "DEFAULT",
+        help="The name of the release channel to publish to. If not provided, the default release channel is used.",
+    ),
+    directive: Optional[str] = typer.Option(
+        "DEFAULT",
+        help="The name of the release directive to update with the specified version and patch. If not provided, the default release directive is used.",
+    ),
+    interactive: bool = InteractiveOption,
+    force: Optional[bool] = ForceOption,
+    create_version: bool = typer.Option(
+        False,
+        "--create-version",
+        help="Create a new version or patch based on the provided `--version` and `--patch` values. Fallback to the manifest values if not provided.",
+        is_flag=True,
+    ),
+    from_stage: bool = typer.Option(
+        False,
+        "--from-stage",
+        help="When enabled, the Snowflake CLI creates a version from the current application package stage without syncing to the stage first. Can only be used with `--create-version` flag.",
+        is_flag=True,
+    ),
+    label: Optional[str] = typer.Option(
+        None,
+        "--label",
+        help="A label for the version that is displayed to consumers. Can only be used with `--create-version` flag.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Adds the version to the release channel and updates the release directive with the new version and patch.
+    """
+    cli_context = get_cli_context()
+    ws = WorkspaceManager(
+        project_definition=cli_context.project_definition,
+        project_root=cli_context.project_root,
+    )
+    package_id = options["package_entity_id"]
+    version_info: VersionInfo = ws.perform_action(
+        package_id,
+        EntityActions.PUBLISH,
+        version=version,
+        patch=patch,
+        release_channel=channel,
+        release_directive=directive,
+        interactive=interactive,
+        force=force,
+        create_version=create_version,
+        from_stage=from_stage,
+        label=label,
+    )
+    return MessageResult(
+        f"Version {version_info.version_name} and patch {version_info.patch_number} published to release directive {directive} of release channel {channel}."
+    )

snowflake/cli/_plugins/nativeapp/constants.py

@@ -22,7 +22,12 @@ COMMENT_COL = "comment"
 OWNER_COL = "owner"
 VERSION_COL = "version"
 PATCH_COL = "patch"
+CHANNEL_COL = "release_channel_name"
 AUTHORIZE_TELEMETRY_COL = "authorize_telemetry_event_sharing"
 
 INTERNAL_DISTRIBUTION = "internal"
 EXTERNAL_DISTRIBUTION = "external"
+
+DEFAULT_CHANNEL = "DEFAULT"
+DEFAULT_DIRECTIVE = "DEFAULT"
+MAX_VERSIONS_IN_RELEASE_CHANNEL = 2