Merge pull request #36 from venveo/feature/layers

Switch to using Lambda Layers

Author: Mosnar

.gitignore

@@ -3,7 +3,7 @@
 .idea
 .nyc_output/
 coverage
-node_modules
+/node_modules/*
 .env
 # package directories
 jspm_packages

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Changed
+- Sharp is now bundled as its own layer, removing the need for swapping between platforms for local development
+
 ### Added
 - Added support for `ar` param, allowing an aspect ratio (16:9) to be supplied
 

README.md

@@ -1,10 +1,13 @@
 # Serverless Sharp Image Processor
-A solution to dynamically optimize and transform images on the fly, utilizing [Sharp](https://sharp.pixelplumbing.com/en/stable/).
+A solution to dynamically optimize and transform images on the fly, utilizing [Sharp](https://sharp.pixelplumbing.com/en/stable/) and AWS Lambda.
 
 ## Who is this for?
-This software is for people who want to optimize and transform (crop, scale, convert, etc) images from an existing S3
+This software is for people who want to optimize and run basic transformations (crop, scale, convert, etc) on images from an existing S3
 bucket without running computationally expensive processes or servers or paying for expensive third-party services.
 
+Serverless Sharp is written to be a drop-in replacement for most essential features of Imgix and costs magnitudes less for
+most users.
+
 ## How does it work?
 After deploying this solution, you'll find yourself with a number of AWS resources (all priced based on usage rather
 than monthly cost). The most important of which are:
@@ -24,6 +27,10 @@ For example: `mybucket/images`
 - `SECURITY_KEY` See security section
 - `SLS_IGNORE` A comma-delineated string of paths that should be ignored (for example, `favicon.ico`)
 
+You can define multiple environments, each of which will inherit your default settings. This is useful if you have
+different buckets for staging & production, for example. You may also wish to create an environment without a sign-key
+for local development.
+
 ## API & Usage
 We chose to base our API around the [Imgix service](https://docs.imgix.com/apis/url) to allow for backwards compatibility
 with the already popular service. The idea is that all CMS plugins should be able to seamlessly use this service in-place of
@@ -120,14 +127,9 @@ This package uses Serverless to allow for local development by simulating API Ga
 5. Run `serverless offline`
 
 ## Deploying to AWS
-First, we need to procure sharp/libvips binaries compiled for Amazon Linux. We can do this by running the following:
-
-```
-npm run sharp:linux
-```
-
-This will remove any existing Sharp binaries and then reinstall them with Linux x64 in mind.
-
-Ensure your `settings.yml` file is properly configured as shown in the previous steps
+Ensure your `settings.yml` file is properly configured as shown in the previous steps.
 
 Run: `serverless deploy [--stage=dev] [--settings=settings.yml]`
+
+If you need to deploy using a specific AWS profile, you should run:
+`AWS_SDK_LOAD_CONFIG=true serverless deploy [--stage=dev] [--settings=settings.yml] --aws-profile PROFILE_NAME `

lambdaLayers/SharpLayer/README.md

@@ -0,0 +1,4 @@
+1. docker run --rm -v "$PWD":/var/task lambci/lambda:build-nodejs10.x npm install sharp
+2. Copy new node_modules into nodejs folder
+3. In a temporary directory, run `npm install --no-cache --arch=x64 --platform=linux --target=8.10.0 sharp`
+4. Locate libvips.so.42.xx.x and libvips-cpp.so.xx.x and copy to lib folder