# projectn-bolt-nodejs-lambda-sample > Sample AWS Lambda app in Node.js that utilizes Bolt TypeScript Client SDK Latest version **1.0.4** (published 2021-07-16) · ISC license · 0 weekly downloads ## Install ```sh npm install projectn-bolt-nodejs-lambda-sample pnpm add projectn-bolt-nodejs-lambda-sample yarn add projectn-bolt-nodejs-lambda-sample bun add projectn-bolt-nodejs-lambda-sample ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.4 | | Published | 2021-07-16 | | First published | 2021-07-14 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 55.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Project N | | Maintainers | madhu.polu | ## Links - npm: https://www.npmjs.com/package/projectn-bolt-nodejs-lambda-sample - npm.io page: https://npm.io/package/projectn-bolt-nodejs-lambda-sample ## Dependencies (3) - [execution-time](https://npm.io/package/execution-time.md) ^1.4.1 - [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.18.0 - [projectn-bolt-aws-typescript-sdk](https://npm.io/package/projectn-bolt-aws-typescript-sdk.md) ^1.0.0 ## Recent versions - 1.0.4 (latest) — 2021-07-16 - 1.0.2 — 2021-07-16 - 1.0.1 — 2021-07-14 - 1.0.0 — 2021-07-14 - 1.0.0-beta.26 — 2021-07-14 - 1.0.0-beta.25 — 2021-07-14 - 1.0.0-beta.24 — 2021-07-14 ## README # AWS Lambda Function in Node.js for Bolt Sample AWS Lambda Function in Node.js that utilizes [TypeScript SDK for Bolt](https://gitlab.com/projectn-oss/projectn-bolt-aws-typescript) ### Requirements - Node.js 14.x or higher - [TypeScript SDK for Bolt](https://gitlab.com/projectn-oss/projectn-bolt-aws-typescript) ### Three ways to build a Node.js AWS Lambda app to consume the Bolt SDK 1. Install Bolt SDK NPM package directly into your existing Node.js project ```shell npm i projectn-bolt-aws-typescript-sdk ``` 2. Clone the [Projec N Bolt Node.js Lambda sample app](https://gitlab.com/projectn-oss/projectn-bolt-nodejs-lambda-sample) repository into your local directory 3. Install Projec N Bolt Node.js Lambda sample app NPM package (which is built on top of the Bolt SDK) directly into your existing Node.js project ```shell npm i projectn-bolt-nodejs-lambda-sample ``` * Create `bolt-typescript-sdk-nodejs-lambda` directory, and pick one of the above three options. * Create deployment package ```bash cd bolt-typescript-sdk-nodejs-lambda zip -r bolt-typescript-sdk-nodejs-lambda-demo.zip . ``` ### Deploy * Deploy the function to AWS Lambda by uploading the deployment package (bolt-typescript-sdk-nodejs-lambda-demo.zip) ```bash aws lambda create-function \ --function-name \ --runtime nodejs14.x \ --zip-file fileb://bolt-typescript-sdk-nodejs-lambda-demo.zip \ --handler dist/BoltS3OpsClientHandler.lambdaHandler \ --role \ --environment "Variables={BOLT_URL=}" \ --memory-size 128 \ --timeout 20 ``` ### Usage The Sample AWS Lambda Function in Node.js illustrates the usage and various operations, via separate handlers, that can be performed using [TypeScript SDK for Bolt](https://gitlab.com/projectn-oss/projectn-bolt-aws-typescript). The deployed AWS lambda function can be tested from the AWS Management Console by creating a test event and specifying its inputs in JSON format. Please ensure that `Bolt` is deployed before testing the sample AWS lambda function. If you haven't deployed `Bolt`, follow the instructions given [here](https://xyz.projectn.co/installation-guide#estimate-savings) to deploy `Bolt`. #### Testing Bolt or S3 Operations `BoltS3OpsClientHandler` is the handler that enables the user to perform Bolt or S3 operations. It sends a Bucket or Object request to Bolt or S3 and returns an appropriate response based on the parameters passed in as input. * BoltS3OpsHandler is the handler that is invoked by AWS Lambda to process an incoming event. * BoltS3OpsHandler accepts the following input parameters as part of the event: * sdkType - Endpoint to which request is sent. The following values are supported: * S3 - The Request is sent to S3. * Bolt - The Request is sent to Bolt, whose endpoint is configured via 'BOLT_URL' environment variable * requestType - type of request / operation to be performed. The following requests are supported: * list_objects_v2 - list objects * list_buckets - list buckets * head_object - head object * head_bucket - head bucket * get_object - get object (md5 hash) * put_object - upload object * delete_object - delete object * bucket - bucket name * key - key name * Following are examples of events, for various requests, that can be used to invoke the handler. * Listing first 1000 objects from Bolt bucket: ```json {"requestType": "list_objects_v2", "sdkType": "BOLT", "bucket": ""} ``` * Listing buckets from S3: ```json {"requestType": "list_buckets", "sdkType": "S3"} ``` * Get Bolt object metadata (HeadObject): ```json {"requestType": "head_object", "sdkType": "BOLT", "bucket": "", "key": ""} ``` * Check if S3 bucket exists (HeadBucket): ```json {"requestType": "head_bucket","sdkType": "S3", "bucket": ""} ``` * Retrieve object (its MD5 Hash) from Bolt: ```json {"requestType": "get_object", "sdkType": "BOLT", "bucket": "", "key": ""} ``` * Upload object to Bolt: ```json {"requestType": "put_object", "sdkType": "BOLT", "bucket": "", "key": "", "value": ""} ``` * Delete object from Bolt: ```json {"requestType": "delete_object", "sdkType": "BOLT", "bucket": "", "key": ""} ``` #### Data Validation Tests `BoltS3ValidateObjHandler` is the handler that enables the user to perform data validation tests. It retrieves the object from Bolt and S3 (Bucket Cleaning is disabled), computes and returns their corresponding MD5 hash. If the object is gzip encoded, object is decompressed before computing its MD5. * BoltS3ValidateObjHandler is a handler that is invoked by AWS Lambda to process an incoming event for performing data validation tests. To use this handler, change the handler of the Lambda function to `BoltS3ValidateObjHandler.lambda_handler` * BoltS3ValidateObjHandler accepts the following input parameters as part of the event: * bucket - bucket name * key - key name * Following is an example of an event that can be used to invoke the handler. * Retrieve object(its MD5 hash) from Bolt and S3: If the object is gzip encoded, object is decompressed before computing its MD5. ```json {"bucket": "", "key": ""} ``` #### Performance Tests `BoltS3PerfHandler` is the handler that enables the user to run Bolt or S3 Performance tests. It measures the performance of Bolt or S3 Operations and returns statistics based on the operation. Before using this handler, ensure that a source bucket has been crunched by `Bolt` with cleaner turned `OFF`. `Get, List Objects` tests are run using the first 1000 objects in the bucket and `Put Object` tests are run using objects of size `100 bytes`. `Delete Object` tests are run on objects that were created by the `Put Object` test. * BoltS3PerfHandler is a handler function that is invoked by AWS Lambda to process an incoming event for Bolt/S3 Performance testing. To use this handler, change the handler of the Lambda function to `BoltS3PerfHandler.lambda_handler` * BoltS3PerfHandler accepts the following input parameters as part of the event: * requestType - type of request / operation to be performed. The following requests are supported: * list_objects_v2 - list objects * get_object - get object * get_object_ttfb - get object (first byte) * get_object_passthrough - get object (via passthrough) of unmonitored bucket * get_object_passthrough_ttfb - get object (first byte via passthrough) of unmonitored bucket * put_object - upload object * delete_object - delete object * all - put, get, delete, list objects (default request if none specified) * bucket - bucket name * Following are examples of events, for various requests, that can be used to invoke the handler. * Measure List objects performance of Bolt / S3. ```json {"requestType": "list_objects_v2", "bucket": ""} ``` * Measure Get object performance of Bolt / S3. ```json {"requestType": "get_object", "bucket": ""} ``` * Measure Get object (first byte) performance of Bolt / S3. ```json {"requestType": "get_object_ttfb", "bucket": ""} ``` * Measure Get object passthrough performance of Bolt. ```json {"requestType": "get_object_passthrough", "bucket": ""} ``` * Measure Get object passthrough (first byte) performance of Bolt. ```json {"requestType": "get_object_passthrough_ttfb", "bucket": ""} ``` * Measure Put object performance of Bolt / S3. ```json {"requestType": "put_object", "bucket": ""} ``` * Measure Delete object performance of Bolt / S3. ```json {"requestType": "delete_object", "bucket": ""} ``` * Measure Put, Delete, Get, List objects performance of Bolt / S3. ```json {"requestType": "all", "bucket": ""} ``` #### Auto Heal Tests `BoltAutoHealHandler` is the handler that enables the user to run auto heal tests. Before running this handler, modify `data-cruncher` to use `standard` tier-class and set `backupduration` and `recoveryscannerperiod` to `1 minute` to ensure that the auto-healing duration is within the lambda execution timeout interval. Crunch a sample bucket having a single object. Then delete the single fragment object from the `n-data`bucket. Now run this handler, passing the name of the crunched bucket along with the single object as input parameters to the handler. The handler attempts to retrieve object repeatedly until it succeeds, which would indicate successful auto-healing of the object and returns the time taken to do so. * BoltAutoHealHandler is a handler function that is invoked by AWS Lambda to process an incoming event for performing Auto-Heal testing. To use this handler, change the handler of the Lambda function to `BoltAutoHealHandler.lambda_handler`. * BoltAutoHealHandler accepts the following input parameters as part of the event: * bucket - bucket name * key - key name * Following is an example of an event that can be used to invoke the handler. * Measure Auto-Heal time of an object in Bolt. ```json {"bucket": "", "key": ""} ``` ### Getting Help For additional assistance, please refer to [Project N Docs](https://xyz.projectn.co/) or contact us directly [here](mailto:support@projectn.co) --- _Source: https://npm.io/package/projectn-bolt-nodejs-lambda-sample · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._