lambda_convert 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 825e8ca26b989d26a26b063d735e7da3db1fd181
-  data.tar.gz: 26be24f32c9170cd23931ebfd2790e822f4bd750
+  metadata.gz: 25c44e1fb6fa07cb8e1aaf5654100b73721aa0c6
+  data.tar.gz: ec7ba833db940fa8dea581cdcd37265e1cea6142
 SHA512:
-  metadata.gz: 4e9aa2767b1080468a3ca599e97090004a3e22133dce311534f85187b0baad546feb5d2a5afff57e24091753d31a0a96c1b173dbfb6ea834cf4e233633730c92
-  data.tar.gz: fa48bfa41584f0ba13ddc0d6494bc69984c25cb61bdd4756a621cdfdb64df6f232b2bba0a98a852ab1e5dcd4545688bd836c6e202d1f91c4bb803d8f7c779b12
+  metadata.gz: 12347aac344bf05dd0e0ca8add187610d50d5adf81b962f0136a04c989c5a669db5e78f0ecd075ff5087f32c261c764783714c20304297407c6bfff7a1353aaf
+  data.tar.gz: fa4d46a0d15d393f455e20fcd45a2cd68c9ff4585052bb59727550cce5741be24c9be1f02f2f0cadd8abcbc8bbef8387adf46eb6904c59da8074d4a015e0eb5a

data/README.md

@@ -1,2 +1,29 @@
 # lambda-convert
 AWS Lambda powered drop-in replacement for ImageMagick convert command line tool
+
+## Background
+
+At Envoy, we have many image file uploaded by users and will be resized via `convert` (ImageMagick) command line tool. It works fine, the only problems are
+
+### Dealing with big GIF image
+
+When user upload a GIF image, to resize it, ImageMagick will need to load the all frames into memory. In that case, even the GIF image file is very small, could posiblly consume huge amount of memory. This brings big impact to our API server, and sometimes the uploading request fails due to this reason.
+
+### Security concerns
+
+Despite it's not really easy to perform, it still possible to leverage exploits of certain image file format loading code in ImageMagick.
+
+## Solution
+
+To eliminate the big image file uploading issue and the security risk, the idea here is to do image resizing on AWS Lambda instead of localhost. This command line tool is a drop-in replacement for `convert` command, except it upload the input image file to S3, does the resizing on AWS Lambda and finally down the result image back to localhost.
+
+## Environment variables
+
+ - **CONVERT_S3_REGION** - AWS region for S3, default value will be reading from `AWS_REGION` if this environment variable is not set. (required)
+ - **CONVERT_LAMBDA_REGION** - AWS region for Lambda, default value will be reading from `AWS_REGION` if this environment variable is not set. (required)
+ - **CONVERT_ACCESS_KEY** - AWS access key, default value will be reading from `AWS_ACCESS_KEY_ID` if this environment variable is not set. (required)
+ - **CONVERT_SECRET_ACCESS_KEY** - AWS secret key, default value will be reading from `AWS_SECRET_ACCESS_KEY` if this environment variable is not set. (required)
+ - **CONVERT_S3_BUCKET** - AWS S3 bucket. (required)
+ - **CONVERT_S3_KEY_PREFIX** - AWS S3 temporary file uploading prefix, default value is `_convert_tmp/`
+ - **CONVERT_LAMBDA_FUNCTION** - Name of the AWS Lambda function to invoke, default value is `image-convert-prod`
+ - **CONVERT_DISABLE_FALLBACK** - By default, this command line tool fallbacks to local `convert` command if remote operation fails. Set this value to 1 to disable the fallback behavior.

data/lib/lambda_convert/cli.rb

@@ -4,6 +4,14 @@ require 'English'
 
 require 'aws-sdk'
 
+# find command path array matching given `cmd` name in $PATH
+def find_cmd(cmd)
+  (ENV['PATH'].split(File::PATH_SEPARATOR).map do |path|
+    cmd_path = File.join(path, cmd)
+    cmd_path if File.executable?(cmd_path) && !File.directory?(cmd_path)
+  end).compact
+end
+
 def parse_input_path(path)
   # convert command input path could be attached with selecting syntax, let's
   # parse it and return them in an array of [filename, selecting syntax]
@@ -97,15 +105,19 @@ end
 
 def local_convert
   logger = Logger.new(STDERR)
+
   env = ENV.to_h
-  # remove Gem bindir from the path, so that we won't invoke ourself
-  path = ENV['PATH'].split(File::PATH_SEPARATOR) - [Gem.bindir]
-  env['PATH'] = path.join(File::PATH_SEPARATOR)
+  # find the original convert bin path
+  original_convert = find_cmd('convert').find do |path|
+    # TODO: maybe we need a more robust way to determine whether is given
+    # convert path from us or someone else
+    File.dirname(path) != Gem.bindir && !path.include?('.rbenv/shims')
+  end
   # we also put a CONVERT_RECURSIVE_FLAG to avoid somehow calling ourself again
   # by mistake
   env['CONVERT_RECURSIVE_FLAG'] = '1'
-  logger.info("Running local convert with args #{ARGV}")
-  system(env, *(['convert'] + ARGV))
+  logger.info("Running local convert #{original_convert} with args #{ARGV}")
+  system(env, *([original_convert] + ARGV))
   abort('Failed to run local convert') unless $CHILD_STATUS.success?
   logger.info('Done')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lambda_convert
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fang-Pen Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk