Changeset 5406

Timestamp:

Sep 13, 2010, 12:36:49 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

References #1509: Job queue order after restarting a job

Added a 'scheduled' property to jobs that is used to order the job queue.

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (3 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/InternalJobQueue.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Job.java (modified) (9 diffs)
• src/core/net/sf/basedb/core/JobAgent.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/PluginExecutionRequest.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/data/JobData.java (modified) (1 diff)
• src/core/net/sf/basedb/core/signal/DelegatingSignalHandler.java (modified) (6 diffs)
• www/views/jobs/index.jsp (modified) (1 diff)
• www/views/jobs/list_jobs.jsp (modified) (2 diffs)
• www/views/jobs/view_job.jsp (modified) (1 diff)

trunk/src/core/common-queries.xml

@@ -1556 +1556 @@
       AND job.type = :type
       AND job.removed = false
-      ORDER BY job.priority ASC, job.created ASC
+      ORDER BY job.priority ASC, job.scheduled ASC
     </sql>
     <description>
       A Hibernate query that loads plugin jobs in the job queue waiting to be
-      executed sorted by priority and waiting type. The query should return all
+      executed sorted by priority and waiting time. The query should return all
       jobs, ignoring all settings specifying that the internal job queue should
       not be used.
@@ -1575 +1575 @@
       AND job.pluginDefinition.useInternalJobQueue = true
       AND job.jobAgentId IS NULL
-      ORDER BY job.priority ASC, job.created ASC
+      ORDER BY job.priority ASC, job.scheduled ASC
     </sql>
     <description>
@@ -3873 +3873 @@
   </query>
 
+  <query id="SET_SCHEDULED_FOR_JOBS" type="HQL">
+    <sql>
+      UPDATE JobData job
+      SET job.scheduled = job.created
+      WHERE job.status > 1 AND job.scheduled IS NULL
+    </sql>
+    <description>
+      An HQL update-query that sets the scheduled date 
+      to the creation date for existing jobs that have been
+      scheduled and doesn't have a scheduled date.
+    </description>
+  </query>
+
+
 </predefined-queries>

trunk/src/core/net/sf/basedb/core/Install.java

@@ -115 +115 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(83).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(84).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

trunk/src/core/net/sf/basedb/core/InternalJobQueue.java

@@ -317 +317 @@
         [AND job.pluginDefinition.useInternalJobQueue = true]
         [AND job.jobAgentId IS NULL]
-        ORDER BY job.priority ASC, job.created ASC
+        ORDER BY job.priority ASC, job.scheduled ASC
       */
       query.setInteger("status", Job.Status.WAITING.getValue());

trunk/src/core/net/sf/basedb/core/Job.java

@@ -353 +353 @@
       getData().setActiveProjectId(projectId);
     }
+    if (action == Action.CREATE && getStatus() == Status.WAITING)
+    {
+      getData().setScheduled(new Date());
+    }
   }
   
@@ -673 +677 @@
   }
 
+  /**
+    Get the date and time the job was scheduled to the job queue.
+    @return A date, or null if the job hasn't been scheduled
+    @since 2.16
+  */
+  public Date getScheduled()
+  {
+    return DateUtil.copy(getData().getScheduled());
+  }
+  
   /**
     Get the date and time the job was started.
@@ -1093 +1107 @@
     data.setStatus(Job.Status.WAITING.getValue());
     data.setPercentComplete(0);
+    data.setScheduled(new Date());
     data.setStarted(null);
     data.setEnded(null);
@@ -1124 +1139 @@
       job is started, if not given {@link Request#COMMAND_EXECUTE}
       is used
+    @param isShuttingDown TRUE if the system is currently shutting down
+      (which means that the 'scheduled' data is not reset to allow the
+      job to be started first once the system is up and running)
     @since 2.16
   */
-  void continueLater(String executeCommand)
+  void continueLater(String executeCommand, boolean isShuttingDown)
   {
     JobData data = getData();
     data.setStatus(Job.Status.WAITING.getValue());
     data.setPercentComplete(0);
+    if (!isShuttingDown)  data.setScheduled(new Date());
     data.setStarted(null);
     data.setEnded(null);
@@ -1366 +1385 @@
     }
     getData().setStatus(Status.WAITING.getValue());
+    getData().setScheduled(new Date());
     setParameterValuesInternal(name, label, description, parameterType, Arrays.asList(value), true);
   }
@@ -1417 +1437 @@
     }
     getData().setStatus(Status.WAITING.getValue());
+    getData().setScheduled(new Date());
     setParameterValuesInternal(name, label, description, parameterType, values, true);
   }
@@ -1684 +1705 @@
       JobData data = job.getData();
       data.setStatus(Job.Status.WAITING.getValue());
+      data.setScheduled(new Date());
       data.setPercentComplete(0);
       data.setStarted(null);
@@ -1719 +1741 @@
     }
     
-    void setEnded(PluginResponse response)
+    void setEnded(PluginResponse response, boolean isShuttingDown)
     {
       DbControl dc = null;
@@ -1735 +1757 @@
         {
           // The job will be continue again when the system restarts
-          job.continueLater(response.getNextCommand());
+          job.continueLater(response.getNextCommand(), isShuttingDown);
         }
         else

trunk/src/core/net/sf/basedb/core/JobAgent.java

@@ -390 +390 @@
       AND job.status = Job.Status.WAITING
       AND job.jobAgentId IS NULL OR job.jobAgentId = this.id
-      ORDER BY job.priority - jas.priorityBoost ASC, job.created ASC
+      ORDER BY job.priority - jas.priorityBoost ASC, job.scheduled ASC
     */
     
@@ -512 +512 @@
     
     // Order by the waiting time
-    query.order(Orders.asc(Hql.property("created")));
+    query.order(Orders.asc(Hql.property("scheduled")));
     
     return query;

trunk/src/core/net/sf/basedb/core/PluginExecutionRequest.java

@@ -27 +27 @@
 import net.sf.basedb.core.plugin.Request;
 import net.sf.basedb.core.plugin.Response;
+import net.sf.basedb.core.signal.DelegatingSignalHandler;
+import net.sf.basedb.core.signal.Signal;
 import net.sf.basedb.core.signal.SignalHandler;
 import net.sf.basedb.core.signal.SignalReceiver;
@@ -88 +90 @@
     Request request = new RequestImpl(false);
     Response response = pluginResponse.getResponseImpl();
-    SignalHandler signalHandler = null;
+    DelegatingSignalHandler signalHandler = null;
+    boolean isShutdown = false;
     Pinger pinger = null;
     try
@@ -98 +101 @@
       {
         // Register a signal handler, receiver and transporter
-        signalHandler = ((SignalTarget)plugin).getSignalHandler();
-        if (signalReceiver != null && signalHandler != null)
+        // We wrap the signal handler in a DelegatingSignalHandler
+        // since we need to know if the SHUTDOWN signal has been sent
+        SignalHandler sh = ((SignalTarget)plugin).getSignalHandler();
+        if (signalReceiver != null && sh != null)
         {
+          signalHandler = new DelegatingSignalHandler(sh);
           signalId = signalReceiver.registerSignalHandler(signalHandler);
           signalTransporter = signalReceiver.getSignalTransporterClass();
@@ -123 +129 @@
     }
     done();
-    if (progress != null) progress.setEnded(pluginResponse);
+    if (progress != null) progress.setEnded(pluginResponse, signalHandler.hasReceived(Signal.SHUTDOWN));
     return pluginResponse;
   }

trunk/src/core/net/sf/basedb/core/Update.java

@@ -908 +908 @@
     </td>
   </tr>
+  <tr>
+    <td>84</td>
+    <td>
+      Added {@link JobData#getScheduled()}. The update will set the scheduled
+      date to the creation date for all existing jobs that is in WAITING status
+      or higher.
+    </td>
+  </tr>
   </table>
 
@@ -1238 +1246 @@
         schemaVersion = setSchemaVersionInTransaction(session, 83);
       }
-    
+
+      if (schemaVersion < 84)
+      {
+        if (progress != null) progress.display((int)(83*progress_factor), 
+            "--Updating schema version: " + schemaVersion + " -> 84...");
+        schemaVersion = updateToSchemaVersion84(session);
+      }
+
       sc.logout();
       if (progress != null) progress.display(100, "Database updated successfully.");
@@ -2865 +2880 @@
       if (tx != null) HibernateUtil.rollback(tx); 
       log.error("updateToSchemaVersion80: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;
+  }
+
+  /**
+    Set the scheduled data for existing jobs.
+  */
+  private static int updateToSchemaVersion84(org.hibernate.Session session)
+    throws BaseException
+  {
+    final int schemaVersion = 84;
+    org.hibernate.Transaction tx = null;
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+      
+      // Load and execute the query
+      org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, "SET_SCHEDULED_FOR_JOBS");
+      /*
+        UPDATE JobData job
+        SET job.scheduled = job.created
+        WHERE job.status > WAITING (=1) AND job.scheduled IS NULL
+      */
+      query.executeUpdate();
+      
+      // Update the schema version number
+      setSchemaVersion(session, schemaVersion);
+  
+      // Commit the changes
+      HibernateUtil.commit(tx);
+      log.info("updateToSchemaVersion84: OK");
+    }
+    catch (BaseException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("updateToSchemaVersion84: FAILED", ex);
       throw ex;
     }

trunk/src/core/net/sf/basedb/core/data/JobData.java

@@ -371 +371 @@
   }
 
+  private Date scheduled;
+  /**
+    Get the date and time the job was scheduled to the job queue, or null
+    if it hasn't been scheduled yet. This timestamp should be updated whenever
+    the status is changed to WAITING.
+    @hibernate.property column="`scheduled`" type="timestamp" not-null="false"
+    @since 2.16
+  */
+  public Date getScheduled()
+  {
+    return scheduled;
+  }
+  public void setScheduled(Date scheduled)
+  {
+    this.scheduled = scheduled;
+  }
+  
   private Date started;
   /**

trunk/src/core/net/sf/basedb/core/signal/DelegatingSignalHandler.java

@@ -22 +22 @@
 package net.sf.basedb.core.signal;
 
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -27 +28 @@
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -53 +55 @@
   */
   private Map<Signal, Set<SignalHandler>> handlers;
+
+  /**
+    List holding received signals.
+    @since 2.16
+  */
+  private final List<Signal> received;
   
   /**
@@ -63 +71 @@
     super();
     handlers = new HashMap<Signal, Set<SignalHandler>>();
+    received = Collections.synchronizedList(new ArrayList<Signal>());
+  }
+  
+  /**
+    Create a new delegating signal handler and register the
+    given handlers as delegates.
+    @param handlers An array with signal handlers that signal should
+      be delegated to
+    @since 2.16
+  */
+  public DelegatingSignalHandler(SignalHandler... handlers)
+  {
+    this();
+    for (SignalHandler sh : handlers)
+    {
+      registerSignalHandler(sh);
+    }
   }
   
@@ -104 +129 @@
       throw new UnsupportedSignalException(signal);
     }
+    received.add(signal);
     for (SignalHandler handler : all)
     {
@@ -153 +179 @@
   }
 
+  /**
+    Check if any signals has been received by this handler.
+    @return TRUE if at least one signal has been received, FALSE otherwise
+    @since 2.16
+  */
+  public boolean hasReceivedSignals()
+  {
+    return received.size() > 0;
+  }
+  
+  /**
+    Get the list of received signals. Calling this method clears the internal
+    list and if no signals are received in the meantime, the next call to
+    this method will return null.
+    @return A list with signals in the order they were
+      received, or null if no signals has been received
+    @since 2.16
+  */
+  public List<Signal> getReceivedSignals()
+  {
+    List<Signal> toReturn = null;
+    if (received.size() > 0)
+    {
+      toReturn = new ArrayList<Signal>(received);
+      received.clear();
+    }
+    return toReturn;
+  }
+  
+  /**
+    Check if the given signal has been received by this signal handler.
+    @param signal The signal to check for
+    @return TRUE if the signal has been received, FALSE otherwise
+    @since 2.16
+  */
+  public boolean hasReceived(Signal signal)
+  {
+    return received.contains(signal);
+  }
+
+  
 }

trunk/www/views/jobs/index.jsp

@@ -56 +56 @@
 <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
 <%!
-  private static final ItemContext defaultContext = Base.createDefaultContext("name", "name,pluginType,percentComplete,status,statusMessage,description");
+  private static final ItemContext defaultContext = Base.createDefaultContext("scheduled", "name,pluginType,scheduled,percentComplete,status,statusMessage,description");
+  {
+    defaultContext.setSortDirection(ItemContext.SortDirection.DESC);
+  }
   private static final Item itemType = Item.JOB;
 %>

trunk/www/views/jobs/list_jobs.jsp

@@ -345 +345 @@
         datatype="date" 
         title="Created" 
+        sortable="true" 
+        filterable="true" 
+        exportable="true"
+        formatter="<%=dateTimeFormatter%>"
+      />
+      <tbl:columndef 
+        id="scheduled" 
+        property="scheduled"
+        datatype="date" 
+        title="Scheduled" 
         sortable="true" 
         filterable="true" 
@@ -644 +654 @@
                 </tbl:cell>
                 <tbl:cell column="created" value="<%=item.getCreated()%>" />
+                <tbl:cell column="scheduled" value="<%=item.getScheduled()%>" />
                 <tbl:cell column="started" value="<%=item.getStarted()%>" />
                 <tbl:cell column="ended" value="<%=item.getEnded()%>" />

trunk/www/views/jobs/view_job.jsp

@@ -378 +378 @@
         <td>
           <%=dateTimeFormatter.format(job.getCreated())%>
+        </td>
+      </tr>
+      <tr valign="top">
+        <td class="prompt">Scheduled</td>
+        <td>
+          <%=dateTimeFormatter.format(job.getScheduled())%>
         </td>
       </tr>