[Buzz 4210] migrate to typescript and update readme (#328)

* migrate image-handler from javascript to typescript and update Readme * feat: variant deployment * feat: prod deployment * fixed test * fix: build command * bump lambda to nodejs 20 runtime --------- Co-authored-by: Matthias Naber <[email protected]>
aws-solutions · thisismana · Dec 7, 2020 · Dec 9, 2020 · Jan 8, 2021 · Jan 11, 2021
commit 83b01854c7fdbda403fdd303d86bd21d134f733b
diff --git a/Makefile b/Makefile
@@ -19,7 +19,7 @@ clean ::
 	@cd $(WORK_DIR) && rm -rf ./dist/ ./node_modules/
 
 npm/install ::
-	cd $(WORK_DIR) && npm install
+	cd $(WORK_DIR) && npm install --cpu=arm64 --os=linux --libc=musl
 
 npm/test ::
 	cd $(WORK_DIR) && npm run test
@@ -36,7 +36,7 @@ build ::
 tf ::
 	rm -f $(WORK_DIR)/terraform/.terraform/terraform.tfstate || true
 	terraform -chdir=$(WORK_DIR)/terraform init $(TF_VARS) -reconfigure -upgrade=$(DO_TF_UPGRADE) $(TF_BACKEND_CFG)
-	if [ "true" == "$(DO_TF_UPGRADE)" ]; then terraform -chdir=$(WORK_DIR)/terraform providers lock -platform=darwin_amd64 -platform=linux_amd64; fi
+	if [ "true" == "$(DO_TF_UPGRADE)" ]; then terraform -chdir=$(WORK_DIR)/terraform providers lock -platform=darwin_amd64 -platform=darwin_arm64 -platform=linux_amd64; fi
 	terraform -chdir=$(WORK_DIR)/terraform $(MODE) $(TF_VARS)
 
 invoke :: # invoke the running docker lambda by posting a sample API-GW-Event

diff --git a/README.md b/README.md
@@ -1,92 +1,116 @@
-**_Important Notice:_**
-Due to a [change in the AWS Lambda execution environment](https://aws.amazon.com/blogs/compute/upcoming-updates-to-the-aws-lambda-execution-environment/), Serverless Image Handler v3 deployments are functionally broken. To address the issue we have released [minor version update v3.1.1](https://solutions-reference.s3.amazonaws.com/serverless-image-handler/v3.1.1/serverless-image-handler.template). We recommend all users of v3 to run cloudformation stack update with v3.1.1. Additionally, we suggest you to look at v5 of the solution and migrate to v5 if it addresses all of your use cases.
+# Serverless Image Handler Readme
+
+The serverless-image-handler mono repository contains the source code and documentation for the [image-handler](#image-handler) and [image-thumbs](#image-thumbs) AWS Lambda functions.
+
+## Table of Contents
+
+- [Serverless Image Handler Readme](#serverless-image-handler-readme)
+- [Table of Contents](#table-of-contents)
+- [Architecture](#architecture)
+- [Image Handler](#image-handler)
+    - [Overview](#overview)
+    - [Prerequisites](#prerequisites)
+    - [Usage](#usage)
+    - [Building](#building)
+    - [Testing](#testing)
+    - [Infrastructure deployment](#infrastructure-deployment)
+- [Image Thumbs](#image-thumbs)
+    - [Overview](#overview-1)
+    - [Prerequisites](#prerequisites-1)
+    - [Building](#building-1)
+    - [Test / Invoke](#test--invoke)
+    - [Infrastructure deployment](#infrastructure-deployment-1)
+
+### Architecture
 
-# AWS Serverless Image Handler Lambda wrapper for SharpJS
-A solution to dynamically handle images on the fly, utilizing Sharp (https://sharp.pixelplumbing.com/en/stable/).
-Published version, additional details and documentation are available here: https://aws.amazon.com/solutions/serverless-image-handler/
+![Architecture](architecture.png)
 
-_Note:_ it is recommended to build the application binary on Amazon Linux.
+## Image Handler
 
-## On This Page
-- [Architecture Overview](#architecture-overview)
-- [Creating a custom build](#creating-a-custom-build)
-- [External Contributors](#external-contributors)
-- [License](#license)
+### Overview
 
-## Architecture Overview
-![Architecture](architecture.png)
+The Image-handler is a solution Image Handler is a serverless image processing project built with Node.js 18 and the [Sharp](https://sharp.pixelplumbing.com/en/stable/) library. 
+It allows you to dynamically scale images on the fly and serves them through AWS Lambda, AWS CloudFront, and AWS S3.
 
-The AWS CloudFormation template deploys an Amazon CloudFront distribution, Amazon API Gateway REST API, and an AWS Lambda function. Amazon CloudFront provides a caching layer to reduce the cost of image processing and the latency of subsequent image delivery. The Amazon API Gateway provides endpoint resources and triggers the AWS Lambda function. The AWS Lambda function retrieves the image from the customer's Amazon Simple Storage Service (Amazon S3) bucket and uses Sharp to return a modified version of the image to the API Gateway. Additionally, the solution generates a CloudFront domain name that provides cached access to the image handler API.
+It aws originally forked from [aws-solutions/serverless-image-handler repository](https://github.com/aws-solutions/serverless-image-handler), but has been heavily modified to suit our needs.
 
-_**Note**:_ From v5.0, all AWS CloudFormation template resources are created be [AWS CDK](https://aws.amazon.com/cdk/) and [AWS Solutions Constructs](https://aws.amazon.com/solutions/constructs/). Since the AWS CloudFormation template resources have the same logical ID comparing to v4.x, it makes the solution upgradable mostly from v4.x to v5.
+### Prerequisites
 
-## Creating a custom build
-The solution can be deployed through the CloudFormation template available on the solution home page.
-To make changes to the solution, download or clone this repo, update the source code and then run the deployment/build-s3-dist.sh script to deploy the updated Lambda code to an Amazon S3 bucket in your account.
+- [Node.js](https://nodejs.org/en/) v18.x or later
+- [Terraform](https://www.terraform.io/downloads.html)
+- Make
+- AWS credentials with sufficient permissions
 
-### Prerequisites:
-* [AWS Command Line Interface](https://aws.amazon.com/cli/)
-* Node.js 12.x or later
+### Usage
 
-### 1. Clone the repository
-```bash
-git clone https://github.com/awslabs/serverless-image-handler.git
-```
+To scale images dynamically on the fly, you can make HTTP requests to the AWS CloudFront distribution URL. 
+The images are fetched from AWS S3, processed using Node.js 18 and Sharp, and then served through CloudFront.
 
-### 2. Run unit tests for customization
-Run unit tests to make sure added customization passes the tests:
-```bash
-cd ./deployment
-chmod +x ./run-unit-tests.sh
-./run-unit-tests.sh
-```
+Example URL:
 
-### 3. Declare environment variables
-```bash
-export REGION=aws-region-code # the AWS region to launch the solution (e.g. us-east-1)
-export DIST_OUTPUT_BUCKET=my-bucket-name # bucket where customized code will reside
-export SOLUTION_NAME=my-solution-name # the solution name
-export VERSION=my-version # version number for the customized code
-```
+```https://images.t-online.de/4k_hdr.jpg```
 
-### 4. Create an Amazon S3 Bucket
-The CloudFormation template is configured to pull the Lambda deployment packages from Amazon S3 bucket in the region the template is being launched in. Create a bucket in the desired region with the region name appended to the name of the bucket.
-```bash
-aws s3 mb s3://$DIST_OUTPUT_BUCKET-$REGION --region $REGION
-```
+For more details see the [Usage](docs/Usage.md) documentation.
 
-### 5. Create the deployment packages
-Build the distributable:
-```bash
-chmod +x ./build-s3-dist.sh
-./build-s3-dist.sh $DIST_OUTPUT_BUCKET $SOLUTION_NAME $VERSION
-```
+### Environment variables
+
+The following environment variables are used by the image-handler:
+
+| Name                      | Description                                     |
+|---------------------------|-------------------------------------------------|
+| `AUTO_WEBP`               | Flag if the AUTO WEBP feature should be enabled |
+| `CORS_ENABLED`            | Flag if CORS should be enabled                  |
+| `CORS_ORIGIN`             | CORS origin.                                    |
+| `LOG_EXT_OPEN_SEARCH_URL` | URL of OpenSearch                               |
+| `SOURCE_BUCKETS`          | S3 Bucket with source images                    |
+
+### Building
+
+To build the package run:
+
+```make build```
+
+### Testing
+
+Run tests using the following Make command:
+
+```make npm/test```
+
+### Infrastructure deployment
+
+Deploy the infrastructure using Terraform with the following Make command:
+
+```make tf```
+
+## Image Thumbs
+
+### Overview
+
+Image-thumbs is an implementation of [thumbhash](https://evanw.github.io/thumbhash/) as a Rust AWS Lambda function URL providing a very compact representation of a placeholder for an image.
+
+### Prerequisites
+
+- [Rust](https://www.rust-lang.org/tools/install)
+
+### Building
+
+To build the package run:
+
+```make SERVICE=thumbs build```
+
+### Test / Invoke
+
+See [cargo lambda](https://www.cargo-lambda.info/guide/getting-started.html)
 
-Deploy the distributable to the Amazon S3 bucket in your account:
 ```bash
-aws s3 sync ./regional-s3-assets/ s3://$DIST_OUTPUT_BUCKET-$REGION/$SOLUTION_NAME/$VERSION/ --recursive --acl bucket-owner-full-control
-aws s3 sync ./global-s3-assets/ s3://$DIST_OUTPUT_BUCKET-$REGION/$SOLUTION_NAME/$VERSION/ --recursive --acl bucket-owner-full-control
+# Terminal 1
+cargo lambda watch
+# Terminal 2
+cargo lambda invoke --data-file apigw-request.json
 ```
 
-### 6. Launch the CloudFormation template.
-* Get the link of the `serverless-image-handler.template` uploaded to your Amazon S3 bucket.
-* Deploy the Serverless Image Handler solution to your account by launching a new AWS CloudFormation stack using the S3 link of the `serverless-image-handler.template`.
-
-## External Contributors
-- [@leviwilson](https://github.com/leviwilson) for [#117](https://github.com/awslabs/serverless-image-handler/pull/117)
-- [@rpong](https://github.com/rpong) for [#130](https://github.com/awslabs/serverless-image-handler/pull/130)
-- [@harriswong](https://github.com/harriswong) for [#138](https://github.com/awslabs/serverless-image-handler/pull/138)
-- [@ganey](https://github.com/ganey) for [#139](https://github.com/awslabs/serverless-image-handler/pull/139)
-- [@browniebroke](https://github.com/browniebroke) for [#151](https://github.com/awslabs/serverless-image-handler/pull/151), [#152](https://github.com/awslabs/serverless-image-handler/pull/152)
-- [@john-shaffer](https://github.com/john-shaffer) for [#158](https://github.com/awslabs/serverless-image-handler/pull/158)
-- [@toredash](https://github.com/toredash) for [#174](https://github.com/awslabs/serverless-image-handler/pull/174), [#195](https://github.com/awslabs/serverless-image-handler/pull/195)
-- [@lith-imad](https://github.com/lith-imad) for [#194](https://github.com/awslabs/serverless-image-handler/pull/194)
-- [@pch](https://github.com/pch) for [#227](https://github.com/awslabs/serverless-image-handler/pull/227)
-- [@atrope](https://github.com/atrope) for [#201](https://github.com/awslabs/serverless-image-handler/pull/201)
-- [@bretto36](https://github.com/bretto36) for [#182](https://github.com/awslabs/serverless-image-handler/pull/182)
-
-***
-## License
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.<br />
-SPDX-License-Identifier: Apache-2.0
+## Infrastructure deployment
+
+To deploy the infrastructure run:
 
+```make SERVICE=thumb tf```
diff --git a/architecture.png b/architecture.png
diff --git a/docs/Usage.md b/docs/Usage.md
@@ -1,23 +1,7 @@
-# Stroeer serverless image handler
+# Usage
 
-This is a customized variant of the [AWS Serverless Image Handler].
-Its **code** is open source and can be found by following the _forked from_ 
-link above or otherwise [on GitHub][AWS Serverless Image Handler Repository].
-
-Under the hood it uses the [sharp image processing library][sharp].
-
-It is recommended to have a look at the [output options][output options], 
-[resize operations][resize operations] and [image operations][image operations].
-
-## Architecture
-
-![architecture](arch.png)
-
-* `pub` and `sub` lambda are described [here][peruggia]. Their task is to publish
-  the master images into the S3 bucket
-* As for the image delivery, we're using CloudFront CDN as an entrypoint
-* Its origin is an API Gateway
-* Which then calls an AWS Lambda who is doing the actual work (image serving and manipulation).
+It is recommended to have a look at the [output options](https://sharp.pixelplumbing.com/api-output), 
+[resize operations](https://sharp.pixelplumbing.com/api-resize) and [image operations](https://sharp.pixelplumbing.com/api-operation).
 
 ### Feature: AUTO WEBP
 
@@ -97,9 +81,9 @@ $ curl -v 'https://images.t-online.de/4k_hdr.jpg' \
 
 ## Filters
 
-Most of the filter are documented on the [AWS Solution page][Serverless Image Handler Filters].
+Most of the filter are documented on the [AWS Solution page](https://docs.aws.amazon.com/solutions/latest/serverless-image-handler/appendix-d.html).
 
-Here is a tl;dr for the most important ones, demonstrated on an image from [the internet][img source]:
+Here is a tl;dr for the most important ones, demonstrated on an image from [the internet](https://wallpapersafari.com/w/pEwDaY):
 ### #nofilter
 
 will simply output the original image as is 
@@ -187,20 +171,9 @@ black frame.
 
 ## Try it out
 
-Visit the [Demo UI], enter the following
+Visit the [Demo UI](https://master-images-053041861227-eu-west-1.s3-eu-west-1.amazonaws.com/index.html), enter the following
 
 * `bucket name = master-images-053041861227-eu-west-1`
 * `image key = oat.jpg`
 
-There are many other images already automatically imported into the image bucket, just check the API for more `keys`.
-
-[AWS Serverless Image Handler]: https://docs.aws.amazon.com/solutions/latest/serverless-image-handler/welcome.html
-[AWS Serverless Image Handler Repository]: https://github.com/awslabs/serverless-image-handler
-[sharp]: https://sharp.pixelplumbing.com/
-[output options]: https://sharp.pixelplumbing.com/api-output
-[resize operations]: https://sharp.pixelplumbing.com/api-resize
-[image operations]: https://sharp.pixelplumbing.com/api-operation
-[Serverless Image Handler Filters]: https://docs.aws.amazon.com/solutions/latest/serverless-image-handler/appendix-d.html
-[Demo UI]: https://master-images-053041861227-eu-west-1.s3-eu-west-1.amazonaws.com/index.html
-[img source]: https://wallpapersafari.com/w/pEwDaY
-[peruggia]: github.com/stroeer/peruggia
+There are many other images already automatically imported into the image bucket, just check the API for more `keys`.
diff --git a/docs/arch.drawio b/docs/arch.drawio
diff --git a/docs/arch.png b/docs/arch.png
diff --git a/source/image-handler/logger/index.js b/source/image-handler/logger/index.js
diff --git a/source/image-handler/logger/logger.js b/source/image-handler/logger/logger.js
diff --git a/source/image-handler/logger/logger.spec.js b/source/image-handler/logger/logger.spec.js