snowflake-cli-labs 2.8.0rc1__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

snowflake/cli/{plugins → _plugins}/nativeapp/commands.py

@@ -14,60 +14,63 @@
 
 from __future__ import annotations
 
+import itertools
 import logging
+from enum import Enum
 from pathlib import Path
 from textwrap import dedent
-from typing import List, Optional
+from typing import Generator, Iterable, List, Optional, cast
 
 import typer
-from click import ClickException
-from snowflake.cli.api.cli_global_context import 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.output.formats import OutputFormat
-from snowflake.cli.api.output.types import (
-    CollectionResult,
-    CommandResult,
-    MessageResult,
-    ObjectResult,
-    StreamResult,
-)
-from snowflake.cli.api.project.project_verification import assert_project_type
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.plugins.nativeapp.common_flags import (
+from snowflake.cli._plugins.nativeapp.common_flags import (
     ForceOption,
     InteractiveOption,
     ValidateOption,
 )
-from snowflake.cli.plugins.nativeapp.init import (
+from snowflake.cli._plugins.nativeapp.init import (
     OFFICIAL_TEMPLATES_GITHUB_URL,
     nativeapp_init,
 )
-from snowflake.cli.plugins.nativeapp.manager import NativeAppManager
-from snowflake.cli.plugins.nativeapp.policy import (
+from snowflake.cli._plugins.nativeapp.manager import NativeAppManager
+from snowflake.cli._plugins.nativeapp.policy import (
     AllowAlwaysPolicy,
     AskAlwaysPolicy,
     DenyAlwaysPolicy,
 )
-from snowflake.cli.plugins.nativeapp.run_processor import NativeAppRunProcessor
-from snowflake.cli.plugins.nativeapp.teardown_processor import (
+from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
+from snowflake.cli._plugins.nativeapp.teardown_processor import (
     NativeAppTeardownProcessor,
 )
-from snowflake.cli.plugins.nativeapp.utils import (
+from snowflake.cli._plugins.nativeapp.utils import (
     get_first_paragraph_from_markdown_file,
     shallow_git_clone,
 )
-from snowflake.cli.plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
+from snowflake.cli._plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
     nativeapp_definition_v2_to_v1,
 )
-from snowflake.cli.plugins.nativeapp.version.commands import app as versions_app
-from snowflake.cli.plugins.stage.diff import (
+from snowflake.cli._plugins.nativeapp.version.commands import app as versions_app
+from snowflake.cli._plugins.stage.diff import (
     DiffResult,
     compute_stage_diff,
-    print_diff_to_console,
 )
+from snowflake.cli._plugins.stage.utils import print_diff_to_console
+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.exceptions import IncompatibleParametersError
+from snowflake.cli.api.output.formats import OutputFormat
+from snowflake.cli.api.output.types import (
+    CollectionResult,
+    CommandResult,
+    MessageResult,
+    ObjectResult,
+    StreamResult,
+)
+from snowflake.cli.api.project.project_verification import assert_project_type
+from snowflake.cli.api.secure_path import SecurePath
+from typing_extensions import Annotated
 
 app = SnowTyperFactory(
     name="app",
@@ -83,6 +86,7 @@ def app_init(
     path: str = typer.Argument(
         ...,
         help=f"""Directory to be initialized with the Snowflake Native App project. This directory must not already exist.""",
+        show_default=False,
     ),
     name: str = typer.Option(
         None,
@@ -166,6 +170,7 @@ def app_bundle(
 
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     manager = NativeAppManager(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -185,6 +190,7 @@ def app_diff(
     """
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     manager = NativeAppManager(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -243,6 +249,7 @@ def app_run(
     else:
         policy = DenyAlwaysPolicy()
 
+    cli_context = get_cli_context()
     processor = NativeAppRunProcessor(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -276,6 +283,7 @@ def app_open(
 
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     manager = NativeAppManager(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -308,6 +316,7 @@ def app_teardown(
 
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     processor = NativeAppTeardownProcessor(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -362,8 +371,9 @@ def app_deploy(
             recursive = False
 
     if has_paths and prune:
-        raise ClickException("--prune cannot be used when paths are also specified")
+        raise IncompatibleParametersError(["paths", "--prune"])
 
+    cli_context = get_cli_context()
     manager = NativeAppManager(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -393,6 +403,7 @@ def app_validate(**options):
 
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     manager = NativeAppManager(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -404,26 +415,144 @@ def app_validate(**options):
     return MessageResult("Snowflake Native App validation succeeded.")
 
 
-@app.command("events", hidden=True, requires_connection=True)
+class RecordType(Enum):
+    LOG = "log"
+    SPAN = "span"
+    SPAN_EVENT = "span_event"
+
+
+# The default number of lines to print before streaming when running
+# snow app events --follow
+DEFAULT_EVENT_FOLLOW_LAST = 20
+
+
+@app.command("events", requires_connection=True)
 @with_project_definition()
 @nativeapp_definition_v2_to_v1
-def app_events(**options):
-    """Fetches events for this app from the event table configured in Snowflake."""
+def app_events(
+    since: str = typer.Option(
+        default="",
+        help="Fetch events that are newer than this time ago, in Snowflake interval syntax.",
+    ),
+    until: str = typer.Option(
+        default="",
+        help="Fetch events that are older than this time ago, in Snowflake interval syntax.",
+    ),
+    record_types: Annotated[
+        list[RecordType], typer.Option(case_sensitive=False)
+    ] = typer.Option(
+        [],
+        "--type",
+        help="Restrict results to specific record type. Can be specified multiple times.",
+    ),
+    scopes: Annotated[list[str], typer.Option()] = typer.Option(
+        [],
+        "--scope",
+        help="Restrict results to a specific scope name. Can be specified multiple times.",
+    ),
+    consumer_org: str = typer.Option(
+        default="", help="The name of the consumer organization."
+    ),
+    consumer_account: str = typer.Option(
+        default="",
+        help="The name of the consumer account in the organization.",
+    ),
+    consumer_app_hash: str = typer.Option(
+        default="",
+        help="The SHA-1 hash of the consumer application name",
+    ),
+    first: int = typer.Option(
+        default=-1,
+        show_default=False,
+        help="Fetch only the first N events. Cannot be used with --last.",
+    ),
+    last: int = typer.Option(
+        default=-1,
+        show_default=False,
+        help="Fetch only the last N events. Cannot be used with --first.",
+    ),
+    follow: bool = typer.Option(
+        False,
+        "--follow",
+        "-f",
+        help=(
+            f"Continue polling for events. Implies --last {DEFAULT_EVENT_FOLLOW_LAST} "
+            f"unless overridden or the --since flag is used."
+        ),
+    ),
+    follow_interval: int = typer.Option(
+        10,
+        help=f"Polling interval in seconds when using the --follow flag.",
+    ),
+    **options,
+):
+    """Fetches events for this app from the event table configured in Snowflake.
+
+    By default, this command will fetch events generated by an app installed in the
+    current connection's account. To fetch events generated by an app installed
+    in a consumer account, use the --consumer-org and --consumer-account options.
+    This requires event sharing to be set up to route events to the provider account:
+    https://docs.snowflake.com/en/developer-guide/native-apps/setting-up-logging-and-events
+    """
+    if first >= 0 and last >= 0:
+        raise IncompatibleParametersError(["--first", "--last"])
+
+    if (consumer_org and not consumer_account) or (
+        consumer_account and not consumer_org
+    ):
+        raise IncompatibleParametersError(["--consumer-org", "--consumer-account"])
+
+    if follow:
+        if until:
+            raise IncompatibleParametersError(["--follow", "--until"])
+        if first >= 0:
+            raise IncompatibleParametersError(["--follow", "--first"])
+
     assert_project_type("native_app")
 
+    record_type_names = [r.name for r in record_types]
     manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
+        project_definition=get_cli_context().project_definition.native_app,
+        project_root=get_cli_context().project_root,
     )
-    events = manager.get_events()
-    if not events:
-        return MessageResult("No events found.")
-
-    def g():
-        for event in events:
-            yield EventResult(event)
+    if follow:
+        if last == -1 and not since:
+            # If we don't have a value for --last or --since, assume a value
+            # for --last so we at least print something before starting the stream
+            last = DEFAULT_EVENT_FOLLOW_LAST
+        stream: Iterable[CommandResult] = (
+            EventResult(event)
+            for event in manager.stream_events(
+                since=since,
+                last=last,
+                interval_seconds=follow_interval,
+                record_types=record_type_names,
+                scopes=scopes,
+                consumer_org=consumer_org,
+                consumer_account=consumer_account,
+                consumer_app_hash=consumer_app_hash,
+            )
+        )
+        # Append a newline at the end to make the CLI output clean when we hit Ctrl-C
+        stream = itertools.chain(stream, [MessageResult("")])
+    else:
+        stream = (
+            EventResult(event)
+            for event in manager.get_events(
+                since=since,
+                until=until,
+                record_types=record_type_names,
+                scopes=scopes,
+                first=first,
+                last=last,
+                consumer_org=consumer_org,
+                consumer_account=consumer_account,
+                consumer_app_hash=consumer_app_hash,
+            )
+        )
 
-    return StreamResult(g())
+    # Cast the stream to a Generator since that's what StreamResult wants
+    return StreamResult(cast(Generator[CommandResult, None, None], stream))
 
 
 class EventResult(ObjectResult, MessageResult):

snowflake/cli/{plugins → _plugins}/nativeapp/common_flags.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 import typer
-from snowflake.cli.plugins.nativeapp.utils import is_tty_interactive
+from snowflake.cli._plugins.nativeapp.utils import is_tty_interactive
 
 
 def interactive_callback(val):

snowflake/cli/{plugins → _plugins}/nativeapp/exceptions.py

@@ -64,15 +64,15 @@ class MissingScriptError(ClickException):
         super().__init__(f'Script "{relpath}" does not exist')
 
 
-class InvalidScriptError(ClickException):
-    """A referenced script had syntax error(s)."""
+class InvalidTemplateInFileError(ClickException):
+    """A referenced templated file had syntax error(s)."""
 
     def __init__(
         self, relpath: str, err: jinja2.TemplateError, lineno: Optional[int] = None
     ):
         lineno_str = f":{lineno}" if lineno is not None else ""
         super().__init__(
-            f'Script "{relpath}{lineno_str}" does not contain a valid template: {err.message}'
+            f'File "{relpath}{lineno_str}" does not contain a valid template: {err.message}'
         )
         self.err = err
 

snowflake/cli/{plugins → _plugins}/nativeapp/init.py

@@ -242,7 +242,7 @@ def _init_from_template(
     try:
         with SecurePath.temporary_directory() as temp_path:
             from git import rmtree as git_rmtree
-            from snowflake.cli.plugins.nativeapp.utils import shallow_git_clone
+            from snowflake.cli._plugins.nativeapp.utils import shallow_git_clone
 
             shallow_git_clone(git_url, temp_path.path)