ENH: Refactor and clean up manual retry infrastructure

ENH: Add job status logging to the detail logging window ENH: Enable thumbnail generation in worker processes BUG: Fix missing update of server settings UI BUG: Add missing Python wrapping methods for ctkJobDetail ENH: Enhance job logging for better traceability PERF: Optimize UI updates by directly calling component slots ENH: Clean servers API calls PERF: Improve queue jobs performances by cleaning mutex use ENH: Improve inserter jobs log report Co-authored-by: Andras Lasso <[email protected]>
commontk · Sep 9, 2024 · 47db447 · 47db447
1 parent 6292d09
commit 47db447
Show file tree

Hide file tree

Showing 63 changed files with 2,856 additions and 1,313 deletions.
diff --git a/Libs/Core/ctkAbstractJob.cpp b/Libs/Core/ctkAbstractJob.cpp
@@ -38,6 +38,7 @@ ctkAbstractJob::ctkAbstractJob()
   this->MaximumConcurrentJobsPerType = 20;
   this->Priority = QThread::Priority::LowPriority;
   this->CreationDateTime = QDateTime::currentDateTime();
+  this->DestroyAfterUse = false;
 }
 
 //----------------------------------------------------------------------------
@@ -212,20 +213,27 @@ void ctkAbstractJob::setRunningThreadID(QString runningThreadID)
 }
 
 //----------------------------------------------------------------------------
-QString ctkAbstractJob::loggedText() const
+QString ctkAbstractJob::log() const
 {
-  return this->LoggedText;
+  return this->Log;
 }
 
 //----------------------------------------------------------------------------
-void ctkAbstractJob::setLoggedText(QString loggedText)
+void ctkAbstractJob::addLog(QString log)
 {
-  if (loggedText.isEmpty())
-  {
-    return;
-  }
+  this->Log += log;
+}
 
-  this->LoggedText += loggedText;
+//----------------------------------------------------------------------------
+bool ctkAbstractJob::destroyAfterUse() const
+{
+  return this->DestroyAfterUse;
+}
+
+//----------------------------------------------------------------------------
+void ctkAbstractJob::setDestroyAfterUse(bool destroyAfterUse)
+{
+  this->DestroyAfterUse = destroyAfterUse;
 }
 
 //----------------------------------------------------------------------------

diff --git a/Libs/Core/ctkAbstractJob.h b/Libs/Core/ctkAbstractJob.h
@@ -55,7 +55,8 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   Q_PROPERTY(QDateTime startDateTime READ startDateTime);
   Q_PROPERTY(QDateTime completionDateTime READ completionDateTime);
   Q_PROPERTY(QString runningThreadID READ runningThreadID WRITE setRunningThreadID);
-  Q_PROPERTY(QString loggedText READ loggedText WRITE setLoggedText);
+  Q_PROPERTY(QString log READ log);
+  Q_PROPERTY(bool destroyAfterUse READ destroyAfterUse WRITE setDestroyAfterUse);
 
 public:
   explicit ctkAbstractJob();
@@ -157,8 +158,8 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
 
   ///@{
   /// Logged Text
-  QString loggedText() const;
-  void setLoggedText(QString loggedText);
+  QString log() const;
+  void addLog(QString log);
   ///@}
 
   /// Generate worker for job
@@ -168,7 +169,7 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   Q_INVOKABLE virtual ctkAbstractJob* clone() const = 0;
 
   /// Logger report string formatting for specific job
-  Q_INVOKABLE virtual QString loggerReport(const QString& status) const = 0;
+  Q_INVOKABLE virtual QString loggerReport(const QString& status) = 0;
 
   /// Return the QVariant value of this job.
   ///
@@ -177,6 +178,16 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   /// \sa ctkJobDetail
   Q_INVOKABLE virtual QVariant toVariant();
 
+  /// Free used resources from job after worker is done
+  Q_INVOKABLE virtual void releaseResources() = 0;
+
+  ///@{
+  /// Destroy job object after worker is done
+  /// default: false
+  bool destroyAfterUse() const;
+  void setDestroyAfterUse(bool destroyAfterUse);
+  ///@}
+
 Q_SIGNALS:
   void started();
   void userStopped();
@@ -197,7 +208,8 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   QDateTime StartDateTime;
   QDateTime CompletionDateTime;
   QString RunningThreadID;
-  QString LoggedText;
+  QString Log;
+  bool DestroyAfterUse;
 
 private:
   Q_DISABLE_COPY(ctkAbstractJob)
@@ -215,7 +227,7 @@ struct CTK_CORE_EXPORT ctkJobDetail {
     this->StartDateTime = job.startDateTime().toString("HH:mm:ss.zzz ddd dd MMM yyyy");
     this->CompletionDateTime = job.completionDateTime().toString("HH:mm:ss.zzz ddd dd MMM yyyy");
     this->RunningThreadID = job.runningThreadID();
-    this->Logging = job.loggedText();
+    this->Logging = job.log();
   }
   virtual ~ctkJobDetail() = default;
 

diff --git a/Libs/Core/ctkCorePythonQtDecorators.h b/Libs/Core/ctkCorePythonQtDecorators.h
@@ -27,8 +27,9 @@
 // CTK includes
 #include <ctkAbstractJob.h> // For ctkJobDetail
 #include <ctkBooleanMapper.h>
-#include <ctkUtils.h>
 #include <ctkErrorLogContext.h>
+#include <ctkLogger.h>
+#include <ctkUtils.h>
 #include <ctkWorkflowStep.h>
 #include <ctkWorkflowTransitions.h>
 
@@ -39,6 +40,8 @@
 // for non-static methods.
 //
 
+static ctkLogger logger("org.commontk.core.ctkCorePythonQtDecorators");
+
 /// \ingroup Core
 class ctkCorePythonQtDecorators : public QObject
 {
@@ -245,21 +248,149 @@ public Q_SLOTS:
 
   void setJobClass(ctkJobDetail* td, const QString& jobClass)
   {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setJobClass - Invalid ctkJobDetail");
+      return;
+    }
+
     td->JobClass = jobClass;
   }
   QString jobClass(ctkJobDetail* td)
   {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::jobClass - Invalid ctkJobDetail");
+      return "";
+    }
+
     return td->JobClass;
   }
 
   void setJobUID(ctkJobDetail* td, const QString& jobUID)
   {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setJobUID - Invalid ctkJobDetail");
+      return;
+    }
+
     td->JobUID = jobUID;
   }
   QString JobUID(ctkJobDetail* td)
   {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::JobUID - Invalid ctkJobDetail");
+      return "";
+    }
+
     return td->JobUID;
   }
+
+  void setCreationDateTime(ctkJobDetail* td, QString creationDateTime)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setCreationDateTime - Invalid ctkJobDetail");
+      return;
+    }
+
+    td->CreationDateTime = creationDateTime;
+  }
+  QString creationDateTime(ctkJobDetail* td)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::creationDateTime - Invalid ctkJobDetail");
+      return "";
+    }
+
+    return td->CreationDateTime;
+  }
+
+  void setStartDateTime(ctkJobDetail* td, QString startDateTime)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setStartDateTime - Invalid ctkJobDetail");
+      return;
+    }
+
+    td->StartDateTime = startDateTime;
+  }
+  QString startDateTime(ctkJobDetail* td)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::startDateTime - Invalid ctkJobDetail");
+      return "";
+    }
+
+    return td->StartDateTime;
+  }
+
+  void setCompletionDateTime(ctkJobDetail* td, QString completionDateTime)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setCompletionDateTime - Invalid ctkJobDetail");
+      return;
+    }
+
+    td->CompletionDateTime = completionDateTime;
+  }
+  QString completionDateTime(ctkJobDetail* td)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::completionDateTime - Invalid ctkJobDetail");
+      return "";
+    }
+
+    return td->CompletionDateTime;
+  }
+
+  void setRunningThreadID(ctkJobDetail* td, QString runningThreadID)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setRunningThreadID - Invalid ctkJobDetail");
+      return;
+    }
+
+    td->RunningThreadID = runningThreadID;
+  }
+  QString runningThreadID(ctkJobDetail* td)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::runningThreadID - Invalid ctkJobDetail");
+      return "";
+    }
+
+    return td->RunningThreadID;
+  }
+
+  void setLogging(ctkJobDetail* td, QString logging)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::setLogging - Invalid ctkJobDetail");
+      return;
+    }
+    td->Logging = logging;
+  }
+  QString logging(ctkJobDetail* td)
+  {
+    if (td == nullptr)
+    {
+      logger.error("ctkJobDetail::logging - Invalid ctkJobDetail");
+      return "";
+    }
+
+    return td->Logging;
+  }
 };
 
 //-----------------------------------------------------------------------------