pkp/pkp-lib#7105 Job processing via cron and worker with new configs and cypress test update

Author: touhidurabir

Jobs/Statistics/CompileUsageStatsFromTemporaryRecords.php

@@ -64,16 +64,16 @@ public function handle(): void
             } else {
                 $message = __('usageStats.compileMetrics.error', ['filename' => $filename]);
             }
-            $this->failed(new JobException($message));
-            return;
+            
+            throw new JobException($message);
         }
 
-        $temporaryTotalsDao = DAORegistry::getDAO('TemporaryTotalsDAO'); /* @var TemporaryTotalsDAO $temporaryTotalsDao */
-        $temporaryItemInvestigationsDao = DAORegistry::getDAO('TemporaryItemInvestigationsDAO'); /* @var TemporaryItemInvestigationsDAO $temporaryItemInvestigationsDao */
-        $temporaryItemRequestsDao = DAORegistry::getDAO('TemporaryItemRequestsDAO'); /* @var TemporaryItemRequestsDAO $temporaryItemRequestsDao */
-        $temporaryTitleInvestigationsDao = DAORegistry::getDAO('TemporaryTitleInvestigationsDAO'); /* @var TemporaryTitleInvestigationsDAO $temporaryTitleInvestigationsDao */
-        $temporaryTitleRequestsDao = DAORegistry::getDAO('TemporaryTitleRequestsDAO'); /* @var TemporaryTitleRequestsDAO $temporaryTitleRequestsDao */
-        $temporaryInstitutionDao = DAORegistry::getDAO('TemporaryInstitutionsDAO'); /* @var TemporaryInstitutionsDAO $temporaryInstitutionDao */
+        $temporaryTotalsDao = DAORegistry::getDAO('TemporaryTotalsDAO'); /** @var TemporaryTotalsDAO $temporaryTotalsDao */
+        $temporaryItemInvestigationsDao = DAORegistry::getDAO('TemporaryItemInvestigationsDAO'); /** @var TemporaryItemInvestigationsDAO $temporaryItemInvestigationsDao */
+        $temporaryItemRequestsDao = DAORegistry::getDAO('TemporaryItemRequestsDAO'); /** @var TemporaryItemRequestsDAO $temporaryItemRequestsDao */
+        $temporaryTitleInvestigationsDao = DAORegistry::getDAO('TemporaryTitleInvestigationsDAO'); /** @var TemporaryTitleInvestigationsDAO $temporaryTitleInvestigationsDao */
+        $temporaryTitleRequestsDao = DAORegistry::getDAO('TemporaryTitleRequestsDAO'); /** @var TemporaryTitleRequestsDAO $temporaryTitleRequestsDao */
+        $temporaryInstitutionDao = DAORegistry::getDAO('TemporaryInstitutionsDAO'); /** @var TemporaryInstitutionsDAO $temporaryInstitutionDao */
 
         $temporaryTotalsDao->deleteByLoadId($this->loadId);
         $temporaryItemInvestigationsDao->deleteByLoadId($this->loadId);
@@ -89,11 +89,11 @@ public function handle(): void
      */
     protected function compileMetrics(): bool
     {
-        $temporaryTotalsDao = DAORegistry::getDAO('TemporaryTotalsDAO'); /* @var TemporaryTotalsDAO $temporaryTotalsDao */
-        $temporaryItemInvestigationsDao = DAORegistry::getDAO('TemporaryItemInvestigationsDAO'); /* @var TemporaryItemInvestigationsDAO $temporaryItemInvestigationsDao */
-        $temporaryItemRequestsDao = DAORegistry::getDAO('TemporaryItemRequestsDAO'); /* @var TemporaryItemRequestsDAO $temporaryItemRequestsDao */
-        $temporaryTitleInvestigationsDao = DAORegistry::getDAO('TemporaryTitleInvestigationsDAO'); /* @var TemporaryTitleInvestigationsDAO $temporaryTitleInvestigationsDao */
-        $temporaryTitleRequestsDao = DAORegistry::getDAO('TemporaryTitleRequestsDAO'); /* @var TemporaryTitleRequestsDAO $temporaryTitleRequestsDao */
+        $temporaryTotalsDao = DAORegistry::getDAO('TemporaryTotalsDAO'); /** @var TemporaryTotalsDAO $temporaryTotalsDao */
+        $temporaryItemInvestigationsDao = DAORegistry::getDAO('TemporaryItemInvestigationsDAO'); /** @var TemporaryItemInvestigationsDAO $temporaryItemInvestigationsDao */
+        $temporaryItemRequestsDao = DAORegistry::getDAO('TemporaryItemRequestsDAO'); /** @var TemporaryItemRequestsDAO $temporaryItemRequestsDao */
+        $temporaryTitleInvestigationsDao = DAORegistry::getDAO('TemporaryTitleInvestigationsDAO'); /** @var TemporaryTitleInvestigationsDAO $temporaryTitleInvestigationsDao */
+        $temporaryTitleRequestsDao = DAORegistry::getDAO('TemporaryTitleRequestsDAO'); /** @var TemporaryTitleRequestsDAO $temporaryTitleRequestsDao */
 
         $temporaryTotalsDao->removeDoubleClicks(StatisticsHelper::COUNTER_DOUBLE_CLICK_TIME_FILTER_SECONDS);
         $temporaryItemInvestigationsDao->compileBookItemUniqueClicks();

config.TEMPLATE.inc.php

@@ -560,8 +560,43 @@
 ; Default queue to use when a job is added to the queue
 default_queue = "queue"
 
-; Do not run jobs on shutdown
-; By default, jobs in the queue will be run during PHP's shutdown
-; function. Disable this if you want to run jobs through a separate
-; cron job or workers.
-disable_jobs_run_at_shutdown = Off
+; Whether or not to turn on the built-in job runner
+;
+; When enabled, jobs will be processed at the end of each web
+; request to the application.
+;
+; Use of the built-in job runner is highly discouraged for high-volume 
+; sites. Instead, a worker daemon or cron job should be configured
+; to process jobs off the application's main thread.
+;
+; See: <link-to-documentation>
+;
+job_runner = On
+
+; The maximum number of jobs to run in a single request when using
+; the built-in job runner.
+job_runner_max_jobs = 30
+
+; The maximum number of seconds the built-in job runner should spend
+; running jobs in a single request.
+;
+; This should be less than the max_execution_time the server has 
+; configured for PHP.
+;
+; Lower this setting if jobs are failing due to timeouts.
+job_runner_max_execution_time = 30
+
+; The maximum consumerable memory that should be spent by the built-in
+; job runner when running jobs.
+;
+; Set as a percentage, such as 80%: 
+;
+; job_runner_max_memory = 80
+;
+; Or set as a fixed value in megabytes:
+; 
+; job_runner_max_memory = 128M
+;
+; When setting a fixed value in megabytes, this should be less than the
+; memory_limit the server has configured for PHP.
+job_runner_max_memory = 80

cypress/support/index.js

@@ -20,18 +20,14 @@ import '@foreachbe/cypress-tinymce'
 
 require('cypress-failed-log')
 
-// See https://stackoverflow.com/questions/58657895/is-there-a-reliable-way-to-have-cypress-exit-as-soon-as-a-test-fails/58660504#58660504
-function abortEarly() {
-	if (this.currentTest.state === 'failed') {
-		return cy.task('shouldSkip', true);
-	}
-	cy.task('shouldSkip').then(value => {
-		if (value) this.skip();
-	});
-}
+beforeEach(function() {
+	cy.abortEarly(this);
+});
 
-beforeEach(abortEarly);
-afterEach(abortEarly);
+afterEach(function() {
+	cy.abortEarly(this);
+	cy.runQueueJobs();
+});
 
 before(() => {
 	if (Cypress.browser.isHeaded) {

registry/scheduledTasks.xml

@@ -54,4 +54,8 @@
 		<descr>Send a monthly reminder email to editors about their outstanding tasks</descr>
 		<frequency day="1"/>
 	</task>
+	<task class="PKP\task\ProcessQueueJobs">
+		<descr>Process pending queue jobs in the default queue driver and queue</descr>
+		<frequency second="0"/>
+	</task>
 </scheduled_tasks>