meerschaum 2.3.0rc2__py3-none-any.whl → 2.3.0rc5__py3-none-any.whl

meerschaum/api/dash/callbacks/jobs.py

@@ -24,13 +24,13 @@ from dash import Patch
 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 alert_from_success_tuple, build_cards_grid
-from meerschaum.utils.daemon import Daemon
 from dash.exceptions import PreventUpdate
 from meerschaum.api.dash.jobs import (
     build_manage_job_buttons_div_children,
     build_status_children,
     build_process_timestamps_children,
 )
+from meerschaum.jobs import Job
 from meerschaum.api.dash.users import is_session_authenticated
 
 @dash_app.callback(
@@ -53,15 +53,11 @@ def download_job_logs(n_clicks):
         raise PreventUpdate
 
     component_dict = json.loads(ctx[0]['prop_id'].split('.' + 'n_clicks')[0])
-    daemon_id = component_dict['index']
-    daemon = Daemon(daemon_id=daemon_id)
+    job_name = component_dict['index']
     now = datetime.now(timezone.utc)
-    filename = (
-        daemon.rotating_log.file_path.name[:(-1 * len('.log'))]
-        + '_' + str(int(now.timestamp())) + '.log'
-    )
+    filename = job_name + '_' + str(int(now.timestamp())) + '.log'
     return {
-        'content': daemon.log_text,
+        'content': job.get_logs(),
         'filename': filename,
     }
 
@@ -73,12 +69,14 @@ def download_job_logs(n_clicks):
     Output({'type': 'process-timestamps-div', 'index': MATCH}, 'children'),
     Input({'type': 'manage-job-button', 'action': ALL, 'index': MATCH}, 'n_clicks'),
     State('session-store', 'data'),
+    State({'type': 'job-label-p', 'index': MATCH}, 'children'),
     prevent_initial_call = True,
 )
 def manage_job_button_click(
-        n_clicks: Optional[int] = None,
-        session_data: Optional[Dict[str, Any]] = None,
-    ):
+    n_clicks: Optional[int] = None,
+    session_data: Optional[Dict[str, Any]] = None,
+    job_label: Optional[str] = None,
+):
     """
     Start, stop, pause, or delete the given job.
     """
@@ -102,20 +100,20 @@ def manage_job_button_click(
         raise PreventUpdate
 
     component_dict = json.loads(ctx[0]['prop_id'].split('.' + 'n_clicks')[0])
-    daemon_id = component_dict['index']
+    job_name = component_dict['index']
     manage_job_action = component_dict['action']
     try:
-        daemon = Daemon(daemon_id=daemon_id)
+        job = Job(job_name, job_label.replace('\n', ' ') if job_label else None)
     except Exception as e:
-        daemon = None
-    if daemon is None:
+        job = None
+    if job is None:
         raise PreventUpdate
 
     manage_functions = {
-        'start': functools.partial(daemon.run, allow_dirty_run=True),
-        'stop': daemon.quit,
-        'pause': daemon.pause,
-        'delete': daemon.cleanup,
+        'start': job.start,
+        'stop': job.stop,
+        'pause': job.pause,
+        'delete': job.delete,
     }
     if manage_job_action not in manage_functions:
         return (
@@ -125,7 +123,7 @@ def manage_job_button_click(
             dash.no_update,
         )
 
-    old_status = daemon.status
+    old_status = job.status
     try:
         success, msg = manage_functions[manage_job_action]()
     except Exception as e:
@@ -136,15 +134,15 @@ def manage_job_button_click(
     check_interval_seconds = 0.01
     begin = time.perf_counter()
     while (time.perf_counter() - begin) < timeout_seconds:
-        if daemon.status != old_status:
+        if job.status != old_status:
             break
         time.sleep(check_interval_seconds)
 
     return (
         alert_from_success_tuple((success, msg)),
-        build_manage_job_buttons_div_children(daemon),
-        build_status_children(daemon),
-        build_process_timestamps_children(daemon),
+        build_manage_job_buttons_div_children(job),
+        build_status_children(job),
+        build_process_timestamps_children(job),
     )
 
 dash_app.clientside_callback(
@@ -165,7 +163,7 @@ dash_app.clientside_callback(
         }
 
         const triggered_id = dash_clientside.callback_context.triggered_id;
-        const job_daemon_id = triggered_id["index"];
+        const job_name = triggered_id["index"];
 
         iframe = document.getElementById('webterm-iframe');
         if (!iframe){ return dash_clientside.no_update; }
@@ -174,7 +172,7 @@ dash_app.clientside_callback(
             {
                action: "show",
                subaction: "logs",
-               subaction_text: job_daemon_id,
+               subaction_text: job_name,
             },
             url
         );
@@ -197,44 +195,38 @@ dash_app.clientside_callback(
     prevent_initial_call = True,
 )
 def refresh_jobs_on_interval(
-        n_intervals: Optional[int] = None,
-        session_data: Optional[Dict[str, Any]] = None,
-    ):
+    n_intervals: Optional[int] = None,
+    session_data: Optional[Dict[str, Any]] = None,
+):
     """
     When the jobs refresh interval fires, rebuild the jobs' onscreen components.
     """
     session_id = session_data.get('session-id', None)
     is_authenticated = is_session_authenticated(session_id)
 
-    daemon_ids = [
+    job_names = [
         component_dict['id']['index']
         for component_dict in dash.callback_context.outputs_grouping[0]
     ]
 
-    ### NOTE: The daemon may have been deleted, but the card may still exist.
-    daemons = []
-    for daemon_id in daemon_ids:
-        try:
-            daemon = Daemon(daemon_id=daemon_id)
-        except Exception as e:
-            daemon = None
-        daemons.append(daemon)
+    ### NOTE: The job may have been deleted, but the card may still exist.
+    jobs = [Job(name) for name in job_names]
 
     return (
         [
             (
-                build_manage_job_buttons_div_children(daemon)
+                build_manage_job_buttons_div_children(job)
                 if is_authenticated
                 else []
             )
-            for daemon in daemons
+            for job in jobs
         ],
         [
-            build_status_children(daemon)
-            for daemon in daemons
+            build_status_children(job)
+            for job in jobs
         ],
         [
-            build_process_timestamps_children(daemon)
-            for daemon in daemons
+            build_process_timestamps_children(job)
+            for job in jobs
         ],
     )

meerschaum/api/dash/jobs.py

@@ -15,12 +15,12 @@ from meerschaum.api.dash.users import is_session_authenticated
 from meerschaum.api import CHECK_UPDATE
 dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
 html, dcc = import_html(), import_dcc()
-dateutil_parser = attempt_import('dateutil.parser', check_update=CHECK_UPDATE)
 from meerschaum.jobs import (
     get_jobs,
     get_running_jobs,
     get_paused_jobs,
     get_stopped_jobs,
+    get_executor_keys_from_context,
     Job,
 )
 from meerschaum.config import get_config
@@ -33,20 +33,21 @@ STATUS_EMOJI: Dict[str, str] = {
     'dne': get_config('formatting', 'emoji', 'failure')
 }
 
+EXECUTOR_KEYS: str = get_executor_keys_from_context()
+
 def get_jobs_cards(state: WebState):
     """
     Build cards and alerts lists for jobs.
     """
-    jobs = get_jobs(include_hidden=False)
+    jobs = get_jobs(executor_keys=EXECUTOR_KEYS, include_hidden=False)
     session_id = state['session-store.data'].get('session-id', None)
     is_authenticated = is_session_authenticated(session_id)
 
     cards = []
 
     for name, job in jobs.items():
-        d = job.daemon
         footer_children = html.Div(
-            build_process_timestamps_children(d),
+            build_process_timestamps_children(job),
             id = {'type': 'process-timestamps-div', 'index': name},
         )
         follow_logs_button = dbc.DropdownMenuItem(
@@ -62,7 +63,7 @@ def get_jobs_cards(state: WebState):
         )
         header_children = [
             html.Div(
-                build_status_children(d),
+                build_status_children(job),
                 id={'type': 'manage-job-status-div', 'index': name},
                 style={'float': 'left'},
             ),
@@ -83,15 +84,16 @@ def get_jobs_cards(state: WebState):
             html.H4(html.B(name), className="card-title"),
             html.Div(
                 html.P(
-                    d.label,
+                    job.label,
                     className="card-text job-card-text",
                     style={"word-wrap": "break-word"},
+                    id={'type': 'job-label-p', 'index': name},
                 ),
                 style={"white-space": "pre-wrap"},
             ),
             html.Div(
                 (
-                    build_manage_job_buttons_div_children(d)
+                    build_manage_job_buttons_div_children(job)
                     if is_authenticated
                     else []
                 ),
@@ -179,13 +181,14 @@ def build_manage_job_buttons(job: Job):
         },
     )
     buttons = []
-    if job.status in ('stopped', 'paused'):
+    status = job.status
+    if status in ('stopped', 'paused'):
         buttons.append(start_button)
-    if job.status == 'stopped':
+    if status == 'stopped':
         buttons.append(delete_button)
-    if job.status in ('running',):
+    if status in ('running',):
         buttons.append(pause_button)
-    if job.status in ('running', 'paused'):
+    if status in ('running', 'paused'):
         buttons.append(stop_button)
 
     return buttons
@@ -193,7 +196,7 @@ def build_manage_job_buttons(job: Job):
 
 def build_status_children(job: Job) -> List[html.P]:
     """
-    Return the status HTML component for this daemon.
+    Return the status HTML component for this Job.
     """
     if job is None:
         return STATUS_EMOJI['dne']
@@ -217,10 +220,16 @@ def build_process_timestamps_children(job: Job) -> List[dbc.Row]:
         return []
 
     children = []
-    for timestamp_key, timestamp_val in sorted_dict(
-        job.daemon.properties.get('process', {})
+    for timestamp_key, timestamp in sorted_dict(
+        {
+            'began': job.began,
+            'paused': job.paused,
+            'ended': job.ended,
+        }
     ).items():
-        timestamp = dateutil_parser.parse(timestamp_val)
+        if timestamp is None:
+            continue
+
         timestamp_str = timestamp.strftime('%Y-%m-%d %H:%M UTC')
         children.append(
             dbc.Row(

meerschaum/api/routes/_actions.py

@@ -18,7 +18,7 @@ from fastapi import WebSocket, WebSocketDisconnect
 from meerschaum.utils.misc import generate_password
 from meerschaum.jobs import Job
 from meerschaum.utils.warnings import warn
-from meerschaum.utils.typing import SuccessTuple, Union, List, Dict
+from meerschaum.utils.typing import SuccessTuple, Union, List, Dict, Any
 from meerschaum.api import (
     fastapi, app, endpoints, get_api_connector, debug, manager, private, no_auth
 )
@@ -26,6 +26,7 @@ from meerschaum.actions import actions
 import meerschaum.core
 from meerschaum.config import get_config
 from meerschaum._internal.arguments._parse_arguments import parse_dict_to_sysargs, parse_arguments
+from meerschaum.api.routes._jobs import clean_sysargs
 
 actions_endpoint = endpoints['actions']
 
@@ -115,11 +116,11 @@ async def do_action_websocket(websocket: WebSocket):
         if not auth_success:
             await websocket.close()
 
-        sysargs = await websocket.receive_json()
-        kwargs = parse_arguments(sysargs)
-        _ = kwargs.pop('executor_keys', None)
-        _ = kwargs.pop('shell', None)
-        sysargs = parse_dict_to_sysargs(kwargs)
+        sysargs = clean_sysargs(await websocket.receive_json())
+        #  kwargs = parse_arguments(sysargs)
+        #  _ = kwargs.pop('executor_keys', None)
+        #  _ = kwargs.pop('shell', None)
+        #  sysargs = parse_dict_to_sysargs(kwargs)
 
         job = Job(
             job_name,
@@ -152,3 +153,50 @@ async def do_action_websocket(websocket: WebSocket):
             job.delete()
         _ = _temp_jobs.pop(job_name, None)
         stop_event.set()
+
+
+@app.post(actions_endpoint + "/{action}", tags=['Actions'])
+def do_action_legacy(
+    action: str,
+    keywords: Dict[str, Any] = fastapi.Body(...),
+    curr_user = (
+        fastapi.Depends(manager) if not no_auth else None
+    ),
+) -> SuccessTuple:
+    """
+    Perform a Meerschaum action (if permissions allow).
+
+    Parameters
+    ----------
+    action: str
+        The action to perform.
+        
+    keywords: Dict[str, Any]
+        The keywords dictionary to pass to the action.
+
+    Returns
+    -------
+    A `SuccessTuple`.
+    """
+    if curr_user is not None and curr_user.type != 'admin':
+        from meerschaum.config import get_config
+        allow_non_admin = get_config(
+            'system', 'api', 'permissions', 'actions', 'non_admin', patch=True
+        )
+        if not allow_non_admin:
+            return False, (
+                "The administrator for this server has not allowed users to perform actions.\n\n"
+                + "Please contact the system administrator, or if you are running this server, "
+                + "open the configuration file with `edit config system` "
+                + "and search for 'permissions'. "
+                + "\nUnder the keys 'api:permissions:actions', "
+                + "you can allow non-admin users to perform actions."
+        )
+
+    if action not in actions:
+        return False, f"Invalid action '{action}'."
+
+    keywords['mrsm_instance'] = keywords.get('mrsm_instance', str(get_api_connector()))
+    _debug = keywords.get('debug', debug)
+    keywords.pop('debug', None)
+    return actions[action](debug=_debug, **keywords)

meerschaum/api/routes/_jobs.py

@@ -107,6 +107,24 @@ def get_job(
     }
 
 
+def clean_sysargs(sysargs: List[str]) -> List[str]:
+    """
+    Remove the executor flag or leading `api {label}` action.
+    """
+    clean_sysargs = []
+    executor_flag = False
+    for arg in sysargs:
+        if arg in ('-e', '--executor', 'api'):
+            executor_flag = True
+            continue
+        if executor_flag:
+            executor_flag = False
+            continue
+
+        clean_sysargs.append(arg)
+    return clean_sysargs
+
+
 @app.post(endpoints['jobs'] + '/{name}', tags=['Jobs'])
 def create_job(
     name: str,
@@ -118,7 +136,7 @@ def create_job(
     """
     Create and start a new job.
     """
-    job = Job(name, sysargs, executor_keys=EXECUTOR_KEYS)
+    job = Job(name, clean_sysargs(sysargs), executor_keys=EXECUTOR_KEYS)
     if job.exists():
         raise fastapi.HTTPException(
             status_code=409,

meerschaum/config/_jobs.py

@@ -7,7 +7,7 @@ Default configuration for jobs.
 """
 
 default_jobs_config = {
-    'timeout_seconds': 8,
+    'timeout_seconds': 4,
     'check_timeout_interval_seconds': 0.1,
     'terminal': {
         'lines': 40,

meerschaum/config/_paths.py

@@ -185,6 +185,7 @@ paths = {
     'SYSTEMD_RESOURCES_PATH'         : ('{DOT_CONFIG_DIR_PATH}', 'systemd'),
     'SYSTEMD_USER_RESOURCES_PATH'    : ('{SYSTEMD_RESOURCES_PATH}', 'user'),
     'SYSTEMD_ROOT_RESOURCES_PATH'    : ('{ROOT_DIR_PATH}', 'systemd'),
+    'SYSTEMD_JOBS_RESOURCES_PATH'    : ('{SYSTEMD_ROOT_RESOURCES_PATH}', 'services'),
     'SYSTEMD_LOGS_RESOURCES_PATH'    : ('{SYSTEMD_ROOT_RESOURCES_PATH}', 'logs'),
 }
 

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.3.0rc2"
+__version__ = "2.3.0rc5"

meerschaum/config/static/__init__.py

@@ -90,6 +90,8 @@ STATIC_CONFIG: Dict[str, Any] = {
             'failure_key': '_argparse_exception',
             'and_key': '+',
             'escaped_and_key': '++',
+            'pipeline_key': ':',
+            'escaped_pipeline_key': '::',
         },
         'urls': {
             'get-pip.py': 'https://bootstrap.pypa.io/get-pip.py',

meerschaum/connectors/api/APIConnector.py

@@ -33,7 +33,12 @@ class APIConnector(Connector):
         delete,
         wget,
     )
-    from ._actions import get_actions, do_action, do_action_async
+    from ._actions import (
+        get_actions,
+        do_action,
+        do_action_async,
+        do_action_legacy,
+    )
     from ._misc import get_mrsm_version, get_chaining_status
     from ._pipes import (
         register_pipe,
@@ -90,6 +95,7 @@ class APIConnector(Connector):
         get_job_is_blocking_on_stdin,
         get_job_began,
         get_job_ended,
+        get_job_paused,
         get_job_status,
     )
 

meerschaum/connectors/api/_actions.py

@@ -13,7 +13,7 @@ import asyncio
 from functools import partial
 
 import meerschaum as mrsm
-from meerschaum.utils.typing import SuccessTuple, List, Callable
+from meerschaum.utils.typing import SuccessTuple, List, Callable, Optional
 from meerschaum.config.static import STATIC_CONFIG
 
 ACTIONS_ENDPOINT: str = STATIC_CONFIG['api']['endpoints']['actions']
@@ -74,3 +74,79 @@ async def do_action_async(
                 break
 
     return True, "Success"
+
+
+def do_action_legacy(
+    self,
+    action: Optional[List[str]] = None,
+    sysargs: Optional[List[str]] = None,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
+    """
+    NOTE: This method is deprecated.
+    Please use `do_action()` or `do_action_async()`.
+
+    Execute a Meerschaum action remotely.
+
+    If `sysargs` are provided, parse those instead.
+    Otherwise infer everything from keyword arguments.
+
+    Examples
+    --------
+    >>> conn = mrsm.get_connector('api:main')
+    >>> conn.do_action(['show', 'pipes'])
+    (True, "Success")
+    >>> conn.do_action(['show', 'arguments'], name='test')
+    (True, "Success")
+    """
+    import sys, json
+    from meerschaum.utils.debug import dprint
+    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum.utils.misc import json_serialize_datetime
+    if action is None:
+        action = []
+
+    if sysargs is not None and action and action[0] == '':
+        from meerschaum._internal.arguments import parse_arguments
+        if debug:
+            dprint(f"Parsing sysargs:\n{sysargs}")
+        json_dict = parse_arguments(sysargs)
+    else:
+        json_dict = kw
+        json_dict['action'] = action
+        if 'noask' not in kw:
+            json_dict['noask'] = True
+        if 'yes' not in kw:
+            json_dict['yes'] = True
+        if debug:
+            json_dict['debug'] = debug
+
+    root_action = json_dict['action'][0]
+    del json_dict['action'][0]
+    r_url = f"{STATIC_CONFIG['api']['endpoints']['actions']}/{root_action}"
+    
+    if debug:
+        from meerschaum.utils.formatting import pprint
+        dprint(f"Sending data to '{self.url + r_url}':")
+        pprint(json_dict, stream=sys.stderr)
+
+    response = self.post(
+        r_url,
+        data = json.dumps(json_dict, default=json_serialize_datetime),
+        debug = debug,
+    )
+    try:
+        response_list = json.loads(response.text)
+        if isinstance(response_list, dict) and 'detail' in response_list:
+            return False, response_list['detail']
+    except Exception as e:
+        print(f"Invalid response: {response}")
+        print(e)
+        return False, response.text
+    if debug:
+        dprint(response)
+    try:
+        return response_list[0], response_list[1]
+    except Exception as e:
+        return False, f"Failed to parse result from action '{root_action}'"

meerschaum/connectors/api/_jobs.py

@@ -112,7 +112,7 @@ def get_job_status(self, name: str, debug: bool = False) -> str:
     metadata = self.get_job_metadata(name, debug=debug)
     return metadata.get('status', 'stopped')
 
-def get_job_began(self, name: str, debug: bool = False) -> str:
+def get_job_began(self, name: str, debug: bool = False) -> Union[str, None]:
     """
     Return a job's `began` timestamp, if it exists.
     """
@@ -123,7 +123,7 @@ def get_job_began(self, name: str, debug: bool = False) -> str:
 
     return began_str
 
-def get_job_ended(self, name: str, debug: bool = False) -> str:
+def get_job_ended(self, name: str, debug: bool = False) -> Union[str, None]:
     """
     Return a job's `ended` timestamp, if it exists.
     """
@@ -134,6 +134,17 @@ def get_job_ended(self, name: str, debug: bool = False) -> str:
 
     return ended_str
 
+def get_job_paused(self, name: str, debug: bool = False) -> Union[str, None]:
+    """
+    Return a job's `paused` timestamp, if it exists.
+    """
+    properties = self.get_job_properties(name, debug=debug)
+    paused_str = properties.get('daemon', {}).get('paused', None)
+    if paused_str is None:
+        return None
+
+    return paused_str
+
 def get_job_exists(self, name: str, debug: bool = False) -> bool:
     """
     Return whether a job exists.