meerschaum 3.0.0rc2__py3-none-any.whl → 3.0.0rc4__py3-none-any.whl

meerschaum/api/dash/callbacks/pipes.py

@@ -5,22 +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.pipes import build_pipe_card
-from meerschaum.api import CHECK_UPDATE
+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'),
@@ -32,24 +45,191 @@ 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))
+    query_params = parse_qs(pipe_search.lstrip('?')) if pipe_search else {}
+    instance = query_params.get('instance', [None])[0] or str(get_api_connector())
+    tags = query_params.get('tags', [None])[0] or []
+    if isinstance(tags, str):
+        tags = tags.split(',')
+
+    connector_keys = query_params.get('connector_keys', [None])[0] or []
+    if isinstance(connector_keys, str):
+        connector_keys = connector_keys.split(',')
+
+    metric_keys = query_params.get('metric_keys', [None])[0] or []
+    if isinstance(metric_keys, str):
+        metric_keys = metric_keys.split(',')
+
+    location_keys = query_params.get('location_keys', [None])[0] or []
+    if isinstance(location_keys, str):
+        location_keys = location_keys.split(',')
 
     keys = pathname.replace('/dash/pipes', '').lstrip('/').rstrip('/').split('/')
-    if len(keys) not in (2, 3):
-        return no_update
+    instance_connector = mrsm.get_connector(instance)
+    viewing_single_pipe = len(keys) in (2, 3)
+    if instance_connector is None:
+        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 (
+            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_cards_grid(cards, 1),
+                html.Br(),
+            ]
+        )
 
     ck = keys[0]
     mk = keys[1]
     lk = keys[2] if len(keys) == 3 else None
-    query_params = parse_qs(pipe_search.lstrip('?')) if pipe_search else {}
-    instance = query_params.get('instance', [None])[0]
 
     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(
+    Output('pipes-location', 'search'),
+    Input('pipes-connector-keys-dropdown', 'value'),
+    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: 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.
+    """
+    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 ''
+
+    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((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((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((quote_plus(str(lk)) for lk in location_keys))
+        if tags or include_instance_keys:
+            search_str += '&'
+
+    if 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) if search_str else ''

meerschaum/api/dash/callbacks/settings/__init__.py

@@ -6,4 +6,3 @@ Define the callbacks for the settings pages.
 """
 
 import meerschaum.api.dash.callbacks.settings.password_reset
-import meerschaum.api.dash.callbacks.settings.tokens

meerschaum/api/dash/callbacks/{settings/tokens.py → 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
@@ -163,7 +164,7 @@ def register_token_click(
     token = Token(
         label=(name or None),
         user=get_user_from_session(session_id),
-        expiration=(datetime.fromisoformat(f"{expiration}T00:00:00Z") if expiration is not None else None),
+        expiration=(datetime.fromisoformat(f"{expiration}") if expiration is not None else None),
     )
     return False, True, build_tokens_register_output_modal(token)
 

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/jobs.py

@@ -98,7 +98,7 @@ def build_job_card(
             html.B(
                 html.A(
                     "🔗 " + job.name,
-                    href=f"/dash/job/{job.name}",
+                    href=f"/dash/jobs/{job.name}",
                     target="_blank",
                     style={
                         'color': 'white',

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/__init__.py

@@ -9,7 +9,8 @@ import meerschaum.api.dash.pages.error
 import meerschaum.api.dash.pages.login
 import meerschaum.api.dash.pages.dashboard
 import meerschaum.api.dash.pages.plugins
+import meerschaum.api.dash.pages.tokens
 import meerschaum.api.dash.pages.register
 import meerschaum.api.dash.pages.pipes
-import meerschaum.api.dash.pages.job
+import meerschaum.api.dash.pages.jobs
 import meerschaum.api.dash.pages.settings

meerschaum/api/dash/pages/{job.py → jobs.py}

@@ -11,11 +11,14 @@ from meerschaum.utils.packages import import_html, import_dcc
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 import dash_bootstrap_components as dbc
 
-from meerschaum.api.dash.components import download_logs, refresh_jobs_interval
+from meerschaum.api.dash.components import download_logs, refresh_jobs_interval, pages_navbar
 
-layout = dbc.Container([
-    dcc.Location('job-location'),
-    html.Div(id='job-output-div'),
-    download_logs,
-    refresh_jobs_interval,
-])
+layout = [
+    pages_navbar,
+    dbc.Container([
+        dcc.Location('job-location'),
+        html.Div(id='job-output-div'),
+        download_logs,
+        refresh_jobs_interval,
+    ]),
+]

meerschaum/api/dash/pages/pipes.py

@@ -7,16 +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
+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([
-        dcc.Location('pipes-location'),
-        download_dataframe,
-        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',
+            },
+        ),
     ])
 ]

meerschaum/api/dash/pages/settings/__init__.py

@@ -6,4 +6,3 @@ Define the layouts for the `settings` pages.
 """
 
 import meerschaum.api.dash.pages.settings.password_reset
-import meerschaum.api.dash.pages.settings.tokens

meerschaum/api/dash/pages/{settings/tokens.py → tokens.py}

@@ -8,16 +8,13 @@ Define the tokens page layout.
 import dash_bootstrap_components as dbc
 import dash.html as html
 import dash.dcc as dcc
-from meerschaum.plugins import web_page
 from meerschaum._internal.static import STATIC_CONFIG
+from meerschaum.api.dash.components import pages_navbar
 
 
-@web_page('tokens', login_required=True, page_group='Settings')
-def page_layout():
-    """
-    Return the layout for the tokens page.
-    """
-    return dbc.Container([
+layout = [
+    pages_navbar,
+    dbc.Container([
         html.Br(), 
         html.H3('Tokens'),
         html.Div(id="tokens-alert-div"),
@@ -52,4 +49,5 @@ def page_layout():
             style={'text-align': 'right'},
         ),
         html.Div(id='tokens-output-div'),
-    ])
+    ]),
+]

meerschaum/api/dash/pipes.py

@@ -12,18 +12,26 @@ import shlex
 from textwrap import dedent
 from urllib.parse import urlencode
 
+from meerschaum.utils import fetch_pipes_keys
 from meerschaum.utils.typing import List, Optional, Dict, Any, Tuple, Union
-from meerschaum.utils.misc import string_to_dict
+from meerschaum.utils.misc import get_connector_labels
+from meerschaum.connectors import instance_types
 from meerschaum.utils.packages import attempt_import, import_dcc, import_html, import_pandas
 from meerschaum.utils.sql import get_pd_type
 from meerschaum.utils.yaml import yaml
 from meerschaum.utils.warnings import warn
 from meerschaum.utils.dataframe import to_json, to_simple_lines
 from meerschaum.connectors.sql._fetch import get_pipe_query
-from meerschaum.api import CHECK_UPDATE
+from meerschaum.api import CHECK_UPDATE, get_api_connector
 from meerschaum.api.dash import debug, _get_pipes
 from meerschaum.api.dash.connectors import get_web_connector
-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,
+    sign_out_button,
+    logo_row,
+    pages_offcanvas,
+)
 from meerschaum.api.dash.sessions import is_session_authenticated
 from meerschaum.config import get_config
 import meerschaum as mrsm
@@ -817,3 +825,211 @@ def get_backtrack_text(
         json_text = '[]'
 
     return json.dumps(json.loads(json_text), indent=4, separators=(',', ': '))
+
+
+def build_pipes_dropdown_keys_row(
+    connector_keys: List[str],
+    metric_keys: List[str],
+    location_keys: List[str],
+    tags: List[str],
+    pipes: List[mrsm.Pipe],
+    instance_connector: mrsm.connectors.InstanceConnector,
+) -> dbc.Row:
+    """
+    Return the dropdown keys row for the dedicated pipes page.
+    """
+    ck_alone = connector_keys and not any([str(x) for x in (tags + metric_keys + location_keys)])
+    mk_alone = metric_keys and not any([str(x) for x in (connector_keys + tags + location_keys)])
+    lk_alone = location_keys and not any([str(x) for x in (connector_keys + metric_keys + tags)])
+    all_keys = fetch_pipes_keys('registered', instance_connector)
+
+    ck_options_source = (
+        {keys_tuple[0] for keys_tuple in all_keys}
+        if ck_alone
+        else {p.connector_keys for p in pipes}
+    )
+    ck_options = sorted(ck_options_source.union(connector_keys))
+
+    mk_options_source = (
+        {keys_tuple[1] for keys_tuple in all_keys}
+        if mk_alone
+        else {p.metric_key for p in pipes}
+    )
+    mk_options = sorted(mk_options_source.union(metric_keys))
+
+    lk_options_source = (
+        {str(keys_tuple[2]) for keys_tuple in all_keys}
+        if lk_alone
+        else {str(p.location_key) for p in pipes}
+    )
+    lk_options = sorted(lk_options_source.union({str(lk) for lk in location_keys}))
+
+    return dbc.Row(
+        [
+            dbc.Col(
+                html.Div(
+                    [
+                        dcc.Dropdown(
+                            id='pipes-connector-keys-dropdown',
+                            options=ck_options,
+                            value=[str(ck) for ck in connector_keys],
+                            placeholder='Connectors',
+                            multi=True,
+                        ),
+                    ],
+                    className='dbc_dark',
+                ),
+                lg=4,
+                md=12,
+                sm=12,
+            ),
+            dbc.Col(
+                html.Div(
+                    [
+                        dcc.Dropdown(
+                            id='pipes-metric-keys-dropdown',
+                            options=mk_options,
+                            value=[str(mk) for mk in metric_keys],
+                            placeholder='Metrics',
+                            multi=True,
+                        ),
+                    ],
+                    className='dbc_dark'
+                ),
+                lg=4,
+                md=12,
+                sm=12,
+            ),
+            dbc.Col(
+                html.Div(
+                    [
+                        dcc.Dropdown(
+                            id='pipes-location-keys-dropdown',
+                            options=lk_options,
+                            value=[str(lk) for lk in location_keys],
+                            placeholder='Locations',
+                            multi=True,
+                        ),
+                    ],
+                    className='dbc_dark'
+                ),
+                lg=4,
+                md=12,
+                sm=12,
+            ),
+        ] ### end of filters row children
+    )
+
+
+def build_pipes_tags_dropdown(
+    connector_keys: List[str],
+    metric_keys: List[str],
+    location_keys: List[str],
+    tags: List[str],
+    instance: str,
+) -> dbc.Row:
+    """
+    Build the tags dropdown for the dedicated pipes page.
+    """
+    _tags_alone = tags and not any([str(x) for x in (connector_keys + metric_keys + location_keys)])
+    _tags_pipes = mrsm.get_pipes(
+        connector_keys=connector_keys,
+        metric_keys=metric_keys,
+        location_keys=location_keys,
+        tags=tags,
+        instance=instance,
+        as_tags_dict=True,
+    )
+
+    _all_tags = list(
+        mrsm.get_pipes(
+            instance=instance,
+            as_tags_dict=True,
+        )
+    ) if _tags_alone else []
+
+    tags_options = [
+        str(tag)
+        for tag in (_all_tags if _tags_alone else _tags_pipes)
+    ]
+    if tags:
+        tags_options += [tag for tag in tags if tag not in tags_options]
+
+    return dbc.Row(
+        [
+            dbc.Col(
+                html.Div(
+                    dcc.Dropdown(
+                        id='pipes-tags-dropdown',
+                        options=tags_options,
+                        value=tags,
+                        placeholder='Tags',
+                        multi=True,
+                        searchable=True,
+                    ),
+                    className="dbc_dark",
+                    id="pipes-tags-dropdown-div",
+                ),
+                width=True,
+            ),
+            dbc.Col(
+                dbc.Button(
+                    "Clear all",
+                    color='link',
+                    size='sm',
+                    style={'text-decoration': 'none'},
+                    id='pipes-clear-all-button',
+                ),
+                width='auto',
+            ),
+        ],
+        className='g-0',
+        align='center',
+    )
+
+
+def build_pipes_navbar(instance_keys: Optional[str] = None, with_instance_select: bool = True):
+    """
+    Build the navbar from the selected instance keys.
+    """
+    instance_select = dbc.Select(
+        id='instance-select',
+        size='sm',
+        value=instance_keys or str(get_api_connector()),
+        options=[
+            {'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',
+    )
+    instance_select_div_style = {} if with_instance_select else {'visibility': 'hidden'}
+    instance_select_div = html.Div(instance_select, style=instance_select_div_style)
+    return html.Div(
+        [
+            pages_offcanvas,
+            dbc.Navbar(
+                dbc.Container(
+                    [
+                        logo_row,
+                        dbc.NavbarToggler(id="navbar-toggler", n_clicks=0),
+                        dbc.Collapse(
+                            dbc.Row(
+                                [
+                                    dbc.Col(instance_select_div, 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,
+                            navbar=True,
+                        ),
+                    ]
+                ),
+                dark=True,
+                color='dark'
+            ),
+        ],
+        id='pages-navbar-div',
+    )