Added timeout when resizing an image (#494)

refs [ENG-827](https://linear.app/tryghost/issue/ENG-827/🐛-crash-on-resizing-animated-gif)

Added a configurable timeout when resizing an image to allow the package
consumer to handle the case when image processing takes too long. If no timeout
is provided, the default value is 0 seconds which means no timeout

Author: mike182uk

packages/image-transform/lib/transform.js

@@ -2,6 +2,8 @@ const errors = require('@tryghost/errors');
 const fs = require('fs-extra');
 const path = require('path');
 
+const DEFAULT_PROCESSING_TIMEOUT_SECONDS = 0; // 0 means no timeout
+
 /**
  * Check if this tool can handle any file transformations as Sharp is an optional dependency
  */
@@ -58,13 +60,14 @@ const canTransformToFormat = format => [
   * https://github.com/lovell/sharp/issues/1360.
   *
   * Resize an image referenced by the `in` path and write it to the `out` path
-  * @param {{in, out, width}} options
+  * @param {{in, out, width, timeout}} options
   */
 const unsafeResizeFromPath = (options = {}) => {
     return fs.readFile(options.in)
         .then((data) => {
             return unsafeResizeFromBuffer(data, {
-                width: options.width
+                width: options.width,
+                timeout: options.timeout
             });
         })
         .then((data) => {
@@ -76,7 +79,7 @@ const unsafeResizeFromPath = (options = {}) => {
  * Resize an image
  *
  * @param {Buffer} originalBuffer image to resize
- * @param {{width?: number, height?: number, format?: keyof import('sharp').FormatEnum, animated?: boolean, withoutEnlargement?: boolean}} [options]
+ * @param {{width?: number, height?: number, format?: keyof import('sharp').FormatEnum, animated?: boolean, withoutEnlargement?: boolean, timeout:? number}} [options]
  *  options.animated defaults to true for file formats where animation is supported (will always maintain animation if possible)
  * @returns {Promise<Buffer>} the resizedBuffer
  */
@@ -105,7 +108,8 @@ const unsafeResizeFromBuffer = async (originalBuffer, options = {}) => {
             withoutEnlargement: options.withoutEnlargement ?? true
         })
         // CASE: Automatically remove metadata and rotate based on the orientation.
-        .rotate();
+        .rotate()
+        .timeout({seconds: options.timeout || DEFAULT_PROCESSING_TIMEOUT_SECONDS});
 
     const metadata = await s.metadata();
 
@@ -162,3 +166,4 @@ module.exports.canTransformToFormat = canTransformToFormat;
 module.exports.generateOriginalImageName = generateOriginalImageName;
 module.exports.resizeFromPath = makeSafe(unsafeResizeFromPath);
 module.exports.resizeFromBuffer = makeSafe(unsafeResizeFromBuffer);
+module.exports.DEFAULT_PROCESSING_TIMEOUT_SECONDS = DEFAULT_PROCESSING_TIMEOUT_SECONDS;

packages/image-transform/test/unit/transform.test.js

@@ -88,7 +88,8 @@ describe('Transform', function () {
                 rotate: sinon.stub().returnsThis(),
                 toBuffer: sinon.stub(),
                 jpeg: sinon.stub().returnsThis(),
-                metadata: sinon.stub().returns({format: 'test'})
+                metadata: sinon.stub().returns({format: 'test'}),
+                timeout: sinon.stub().returnsThis()
             };
 
             sharp = sinon.stub().callsFake(() => {
@@ -157,6 +158,40 @@ describe('Transform', function () {
                     err.code.should.eql('IMAGE_PROCESSING');
                 });
         });
+
+        it('uses the default processing timeout when resizing an image', function () {
+            sharpInstance.toBuffer.resolves('manipulated');
+
+            return transform.resizeFromPath({width: 1000})
+                .then(() => {
+                    sharpInstance.resize.calledOnce.should.be.true();
+                    sharpInstance.rotate.calledOnce.should.be.true();
+                    sharpInstance.timeout.calledOnce.should.be.true();
+
+                    sharpInstance.timeout.getCall(0).args[0].should.eql({seconds: transform.DEFAULT_PROCESSING_TIMEOUT_SECONDS});
+
+                    fs.writeFile.calledOnce.should.be.true();
+                    fs.writeFile.calledWith('manipulated');
+                });
+        });
+
+        it('uses the provided processing timeout when resizing an image', function () {
+            sharpInstance.toBuffer.resolves('manipulated');
+
+            const timeout = 10;
+
+            return transform.resizeFromPath({width: 1000, timeout})
+                .then(() => {
+                    sharpInstance.resize.calledOnce.should.be.true();
+                    sharpInstance.rotate.calledOnce.should.be.true();
+                    sharpInstance.timeout.calledOnce.should.be.true();
+
+                    sharpInstance.timeout.getCall(0).args[0].should.eql({seconds: timeout});
+
+                    fs.writeFile.calledOnce.should.be.true();
+                    fs.writeFile.calledWith('manipulated');
+                });
+        });
     });
 
     describe('installation', function () {