add aws-node-image-resizer example

craftizard · craftizard · commit 5039a395eb05 · 2019-03-14T20:50:40.000+01:00
diff --git a/aws-node-image-resizer/Dockerfile b/aws-node-image-resizer/Dockerfile
@@ -0,0 +1,11 @@
+FROM amazonlinux
+WORKDIR /deploy
+RUN yum -y install make gcc*
+RUN curl --silent --location https://rpm.nodesource.com/setup_8.x | bash -
+RUN yum -y install nodejs
+RUN npm install -g serverless
+COPY . .
+RUN npm i --production
+
+RUN ["chmod", "+x", "deploy.sh"]
+CMD ./deploy.sh ; sleep 2m
diff --git a/aws-node-image-resizer/README.md b/aws-node-image-resizer/README.md
@@ -0,0 +1,77 @@
+<!--
+title: 'Dynamic Image Resizing API'
+description: 'This example shows you how to setup a dynamic image resizer API'
+layout: Doc
+framework: v1
+platform: AWS
+language: nodeJS
+authorLink: 'https://github.com/sebito91'
+authorName: 'Sebastian Borza'
+authorAvatar: 'https://avatars0.githubusercontent.com/u/3159454?v=4&s=140'
+-->
+
+# Dynamic image resizing with Node.js and Serverless framework
+
+In this example, we set up a dynamic image resizing solution with AWS S3 and a Serverless framework function written in Node.js. We use [the `sharp` package](https://www.npmjs.com/package/sharp) for image resizing.
+
+`sharp` includes native dependencies, so in this example we are building and deploying the Serverless function from a Docker container that’s based on Amazon Linux.
+
+## Pre-requisites
+
+In order to deploy the function, you will need the following:
+
+- API credentials for AWS, with Administrator permissions (for simplicity, not recommended in production).
+- An S3 bucket in your AWS account.
+- Serverless framework installed locally via `yarn global add serverless`.
+- Node.js 8 and `yarn` installed locally.
+- Docker and docker-compose installed locally.
+
+## Deploying the Serverless project
+
+1. Clone the repository and install the dependencies:\
+
+```
+yarn
+```
+
+2. Add your AWS credentials into the `secrets/secrets.env` file.
+3. Deploy the Serverless project:\
+
+```
+docker-compose up --build
+```
+
+## Setting up the S3 bucket
+
+Make sure that your S3 bucket is public. Then follow these additional setup steps:
+
+1. Configure the S3 bucket for website hosting as shown [in the S3 documentation](https://docs.aws.amazon.com/AmazonS3/latest/dev/HowDoIWebsiteConfiguration.html).
+2. In the [Advanced Conditional Redirects section](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) of the Website Hosting settings for the S3 bucket, set up the following redirect rule:
+
+```
+<RoutingRules>
+  <RoutingRule>
+    <Condition>
+      <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
+    </Condition>
+    <Redirect>
+      <Protocol>https</Protocol>
+      <HostName>your_api_endpoint.execute-api.us-east-1.amazonaws.com</HostName>
+      <ReplaceKeyPrefixWith>dev-1/</ReplaceKeyPrefixWith>
+      <HttpRedirectCode>307</HttpRedirectCode>
+    </Redirect>
+  </RoutingRule>
+</RoutingRules>
+```
+
+You will need to replace `your_api_endpoint` part with the URL of your Serverless endpoint. You can find out what’s the endpoint URL by running:
+
+```
+serverless info
+```
+
+or observing the output of the deployment step.
+
+## Any questions or suggestions?
+
+Please feel free to open an issue on this repository if something doesn’t work is doesn’t behave as described here. Thanks for giving this project a try!
diff --git a/aws-node-image-resizer/config/.env.example b/aws-node-image-resizer/config/.env.example
@@ -0,0 +1,3 @@
+STAGE=dev-1
+PROFILE=
+REGION=us-east-1
diff --git a/aws-node-image-resizer/config/pull-secret.sh b/aws-node-image-resizer/config/pull-secret.sh
@@ -0,0 +1,10 @@
+echo "🔍  $(tput bold)Pull secret$(tput sgr0)"
+
+if [ "$#" -lt 1 ]; then
+  printf "Secret key: "
+  read key
+else
+  key=$1
+fi;
+
+aws ssm get-parameter --name $key --region us-east-1 --with-decryption
diff --git a/aws-node-image-resizer/config/push-secret.sh b/aws-node-image-resizer/config/push-secret.sh
@@ -0,0 +1,13 @@
+echo "💾  $(tput bold)Push secret$(tput sgr0)"
+
+if [ "$#" -lt 2 ]; then
+  printf "Secret key: "
+  read key
+  printf "Secret value: "
+  read value
+else
+  value=$1
+  key=$2
+fi;
+
+aws ssm put-parameter --name $key --value $value --type SecureString --region us-east-1 --overwrite
diff --git a/aws-node-image-resizer/deploy.sh b/aws-node-image-resizer/deploy.sh
@@ -0,0 +1,13 @@
+stage=${STAGE}
+region=${REGION}
+bucket=${BUCKET}
+secrets='/deploy/secrets/secrets.json'
+
+sls config credentials \
+  --provider aws \
+  --key ${SLS_KEY} \
+  --secret ${SLS_SECRET} \
+  --profile ${PROFILE}
+
+echo 'Deploying'
+sls deploy -s ${STAGE}
diff --git a/aws-node-image-resizer/docker-compose.yml b/aws-node-image-resizer/docker-compose.yml
@@ -0,0 +1,8 @@
+version: "3"
+services:
+  image-resize:
+    build: .
+    volumes:
+      - ./secrets:/deploy/secrets
+    env_file:
+      - ./secrets/secrets.env
diff --git a/aws-node-image-resizer/package.json b/aws-node-image-resizer/package.json
@@ -0,0 +1,45 @@
+{
+  "name": "fii-sls",
+  "version": "1.0.0",
+  "license": "MIT",
+  "author": "Artur Figiel",
+  "scripts": {
+    "eslint": "eslint ./src",
+    "deploy": "SLS_DEBUG=* sls deploy --stage $STAGE --region $REGION --verbose",
+    "deploy:local": "export $(cat ./config/.env | xargs) && serverless deploy --stage $STAGE --region $REGION --verbose",
+    "remove:stack": "export $(cat ./config/.env | xargs) && sls remove -s $STAGE",
+    "offline": "export $(cat ./config/.env | xargs) && serverless offline start --stage $STAGE",
+    "add:env": "./config/push-secret.sh"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.3.1",
+    "babel-runtime": "^7.0.0-beta.3",
+    "lodash": "^4.17.11",
+    "serverless-offline": "^4.7.0",
+    "serverless-webpack": "^5.2.0",
+    "sharp": "^0.21.3",
+    "source-map-support": "^0.5.10",
+    "stream": "^0.0.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.2.3",
+    "@babel/core": "^7.3.4",
+    "@babel/plugin-transform-runtime": "^7.2.0",
+    "@babel/preset-env": "^7.3.1",
+    "aws-sdk": "^2.409.0",
+    "babel-core": "^7.0.0-bridge.0",
+    "babel-jest": "^24.1.0",
+    "babel-loader": "^8.0.5",
+    "babel-plugin-source-map-support": "^2.0.1",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-env": "^1.7.0",
+    "babel-preset-stage-3": "^6.24.1",
+    "jest": "^23.6.0",
+    "serverless": "^1.35.1",
+    "webpack": "^4.28.3",
+    "webpack-node-externals": "^1.7.2"
+  },
+  "resolutions": {
+    "babel-core": "7.0.0-bridge.0"
+  }
+}
diff --git a/aws-node-image-resizer/secrets/secrets.env b/aws-node-image-resizer/secrets/secrets.env
@@ -0,0 +1,5 @@
+SLS_KEY=
+SLS_SECRET=
+PROFILE=
+STAGE=dev-1
+REGION=us-east-1
diff --git a/aws-node-image-resizer/secrets/secrets.json b/aws-node-image-resizer/secrets/secrets.json
@@ -0,0 +1 @@
+{"DOMAIN":""}
diff --git a/aws-node-image-resizer/serverless.yml b/aws-node-image-resizer/serverless.yml
@@ -0,0 +1,71 @@
+service:
+  name: ${self:custom.serviceName}
+
+plugins:
+  - serverless-offline
+  - serverless-webpack
+
+provider:
+  name: aws
+  runtime: nodejs8.10
+  profile: dev-fii
+
+  usagePlan:
+    quota:
+      limit: 100
+      offset: 2
+      period: MONTH
+    throttle:
+      burstLimit: 100
+      rateLimit: 50
+
+custom:
+  serviceName: image-resizing
+  stage: ${opt:stage, self:custom.defaultStage}
+  bucket: dynamic-image-resizing
+  webpack:
+    includeModules:
+      forceExclude:
+        - aws-sdk
+  defaultStage: dev
+  stages:
+    - ${opt:stage}
+    - dev
+    - integration
+    - production
+
+functions:
+  resize:
+    handler: src/handlers/resizer/index.handler
+    events:
+      - http:
+          path: /{size}/{image}
+          method: get
+    environment:
+      # Provide your bucket name here
+      BUCKET: dynamic-image-resizing
+      REGION: us-east-1
+    # layers:
+    #   - {Ref: ImageLibsLambdaLayer}
+    iamRoleStatements:
+      - Effect: "Allow"
+        Action:
+          - "s3:GetObject"
+        Resource: "arn:aws:s3:::dynamic-image-resizing/*"
+      - Effect: "Allow"
+        Action:
+          - "s3:PutObject"
+        Resource: "arn:aws:s3:::dynamic-image-resizing/*"
+
+package:
+  exclude:
+    - layer/**
+    - node_modules/**
+    - '!node_modules/babel-runtime/**'
+    - '!node_modules/sharp/**'
+
+# layers:
+#   imageLibs:
+#     path: layer
+#     compatibleRuntimes:
+#       - nodejs8.10
diff --git a/aws-node-image-resizer/src/handlers/resizer/index.js b/aws-node-image-resizer/src/handlers/resizer/index.js
@@ -0,0 +1,17 @@
+import { resizeHandler } from './resizeHandler'
+
+export const handler = async (event) => {
+  try {
+    const imagePath = await resizeHandler._process(event)
+    const URL = `http://${process.env.BUCKET}.s3-website.${process.env.REGION}.amazonaws.com`
+
+    return {
+      headers: { 'location': `${URL}/${imagePath}` },
+      statusCode: 301,
+      body: ''
+    }
+  } catch (error) {
+    console.log(error)
+    return new Error(error)
+  }
+}
diff --git a/aws-node-image-resizer/src/handlers/resizer/resizeHandler.js b/aws-node-image-resizer/src/handlers/resizer/resizeHandler.js
@@ -0,0 +1,43 @@
+import { s3Handler } from './s3Handler'
+
+//Core image processing package
+const sharp = require('sharp')
+
+class ResizerHandler {
+  constructor(){ }
+
+  async _process(event) {
+    const { size, image } = event.pathParameters
+    return await this.resize(size, image)
+  }
+
+  async resize(size, path) {
+    try {
+      const sizeArray = size.split('x')
+      const width = parseInt(sizeArray[0])
+      const height = parseInt(sizeArray[1])
+      const Key = path
+      const newKey = '' + width + 'x' + height + '/' + path
+
+      const Bucket = process.env.BUCKET
+      const streamResize = sharp()
+        .resize(width, height)
+        .toFormat('png')
+
+      const readStream = s3Handler.readStream({ Bucket, Key })
+      const { writeStream, uploaded } = s3Handler.writeStream({ Bucket, Key: newKey })
+
+      //data streaming
+      readStream
+        .pipe(streamResize)
+        .pipe(writeStream)
+
+      await uploaded
+      return newKey
+    } catch (error) {
+      throw new Error(error)
+    }
+  }
+}
+
+export const resizeHandler = new ResizerHandler()
diff --git a/aws-node-image-resizer/src/handlers/resizer/s3Handler.js b/aws-node-image-resizer/src/handlers/resizer/s3Handler.js
@@ -0,0 +1,28 @@
+import * as AWS from 'aws-sdk'
+import stream from 'stream'
+
+AWS.config.region = 'us-east-1'
+const S3 = new AWS.S3()
+
+class S3Handler {
+  constructor() { }
+
+  readStream({ Bucket, Key }) {
+    return S3.getObject({ Bucket, Key }).createReadStream()
+  }
+
+  writeStream({ Bucket, Key }) {
+    const passThrough = new stream.PassThrough()
+    return {
+      writeStream: passThrough,
+      uploaded: S3.upload({
+        ContentType: 'image/png',
+        Body: passThrough,
+        Bucket,
+        Key
+      }).promise()
+    }
+  }
+}
+
+export const s3Handler = new S3Handler()
diff --git a/aws-node-image-resizer/src/lib/BaseHandler.js b/aws-node-image-resizer/src/lib/BaseHandler.js
@@ -0,0 +1,16 @@
+export default class BaseHandler {
+  constructor() {
+    this.handlerName = this.constructor.name
+  }
+
+  async execute(event, context) {
+    console.log(`Executing handler ${this.handlerName}`)
+    return this._process(event, context)
+  }
+
+  async _process(event, context) {
+    console.log(event)
+    console.log(context)
+    console.log('Remember to overwrite this method if you need to provide custom handling logic.')
+  }
+}
diff --git a/aws-node-image-resizer/webpack.config.js b/aws-node-image-resizer/webpack.config.js
@@ -0,0 +1,23 @@
+const slsw = require('serverless-webpack')
+const webpack = require('webpack')
+
+module.exports = {
+  entry: slsw.lib.entries,
+  target: 'node',
+  mode: 'development',
+  devtool: 'source-map',
+  optimization: {
+    minimize: false
+  },
+  module: {
+    rules: [
+      {
+        test: /\.js$/,
+        loaders: ['babel-loader'],
+        include: __dirname,
+        exclude: /node_modules/
+      }
+    ]
+  },
+  externals: ['sharp', 'aws-sdk']
+}
diff --git a/aws-node-image-resizer/yarn.lock b/aws-node-image-resizer/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+STAGE=dev-1`
	`2`	`+PROFILE=`
	`3`	`+REGION=us-east-1`