Netacea CloudFront

!Netacea Header

  

@netacea/cloudfront is a package designed to add Netacea functionality to CloudFront Lambda@Edge.

Installation

$3

Quickest way to get started, is pulling the Netacea CloudFront template repository from github and following the steps in there to get up and running.

``bash
git clone https://github.com/Netacea/cloudfront-worker-template-typescript.git
`

Follow the README.md in the cloudfront-worker-template-typescript repository to get this deployed.

$3

Run the following command to install the netacea worker

` bash
npm i @netacea/cloudfront --save
`

Require (javascript) or import (typescript) the worker

` javascript
// JAVASCRIPT:
const NetaceaCloudFront = require('@netacea/cloudfront').default
// TYPESCRIPT:
import NetaceaCloudFront from '@netacea/cloudfront'
`

Then declare a variable for the worker.

` javascript
const worker = new NetaceaCloudFront({
apiKey: 'your-api-key', // REQUIRED
secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})
`

It's best security practice to not commit your apiKey, secretKey, kinesisAccessKey, kinesisSecretKey to any repository.

The code will run in the Viewer Request, Origin Response and Viewer Response events.

Example Viewer Request:

` javascript
import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
apiKey: 'your-api-key', // REQUIRED
secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise => {
context.callbackWaitsForEmptyEventLoop = false
const netaceaResponse = await worker.run(event)
const { request, response } = netaceaResponse.Records[0].cf
if (response !== undefined) {
return callback(null, response)
}
return callback(null, request)
}
`

Example Origin Response:

` javascript
import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
apiKey: 'your-api-key', // REQUIRED
secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise => {
context.callbackWaitsForEmptyEventLoop = false
if (event.Records[0].cf.response.status >= 400) {
worker.addNetaceaCookiesToResponse(event)
worker.ingest(event)
}
return callback(null, event.Records[0].cf.response)
}
`

Example Viewer Response:

` javascript
import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
apiKey: 'your-api-key', // REQUIRED
secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise => {
context.callbackWaitsForEmptyEventLoop = false
if (event.Records[0].cf.response.status < 400) {
worker.addNetaceaCookiesToResponse(event)
worker.ingest(event)
}
return callback(null, event.Records[0].cf.response)
}
`

This line is very important for ingest to take place.
Without this, latency will be added to some requests.

` javascript
context.callbackWaitsForEmptyEventLoop = false
`

⬆ Updating

`bash
npm i @netacea/cloudfront@latest --save
``

This will update the netacea module to the latest version.