bfabric-web-apps 0.2.3__tar.gz → 0.2.4__tar.gz

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bfabric-web-apps
-Version: 0.2.3
+Version: 0.2.4
 Summary: A package containing handy boilerplate utilities for developing bfabric web-applications
 Author: Marc Zuber, Griffin White, GWC GmbH
 Requires-Python: >=3.10,<4.0

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/__init__.py

@@ -29,8 +29,9 @@ from .utils.callbacks import (
 )
 
 from .utils.config import settings as config
+from .utils.components import no_auth, expired, no_entity, dev, auth, charge_switch
 
-from. utils.run_main_pipeline import run_main_job, read_file_as_bytes
+from .utils.run_main_pipeline import run_main_job, read_file_as_bytes
 
 from .utils.resource_utilities import (
     create_workunit, 

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/layouts/layouts.py

@@ -43,10 +43,24 @@ def get_static_layout(base_title=None, main_content=None, documentation_content=
                             children=[str(" ")],
                             style={"font-size": "40px", "margin-left": "20px", "margin-top": "10px"}
                         ),
-
-                        # View Logs Button (Aligned Right)
                         html.Div(
                             children=[
+                                html.A(
+                                    dbc.Button(
+                                        "B-Fabric Entity",
+                                        id="bfabric-entity-button",
+                                        color="secondary", # Greyish color
+                                        style={
+                                            "font-size": "18px",
+                                            "padding": "10px 20px",
+                                            "border-radius": "8px",
+                                            "margin-right": "10px"
+                                        }
+                                    ),
+                                    id="bfabric-entity-link",
+                                    href="#",  # will be set in the Callback
+                                    target="_blank"
+                                ),
                                 html.A(
                                     dbc.Button(
                                         "View Logs",
@@ -67,6 +81,8 @@ def get_static_layout(base_title=None, main_content=None, documentation_content=
                                 "position": "absolute",
                                 "right": "20px",
                                 "top": "10px",  # Aligns with title
+                                "display": "flex",
+                                "align-items": "center"
                             }
                         ),
                     ],
@@ -124,7 +140,6 @@ def get_static_layout(base_title=None, main_content=None, documentation_content=
                             ),
                         ),
                     ),
-
                     # Page Title Section + View Logs Button (Aligned Right)
                     header_row, 
 

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/objects/BfabricInterface.py

@@ -9,8 +9,10 @@ from bfabric_web_apps.utils.get_logger import get_logger
 import os
 import bfabric_web_apps
 
-VALIDATION_URL = "https://fgcz-bfabric.uzh.ch/bfabric/rest/token/validate?token="
-HOST = "fgcz-bfabric.uzh.ch"
+from bfabric_web_apps.utils.config import settings
+
+HOST = settings.PRODUCTION_BFABRIC_DOMAIN
+VALIDATION_URL = f"https://{HOST}/bfabric/rest/token/validate?token="
 
 class BfabricInterface( Bfabric ):
     _instance = None  # Singleton instance
@@ -89,7 +91,11 @@ class BfabricInterface( Bfabric ):
                 return "EXPIRED"
             
             envioronment_name = str(userinfo['environment']).strip().lower()
-            environment_dict = {"production":"https://fgcz-bfabric.uzh.ch/bfabric","prod":"https://fgcz-bfabric.uzh.ch/bfabric","test":"https://fgcz-bfabric-test.uzh.ch/bfabric"}
+            environment_dict = {
+                "production":f"https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric",
+                "prod":f"https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric",
+                "test":f"https://{settings.TEST_BFABRIC_DOMAIN}/bfabric"
+            }
             
             token_data = dict(
                 environment = userinfo['environment'],

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/utils/callbacks.py

@@ -7,7 +7,7 @@ from bfabric_web_apps.utils.get_logger import get_logger
 from rq import Queue
 from .redis_connection import redis_conn
 from rq.registry import StartedJobRegistry, FailedJobRegistry, FinishedJobRegistry
-
+from bfabric_web_apps.utils.config import settings
 
 def process_url_and_token(url_params):
     """
@@ -25,22 +25,27 @@ def process_url_and_token(url_params):
                - page_title (str): Title for the page header.
                - session_details (list): HTML-formatted session details.
                - job_link (str): Dynamically generated link to the job page.
+               - entity_link (str): Link to the B-Fabric entity page.
     """
     base_title = " "
 
     if not url_params:
-        return None, None, None, None, base_title, None, None
+        return None, None, None, None, base_title, None, None, None
 
     token = "".join(url_params.split('token=')[1:])
+
+    # TODO: Implement environment spec once implemented in bfabric production
+    # environment = url_params.split('environment=')[1].split('&')[0].strip().lower()
+
     tdata_raw = bfabric_interface.token_to_data(token)
 
     if tdata_raw:
         if tdata_raw == "EXPIRED":
-            return None, None, None, None, base_title, None, None
+            return None, None, None, None, base_title, None, None, None
         else:
             tdata = json.loads(tdata_raw)
     else:
-        return None, None, None, None, base_title, None, None
+        return None, None, None, None, base_title, None, None, None
 
     if tdata:
         entity_data_json = bfabric_interface.entity_data(tdata)
@@ -55,14 +60,26 @@ def process_url_and_token(url_params):
         environment = tdata.get("environment", "").strip().lower()  # 'test' or 'prod'
         tdata["environment"] = environment.lower()
 
+
+        # Build B-Fabric entity link
+        entity_link = None
+        base_url = tdata.get("webbase_data")  # e.g. https://fgcz-bfabric-test.uzh.ch/bfabric
+        eclass = (tdata.get("entityClass_data").lower()) # Get the entity class name (e.g., "Plate")
+        eid = tdata.get("entity_id_data") # Get the entity ID (e.g., 5044)
+
+        if base_url and eclass and eid:
+            entity_link = f"{base_url}/{str(eclass)}/show.html?id={eid}&tab=details"
+
+
+        # Build job link if job ID is available
         job_id = tdata.get("jobId", None)  # Extract job ID
 
         job_link = None
         if job_id:
             if "test" in environment:
-                job_link = f"https://fgcz-bfabric-test.uzh.ch/bfabric/job/show.html?id={job_id}&tab=details"
+                job_link = f"https://{settings.TEST_BFABRIC_DOMAIN}/bfabric/job/show.html?id={job_id}&tab=details"
             else:
-                job_link = f"https://fgcz-bfabric.uzh.ch/bfabric/job/show.html?id={job_id}&tab=details"
+                job_link = f"https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric/job/show.html?id={job_id}&tab=details"
 
         session_details = [
             html.P([
@@ -88,9 +105,9 @@ def process_url_and_token(url_params):
             ])
         ]
 
-        return token, tdata, entity_data, app_data, page_title, session_details, job_link
+        return token, tdata, entity_data, app_data, page_title, session_details, job_link, entity_link
     else:
-        return None, None, None, None, base_title, None, None
+        return None, None, None, None, base_title, None, None, None
 
 
 def submit_bug_report(n_clicks, bug_description, token, entity_data):
@@ -184,8 +201,8 @@ def populate_workunit_details(token_data):
     """
 
     environment_urls = {
-        "test": "https://fgcz-bfabric-test.uzh.ch/bfabric/workunit/show.html?id=",
-        "production": "https://fgcz-bfabric.uzh.ch/bfabric/workunit/show.html?id="
+        "test": f"https://{settings.TEST_BFABRIC_DOMAIN}/bfabric/workunit/show.html?id=",
+        "production": f"https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric/workunit/show.html?id="
     }
 
     if token_data:

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/utils/charging.py

@@ -2,7 +2,7 @@
 from bfabric_web_apps.utils.get_logger import get_logger
 from bfabric_web_apps.utils.get_power_user_wrapper import get_power_user_wrapper
 
-def create_charge(token_data, container_id, service_id):
+def create_charge(token_data, container_id, service_id, n_charges=1):
     """
     Create a charge in B-Fabric.
     
@@ -10,6 +10,7 @@ def create_charge(token_data, container_id, service_id):
         token_data (dict): Authentication token data.
         container_id (int): Container ID (Order ID).
         service_id (int): Service ID.
+        n_charges (int): Number of total charges. Default is 1.
     
     Returns:
         list[dict]: List of charge data.
@@ -25,7 +26,8 @@ def create_charge(token_data, container_id, service_id):
     charge_data = {
         "serviceid": service_id,
         "containerid": container_id,
-        "chargerid": usr_id
+        "chargerid": usr_id,
+        "total": str(n_charges),
     }
 
     # Create and log the charge

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/utils/components.py

@@ -1,16 +1,17 @@
 from dash import html
 import dash_daq as daq
+from bfabric_web_apps.utils.config import settings
 
 DEVELOPER_EMAIL = "gwhite@fgcz.ethz.ch"
 
 expired = [
     html.P("Your session has expired. Please log into bfabric to continue:"),
-    html.A('Login to Bfabric', href='https://fgcz-bfabric.uzh.ch/bfabric/')
+    html.A('Login to Bfabric', href=f'https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric/')
 ]
 
 no_entity = [
     html.P("There was an error fetching the data for your entity. Please try accessing the applicaiton again from bfabric:"),
-    html.A('Login to Bfabric', href='https://fgcz-bfabric.uzh.ch/bfabric/')
+    html.A('Login to Bfabric', href=f'https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric/')
 ]
 
 dev = [html.P("This page is under development. Please check back later."),html.Br(),html.A("email the developer for more details",href="mailto:"+DEVELOPER_EMAIL)]
@@ -19,7 +20,7 @@ auth = [html.Div(id="auth-div")]
 
 no_auth = [
     html.P("You are not currently logged into an active session. Please log into bfabric to continue:"),
-    html.A('Login to Bfabric', href='https://fgcz-bfabric.uzh.ch/bfabric/')
+    html.A('Login to Bfabric', href=f'https://{settings.PRODUCTION_BFABRIC_DOMAIN}/bfabric/')
 ]
 
 charge_switch = [

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/utils/config.py

@@ -34,6 +34,10 @@ class Settings(BaseSettings):
     # Which dataset template id to use for dataset creation
     DATASET_TEMPLATE_ID: int = 0
 
+    # B-Fabric url paths
+    PRODUCTION_BFABRIC_DOMAIN: str = "fgcz-bfabric.uzh.ch"
+    TEST_BFABRIC_DOMAIN: str = "fgcz-bfabric-test.uzh.ch"
+
     class Config:
 
         env_file = ".env"  

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/bfabric_web_apps/utils/run_main_pipeline.py

@@ -6,6 +6,9 @@ import subprocess
 from pathlib import Path
 import time
 from collections import defaultdict
+import signal
+import sys
+import atexit
 
 from .get_logger import get_logger
 from .get_power_user_wrapper import get_power_user_wrapper
@@ -74,7 +77,7 @@ def run_main_job(
     """
 
     # STEP 0: Parse token, logger, etc.
-    token, token_data, entity_data, app_data, page_title, session_details, job_link = process_url_and_token(token)
+    token, token_data, entity_data, app_data, page_title, session_details, job_link, bfabric_entity_link = process_url_and_token(token)
 
     if token is None:
         raise ValueError("Error: 'token' is None")
@@ -85,111 +88,130 @@ def run_main_job(
     if app_data is None:
         raise ValueError("Error: 'app_data' is None")
     
-    
     L = get_logger(token_data)
     print("Token Data:", token_data)
     print("Entity Data:", entity_data)
     print("App Data:", app_data)
-     
-
-    # Step 1: Save files to the server
-    try:
-        summary = save_files_from_bytes(files_as_byte_strings, L)
-        L.log_operation("Success | ORIGIN: run_main_job function", f"File copy summary: {summary}", params=None, flush_logs=True)
-        print("Summary:", summary)
-        
-    except Exception as e:
-        # If something unexpected blows up the entire process
-        L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to copy files: {e}", params=None, flush_logs=True)
-        print("Error copying files:", e)
-
-    
-    # STEP 2: Execute bash commands
-    try:
-        bash_log = execute_and_log_bash_commands(bash_commands)
-        L.log_operation("Success | ORIGIN: run_main_job function", f"Bash commands executed success | origin: run_main_job functionfully:\n{bash_log}", 
-                        params=None, flush_logs=True)
-    except Exception as e:
-        L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to execute bash commands: {e}", 
-                        params=None, flush_logs=True)
-        print("Error executing bash commands:", e)
 
+    job_id = token_data.get("jobId", None)
+    set_job_status(token_data, job_id, "running")
+    job_status = "running"
 
-    # STEP 3: Create Workunits
     try:
-        workunit_map, workunit_container_map = create_workunits_step(token_data, app_data, resource_paths, L)
-    except Exception as e:
-        L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to create workunits in B-Fabric: {e}", 
-                        params=None, flush_logs=True)
-        print("Error creating workunits:", e)
-        workunit_map = []
-
+        # Step 1: Save files to the server
+        try:
+            summary = save_files_from_bytes(files_as_byte_strings, L)
+            L.log_operation("Success | ORIGIN: run_main_job function", f"File copy summary: {summary}", params=None, flush_logs=True)
+            print("Summary:", summary)
+            
+        except Exception as e:
+            # If something unexpected blows up the entire process
+            job_status = "failed"
+            L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to copy files: {e}", params=None, flush_logs=True)
+            print("Error copying files:", e)
 
-    # STEP 4: Create Dataset
-    if dataset_dict:
-        for container_id, dataset_data in dataset_dict.items():
+        
+        # STEP 2: Execute bash commands
+        try:
+            bash_log = execute_and_log_bash_commands(bash_commands)
+            L.log_operation("Success | ORIGIN: run_main_job function", f"Bash commands executed success | origin: run_main_job functionfully:\n{bash_log}", 
+                            params=None, flush_logs=True)
+        except Exception as e:
+            job_status = "failed"
+            L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to execute bash commands: {e}", 
+                            params=None, flush_logs=True)
+            print("Error executing bash commands:", e)
 
-            dataset_name = f'Dataset - {str(app_data.get("name", "Unknown App"))} - Container {container_id}'
-            linked_workunit_id = workunit_container_map.get(str(container_id), None)
 
-            try:
-                dataset = dictionary_to_dataset(dataset_data, dataset_name, container_id, DATASET_TEMPLATE_ID, linked_workunit_id)
-                dataset = create_dataset(token_data, dataset)
-                L.log_operation("Success | ORIGIN: run_main_job function", f'Dataset {dataset.get("id", "Null")} created successfully for container {container_id}', params=None, flush_logs=True)
-                print(f"Dataset created successfully for container {container_id}")
-            except Exception as e:
-                L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to create dataset for container {container_id}: {e}", params=None, flush_logs=True)
-                print(f"Error creating dataset for container {container_id}:", e)
-    else:
-        L.log_operation("Info | ORIGIN: run_main_job function", "No dataset creation requested.", params=None, flush_logs=True)
-        print("No dataset creation requested.")
+        # STEP 3: Create Workunits
+        try:
+            workunit_map, workunit_container_map = create_workunits_step(token_data, app_data, resource_paths, L)
+        except Exception as e:
+            job_status = "failed"
+            L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to create workunits in B-Fabric: {e}", 
+                            params=None, flush_logs=True)
+            print("Error creating workunits:", e)
+            workunit_map = {}
+
+
+        # STEP 4: Create Dataset
+        if dataset_dict:
+            for container_id, dataset_data in dataset_dict.items():
+
+                dataset_name = f'Dataset - {str(app_data.get("name", "Unknown App"))} - Container {container_id}'
+                linked_workunit_id = workunit_container_map.get(str(container_id), None)
+
+                try:
+                    dataset = dictionary_to_dataset(dataset_data, dataset_name, container_id, DATASET_TEMPLATE_ID, linked_workunit_id)
+                    dataset = create_dataset(token_data, dataset)
+                    L.log_operation("Success | ORIGIN: run_main_job function", f'Dataset {dataset.get("id", "Null")} created successfully for container {container_id}', params=None, flush_logs=True)
+                    print(f"Dataset created successfully for container {container_id}")
+                except Exception as e:
+                    job_status = "failed"
+                    L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to create dataset for container {container_id}: {e}", params=None, flush_logs=True)
+                    print(f"Error creating dataset for container {container_id}:", e)
+        else:
+            L.log_operation("Info | ORIGIN: run_main_job function", "No dataset creation requested.", params=None, flush_logs=True)
+            print("No dataset creation requested.")
 
 
-    # STEP 5: Register Resources (Refactored)
-    try:
-        attach_resources_to_workunits(token_data, L, workunit_map)
-    except Exception as e:
-        L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to register resources: {e}", params=None, flush_logs=True)
-        print("Error registering resources:", e)
+        # STEP 5: Register Resources (Refactored)
+        try:
+            attach_resources_to_workunits(token_data, L, workunit_map)
+        except Exception as e:
+            job_status = "failed"
+            L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to register resources: {e}", params=None, flush_logs=True)
+            print("Error registering resources:", e)
 
-    # STEP 6: Attach gstore files (logs, reports, etc.) to B-Fabric entity as a Link
-    try:
-        attach_gstore_files_to_entities_as_link(token_data, L, attachment_paths)
-        print("Attachment Paths:", attachment_paths)
-    except Exception as e:
-        L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to attach extra files: {e}", params=None, flush_logs=True)
-        print("Error attaching extra files:", e)
+        # STEP 6: Attach gstore files (logs, reports, etc.) to B-Fabric entity as a Link
+        try:
+            attach_gstore_files_to_entities_as_link(token_data, L, attachment_paths)
+            print("Attachment Paths:", attachment_paths)
+        except Exception as e:
+            job_status = "failed"
+            L.log_operation("Error | ORIGIN: run_main_job function", f"Failed to attach extra files: {e}", params=None, flush_logs=True)
+            print("Error attaching extra files:", e)
 
 
-    # STEP 7: Charge the container for the service
-    if charge: 
+        # STEP 7: Charge the container for the service
+        if charge: 
+            
+            if service_id == 0:
+                print("Service ID not provided. Skipping charge creation.")
+                L.log_operation("Info | ORIGIN: run_main_job function", "Service ID not provided. Skipping charge creation.", params=None, flush_logs=True)
+            else:
+                container_ids = charge
+                print("Container IDs to charge:", container_ids)
+                if not container_ids:
+                    L.log_operation("Error | ORIGIN: run_main_job function", "No container IDs found for charging.", params=None, flush_logs=True)
+                    print("Error: No container IDs found for charging.")
+                    set_job_status(token_data, job_id, "failed")
+                    return
+                for container_id in container_ids:
+                    charges = create_charge(token_data, container_id, service_id)
+                    charge_id = charges[0].get("id")
+                    L.log_operation("Success | ORIGIN: run_main_job function", f"Charge created for container {container_id} with service ID {service_id} and charge id {charge_id}", params=None, flush_logs=False)
+                    print(f"Charge created with id {charge_id} for container {container_id} with service ID {service_id}")
+                L.flush_logs()
+        else:
+            L.log_operation("Info | ORIGIN: run_main_job function", "Charge creation skipped.", params=None, flush_logs=True)
+            print("Charge creation skipped.")
         
-        if service_id == 0:
-            print("Service ID not provided. Skipping charge creation.")
-            L.log_operation("Info | ORIGIN: run_main_job function", "Service ID not provided. Skipping charge creation.", params=None, flush_logs=True)
+        # Final log message
+        if job_status == "running":
+            set_job_status(token_data, job_id, "done")
+            L.log_operation("Success | ORIGIN: run_main_job function", "All steps completed successfully.", params=None, flush_logs=True)
+            print("All steps completed successfully.")
         else:
-            container_ids = charge
-            print("Container IDs to charge:", container_ids)
-            if not container_ids:
-                L.log_operation("Error | ORIGIN: run_main_job function", "No container IDs found for charging.", params=None, flush_logs=True)
-                print("Error: No container IDs found for charging.")
-                return
-            for container_id in container_ids:
-                charges = create_charge(token_data, container_id, service_id)
-                charge_id = charges[0].get("id")
-                L.log_operation("Success | ORIGIN: run_main_job function", f"Charge created for container {container_id} with service ID {service_id} and charge id {charge_id}", params=None, flush_logs=False)
-                print(f"Charge created with id {charge_id} for container {container_id} with service ID {service_id}")
-            L.flush_logs()
-    else:
-        L.log_operation("Info | ORIGIN: run_main_job function", "Charge creation skipped.", params=None, flush_logs=True)
-        print("Charge creation skipped.")
-    
-    # Final log message
-    L.log_operation("Success | ORIGIN: run_main_job function", "All steps completed successfully.", params=None, flush_logs=True)
-    print("All steps completed successfully.")
+            set_job_status(token_data, job_id, "failed")
+            L.log_operation("Failed | ORIGIN: run_main_job function", "The Pipline did not run successfully", params=None, flush_logs=True)
+   
+    # It’s the “catch absolutely everything” version of except Exception
+    except BaseException as e:
+        set_job_status(token_data, job_id, "failed")
+        L.log_operation("Error | ORIGIN: run_main_job function", f"Unhandled termination: {e}", params=None, flush_logs=True)
 
 #---------------------------------------------------------------------------------------------------------------------
-#---------------------------------------------------------------------------------------------------------------------
 
 
 # -----------------------------------------------------------------------------
@@ -547,3 +569,14 @@ def read_file_as_bytes(file_path, max_size_mb=400):
         file_as_bytes = f.read()
 
     return file_as_bytes
+
+def set_job_status(token_data, job_id, set_status_to):
+    """
+    Updates the job status in B-Fabric.
+
+    :param token_data: Authentication token data
+    :param job_id: ID of the job to update
+    :param set_status_to: String, e.g. "running", "done", or "failed"
+    """
+    wrapper = get_power_user_wrapper(token_data)
+    wrapper.save("job", {"id": job_id, "status": set_status_to})

{bfabric_web_apps-0.2.3 → bfabric_web_apps-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bfabric-web-apps"
-version = "0.2.3"
+version = "0.2.4"
 description = "A package containing handy boilerplate utilities for developing bfabric web-applications"
 authors = ["Marc Zuber, Griffin White, GWC GmbH"]