meerschaum 2.7.7__py3-none-any.whl → 2.7.9__py3-none-any.whl

meerschaum/api/dash/keys.py

@@ -105,59 +105,58 @@ action_dropdown_row = html.Div(
                 dbc.Col(
                     html.Div(
                         dcc.Dropdown(
-                            id = 'flags-dropdown',
-                            multi = True,
-                            placeholder = 'Boolean flags',
-                            options = ['--yes'],
-                            value = ['--yes'],
+                            id='flags-dropdown',
+                            multi=True,
+                            placeholder='Boolean flags',
+                            options=[],
+                            value=[],
                         ),
-                        id = 'flags-dropdown-div',
-                        className = 'dbc_dark input-text',
+                        id='flags-dropdown-div',
+                        className='dbc_dark input-text',
                     ),
-                    width = widths['flags'],
+                    width=widths['flags'],
                 ),
             ],
         ),
         html.Br(),
         html.Div(id='input-flags-div'),
         dbc.Row(
-            children = [
+            children=[
                 dbc.Col(
-                    children = [
+                    children=[
                         html.Div(
-                            children = [
+                            children=[
                                 dbc.Button(
                                     'Additional parameters',
-                                    id = 'show-arguments-collapse-button',
-                                    color = 'link',
-                                    size = 'md',
-                                    outline = True,
-                                    style = {'display': 'none'},
+                                    id='show-arguments-collapse-button',
+                                    color='link',
+                                    size='md',
+                                    outline=True,
+                                    style={'display': 'none'},
                                 ),
-                                #  html.Br(),
                                 dbc.Collapse(
-                                    children = [
+                                    children=[
                                         dbc.Button(
                                             'Clear',
-                                            id = 'clear-begin-end-datepicker-button',
-                                            color = 'link',
-                                            size = 'sm',
+                                            id='clear-begin-end-datepicker-button',
+                                            color='link',
+                                            size='sm',
                                         ),
                                         dcc.DatePickerRange(
-                                            id = 'begin-end-datepicker',
+                                            id='begin-end-datepicker',
                                         ),
                                     ],
-                                    id = 'arguments-collapse',
+                                    id='arguments-collapse',
                                 ),
                             ], ### end of div children
                         ),
                     ], ### end of col children
-                    width = widths['arguments'],
+                    width=widths['arguments'],
                 ),
             ], ### end of row children
         ),
     ], ### end of parent div children
-    id = 'action-div',
+    id='action-div',
 )
 
 
@@ -167,49 +166,49 @@ dropdown_keys_row = dbc.Row(
             html.Div(
                 [
                     dcc.Dropdown(
-                        id = 'connector-keys-dropdown',
-                        options = [],
-                        placeholder = placeholders['ck'],
-                        multi = True,
+                        id='connector-keys-dropdown',
+                        options=[],
+                        placeholder=placeholders['ck'],
+                        multi=True,
                     ),
                 ],
-                className = 'dbc_dark',
+                className='dbc_dark',
             ),
-            lg = 4,
-            md = 12,
-            sm = 12,
+            lg=4,
+            md=12,
+            sm=12,
         ),
         dbc.Col(
             html.Div(
                 [
                     dcc.Dropdown(
-                        id = 'metric-keys-dropdown',
-                        options = [],
-                        placeholder = placeholders['mk'],
-                        multi = True,
+                        id='metric-keys-dropdown',
+                        options=[],
+                        placeholder=placeholders['mk'],
+                        multi=True,
                     ),
                 ],
-                className = 'dbc_dark'
+                className='dbc_dark'
             ),
-            lg = 4,
-            md = 12,
-            sm = 12,
+            lg=4,
+            md=12,
+            sm=12,
         ),
         dbc.Col(
             html.Div(
                 [
                     dcc.Dropdown(
-                        id = 'location-keys-dropdown',
-                        options = [],
-                        placeholder = placeholders['lk'],
-                        multi = True,
+                        id='location-keys-dropdown',
+                        options=[],
+                        placeholder=placeholders['lk'],
+                        multi=True,
                     ),
                 ],
-                className = 'dbc_dark'
+                className='dbc_dark'
             ),
-            lg = 4,
-            md = 12,
-            sm = 12,
+            lg=4,
+            md=12,
+            sm=12,
         ),
     ] ### end of filters row children
 )
@@ -217,10 +216,9 @@ dropdown_tab_content = html.Div([
     dbc.Card(
         dbc.CardBody(
             [
-                #  html.P('Pipe Keys'),
                 dropdown_keys_row,
             ], ### end of card children
-            className = 'card-text',
+            className='card-text',
         )
     ),
     html.Br(),
@@ -229,7 +227,7 @@ dropdown_tab_content = html.Div([
             [
                 action_dropdown_row,
             ],
-            className = 'card-text',
+            className='card-text',
         ),
     ),
 ])
@@ -242,75 +240,66 @@ text_tab_content = dbc.Card(
                     dbc.Col(html.Div(className='dbc_dark', children=[
                         dbc.InputGroup(
                             [
-                                #  dbc.InputGroupAddon(
                                     dbc.Button(
                                         'Clear',
-                                        id = 'clear-connector-keys-input-button',
-                                        color = 'link',
-                                        size = 'sm',
+                                        id='clear-connector-keys-input-button',
+                                        color='link',
+                                        size='sm',
                                     ),
-                                    #  addon_type = 'prepend',
-                                #  ),
                                 dbc.Input(
-                                    id = 'connector-keys-input',
-                                    placeholder = placeholders['ck'],
-                                    type = 'text',
-                                    value = '',
-                                    list = 'connector-keys-list',
-                                    className = 'dbc_dark'
+                                    id='connector-keys-input',
+                                    placeholder=placeholders['ck'],
+                                    type='text',
+                                    value='',
+                                    list='connector-keys-list',
+                                    className='dbc_dark'
                                 ),
                             ],
-                            size = input_group_sizes['ck'],
+                            size=input_group_sizes['ck'],
                         )]),
-                        width = 4,
+                        width=4,
                     ),
                     dbc.Col(
                         dbc.InputGroup(
                             [
-                                #  dbc.InputGroupAddon(
                                     dbc.Button(
                                         'Clear',
-                                        id = 'clear-metric-keys-input-button',
-                                        color = 'link',
-                                        size = 'sm',
+                                        id='clear-metric-keys-input-button',
+                                        color='link',
+                                        size='sm',
                                     ),
-                                    #  addon_type = 'prepend',
-                                #  ),
                                 dbc.Input(
-                                    id = 'metric-keys-input',
-                                    placeholder = placeholders['mk'],
-                                    type = 'text',
-                                    value = '',
-                                    list = 'metric-keys-list',
+                                    id='metric-keys-input',
+                                    placeholder=placeholders['mk'],
+                                    type='text',
+                                    value='',
+                                    list='metric-keys-list',
                                 ),
                             ],
-                            size = input_group_sizes['mk'],
+                            size=input_group_sizes['mk'],
                         ),
-                        width = 4,
+                        width=4,
                     ),
                     dbc.Col(
                         dbc.InputGroup(
                             [
-                                #  dbc.InputGroupAddon(
                                     dbc.Button(
                                         'Clear',
-                                        id = 'clear-location-keys-input-button',
-                                        color = 'link',
-                                        size = 'sm',
+                                        id='clear-location-keys-input-button',
+                                        color='link',
+                                        size='sm',
                                     ),
-                                    #  addon_type = 'prepend',
-                                #  ),
                                 dbc.Input(
-                                    id = 'location-keys-input',
-                                    placeholder = placeholders['lk'],
-                                    type = 'text',
-                                    value = '',
-                                    list = 'location-keys-list',
+                                    id='location-keys-input',
+                                    placeholder=placeholders['lk'],
+                                    type='text',
+                                    value='',
+                                    list='location-keys-list',
                                 ),
                             ],
-                            size = input_group_sizes['lk'],
+                            size=input_group_sizes['lk'],
                         ),
-                        width = 4,
+                        width=4,
                     ),
                 ]
             ),
@@ -319,23 +308,9 @@ text_tab_content = dbc.Card(
                 dbc.Col(
                     dbc.InputGroup(
                         [
-                            #  dbc.InputGroupAddon(
-                                #  dbc.Button(
-                                    #  'Clear',
-                                    #  id = 'clear-params-textarea-button',
-                                    #  color = 'link',
-                                    #  size = 'sm',
-                                #  ),
-                                #  addon_type = 'prepend',
-                            #  ),
                             search_parameters_editor,
-                            #  dbc.Textarea(
-                                #  id = 'params-textarea',
-                                #  placeholder = placeholders['params'],
-                                #  value = '',
-                            #  )
                         ],
-                        size = input_group_sizes['params'],
+                        size=input_group_sizes['params'],
                     )
                 )
             ),
@@ -348,4 +323,3 @@ keys_lists_content = html.Div([
     html.Datalist(id='metric-keys-list'),
     html.Datalist(id='location-keys-list'),
 ], hidden=True)
-

meerschaum/api/dash/pages/dashboard.py

@@ -65,16 +65,16 @@ layout = html.Div(
                                 children = [
                                     dbc.Tab(
                                         dropdown_tab_content,
-                                        label = 'Filter',
-                                        id = 'pipes-filter-dropdown-tab',
-                                        tab_id = 'dropdown',
+                                        label='Filters',
+                                        id='pipes-filter-dropdown-tab',
+                                        tab_id='dropdown',
                                     ),
                                     dbc.Tab(
                                         text_tab_content,
-                                        label = 'Text',
-                                        id = 'pipes-filter-input-tab',
-                                        tab_id = 'input',
-                                        tab_style = {"display": "none"},
+                                        label='Text',
+                                        id='pipes-filter-input-tab',
+                                        tab_id='input',
+                                        tab_style={"display": "none"},
                                     ),
                                 ]
                             ),
@@ -83,12 +83,12 @@ layout = html.Div(
                             test_button,
                             html.Div(id='ws-div'),
                         ],
-                        id = 'content-col-left',
-                        md = 12,
-                        lg = 6,
+                        id='content-col-left',
+                        md=12,
+                        lg=6,
                     ),
                     dbc.Col(
-                        children = [
+                        children=[
                             dbc.Col([
                                     html.Div(id='success-alert-div'),
                                     html.Div(id='instance-alert-div')
@@ -97,20 +97,20 @@ layout = html.Div(
                             ),
                             html.Div(id='webterm-div'),
                             html.Div(
-                                id = 'content-div-right',
-                                children = [console_div],
+                                id='content-div-right',
+                                children=[console_div],
                             ),
                             html.Div(id='terminal'),
                         ],
-                        md = 12,
-                        lg = 6,
-                        id = 'content-col-right',
+                        md=12,
+                        lg=6,
+                        id='content-col-right',
                     ),
                 ],
                 style = {'max-width': '100%', 'padding': '15px'},
             ), ### end of Row
             className = 'container-fluid',
         ), ### end of Div
-        html.P('', id='line-buffer', style = {'display': 'none'}),
+        html.P('', id='line-buffer', style={'display': 'none'}),
     ],
 )

meerschaum/api/dash/sessions.py

@@ -97,6 +97,7 @@ def delete_session(session_id: str):
     """
     Delete a session if it's been set.
     """
+    ### TODO: Delete webterm sessions.
     if debug:
         dprint(f"Deleting {session_id=}")
     conn = get_cache_connector()

meerschaum/api/dash/webterm.py

@@ -14,10 +14,12 @@ from meerschaum.utils.typing import WebState, Tuple, Any
 from meerschaum.utils.packages import attempt_import, import_html, import_dcc
 from meerschaum._internal.term.tools import is_webterm_running
 from meerschaum.utils.threading import Thread, RLock
+from meerschaum.utils.misc import is_tmux_available
 dcc, html = import_dcc(check_update=CHECK_UPDATE), import_html(check_update=CHECK_UPDATE)
 dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
 
 MAX_WEBTERM_ATTEMPTS: int = 10
+TMUX_IS_AVAILABLE: bool = is_tmux_available()
 
 _locks = {'webterm_thread': RLock()}
 
@@ -32,7 +34,7 @@ def get_webterm(state: WebState) -> Tuple[Any, Any]:
         return (
             html.Div(
                 html.Pre(msg, id='console-pre'),
-                id = "console-div",
+                id="console-div",
             ),
             [alert_from_success_tuple((
                 False,
@@ -41,12 +43,21 @@ def get_webterm(state: WebState) -> Tuple[Any, Any]:
         )
 
     for i in range(MAX_WEBTERM_ATTEMPTS):
-        if is_webterm_running('localhost', 8765):
+        if is_webterm_running('localhost', 8765, session_id=(username or session_id)):
             return (
-                html.Iframe(
-                    src = f"/webterm?s={session_id}",
-                    id = "webterm-iframe",
-                ),
+                [
+                    html.Div(
+                        [
+                            dbc.Button('Refresh', color='black', id='webterm-refresh-button'),
+                            dbc.Button('New Tab', color='black', id='webterm-new-tab-button'),
+                        ],
+                        id='webterm-controls-div',
+                    ),
+                    html.Iframe(
+                        src=f"/webterm/{session_id}",
+                        id="webterm-iframe",
+                    ),
+                ],
                 []
             )
         time.sleep(1)

meerschaum/api/resources/static/js/terminado.js

@@ -15,9 +15,7 @@ function make_terminal(element, size, ws_url) {
   term.attachCustomKeyEventHandler(copyPasteKeyEventHandler);
   term.open(element);
 
-  sessionStore = localStorage.getItem("session-store");
   ws.onopen = function (event) {
-    ws.send(sessionStore);
     ws.send(
       JSON.stringify([
         "set_size",

meerschaum/api/resources/templates/termpage.html

@@ -84,6 +84,15 @@ window.addEventListener(
         flags_str += " " + fl + " " + fl_val;
     }
 
+    let line = "";
+    if (action_str === "__TMUX_NEW_WINDOW") {
+      line = "\x02:";
+      window.terminal.socket.send(JSON.stringify(["stdin", line]));
+      line = "new-window python3 -m meerschaum\r";
+      window.terminal.socket.send(JSON.stringify(["stdin", line]));
+      return;
+    }
+
     line = (
       "\x03"
       + action_str
@@ -98,6 +107,26 @@ window.addEventListener(
   false,
 );
 
+let reconnectTimeout;
+
+function cleanUpWebSocket(socket) {
+    if (!socket) { return; }
+      socket.onopen = null;
+      socket.onmessage = null;
+      socket.onerror = null;
+      socket.onclose = null;
+
+      if (socket.readyState === WebSocket.OPEN || socket.readyState === WebSocket.CONNECTING) {
+          socket.close(1000, "Reconnecting");
+      }
+
+      if (reconnectTimeout) {
+          clearTimeout(reconnectTimeout);
+          reconnectTimeout = null;
+      }
+
+      socket = null;
+}
 
 window.onload = function() {
     var termRowHeight = 0.0 + 0.95*document.getElementById("dummy-screen").offsetHeight / 25;
@@ -115,15 +144,29 @@ window.onload = function() {
 
     xterm_div = document.getElementById("xterm-div");
     size = calculate_size(window);
-    var terminal = make_terminal(xterm_div, size, ws_url);
-    window.terminal = terminal;
+
+    function init_webterm() {
+      old_terminal = window.terminal;
+      if (old_terminal){
+        xterm_div.innerHTML = "";
+        cleanUpWebSocket(old_terminal.socket);
+      }
+      window.terminal = make_terminal(xterm_div, size, ws_url);
+      window.terminal.socket.onclose = function (event) {
+        if (!event.wasClean && event.code !== 1005) {
+          reconnectTimeout = setTimeout(init_webterm, 1000);
+        }
+      }
+    }
+
+    init_webterm();
 
     window.onresize = function() {
       var geom = calculate_size(window);
       rows = geom.rows;
       cols = geom.cols;
-      terminal.term.resize(cols, rows);
-      terminal.socket.send(
+      window.terminal.term.resize(cols, rows);
+      window.terminal.socket.send(
           JSON.stringify(
               ["set_size", rows, cols, xterm_div.innerHeight, xterm_div.innerWidth]
           )

meerschaum/api/routes/_webterm.py

@@ -10,7 +10,7 @@ import asyncio
 from meerschaum.utils.typing import Optional
 from meerschaum.api import app, endpoints
 from meerschaum.utils.packages import attempt_import
-from meerschaum.api.dash.sessions import is_session_authenticated
+from meerschaum.api.dash.sessions import is_session_authenticated, get_username_from_session
 fastapi, fastapi_responses = attempt_import('fastapi', 'fastapi.responses')
 import starlette
 
@@ -27,12 +27,12 @@ PlainTextResponse = fastapi_responses.PlainTextResponse
 @app.get(endpoints['webterm'], tags=["Webterm"])
 async def get_webterm(
     request: Request,
-    s: Optional[str] = None,
+    session_id: str,
 ) -> HTMLResponse:
     """
     Get the main HTML template for the Webterm.
     """
-    if not is_session_authenticated(s):
+    if not is_session_authenticated(session_id):
         return HTMLResponse(
             """
             <html>
@@ -69,35 +69,39 @@ async def get_webterm(
             status_code = 401,
         )
 
+    username = get_username_from_session(session_id)
     async with httpx.AsyncClient() as client:
-        response = await client.get("http://localhost:8765/")
+        webterm_url = f"http://localhost:8765/webterm/{username or session_id}"
+        response = await client.get(webterm_url)
         text = response.text
         if request.url.scheme == 'https':
             text = text.replace('ws://', 'wss://')
+        text = text.replace(f'_websocket/{username}', f'_websocket/{session_id}')
         return HTMLResponse(
-            content = text,
-            status_code = response.status_code,
-            headers = request.headers,
+            content=text,
+            status_code=response.status_code,
+            headers=request.headers,
         )
 
 
 @app.websocket(endpoints['webterm_websocket'])
-async def webterm_websocket(websocket: WebSocket):
+async def webterm_websocket(websocket: WebSocket, session_id: str):
     """
     Connect to the Webterm's websocket.
     """
     try:
         await websocket.accept()
-        session_doc = await websocket.receive_json()
     except starlette.websockets.WebSocketDisconnect:
         return
-    session_id = (session_doc or {}).get('session-id', 'no-auth')
 
     if not is_session_authenticated(session_id):
         await websocket.close()
         return
 
-    async with websockets.connect("ws://localhost:8765/websocket") as ws:
+    username = get_username_from_session(session_id)
+
+    ws_url = f"ws://localhost:8765/_websocket/{username or session_id}"
+    async with websockets.connect(ws_url) as ws:
         async def forward_messages():
             try:
                 while True:

meerschaum/config/_default.py

@@ -127,6 +127,12 @@ default_system_config = {
         },
         'protocol': default_meerschaum_config['connectors']['api']['default']['protocol'],
     },
+    'webterm': {
+        'tmux': {
+            'enabled': True,
+            'session_suffix': '_mrsm',
+        },
+    },
     'experimental': {
         'fetch': False,
         'cache': True,

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.7.7"
+__version__ = "2.7.9"

meerschaum/config/static/__init__.py

@@ -32,8 +32,8 @@ STATIC_CONFIG: Dict[str, Any] = {
             'chaining': '/chaining',
             'websocket': '/ws',
             'dash': '/dash',
-            'webterm': '/webterm',
-            'webterm_websocket': '/websocket',
+            'webterm': r'/webterm/{session_id}',
+            'webterm_websocket': r'/_websocket/{session_id}',
             'info': '/info',
             'healthcheck': '/healthcheck',
         },