Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 3.96 KB

Contributing to Fingerprint Pro CloudFront Integration

Working with code

We prefer using pnpm for installing dependencies and running scripts.

For proposing changes, use the standard pull request approach. It's recommended to discuss fixes or new functionality in the Issues, first.

  • The main and rc branches are locked for the push action.
  • Releases are created from the main branch. If you have CloudFront Integration set up, it is running code from the main branch. Pull requests into the main branch are not accepted.
  • The rc branch functions as a candidate for the next release. Create your pull requests into this branch. The code in rc must always pass the tests.

How to build

  • After cloning the repository, run pnpm install to install dependencies.

  • Run pnpm build to build the project into the dist folder. The created dist/fingerprintjs-pro-cloudfront-lambda-function.js file is meant to be deployed to Lambda@Edge.

How to deploy to Lambda@Edge

  1. Install the AWS CLI and configure it according to the AWS CLI Guide.
  2. Create a Lambda function using the AWS Console. For the Lambda function for CloudFront distribution, you must create it in the us-east-1 region.
  3. Prepare a .zip archive that contains the built Lambda@Edge function (dist/fingerprintjs-pro-cloudfront-lambda-function.js).
  4. Run 
    aws lambda update-function-code --function-name <LAMBDA_FUNCTION_NAME> --region <AWS_REGION> --zip-file file://lambda.zip --publish

You can invoke the function from your local environment using the Invoke command in the AWS CLI, for example aws lambda invoke --function-name <LAMBDA_FUNCTION_NAME> --region <AWS_REGION> --invocation-type RequestResponse --payload <EVENT_JSON>, where the <EVENT_JSON> is the JSON you want to provide to your Lambda function as input. See examples of events here.

To deploy your function to your CloudFront distribution follow the Cloudfront Developer Guide.

Code style

Consistent code formatting is enforced by ESLint and Prettier. To check your code, run:

pnpm lint

You don't need to do this manually, CI runs the check automatically. To fix all auto-fixable issues at once, run:

pnpm lint:fix

Commit style

You are required to follow conventional commits rules.

How to test

End-to-end tests are written in playwright and pulumi and located in the e2e folder. These tests are run automatically by the deploy_test_branch.yml workflow on every PR automatically, you don't need to run them locally.

How to release a new version

Every PR should target rc branch first. Upon merge, if there are relevant changes a new release candidate is created. When that happens, an automated PR is created to main branch, and E2E tests run against it. If the tests pass, the PR can be merged and the release is created.

The integration is automatically released on every push to the main branch if there are relevant changes. The workflow must be approved by one of the maintainers, first.

How to keep your integration up-to-date

CloudFront Integration by Fingerprint always uses the latest stable version for the customers and keeps it up-to-date by using the management Lambda function created during the installation.