@arcjet/analyze

@arcjet/analyze

Arcjet helps developers protect their apps in just a few lines of code. Implement rate limiting, bot protection, email verification, and defense against common attacks.

This is the Arcjet local analysis engine.

Installation

npm install -S @arcjet/analyze

Example

import { generateFingerprint, isValidEmail } from "@arcjet/analyze";

const fingerprint = generateFingerprint("127.0.0.1");
console.log("fingerprint: ", fingerprint);

const valid = isValidEmail("[e-mail]");
console.log("is email valid?", valid);

Implementation

This package provides analyze logic implemented as a WebAssembly module which will run local analysis on request details before calling the Arcjet API.

The arcjet.wasm.js file contains the binary inlined as a base64 Data URL with the application/wasm MIME type.

This was chosen to save on storage space over inlining the file directly as a Uint8Array, which would take up ~3x the space of the Wasm file. See Better Binary Batter: Mixing Base64 and Uint8Array for more details.

It is then decoded into an ArrayBuffer to be used directly via WebAssembly's compile() function in our entry point file.

This is all done to avoid trying to read or bundle the Wasm asset in various ways based on the platform or bundler a user is targeting. One example being that Next.js requires special asyncWebAssembly webpack config to load our Wasm file if we don't do this.

In the future, we hope to do away with this workaround when all bundlers properly support consistent asset bundling techniques.

API

In progress.

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-alpha.28 (2024-10-23)

⚠ BREAKING CHANGES

• ip: Accept Request or IncomingMessage directly (#2018)
• ip: Exit early if platform-specific headers are missing IP (#2021)
• Ensure performance metrics are scoped to same call (#2019)
• Return ERROR decision when fingerprint cannot be generated (#1990)
• protocol: Remove received_at and decision fields from Report (#1988)
• analyze: improve sensitive info string token accuracy (#1962)
• Update Wasm with phone-number fix and tokenizer update (#1854)
• Remove match option from rate limit rules (#1815)

🚀 New Features

• Add Remix adapter (#1866) (32d6d41), closes #1313
• analyze: improve sensitive info string token accuracy (#1962) (abad1bd)
• ip: Accept Request or IncomingMessage directly (#2018) (1704da8), closes #1904
• ip: Add Vercel platform-specific IP header detection (#2022) (d886c76)
• nextjs: Support Next.js Server Actions (#1991) (07e68dc), closes #1200
• Use waitUntil for Report call if available (#1838) (2851021), closes #884

🪲 Bug Fixes

• arcjet: Ensure performance measurements are 1-to-1 and always captured (#1858) (4d29f9a)
• Ensure performance metrics are scoped to same call (#2019) (e9f869c), closes #1865
• ip: Exit early if platform-specific headers are missing IP (#2021) (1a13d9c)
• nestjs: Lookup request from GraphQL context in ArcjetGuard (#1857) (c0b2903), closes #1856
• Return ERROR decision when fingerprint cannot be generated (#1990) (618a1ee), closes #1801
• Update Wasm with phone-number fix and tokenizer update (#1854) (f94f078)

🧹 Miscellaneous Chores

• Add README links for new adapters (#1831) (81885d9), closes #1813
• analyze: Regenerate Wasm with updated dependencies (#2067) (f96994c)
• examples: Reorganize examples for clarity and decoupling from Next.js version (#2017) (8568bf2)
• examples: Various cleanup (#2066) (c626228)
• protocol: Remove received_at and decision fields from Report (#1988) (3da543e)
• Remove match option from rate limit rules (#1815) (853119d), closes #1810