meerschaum 2.3.0rc1__py3-none-any.whl → 2.3.0rc3__py3-none-any.whl

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

@@ -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,

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

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

meerschaum/config/static/__init__.py

@@ -88,6 +88,8 @@ STATIC_CONFIG: Dict[str, Any] = {
             ),
             'underscore_standin': '<UNDERSCORE>', ### Temporary replacement for parsing.
             'failure_key': '_argparse_exception',
+            'and_key': '+',
+            'escaped_and_key': '++',
         },
         'urls': {
             'get-pip.py': 'https://bootstrap.pypa.io/get-pip.py',

meerschaum/connectors/api/APIConnector.py

@@ -90,6 +90,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/_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.

meerschaum/connectors/parse.py

@@ -120,7 +120,6 @@ def parse_repo_keys(keys: Optional[str] = None, **kw):
 def parse_executor_keys(keys: Optional[str] = None, **kw):
     """Parse the executor keys into an APIConnector or string."""
     from meerschaum.jobs import get_executor_keys_from_context
-    from meerschaum.config import get_config
     if keys is None:
         keys = get_executor_keys_from_context()
 

meerschaum/jobs/_Job.py

@@ -91,6 +91,14 @@ class Job:
         if isinstance(sysargs, str):
             sysargs = shlex.split(sysargs)
 
+        and_key = STATIC_CONFIG['system']['arguments']['and_key']
+        escaped_and_key = STATIC_CONFIG['system']['arguments']['escaped_and_key']
+        if sysargs:
+            sysargs = [
+                (arg if arg != escaped_and_key else and_key)
+                for arg in sysargs
+            ]
+
         ### NOTE: 'local' and 'systemd' executors are being coalesced.
         if executor_keys is None:
             from meerschaum.jobs import get_executor_keys_from_context
@@ -732,7 +740,7 @@ class Job:
         The datetime when the job began running.
         """
         if self.executor is not None:
-            began_str = self.executor.get_job_began(name)
+            began_str = self.executor.get_job_began(self.name)
             if began_str is None:
                 return None
             return (
@@ -754,6 +762,8 @@ class Job:
         """
         if self.executor is not None:
             ended_str = self.executor.get_job_ended(self.name)
+            if ended_str is None:
+                return None
             return (
                 datetime.fromisoformat(ended_str)
                 .astimezone(timezone.utc)
@@ -771,6 +781,16 @@ class Job:
         """
         The datetime when the job was suspended while running.
         """
+        if self.executor is not None:
+            paused_str = self.executor.get_job_paused(self.name)
+            if paused_str is None:
+                return None
+            return (
+                datetime.fromisoformat(paused_str)
+                .astimezone(timezone.utc)
+                .replace(tzinfo=None)
+            )
+
         paused_str = self.daemon.properties.get('process', {}).get('paused', None)
         if paused_str is None:
             return None
@@ -788,11 +808,8 @@ class Job:
         if not self.daemon.stop_path.exists():
             return None
 
-        try:
-            with open(self.daemon.stop_path, 'r', encoding='utf-8') as f:
-                stop_data = json.load(f)
-        except Exception as e:
-            warn(f"Failed to read stop file for {self}:\n{e}")
+        stop_data = self.daemon._read_stop_file()
+        if not stop_data:
             return None
 
         stop_time_str = stop_data.get('stop_time', None)
@@ -831,7 +848,7 @@ class Job:
         """
         Return the job's Daemon label (joined sysargs).
         """
-        return shlex.join(self.sysargs)
+        return shlex.join(self.sysargs).replace(' + ', '\n+ ')
 
     def __str__(self) -> str:
         sysargs = self.sysargs

meerschaum/jobs/_SystemdExecutor.py

@@ -19,9 +19,10 @@ from functools import partial
 import meerschaum as mrsm
 from meerschaum.jobs import Job, Executor, make_executor
 from meerschaum.utils.typing import Dict, Any, List, SuccessTuple, Union, Optional, Callable
+from meerschaum.config import get_config
 from meerschaum.config.static import STATIC_CONFIG
 from meerschaum.utils.warnings import warn, dprint
-from meerschaum._internal.arguments._parse_arguments import parse_arguments, parse_dict_to_sysargs
+from meerschaum._internal.arguments._parse_arguments import parse_arguments
 
 JOB_METADATA_CACHE_SECONDS: int = STATIC_CONFIG['api']['jobs']['metadata_cache_seconds']
 
@@ -36,11 +37,11 @@ class SystemdExecutor(Executor):
         """
         Return a list of existing jobs, including hidden ones.
         """
-        from meerschaum.config.paths import SYSTEMD_USER_RESOURCES_PATH
+        from meerschaum.config.paths import SYSTEMD_ROOT_RESOURCES_PATH
         return [
             service_name[len('mrsm-'):(-1 * len('.service'))]
-            for service_name in os.listdir(SYSTEMD_USER_RESOURCES_PATH)
-            if service_name.startswith('mrsm-')
+            for service_name in os.listdir(SYSTEMD_ROOT_RESOURCES_PATH)
+            if service_name.startswith('mrsm-') and service_name.endswith('.service')
         ]
 
     def get_job_exists(self, name: str, debug: bool = False) -> bool:
@@ -51,10 +52,10 @@ class SystemdExecutor(Executor):
         if debug:
             dprint(f'Existing services: {user_services}')
         return name in user_services
-    
+
     def get_jobs(self, debug: bool = False) -> Dict[str, Job]:
         """
-        Return a dictionary of `systemd` Jobs (excluding hidden jobs).
+        Return a dictionary of `systemd` Jobs (including hidden jobs).
         """
         user_services = self.get_job_names(debug=debug)
         jobs = {
@@ -64,7 +65,6 @@ class SystemdExecutor(Executor):
         return {
             name: job
             for name, job in jobs.items()
-            if not job.hidden
         }
 
     def get_service_name(self, name: str, debug: bool = False) -> str:
@@ -73,13 +73,20 @@ class SystemdExecutor(Executor):
         """
         return f"mrsm-{name.replace(' ', '-')}.service"
 
-    def get_service_file_path(self, name: str, debug: bool = False) -> pathlib.Path:
+    def get_service_symlink_file_path(self, name: str, debug: bool = False) -> pathlib.Path:
         """
-        Return the path to a Job's service file.
+        Return the path to where to create the service symlink.
         """
         from meerschaum.config.paths import SYSTEMD_USER_RESOURCES_PATH
         return SYSTEMD_USER_RESOURCES_PATH / self.get_service_name(name, debug=debug)
 
+    def get_service_file_path(self, name: str, debug: bool = False) -> pathlib.Path:
+        """
+        Return the path to a Job's service file.
+        """
+        from meerschaum.config.paths import SYSTEMD_ROOT_RESOURCES_PATH
+        return SYSTEMD_ROOT_RESOURCES_PATH / self.get_service_name(name, debug=debug)
+
     def get_service_logs_path(self, name: str, debug: bool = False) -> pathlib.Path:
         """
         Return the path to direct service logs to.
@@ -135,7 +142,8 @@ class SystemdExecutor(Executor):
             STATIC_CONFIG['environment']['systemd_log_path']: service_logs_path.as_posix(),
             STATIC_CONFIG['environment']['systemd_result_path']: result_path.as_posix(),
             STATIC_CONFIG['environment']['systemd_stdin_path']: socket_path.as_posix(),
-
+            'LINES': get_config('jobs', 'terminal', 'lines'),
+            'COLUMNS': get_config('jobs', 'terminal', 'columns'),
         })
         environment_lines = [
             f"Environment={key}={val}"
@@ -150,8 +158,7 @@ class SystemdExecutor(Executor):
             "\n"
             "[Service]\n"
             f"ExecStart={exec_str}\n"
-            "KillSignal=SIGINT\n"
-            "TimeoutStopSpec=8\n"
+            "KillSignal=SIGTERM\n"
             "Restart=always\n"
             "RestartPreventExitStatus=0\n"
             f"SyslogIdentifier={service_name}\n"
@@ -180,23 +187,11 @@ class SystemdExecutor(Executor):
         )
         return socket_text
 
-    @staticmethod
-    def clean_sysargs(sysargs: List[str]) -> List[str]:
-        """
-        Return a sysargs list with the executor key set to 'local'.
-        """
-        kwargs = parse_arguments(sysargs)
-        _ = kwargs.pop('executor_keys', None)
-        _ = kwargs.pop('systemd', None)
-        return parse_dict_to_sysargs(kwargs)
-
     def get_hidden_job(self, name: str, sysargs: Optional[List[str]] = None, debug: bool = False):
         """
         Return the hidden "sister" job to store a job's parameters.
         """
         hidden_name = f'.systemd-{self.get_service_name(name, debug=debug)}' 
-        if sysargs:
-            sysargs = self.clean_sysargs(sysargs)
 
         return Job(
             hidden_name,
@@ -266,7 +261,10 @@ class SystemdExecutor(Executor):
             return None
 
         psutil = mrsm.attempt_import('psutil')
-        return psutil.Process(pid)
+        try:
+            return psutil.Process(pid)
+        except Exception:
+            return None
 
     def get_job_status(self, name: str, debug: bool = False) -> str:
         """
@@ -278,13 +276,19 @@ class SystemdExecutor(Executor):
             debug=debug,
         )
 
+        if output == 'activating':
+            return 'running'
+
         if output == 'active':
             process = self.get_job_process(name, debug=debug)
             if process is None:
                 return 'stopped'
 
-            if process.status() == 'stopped':
-                return 'paused'
+            try:
+                if process.status() == 'stopped':
+                    return 'paused'
+            except Exception:
+                return 'stopped'
 
             return 'running'
 
@@ -309,12 +313,15 @@ class SystemdExecutor(Executor):
             return None
 
         pid_str = output[len('MainPID='):]
+        if pid_str == '0':
+            return None
+
         if is_int(pid_str):
             return int(pid_str)
         
         return None
 
-    def get_job_began(self, name: str, debug: bool = False) -> Union[datetime, None]:
+    def get_job_began(self, name: str, debug: bool = False) -> Union[str, None]:
         """
         Return when a job began running.
         """
@@ -330,10 +337,62 @@ class SystemdExecutor(Executor):
         if not output.startswith('ActiveEnterTimestamp'):
             return None
 
+        dt_str = output.split('=')[-1]
+        if not dt_str:
+            return None
+
         dateutil_parser = mrsm.attempt_import('dateutil.parser')
-        dt = dateutil_parser.parse(output.split('=')[-1])
+        try:
+            dt = dateutil_parser.parse(dt_str)
+        except Exception as e:
+            warn(f"Cannot parse '{output}' as a datetime:\n{e}")
+            return None
+
         return dt.astimezone(timezone.utc).isoformat()
 
+    def get_job_ended(self, name: str, debug: bool = False) -> Union[str, None]:
+        """
+        Return when a job began running.
+        """
+        output = self.run_command(
+            [
+                'show',
+                self.get_service_name(name, debug=debug),
+                '--property=InactiveEnterTimestamp'
+            ],
+            as_output=True,
+            debug=debug,
+        )
+        if not output.startswith('InactiveEnterTimestamp'):
+            return None
+
+        dt_str = output.split('=')[-1]
+        if not dt_str:
+            return None
+
+        dateutil_parser = mrsm.attempt_import('dateutil.parser')
+
+        try:
+            dt = dateutil_parser.parse(dt_str)
+        except Exception as e:
+            warn(f"Cannot parse '{output}' as a datetime:\n{e}")
+            return None
+        return dt.astimezone(timezone.utc).isoformat()
+
+    def get_job_paused(self, name: str, debug: bool = False) -> Union[str, None]:
+        """
+        Return when a job was paused.
+        """
+        job = self.get_hidden_job(name, debug=debug)
+        if self.get_job_status(name, debug=debug) != 'paused':
+            return None
+
+        stop_time = job.stop_time
+        if stop_time is None:
+            return None
+
+        return stop_time.isoformat()
+
     def get_job_result(self, name: str, debug: bool = False) -> SuccessTuple:
         """
         Return the job's result SuccessTuple.
@@ -438,19 +497,19 @@ class SystemdExecutor(Executor):
         """
         Create a job as a service to be run by `systemd`.
         """
-
+        from meerschaum.utils.misc import make_symlink
         service_name = self.get_service_name(name, debug=debug)
         service_file_path = self.get_service_file_path(name, debug=debug)
-        service_socket_path = self.get_service_socket_path(name, debug=debug)
-        socket_path = self.get_socket_path(name, debug=debug)
+        service_symlink_file_path = self.get_service_symlink_file_path(name, debug=debug)
         socket_stdin = self.get_job_stdin_file(name, debug=debug)
         _ = socket_stdin.file_handler
 
-        job = self.get_hidden_job(name, sysargs, debug=debug)
-
-        clean_sysargs = self.clean_sysargs(sysargs)
         with open(service_file_path, 'w+', encoding='utf-8') as f:
-            f.write(self.get_service_file_text(name, clean_sysargs, debug=debug))
+            f.write(self.get_service_file_text(name, sysargs, debug=debug))
+
+        symlink_success, symlink_msg = make_symlink(service_file_path, service_symlink_file_path)
+        if not symlink_success:
+            return symlink_success, symlink_msg
 
         commands = [
             ['daemon-reload'],
@@ -494,6 +553,19 @@ class SystemdExecutor(Executor):
         """
         job = self.get_hidden_job(name, debug=debug)
         job.daemon._write_stop_file('quit')
+        sigint_success, sigint_msg = self.run_command(
+            ['kill', '-s', 'SIGINT', self.get_service_name(name, debug=debug)],
+            debug=debug,
+        )
+
+        check_timeout_interval = get_config('jobs', 'check_timeout_interval_seconds')
+        loop_start = time.perf_counter()
+        while (time.perf_counter() - loop_start) < get_config('jobs', 'timeout_seconds'):
+            if self.get_job_status(name, debug=debug) == 'stopped':
+                return True, 'Success'
+
+            time.sleep(check_timeout_interval)
+
         return self.run_command(
             ['stop', self.get_service_name(name, debug=debug)],
             debug=debug,
@@ -516,28 +588,25 @@ class SystemdExecutor(Executor):
         """
         from meerschaum.config.paths import SYSTEMD_LOGS_RESOURCES_PATH
 
-        stop_success, stop_msg = self.stop_job(name, debug=debug)
-        if not stop_success:
-            return stop_success, stop_msg
-
-        disable_success, disable_msg = self.run_command(
+        _ = self.stop_job(name, debug=debug)
+        _ = self.run_command(
             ['disable', self.get_service_name(name, debug=debug)],
             debug=debug,
         )
-        if not disable_success:
-            return disable_success, disable_msg
 
-        service_file_path = self.get_service_file_path(name, debug=debug)
-        service_socket_path = self.get_service_socket_path(name, debug=debug)
-        socket_path = self.get_socket_path(name, debug=debug)
-        result_path = self.get_result_path(name, debug=debug)
         service_logs_path = self.get_service_logs_path(name, debug=debug)
         logs_paths = [
             (SYSTEMD_LOGS_RESOURCES_PATH / name)
             for name in os.listdir(SYSTEMD_LOGS_RESOURCES_PATH)
             if name.startswith(service_logs_path.name + '.')
         ]
-        paths = [service_file_path, service_socket_path, socket_path, result_path] + logs_paths
+        paths = [
+            self.get_service_file_path(name, debug=debug),
+            self.get_service_symlink_file_path(name, debug=debug),
+            self.get_socket_path(name, debug=debug),
+            self.get_result_path(name, debug=debug),
+        ] + logs_paths
+
         for path in paths:
             if path.exists():
                 try:
@@ -547,7 +616,7 @@ class SystemdExecutor(Executor):
                     return False, str(e)
 
         job = self.get_hidden_job(name, debug=debug)
-        job.delete()
+        _ = job.delete()
 
         return self.run_command(['daemon-reload'], debug=debug)