merge main in

backend/app/internal/flowsheet_manager.py

@@ -76,6 +76,7 @@ def __init__(self, **kwargs):
         """
         self.app_settings = AppSettings(**kwargs)
         self._objs, self._flowsheets = {}, {}
+        self.startup_time = time.time()
 
         # Add custom flowsheets path to the system path
         self.custom_flowsheets_path = Path.home() / ".watertap" / "custom_flowsheets"
@@ -202,7 +203,7 @@ def get_diagram(self, id_: str) -> bytes:
 
         data = b""
         info = self.get_info(id_)
-        # _log.info(f"inide get diagram:: info is - {info}")
+        # _log.info(f"inside get diagram:: info is - {info}")
         if info.custom:
             # do this
             data_path = (
@@ -531,7 +532,7 @@ def add_custom_flowsheets(self):
         for f in files:
             if "_ui.py" in f:
                 try:
-                    _log.info(f"attempting to add custom flowsheet module: {f}")
+                    _log.info(f"adding imported flowsheet module: {f}")
                     module_name = f.replace(".py", "")
                     custom_module = importlib.import_module(module_name)
                     fsi = self._get_flowsheet_interface(custom_module)
@@ -574,6 +575,9 @@ def set_number_of_subprocesses(self, value):
         )
         return value
 
+    def get_logs_path(self):
+        """Return logs path."""
+        return self.app_settings.log_dir
 
     @staticmethod
     def _get_flowsheet_interface(module: ModuleType) -> Optional[FlowsheetInterface]:

backend/app/internal/log_parser.py

@@ -0,0 +1,46 @@
+import time
+
+def parse_logs(logs_path, time_since):
+    """ 
+        Assume a log format of:
+        "[%(levelname)s] %(asctime)s %(name)s (%(filename)s:%(lineno)s): %(message)s"
+    """
+    result = []
+    log_entries = []
+    log_file = open(logs_path, 'r')
+    all_logs = log_file.read()
+    log_file.close()
+    logs = all_logs.split('\n[')
+    for line in logs:
+        try:
+            log_split = line.split(' ')
+            log_time = log_split[1:3]
+            log_time_string = f'{log_time[0]} {log_time[1]}'.split(',')[0]
+            stripped_time = time.strptime(log_time_string, "%Y-%m-%d %H:%M:%S")
+            asctime = time.mktime(stripped_time)
+            if asctime > time_since:
+                result.append(line)
+                log_level = line.split(']')[0]
+                log_name = log_split[3]
+                log_file_lineno = log_split[4]
+                log_file = log_file_lineno.split(":")[0]
+                log_lineno = log_file_lineno.split(":")[1]
+                log_message = line.split(log_file_lineno)[1]
+                if len(log_file) > 0:
+                    log_file = log_file[1:]
+                if len(log_lineno) > 0:
+                    log_lineno = log_lineno[:-1]
+                if len(log_message) > 0:
+                    log_message = log_message[1:]
+                log_entry = {
+                    "log_time": asctime,
+                    "log_level": log_level,
+                    "log_name": log_name,
+                    "log_file": log_file,
+                    "log_lineno": log_lineno,
+                    "log_message": log_message,
+                }
+                log_entries.append(log_entry)
+        except Exception as e:
+            print(f'unable to parse log line: {e}')
+    return log_entries

backend/app/internal/settings.py

@@ -31,7 +31,7 @@ def validate_log_dir(cls, v):
         v.mkdir(parents=True, exist_ok=True)
 
         loggingFormat = "[%(levelname)s] %(asctime)s %(name)s (%(filename)s:%(lineno)s): %(message)s"
-        loggingFileHandler = logging.handlers.RotatingFileHandler(v / "ui_backend_logs.log", backupCount=2, maxBytes=5000000)
+        loggingFileHandler = logging.handlers.RotatingFileHandler(v / "watertap-ui_backend_logs.log", backupCount=2, maxBytes=5000000)
         logging.basicConfig(level=logging.INFO, format=loggingFormat, handlers=[loggingFileHandler])
         return v
 

backend/app/routers/flowsheets.py

@@ -2,7 +2,6 @@
 Handle flowsheet-related API requests from web client.
 """
 # stdlib
-import csv
 import io
 import aiofiles
 from pathlib import Path
@@ -15,16 +14,19 @@
 import pandas as pd
 from pydantic import BaseModel
 from pydantic.error_wrappers import ValidationError
+import re
 
 # package-local
 from app.internal.flowsheet_manager import FlowsheetManager, FlowsheetInfo
 from app.internal.parameter_sweep import run_parameter_sweep
+from app.internal.log_parser import parse_logs
 from watertap.ui.fsapi import FlowsheetInterface, FlowsheetExport
 import idaes.logger as idaeslog
 
 CURRENT = "current"
 
 _log = idaeslog.getLogger(__name__)
+_solver_log = idaeslog.getLogger(__name__+'.solver')
 
 router = APIRouter(
     prefix="/flowsheets",
@@ -138,10 +140,12 @@ async def solve(flowsheet_id: str, request: Request):
 
     # run solve
     try:
-        flowsheet.solve()
+        with idaeslog.solver_log(_log, level=idaeslog.INFO) as slc:
+            flowsheet.solve()
         # set last run in tiny db
         flowsheet_manager.set_last_run(info.id_)
     except Exception as err:
+        _log.error(f"Solve failed: {err}")
         raise HTTPException(500, detail=f"Solve failed: {err}")
     return flowsheet.fs_exp
 
@@ -175,10 +179,11 @@ async def sweep(flowsheet_id: str, request: Request):
         info.updated(built=True)
 
     _log.info("trying to sweep")
-    results_table = run_parameter_sweep(
-        flowsheet=flowsheet,
-        info=info,
-    )
+    with idaeslog.solver_log(_log, level=idaeslog.INFO) as slc:
+        results_table = run_parameter_sweep(
+            flowsheet=flowsheet,
+            info=info,
+        )
     flowsheet.fs_exp.sweep_results = results_table
     # set last run in tiny db
     flowsheet_manager.set_last_run(info.id_)
@@ -276,11 +281,9 @@ async def upload_flowsheet(files: List[UploadFile]) -> str:
     try:
         # get file contents
         new_files = []
-
-        print("trying to read files with aiofiles")
         for file in files:
             # for file in files:
-            print(file.filename)
+            _log.info(f'reading {file.filename}')
             new_files.append(file.filename)
             if "_ui.py" in file.filename:
                 new_id = file.filename.replace(".py", "")
@@ -492,3 +495,22 @@ async def remove_flowsheet(request: Request):
     flowsheet_manager.set_number_of_subprocesses(new_value)
 
     return {"new_value": new_value}
+@router.get("/get_logs")
+async def get_logs() -> List[str]:
+    """Get backend logs.
+
+    Returns:
+        Logs formatted as a list
+    """
+    logs_path = flowsheet_manager.get_logs_path() / "watertap-ui_backend_logs.log"
+    return parse_logs(logs_path, flowsheet_manager.startup_time)
+
+@router.post("/download_logs", response_class=FileResponse)
+async def download_logs() -> Path:
+    """Download full backend logs.
+
+    Returns:
+        Log file
+    """
+    logs_path = flowsheet_manager.get_logs_path() / "watertap-ui_backend_logs.log"
+    return logs_path

electron/ui/package.json

@@ -23,6 +23,7 @@
     "react": "^18.1.0",
     "react-dom": "^18.1.0",
     "react-drag-drop-files": "^2.3.10",
+    "react-draggable": "^4.4.6",
     "react-plotly.js": "^2.6.0",
     "react-plotlyjs": "^0.4.4",
     "react-router-dom": "^6.3.0",

electron/ui/public/main.js

@@ -17,8 +17,16 @@ let uiReady = false
 const serverURL = `http://localhost:${PY_PORT}`
 const uiURL = `http://localhost:${UI_PORT}`
 
-log.transports.file.resolvePath = () => path.join(__dirname, '/logsmain.log');
+if(isDev) {
+  log.transports.file.resolvePath = () => path.join(__dirname, '/logsdev.log');
+} else {
+  log.transports.file.resolvePath = () => path.join(__dirname, '/logsmain.log');
+}
+
 log.transports.file.level = "info";
+// log.transports.console.format = '{h}:{i}:{s} {text}'
+log.transports.console.format = '{text}'
+log.transports.file.format = '{text}'
 
 exports.log = (entry) => log.info(entry)
 
@@ -62,6 +70,7 @@ function createWindow() {
   } 
 
   console.log("storing user preferences in: ",app.getPath('userData'));
+  log.info("storing user preferences in: ",app.getPath('userData'))
 
   // save size of window when resized
   win.on("resized", () => saveBounds(win.getSize()));
@@ -85,22 +94,20 @@ const installExtensions = () => {
       ]
     );
 
-  log.info("installation started");
-  console.log("installation started");
+  log.info("installing idaes extensions");
+  console.log("installing idaes extensions");
 
     var scriptOutput = "";
     installationProcess.stdout.setEncoding('utf8');
     installationProcess.stdout.on('data', function(data) {
-        // console.log('stdout: ' + data);
-        log.info('stdout: ' + data);
+        log.info(data);
         data=data.toString();
         scriptOutput+=data;
     });
 
     installationProcess.stderr.setEncoding('utf8');
     installationProcess.stderr.on('data', function(data) {
-        // console.log('stderr: ' + data);
-        log.info('stderr: ' + data);
+        log.info(data);
         data=data.toString();
         scriptOutput+=data;
     });
@@ -124,7 +131,7 @@ const startServer = () => {
         {
             cwd: '../backend/app'
         }
-    );
+      );
       // log.info("Python process started in dev mode");
       // console.log("Python process started in dev mode");
     } else {
@@ -139,15 +146,15 @@ const startServer = () => {
         backendProcess.stdout.setEncoding('utf8');
         backendProcess.stdout.on('data', function(data) {
             console.log('stdout: ' + data);
-            log.info('stdout: ' + data);
+            log.info(data);
             data=data.toString();
             scriptOutput+=data;
         });
 
         backendProcess.stderr.setEncoding('utf8');
         backendProcess.stderr.on('data', function(data) {
             console.log('stderr: ' + data);
-            log.info('stderr: ' + data);
+            log.info(data);
             data=data.toString();
             scriptOutput+=data;
         });
@@ -176,8 +183,8 @@ app.whenReady().then(() => {
       let serverProcess
       let installationProcess = installExtensions()
       installationProcess.on('exit', code => {
-        log.info('installation exit code is', code)
-        console.log('installation exit code is', code)
+        // log.info('installation exit code is', code)
+        // console.log('installation exit code is', code)
         log.info('starting server')
         console.log('starting server')
         serverProcess = startServer()

electron/ui/src/components/Boilerplate/Header/Header.js

@@ -1,14 +1,31 @@
 import './Header.css';
 import React from 'react';
 import logo from "../../../assets/nawi-logo-color.png";
+import LoggingPanel from '../../LoggingPanel/LoggingPanel';
 import { useNavigate } from "react-router-dom";
-import Button from '@mui/material/Button';
-
+import { Button, Menu, MenuItem, IconButton } from '@mui/material';
+import ListIcon from '@mui/icons-material/List';
+
 export default function Header(props) {
   let navigate = useNavigate();
+  const [ showLogs, setShowLogs ] = React.useState(false)
+  const [ actionsList, setActionsList ] = React.useState(false)
+  const [ anchorEl, setAnchorEl ] = React.useState(null);
+
   const handleNavigateHome = () => {
+      // setActionsList(!actionsList)
       navigate("/flowsheets", {replace: true})
   }
+
+  const handleShowLogs = () => {
+    setShowLogs(!showLogs)
+    setActionsList(false)
+  }
+
+  const handleShowActions = (event) => {
+    setActionsList(!actionsList)
+    setAnchorEl(event.currentTarget);
+  }
     return (
       props.show && 
       <div id="Header">
@@ -20,11 +37,20 @@ export default function Header(props) {
         <div id="titlebar-name">
           WaterTAP
         </div>
-        <div  className="right" > 
-        <Button style={{ color:"white" }} onClick={handleNavigateHome}>Return to list page</Button>
+        <div  className="right" >
+        <IconButton style={{ color:"white" }} onClick={handleShowActions}><ListIcon/></IconButton>
+        <Menu
+          id="actions-list"
+          anchorEl={anchorEl}
+          open={actionsList}
+          onClose={() => setActionsList(false)}
+        >
+          <MenuItem onClick={handleShowLogs}>View Logs</MenuItem>
+          <MenuItem onClick={handleNavigateHome}>Return to list page</MenuItem>
+        </Menu>
         </div>
       </div> 
-
+       <LoggingPanel open={showLogs} onClose={handleShowLogs}/>
       </div>
     );
 }