meerschaum 3.0.0rc3__py3-none-any.whl → 3.0.0rc7__py3-none-any.whl

meerschaum/api/dash/callbacks/pipes.py

@@ -5,28 +5,35 @@
 Define callbacks for the `/dash/pipes/` page.
 """
 
-from urllib.parse import parse_qs
+from urllib.parse import parse_qs, quote_plus
+from typing import List, Optional, Dict, Any
 
+import dash
 from dash.dependencies import Input, Output, State
 from dash import no_update
 from dash.exceptions import PreventUpdate
+import dash_bootstrap_components as dbc
 
 import meerschaum as mrsm
 from meerschaum.api.dash import dash_app
-from meerschaum.api.dash.components import alert_from_success_tuple, build_cards_grid
+from meerschaum.api.dash.components import (
+    alert_from_success_tuple,
+    build_cards_grid,
+)
 from meerschaum.api.dash.pipes import (
     build_pipe_card,
     build_pipes_dropdown_keys_row,
     build_pipes_tags_dropdown,
+    build_pipes_navbar,
 )
 from meerschaum.api import CHECK_UPDATE, get_api_connector
 from meerschaum.utils.packages import import_html, import_dcc
 from meerschaum.api.dash.sessions import is_session_authenticated
-from meerschaum.utils.typing import Optional, Dict, Any
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 
 
 @dash_app.callback(
+    Output('pipes-navbar-div', 'children'),
     Output('pipe-output-div', 'children'),
     Input('pipes-location', 'pathname'),
     State('pipes-location', 'search'),
@@ -38,7 +45,7 @@ def render_pipe_page_from_url(
     session_data: Optional[Dict[str, Any]],
 ):
     if not str(pathname).startswith('/dash/pipes'):
-        return no_update
+        raise PreventUpdate
 
     session_id = (session_data or {}).get('session-id', None)
     authenticated = is_session_authenticated(str(session_id))
@@ -60,63 +67,103 @@ def render_pipe_page_from_url(
     if isinstance(location_keys, str):
         location_keys = location_keys.split(',')
 
+    keys = pathname.replace('/dash/pipes', '').lstrip('/').rstrip('/').split('/')
     instance_connector = mrsm.get_connector(instance)
+    viewing_single_pipe = len(keys) in (2, 3)
     if instance_connector is None:
-        return [
-            html.Br(),
-            alert_from_success_tuple((False, f"Invalid instance keys '{instance}'.")),
-            html.Br(),
-        ]
-
-    keys = pathname.replace('/dash/pipes', '').lstrip('/').rstrip('/').split('/')
-    if len(keys) not in (2, 3):
-        pipes = mrsm.get_pipes(
-            as_list=True,
-            connector_keys=connector_keys,
-            metric_keys=metric_keys,
-            location_keys=location_keys,
-            tags=tags,
-            instance=instance_connector,
+        return (
+            build_pipes_navbar(instance, with_instance_select=(not viewing_single_pipe)),
+            [
+                html.Br(),
+                alert_from_success_tuple((False, f"Invalid instance keys '{instance}'.")),
+                html.Br(),
+            ]
         )
+
+    if not viewing_single_pipe:
+        try:
+            pipes = mrsm.get_pipes(
+                as_list=True,
+                connector_keys=connector_keys,
+                metric_keys=metric_keys,
+                location_keys=location_keys,
+                tags=tags,
+                instance=instance_connector,
+            )
+        except Exception as e:
+            return (
+                build_pipes_navbar(instance, with_instance_select=False),
+                [
+                    html.Br(),
+                    alert_from_success_tuple(
+                        (False, f"Failed to get pipes for instance '{instance}':\n{e}")
+                    ),
+                    html.Br(),
+                    dbc.Row(
+                        [
+                            dbc.Button(
+                                "Reload",
+                                id='pipes-reload-button',
+                                size='lg',
+                                href=(
+                                    "/dash/pipes"
+                                    if pathname.startswith('/dash/pipes/')
+                                    else "/dash/pipes/" 
+                                )
+                            ),
+                        ],
+                        justify='center',
+                        align='center',
+                        className='h-50',
+                    ),
+                ]
+            )
+
         cards = [
             build_pipe_card(pipe, authenticated=authenticated, include_manage=False)
             for pipe in pipes
         ]
-        return [
-            html.Div([
+        return (
+            build_pipes_navbar(instance, with_instance_select=True),
+            [
+                html.Div([
+                    html.Br(),
+                    build_pipes_dropdown_keys_row(
+                        connector_keys,
+                        metric_keys,
+                        location_keys,
+                        tags,
+                        pipes,
+                        instance_connector,
+                    ),
+                    html.Br(),
+                    build_pipes_tags_dropdown(
+                        connector_keys,
+                        metric_keys,
+                        location_keys,
+                        tags,
+                        instance,
+                    ),
+                ]),
                 html.Br(),
-                build_pipes_dropdown_keys_row(
-                    connector_keys,
-                    metric_keys,
-                    location_keys,
-                    tags,
-                    pipes,
-                    instance_connector,
-                ),
+                build_cards_grid(cards, 1),
                 html.Br(),
-                build_pipes_tags_dropdown(
-                    connector_keys,
-                    metric_keys,
-                    location_keys,
-                    tags,
-                    instance,
-                ),
-            ]),
-            html.Br(),
-            build_cards_grid(cards, 1),
-            html.Br(),
-        ]
+            ]
+        )
 
     ck = keys[0]
     mk = keys[1]
     lk = keys[2] if len(keys) == 3 else None
 
     pipe = mrsm.Pipe(ck, mk, lk, instance=instance)
-    return [
-        html.Br(),
-        build_pipe_card(pipe, authenticated=authenticated, include_manage=False),
-        html.Br(),
-    ]
+    return (
+        build_pipes_navbar(instance, with_instance_select=False),
+        [
+            html.Br(),
+            build_pipe_card(pipe, authenticated=authenticated, include_manage=False),
+            html.Br(),
+        ]
+    )
 
 
 @dash_app.callback(
@@ -125,32 +172,64 @@ def render_pipe_page_from_url(
     Input('pipes-metric-keys-dropdown', 'value'),
     Input('pipes-location-keys-dropdown', 'value'),
     Input('pipes-tags-dropdown', 'value'),
+    Input('instance-select', 'value'),
+    Input('pipes-clear-all-button', 'n_clicks'),
 )
-def update_location_on_pipes_filter_change(connector_keys, metric_keys, location_keys, tags):
+def update_location_on_pipes_filter_change(
+    connector_keys: Optional[List[str]],
+    metric_keys: Optional[List[str]],
+    location_keys: Optional[List[str]],
+    tags: Optional[List[str]],
+    instance_keys: str,
+    clear_all_button_n_clicks: Optional[int],
+):
     """
     Update the URL parameters when clicking the dropdowns.
     """
-    if not any((connector_keys or []) + (metric_keys or []) + (location_keys or []) + (tags or [])):
+    ctx = dash.callback_context.triggered
+    if len(ctx) != 1:
+        raise PreventUpdate
+
+    if not any(
+        (connector_keys or [])
+        + (metric_keys or [])
+        + (location_keys or [])
+        + (tags or [])
+        + ([instance_keys] if instance_keys else [])
+    ):
         return ''
 
-    search_str = "?"
+    if ctx[0].get('prop_id', None) == 'pipes-clear-all-button.n_clicks':
+        connector_keys = []
+        metric_keys = []
+        location_keys = []
+        tags = []
+
+    include_instance_keys = instance_keys and instance_keys != str(get_api_connector())
+    search_str = ""
     
     if connector_keys:
-        search_str += "connector_keys=" + ','.join(connector_keys)
-        if metric_keys or location_keys or tags:
+        search_str += "connector_keys=" + ','.join((quote_plus(ck) for ck in connector_keys))
+        if metric_keys or location_keys or tags or include_instance_keys:
             search_str += '&'
 
     if metric_keys:
-        search_str += "metric_keys=" + ','.join(metric_keys)
-        if location_keys or tags:
+        search_str += "metric_keys=" + ','.join((quote_plus(mk) for mk in metric_keys))
+        if location_keys or tags or include_instance_keys:
             search_str += '&'
 
     if location_keys:
-        search_str += "location_keys=" + ','.join(location_keys)
-        if tags:
+        search_str += "location_keys=" + ','.join((quote_plus(str(lk)) for lk in location_keys))
+        if tags or include_instance_keys:
             search_str += '&'
 
     if tags:
-        search_str += "tags=" + ','.join(tags)
+        search_str += "tags=" + ','.join((quote_plus(tag) for tag in tags))
+        if include_instance_keys:
+            search_str += '&'
+
+    if instance_keys:
+        if include_instance_keys:
+            search_str += "instance=" + quote_plus(instance_keys)
 
-    return search_str
+    return ('?' + search_str) if search_str else ''

meerschaum/api/dash/callbacks/register.py

@@ -15,6 +15,7 @@ from dash.exceptions import PreventUpdate
 from meerschaum.core import User
 from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.packages import attempt_import
+from meerschaum.api._oauth2 import CustomOAuth2PasswordRequestForm
 dash = attempt_import('dash', check_update=CHECK_UPDATE)
 from fastapi.exceptions import HTTPException
 
@@ -97,10 +98,16 @@ def register_button_click(
         form_class += ' is-invalid'
         return {}, form_class, dash.no_update
     try:
-        _ = login({'username': username, 'password': password})
+        form = CustomOAuth2PasswordRequestForm(
+            grant_type='password',
+            username=username,
+            password=password,
+            scope=' '.join(STATIC_CONFIG['tokens']['scopes'])
+        )
+        _ = login(form)
         session_data = {'session-id': str(uuid.uuid4())}
         set_session(session_data['session-id'], {'username': username})
-    except HTTPException as e:
+    except HTTPException:
         form_class += ' is-invalid'
         session_data = None
     return session_data, form_class, (dash.no_update if not session_data else endpoints['dash'])

meerschaum/api/dash/callbacks/tokens.py

@@ -54,7 +54,8 @@ def refresh_tokens_button_click(
                 html.H4('No tokens registered.'),
                 html.P('Click the `+` button to register a new token.'),
             ],
-            alerts
+            build_tokens_register_input_modal(),
+            alerts,
         )
 
     return tokens_table, build_tokens_register_input_modal(), alerts

meerschaum/api/dash/components.py

@@ -13,7 +13,7 @@ from meerschaum.utils.typing import SuccessTuple, List
 from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.misc import remove_ansi
 from meerschaum._internal.shell.Shell import get_shell_intro
-from meerschaum.api import endpoints, CHECK_UPDATE, docs_enabled
+from meerschaum.api import endpoints, CHECK_UPDATE, docs_enabled, get_api_connector
 from meerschaum.connectors import instance_types, _load_builtin_custom_connectors
 from meerschaum.utils.misc import get_connector_labels
 from meerschaum.config import __doc__ as doc
@@ -104,7 +104,7 @@ instance_select = dbc.Select(
     id='instance-select',
     size='sm',
     options=[
-        {'label': i, 'value': i}
+        {'label': (i[:32] + '…') if len(i) > 32 else i, 'value': i}
         for i in get_connector_labels(*instance_types)
     ],
     class_name='dbc_dark custom-select custom-select-sm',
@@ -163,6 +163,7 @@ pages_navbar = html.Div(
     id='pages-navbar-div',
 )
 
+
 navbar = dbc.Navbar(
     dbc.Container(
         [
@@ -171,13 +172,11 @@ navbar = dbc.Navbar(
             dbc.Collapse(
                 dbc.Row(
                     [
-                        dbc.Col(instance_select),
-                        dbc.Col(
-                            sign_out_button,
-                            className="ms-auto",
-                        ),
+                        dbc.Col(instance_select, width="auto"),
+                        dbc.Col(sign_out_button, width="auto"),
                     ],
                     className="g-0 ms-auto flex-nowrap mt-3 mt-md-0",
+                    align="center",
                 ),
                 id='navbar-collapse',
                 is_open=False,

meerschaum/api/dash/keys.py

@@ -227,7 +227,23 @@ dropdown_tab_content = html.Div([
             [
                 dropdown_keys_row,
                 html.Br(),
-                tags_dropdown,
+                dbc.Row(
+                    [
+                        dbc.Col(tags_dropdown, width=True),
+                        dbc.Col(
+                            dbc.Button(
+                                "Clear all",
+                                id='clear-all-keys-button',
+                                color='link',
+                                size='sm',
+                                style={'text-decoration': 'none'},
+                            ),
+                            width='auto',
+                        ),
+                    ],
+                    className='g-0',
+                    align='center',
+                ),
             ], ### end of card children
             className='card-text',
         )

meerschaum/api/dash/pages/login.py

@@ -49,11 +49,11 @@ registration_div = html.Div(
                         html.Code('mrsm register user newuser -i sql:main', className='codeblock'),
                     ),
                     dcc.Markdown("""
-                        To enable online registration, open the `system` configuration file and""" +
+                        To enable online registration, open the `api` configuration file and""" +
                     """ set the permissions to `true`:"""
                     ),
                     html.Pre(
-                        html.Code('mrsm edit config system', className='codeblock'),
+                        html.Code('mrsm edit config api', className='codeblock'),
                     ),
                     html.Br(),
                     dcc.Markdown('The settings file should look something like this:'),

meerschaum/api/dash/pages/pipes.py

@@ -7,17 +7,27 @@ Display pipes via a shareable URL.
 
 from meerschaum.api import CHECK_UPDATE
 from meerschaum.utils.packages import import_html, import_dcc
-from meerschaum.api.dash.components import download_dataframe, pages_navbar, navbar
+from meerschaum.api.dash.components import (
+    download_dataframe,
+)
 
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 import dash_bootstrap_components as dbc
 
-
 layout = [
-    pages_navbar,
+    html.Div(id='pipes-navbar-div'),
     dcc.Location('pipes-location'),
     download_dataframe,
     dbc.Container([
-        html.Div(id='pipe-output-div'),
+        dcc.Loading(
+            html.Div(id='pipe-output-div'),
+            id='pipes-loading',
+            type='circle',
+            delay_hide=1000,
+            delay_show=1000,
+            style={
+                'padding-top': '100px',
+            },
+        ),
     ])
 ]