Skip to content

Commit

Permalink
feat: Create Bun.sh adapter (#757)
Browse files Browse the repository at this point in the history
This creates an Arcjet SDK adapter for [bun.sh](https://bun.sh/). This was much the same as the Node.js adapter, but I needed to introduce a new API to the adapter: `aj.handler()`. This API is used to wrap the request handler (called `fetch()` in Bun) to do some preprocessing on the request—in this case looking up the IP with `server.requestIP(request)` before storing it in a WeakMap.

Users *could* use this without using the `aj.handler()` function, but they'd need to have a proper IP existing in the headers, such as the `Fly-Client-IP` on fly.io; however, those won't exist when running locally and the `protect()` call will error without using `aj.handler()`.

TODO:
- [x] Add to CI and dependabot
- [x] SDK Stack in protobuf
- [x] Examples

Closes #475
  • Loading branch information
blaine-arcjet authored May 17, 2024
1 parent c223ba0 commit 381dde5
Show file tree
Hide file tree
Showing 33 changed files with 1,347 additions and 1 deletion.
40 changes: 40 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,46 @@ updates:

# Dependencies in our examples

# Bun isn't supported by Dependabot so any changes to a Bun example require us
# to run `bun install` within the Dependabot branch to update the lockfile.
# Ref: https://github.com/dependabot/dependabot-core/issues/6528
- package-ecosystem: npm
directory: /examples/bun-hono-rl
schedule:
# Our dependencies should be checked daily
interval: daily
assignees:
- blaine-arcjet
reviewers:
- blaine-arcjet
commit-message:
prefix: deps(example)
prefix-development: deps(example)
groups:
dependencies:
patterns:
- "*"

# Bun isn't supported by Dependabot so any changes to a Bun example require us
# to run `bun install` within the Dependabot branch to update the lockfile.
# Ref: https://github.com/dependabot/dependabot-core/issues/6528
- package-ecosystem: npm
directory: /examples/bun-rl
schedule:
# Our dependencies should be checked daily
interval: daily
assignees:
- blaine-arcjet
reviewers:
- blaine-arcjet
commit-message:
prefix: deps(example)
prefix-development: deps(example)
groups:
dependencies:
patterns:
- "*"

- package-ecosystem: "npm"
directory: /examples/nextjs-14-app-dir-rl
schedule:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ find a specific one through the categories and descriptions below.

- [`@arcjet/next`](./arcjet-next/README.md): SDK for the Next.js framework.
- [`@arcjet/node`](./arcjet-node/README.md): SDK for Node.js.
- [`@arcjet/bun`](./arcjet-bun/README.md): SDK for Bun.sh.

### Analysis

Expand Down
6 changes: 6 additions & 0 deletions arcjet-bun/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/.turbo/
/coverage/
/node_modules/
*.d.ts
*.js
!*.config.js
4 changes: 4 additions & 0 deletions arcjet-bun/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
root: true,
extends: ["@arcjet/eslint-config"],
};
135 changes: 135 additions & 0 deletions arcjet-bun/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# Generated files
index.js
index.d.ts
test/*.js
Loading

0 comments on commit 381dde5

Please sign in to comment.