tinybird-cli 5.4.1.dev2__tar.gz → 5.4.1.dev4__tar.gz

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinybird-cli
-Version: 5.4.1.dev2
+Version: 5.4.1.dev4
 Summary: Tinybird Command Line Tool
 Home-page: https://www.tinybird.co/docs/cli/introduction.html
 Author: Tinybird
@@ -18,6 +18,16 @@ The Tinybird command-line tool allows you to use all the Tinybird functionality
 Changelog
 ----------
 
+5.4.1.dev4
+**********
+
+- `Improved` info and error messages when using "user token" vs "admin your@email.com" token
+
+5.4.1.dev3
+**********
+
+- `Changed` Internal change
+
 5.4.1.dev1
 **********
 

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/__cli__.py

@@ -4,5 +4,5 @@ __description__ = 'Tinybird Command Line Tool'
 __url__ = 'https://www.tinybird.co/docs/cli/introduction.html'
 __author__ = 'Tinybird'
 __author_email__ = 'support@tinybird.co'
-__version__ = '5.4.1.dev2'
-__revision__ = '5e2ca7a'
+__version__ = '5.4.1.dev4'
+__revision__ = 'f135c10'

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/datafile.py

@@ -3047,20 +3047,14 @@ async def new_ds(
                 and params.get("connector")
                 and params.get("bucket_uri")
             ):
-                data = await client.preview_bucket(params["connector"], params["bucket_uri"])
-                if data:
-                    files = data.get("files", [])
-                    if len(files) > 0:
-                        file_name = files[0].get("name", "")
-                        extension = file_name.split(".")[-1]
-                        if extension == "gz":
-                            extension = file_name.split(".")[-2]
-                        valid_formats = ["csv", "json", "jsonl", "ndjson", "parquet"]
-                        if extension not in valid_formats:
-                            raise Exception(
-                                FeedbackManager.error_format(extension=extension, valid_formats=valid_formats)
-                            )
-                        params["format"] = extension
+                bucket_uri = params.get("bucket_uri")
+                extension = bucket_uri.split(".")[-1]
+                if extension == "gz":
+                    extension = bucket_uri.split(".")[-2]
+                valid_formats = ["csv", "json", "jsonl", "ndjson", "parquet"]
+                if extension not in valid_formats:
+                    raise Exception(FeedbackManager.error_format(extension=extension, valid_formats=valid_formats))
+                params["format"] = extension
             datasource_response = await client.datasource_create_from_definition(params)
             datasource = datasource_response.get("datasource", {})
 

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/feedback_manager.py

@@ -654,7 +654,6 @@ Ready? """
     info_dependency_list_item = info_message("** --- {dependency}")
     info_no_dependencies_found = info_message("** No dependencies found for {dependency}")
     info_no_compatible_dependencies_found = info_message("** Data Sources with incompatible partitions found:")
-    info_admin_token = info_message("** Go to {host}/tokens, copy the admin token and paste it")
     info_append_data = info_message("** => If you want to insert data use: $ tb datasource append")
     info_datasources = info_message("** Data Sources:")
     info_connections = info_message("** Connections:")

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/sql_template.py

@@ -20,6 +20,7 @@ from .tornado_template import VALID_CUSTOM_FUNCTION_NAMES, SecurityException, Te
 TB_SECRET_IN_TEST_MODE = "tb_secret_dont_raise"
 TB_SECRET_PREFIX = "tb_secret_"
 CH_PARAM_PREFIX = "param_"
+REQUIRED_PARAM_NOT_DEFINED = "Required parameter is not defined"
 
 
 def secret_template_key(secret_name: str) -> str:
@@ -129,9 +130,7 @@ def transform_type(
             x = default
             if x is None:
                 if defined:
-                    raise SQLTemplateException(
-                        "Required parameter is not defined", documentation="/cli/advanced-templates.html"
-                    )
+                    raise SQLTemplateException(REQUIRED_PARAM_NOT_DEFINED, documentation="/cli/advanced-templates.html")
                 else:
                     return None
         if tester == "String":
@@ -378,7 +377,7 @@ def array_type(types):  # noqa: C901
                 if x is None:
                     if defined:
                         raise SQLTemplateException(
-                            "Required parameter is not defined", documentation="/cli/advanced-templates.html"
+                            REQUIRED_PARAM_NOT_DEFINED, documentation="/cli/advanced-templates.html"
                         )
                     else:
                         return None
@@ -1866,26 +1865,25 @@ def get_template_and_variables(sql: str, name: Optional[str], escape_arrays: boo
         raise SQLTemplateException(e)
 
 
-def preprocess_variables(variables: dict, t: Template):
+def preprocess_variables(variables: dict, template_variables_with_types: List[dict]):
     """
-    >>> preprocess_variables({"test": "1,2"}, Template("select * from table where f = {{Array(test, 'String')}}"))
+    >>> preprocess_variables({"test": '24'}, [{"name": "test", "type": "Int32", "default": None}])
+    {}
+    >>> preprocess_variables({"test": "1,2"}, [{"name": "test", "type": "Array(String)", "default": None}])
     {'test': ['1', '2']}
-    >>> preprocess_variables({"test": ['1', '2']}, Template("select * from table where f = {{Array(test, 'String')}}"))
+    >>> preprocess_variables({"test": ['1', '2']}, [{"name": "test", "type": "Array(String)", "default": None}])
     {'test': ['1', '2']}
-    >>> preprocess_variables({"test": [1,2]}, Template("select * from table where f = {{Array(test, 'String')}}"))
+    >>> preprocess_variables({"test": [1,2]}, [{"name": "test", "type": "Array(String)", "default": None}])
     {'test': ['1', '2']}
-    >>> preprocess_variables({"test": '24'}, Template("select * from table where f = {{Int32(test)}}"))
-    {}
-    >>> preprocess_variables({"test": "1,2,3"}, Template("select * from table where f = {{Array(test,'Int32')}}"))
+    >>> preprocess_variables({"test": "1,2,3"}, [{"name": "test", "type": "Array(Int32)", "default": None}])
     {'test': [1, 2, 3]}
-    >>> preprocess_variables({"test": "1,2,msg"}, Template("select * from table where f = {{Array(test,'Int32')}}"))
+    >>> preprocess_variables({"test": "1,2,msg"}, [{"name": "test", "type": "Array(Int32)", "default": None}])
     {}
     """
-    template_variables = get_var_names_and_types_cached(t)
     processed_variables = {}
     for variable, value in variables.items():
         try:
-            template_vars = [t_var for t_var in template_variables if t_var["name"] == variable] or None
+            template_vars = [t_var for t_var in template_variables_with_types if t_var["name"] == variable] or None
             if template_vars is None or value is None:
                 continue
 
@@ -1909,6 +1907,43 @@ def preprocess_variables(variables: dict, t: Template):
     return processed_variables
 
 
+def format_SQLTemplateException_message(e: SQLTemplateException, vars_and_types: Optional[dict] = None):
+    def join_with_different_last_separator(items, separator=", ", last_separator=" and "):
+        if not items:
+            return ""
+        if len(items) == 1:
+            return items[0]
+
+        result = separator.join(items[:-1])
+        return result + last_separator + items[-1]
+
+    message = str(e)
+    var_names = ""
+
+    try:
+        if REQUIRED_PARAM_NOT_DEFINED in message and vars_and_types:
+            vars_with_default_none = []
+            for item in vars_and_types:
+                if (
+                    item.get("default") is None
+                    and item.get("used_in", None) is None
+                    and item.get("name") not in vars_with_default_none
+                ):
+                    vars_with_default_none.append(item["name"])
+
+            var_names = join_with_different_last_separator(vars_with_default_none)
+    except Exception:
+        pass
+
+    if var_names:
+        raise SQLTemplateException(
+            f"{REQUIRED_PARAM_NOT_DEFINED}. Check the parameters {join_with_different_last_separator(vars_with_default_none)}. Please provide a value or set a default value in the pipe code.",
+            e.documentation,
+        )
+    else:
+        raise e
+
+
 def render_sql_template(
     sql: str,
     variables: Optional[dict] = None,
@@ -2131,6 +2166,14 @@ def render_sql_template(
     Traceback (most recent call last):
     ...
     tinybird.sql_template.SQLTemplateException: Template Syntax Error: Cannot access secret 'test'. Check the secret exists in the Workspace and the token has the required scope.
+    >>> render_sql_template("select * from table where str = {{String(test)}} and category = {{String(category, 'shirts')}} and color = {{ Int32(color)}}", test_mode=False)
+    Traceback (most recent call last):
+    ...
+    tinybird.sql_template.SQLTemplateException: Template Syntax Error: Required parameter is not defined. Check the parameters test and color. Please provide a value or set a default value in the pipe code.
+    >>> render_sql_template("select columns(cols, 'salary') from table where str = {{String(test)}}", test_mode=False)
+    Traceback (most recent call last):
+    ...
+    tinybird.sql_template.SQLTemplateException: Template Syntax Error: Required parameter is not defined. Check the parameters test. Please provide a value or set a default value in the pipe code.
     """
     escape_split_to_array = ff_split_to_array_escape.get(False)
     bypass_preprocess_variables = ff_preprocess_parameters_circuit_breaker.get(False)
@@ -2138,9 +2181,10 @@ def render_sql_template(
     t, template_variables, variable_warnings = get_template_and_variables(
         sql, name, escape_arrays=escape_split_to_array
     )
+    template_variables_with_types = get_var_names_and_types_cached(t)
 
     if not bypass_preprocess_variables and variables is not None:
-        processed_variables = preprocess_variables(variables, t)
+        processed_variables = preprocess_variables(variables, template_variables_with_types)
         variables.update(processed_variables)
 
     if test_mode:
@@ -2188,7 +2232,8 @@ def render_sql_template(
         return sql, template_execution_results, variable_warnings
     except NameError as e:
         raise SQLTemplateException(e, documentation="/cli/advanced-templates.html#defined")
-    except SQLTemplateException:
+    except SQLTemplateException as e:
+        format_SQLTemplateException_message(e, vars_and_types=template_variables_with_types)
         raise
     except Exception as e:
         # errors might vary here, we need to support as much as possible

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/tb_cli_modules/common.py

@@ -811,7 +811,7 @@ async def authenticate(ctx, host, token=None, regions=None, interactive=False, t
     if not token:
         tokens_url = urljoin(ui_host, "tokens")
         token = click.prompt(
-            f"\nCopy the admin token from {tokens_url} and paste it here { f'OR press enter to use the token from .tinyb file' if default_password else ''}",
+            f"\nCopy the \"admin your@email\" token from {tokens_url} and paste it here { f'OR press enter to use the token from .tinyb file' if default_password else ''}",
             hide_input=True,
             show_default=False,
             default=default_password,
@@ -860,13 +860,37 @@ async def authenticate(ctx, host, token=None, regions=None, interactive=False, t
 
 def ask_for_user_token(action: str, ui_host: str) -> str:
     return click.prompt(
-        f"\nIn order to {action} we need your user token. Copy it from {ui_host}/tokens and paste it here",
+        f'\nUse the token called "user token" in order to {action}. Copy it from {ui_host}/tokens and paste it here',
         hide_input=True,
         show_default=False,
         default=None,
     )
 
 
+async def check_user_token(ctx: Context, token: str):
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    try:
+        user_client: TinyB = deepcopy(client)
+        user_client.token = token
+
+        is_authenticated = await user_client.check_auth_login()
+    except Exception as e:
+        raise CLIWorkspaceException(FeedbackManager.error_exception(error=str(e)))
+
+    if not is_authenticated.get("is_valid", False):
+        raise CLIWorkspaceException(
+            FeedbackManager.error_exception(
+                error='Invalid token. Please, be sure you are using the "user token" instead of the "admin your@email" token.'
+            )
+        )
+    if is_authenticated.get("is_valid") and not is_authenticated.get("is_user", False):
+        raise CLIWorkspaceException(
+            FeedbackManager.error_exception(
+                error='Invalid user authentication. Please, be sure you are using the "user token" instead of the "admin your@email" token.'
+            )
+        )
+
+
 async def get_available_starterkits(ctx: Context) -> List[Dict[str, Any]]:
     ctx_dict = ctx.ensure_object(dict)
     available_starterkits = ctx_dict.get("available_starterkits", None)
@@ -1826,7 +1850,7 @@ async def try_update_config_with_remote(
 def ask_for_admin_token_interactively(ui_host: str, default_token: Optional[str]) -> str:
     return (
         click.prompt(
-            f"\nCopy the admin token from {ui_host}/tokens and paste it here { f'OR press enter to use the token from .tinyb file' if default_token else ''}",
+            f"\nCopy the \"admin your@email\" token from {ui_host}/tokens and paste it here { f'OR press enter to use the token from .tinyb file' if default_token else ''}",
             hide_input=True,
             show_default=False,
             default=default_token,

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/tb_cli_modules/datasource.py

@@ -27,6 +27,7 @@ from tinybird.tb_cli_modules.common import (
     _generate_datafile,
     ask_for_user_token,
     autocomplete_topics,
+    check_user_token,
     coro,
     echo_safe_humanfriendly_tables_format_smart_table,
     get_config_and_hosts,
@@ -631,6 +632,7 @@ async def datasource_share(ctx: Context, datasource_name: str, workspace_name_or
 
     if not user_token:
         user_token = ask_for_user_token("share a Data Source", ui_host)
+    await check_user_token(ctx, user_token)
 
     client.token = user_token
 
@@ -696,6 +698,7 @@ async def datasource_unshare(ctx: Context, datasource_name: str, workspace_name_
 
     if not user_token:
         user_token = ask_for_user_token("unshare a Data Source", ui_host)
+    await check_user_token(ctx, user_token)
 
     client.token = user_token
 

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/tb_cli_modules/workspace.py

@@ -16,6 +16,7 @@ from tinybird.tb_cli_modules.common import (
     _get_config,
     _get_workspace_plan_name,
     ask_for_user_token,
+    check_user_token,
     coro,
     create_workspace_interactive,
     create_workspace_non_interactive,
@@ -216,6 +217,7 @@ async def create_workspace(
         user_token = ask_for_user_token("create a new workspace", ui_host)
         if not user_token:
             return
+    await check_user_token(ctx, user_token)
 
     # If we have at least workspace_name, we start the non interactive
     # process, creating an empty workspace
@@ -247,6 +249,7 @@ async def delete_workspace(
 
     if not user_token:
         user_token = ask_for_user_token("delete a workspace", ui_host)
+    await check_user_token(ctx, user_token)
 
     workspaces = (await client.user_workspaces()).get("workspaces", [])
     workspace_to_delete = next(

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird/tb_cli_modules/workspace_members.py

@@ -14,6 +14,7 @@ from tinybird.client import TinyB
 from tinybird.feedback_manager import FeedbackManager
 from tinybird.tb_cli_modules.common import (
     ask_for_user_token,
+    check_user_token,
     coro,
     echo_safe_humanfriendly_tables_format_smart_table,
     get_config_and_hosts,
@@ -81,6 +82,7 @@ async def add_members_to_workspace(
     else:
         if not user_token:
             user_token = ask_for_user_token(f"add users to {cmd_ctx.workspace['name']}", cmd_ctx.ui_host)
+        await check_user_token(ctx, user_token)
 
         user_client: TinyB = deepcopy(cmd_ctx.client)
         user_client.token = user_token
@@ -130,6 +132,7 @@ async def remove_members_from_workspace(ctx: Context, members_emails: str, user_
     else:
         if not user_token:
             user_token = ask_for_user_token(f"remove users from {cmd_ctx.workspace['name']}", cmd_ctx.ui_host)
+        await check_user_token(ctx, user_token)
 
         if len(non_valid_users) > 0:
             click.echo(
@@ -179,6 +182,7 @@ async def set_workspace_member_role(ctx: Context, role: str, members_emails: str
     else:
         if not user_token:
             user_token = ask_for_user_token(f"change user roles in {cmd_ctx.workspace['name']}", cmd_ctx.ui_host)
+        await check_user_token(ctx, user_token)
 
         if len(non_valid_users) > 0:
             click.echo(

{tinybird-cli-5.4.1.dev2 → tinybird-cli-5.4.1.dev4}/tinybird_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinybird-cli
-Version: 5.4.1.dev2
+Version: 5.4.1.dev4
 Summary: Tinybird Command Line Tool
 Home-page: https://www.tinybird.co/docs/cli/introduction.html
 Author: Tinybird
@@ -18,6 +18,16 @@ The Tinybird command-line tool allows you to use all the Tinybird functionality
 Changelog
 ----------
 
+5.4.1.dev4
+**********
+
+- `Improved` info and error messages when using "user token" vs "admin your@email.com" token
+
+5.4.1.dev3
+**********
+
+- `Changed` Internal change
+
 5.4.1.dev1
 **********