Merge pull request #31 from KnpLabs/fix/add-job-timeout-configuration

Add job timeout configuration

.env.dist

@@ -3,6 +3,7 @@ LOG_LEVEL=DEBUG
 
 # Queue configurations
 QUEUE_REDIS_DSN=redis://redis:6379
+QUEUE_JOB_TIMEOUT=30000
 
 # Manager configurations
 MANAGER_ENABLED=1

src/configuration.js

@@ -76,6 +76,9 @@ const generate = () => ({
   },
   queue: {
     redis_dsn: process.env.QUEUE_REDIS_DSN,
+    job: {
+      timeout: Number(process.env.QUEUE_JOB_TIMEOUT ?? 30000),
+    },
   },
   manager: {
     enabled: 1 === Number(process.env.MANAGER_ENABLED ?? 1),

src/configuration.test.js

@@ -28,6 +28,9 @@ describe('configuration :: createConfiguration', () => {
       },
       queue: {
         redis_dsn: 'redis://redis:6379',
+        job: {
+          timeout: 30000,
+        },
       },
       worker: {
         enabled: true,
@@ -61,6 +64,9 @@ describe('configuration :: createConfiguration', () => {
       },
       queue: {
         redis_dsn: 'redis://redis:6379',
+        job: {
+          timeout: 30000,
+        },
       },
       worker: {
         enabled: true,
@@ -94,6 +100,9 @@ describe('configuration :: createConfiguration', () => {
       },
       queue: {
         redis_dsn: 'redis://redis:6379',
+        job: {
+          timeout: 30000,
+        },
       },
       worker: {
         enabled: false,
@@ -113,6 +122,7 @@ describe('configuration :: createConfiguration', () => {
   it(`creates a configuration`, () => {
     process.env.LOG_LEVEL = 'ERROR'
     process.env.QUEUE_REDIS_DSN = 'redis://redis:6379'
+    process.env.QUEUE_JOB_TIMEOUT = 5000
     process.env.MANAGER_ENABLED = 1
     process.env.MANAGER_HTTP_SERVER_PORT = 8081
     process.env.MANAGER_HTTP_SERVER_HOST = '127.0.0.1'
@@ -134,6 +144,9 @@ describe('configuration :: createConfiguration', () => {
       },
       queue: {
         redis_dsn: 'redis://redis:6379',
+        job: {
+          timeout: 5000,
+        },
       },
       worker: {
         enabled: true,

src/manager/http-server/index.js

@@ -2,9 +2,9 @@ import attachRenderMiddleware from './middlewares/render'
 import express from 'express'
 import { pipe } from 'ramda'
 
-// createHttpServer => (Configuration, Logger, Queue) -> HttpServer
+// createHttpServer => (Configuration, Logger, Queue, RequestRegistry) -> HttpServer
 export default (configuration, logger, queue, requestRegistry) => pipe(
-  attachRenderMiddleware(logger, queue, requestRegistry),
+  attachRenderMiddleware(configuration, logger, queue, requestRegistry),
   app => app.listen(
     configuration.manager.http_server.port,
     configuration.manager.http_server.host,

src/manager/http-server/middlewares/render.js

@@ -1,8 +1,8 @@
 import { call, complement, compose, ifElse, isNil, path, pipe } from 'ramda'
 import { DEFAULT_JOB_OPTIONS } from '../../../queue'
 
-// default :: (Logger, Queue, RequestRegistry) -> Express.app -> Express.app
-export default (logger, queue, requestRegistry) => app =>
+// default :: (Configuration, Logger, Queue, RequestRegistry) -> Express.app -> Express.app
+export default (configuration, logger, queue, requestRegistry) => app =>
   app.get('/render', (req, res, next) => call(pipe(
     () => logger.info(`Render request for url "${req.query.url}" started.`),
     ifElse(
@@ -13,6 +13,7 @@ export default (logger, queue, requestRegistry) => app =>
           url: req.query.url,
         }, {
           ...DEFAULT_JOB_OPTIONS,
+          timeout: configuration.queue.job.timeout,
           jobId,
         }),
       ),

src/queue.js

@@ -8,7 +8,6 @@ export const DEFAULT_QUEUE_OPTIONS = {}
 
 export const DEFAULT_JOB_OPTIONS = {
   attempts: 1,
-  timeout: 5000,
   removeOnComplete: true,
   removeOnFail: true,
 }

src/worker/renderers/chrome/index.js

@@ -17,6 +17,7 @@ const renderPageContent = async (configuration, logger, browserInstance, url) =>
 
   await page.goto(url, {
     waitUntil: 'networkidle0',
+    timeout: configuration.queue.job.timeout,
   })
 
   return await page.content()