Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxy/lambda-js-prerender
:twisted_rightwards_arrows: AWS CloudFront Lambda serverless JavaScript prerenderer.
https://github.com/nuxy/lambda-js-prerender
aws-lambda function javascript puppeteer renderer serverless
Last synced: about 4 hours ago
JSON representation
:twisted_rightwards_arrows: AWS CloudFront Lambda serverless JavaScript prerenderer.
- Host: GitHub
- URL: https://github.com/nuxy/lambda-js-prerender
- Owner: nuxy
- License: mit
- Created: 2023-10-14T22:18:58.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-22T18:22:46.000Z (8 months ago)
- Last Synced: 2024-03-22T19:36:33.584Z (8 months ago)
- Topics: aws-lambda, function, javascript, puppeteer, renderer, serverless
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# lambda-js-prerender
 [](https://github.com/nuxy/lambda-js-prerender/actions) [](https://github.com/nuxy/lambda-js-prerender/releases)
AWS [CloudFront Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) serverless JavaScript [prerenderer](https://github.com/prerender/prerender).
## Features
- Ability to prerender SPA (Single-page application) pages for SEO indexing.
- Ability to create screenshots of dynamically generated pages for testing.
- Serverless function, scales [on a tight budget](https://s3.amazonaws.com/lambda-tools/pricing-calculator.html).
- Can be set-up easily (in minutes).
## Dependencies
- [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
- [Docker](https://www.docker.com/get-started)
- [Node.js](https://nodejs.org)
### Get the [Chromium](https://opensource.google/projects/chromium) binary
$ wget -c https://github.com/nuxy/chromium-lambda-build/releases/download/0.0.2/headless_shell.tar.gz -O - | tar -xz
## Deploying to AWS
$ ./deploy --profile
The following operations are orchestrated by AWS [CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) during execution:
- Docker container image is created and uploaded to AWS [Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html).
- AWS [Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) function is created with a configured [Function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) endpoint.
- AWS [CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html) distribution is created using the new function as origin.
- Network routing occurs thereby exposing your Lambda function URL
## Invoking the service
### Command-line
```sh
curl -X 'POST' \
'https://.lambda-url..on.aws' \
-H 'Accept: text/html' \
-H 'Content-Type: application/json' \
-d '{"url": "", "image": }'
```
### In Node.js
#### AWS SDK for JavaScript v3
```javascript
const {LambdaClient, InvokeCommand} = require('@aws-sdk/client-lambda');
const client = new LambdaClient({region: ''});
const params = {
FunctionName: 'PrerenderApi',
InvocationType: 'RequestResponse',
LogType: 'Tail',
Payload: JSON.stringify({
url: '',
image:
})
};
const command = new InvokeCommand(params);
try {
const {PayLoad} = await client.send(command);
console.log(Payload?.body));
} catch (err) {
console.warn(err.message);
throw err;
}
```
#### AWS SDK for JavaScript v2
```javascript
const AWS = require('aws-sdk');
const client = new AWS.Lambda({region: ''});
const params = {
FunctionName: 'PrerenderApi',
InvocationType: 'RequestResponse',
LogType: 'Tail',
Payload: JSON.stringify({
url: '',
image:
})
};
client.invoke(params).promise()
.then(function({Payload}) {
console.log(Payload?.body));
})
.catch(function(err) {
console.warn(err.message);
throw err;
});
```
## Environment variables
The following function environment overrides can be configured in the SAM [template](https://github.com/nuxy/human-face-detection/blob/master/template.yaml#L23) file:
| Variable name | Description | Default value |
|--------------------|----------------------|---------------|
| `PRERENDER_DEBUG` | Enable verbose logging to [CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) group | false |
|`PRERENDER_TIMEOUT` | Execution timeout in seconds | 60 |
## AWS requirements
In order to successfully deploy your application you must have [set-up your AWS Config](https://docs.aws.amazon.com/config/latest/developerguide/gs-cli.html) and have [created an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) with the following [policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html):
- [IAMFullAccess](https://console.aws.amazon.com/iam/home#/policies/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FIAMFullAccess)
- [CloudFrontFullAccess](https://console.aws.amazon.com/iam/home#/policies/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FCloudFrontFullAccess)
- [AWSCloudFormationFullAccess](https://console.aws.amazon.com/iam/home#/policies/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAWSCloudFormationFullAccess)
- [AWSLambda_FullAccess](https://console.aws.amazon.com/iam/home#/policies/arn%3Aaws%3Aiam%3A%3Aaws%3Apolicy%2FAWSLambda_FullAccess)
- [AmazonEC2ContainerRegistryFullAccess](https://us-east-1.console.aws.amazon.com/iam/home#/policies/arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryFullAccess)
WARNING: The policies above are provided to ensure a successful application deployment. It is recommended that you adjust these policies to meet the security requirements of your Lambda application. They should NOT be used in a Production environment.
## Developers
### CLI options
Run [ESLint](https://eslint.org/) on project sources:
$ npm run lint
Generate [Swagger](https://swagger.io) OpenAPI definitions:
$ npm run genapi
Run [Mocha](https://mochajs.org) unit tests:
$ npm run test
## Performance
Running in Lambda there is overhead that occurs ([cold start](https://docs.aws.amazon.com/lambda/latest/operatorguide/execution-environments.html)) when the environment is first launched. This overhead does not include [headless shell](https://github.com/nuxy/chromium-lambda-build) initialization which creates its own latency. Due to this, you can expect a longer response time for the first request. As long as there is an active Lambda handler (hot start) all subsequent requests will not incurr this overhead.
## References
- [Setting IAM Permissions and Roles](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-edge-permissions.html)
- [Scaling and concurrency in Lambda](https://docs.aws.amazon.com/lambda/latest/operatorguide/scaling-concurrency.html)
- [Lambda quotas](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html)
- [AWS SDK for JavaScript](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html)
- [chromium-lambda-build](https://github.com/nuxy/chromium-lambda-build)
- [content_switches.cc](https://source.chromium.org/chromium/chromium/src/+/main:content/public/common/content_switches.cc?q=kDisableGpu&ss=chromium)
## Versioning
This package is maintained under the [Semantic Versioning](https://semver.org) guidelines.
## License and Warranty
This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.
_lambda-js-prerender_ is provided under the terms of the [MIT license](http://www.opensource.org/licenses/mit-license.php)
[AWS](https://aws.amazon.com) is a registered trademark of Amazon Web Services, Inc.
## Author
[Marc S. Brooks](https://github.com/nuxy)