├── .husky ├── pre-commit └── commit-msg ├── .npmignore ├── bun.lockb ├── commitlint.config.ts ├── eslint.config.js ├── .env.example ├── tsconfig.json ├── .github ├── renovate.json └── workflows │ └── release.yml ├── src ├── types.ts ├── utils.test.ts ├── utils.ts ├── index.ts ├── websocket.test.ts └── websocket.ts ├── .releaserc.json ├── package.json ├── .gitignore ├── CHANGELOG.md ├── README.md └── LICENSE /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | npx lint-staged 2 | -------------------------------------------------------------------------------- /.husky/commit-msg: -------------------------------------------------------------------------------- 1 | npm run commitlint "${1}" 2 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .github 2 | .husky 3 | .releaserc.json 4 | src 5 | -------------------------------------------------------------------------------- /bun.lockb: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephenjason89/bun-pulse/HEAD/bun.lockb -------------------------------------------------------------------------------- /commitlint.config.ts: -------------------------------------------------------------------------------- 1 | export default { extends: ['@commitlint/config-conventional'] } 2 | -------------------------------------------------------------------------------- /eslint.config.js: -------------------------------------------------------------------------------- 1 | // @ts-check 2 | import antfu from '@antfu/eslint-config' 3 | 4 | export default antfu( 5 | { 6 | stylistic: { 7 | indent: 'tab', 8 | }, 9 | rules: { 'no-console': 'off' }, 10 | }, 11 | ) 12 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | PUSHER_APP_ID=2ab7219d-01c7-430e-95d0-e32f66a49726 2 | PUSHER_APP_KEY=2ab7219d-01c7-430e-95d0-e32f66a49726 3 | PUSHER_APP_SECRET=5e7332SFslRDR2ku6hQQVw9wCM4eNmNnTZtf5AaxmsqRYBp4 4 | 5 | AXIOM_API_KEY=xaat-f067ae9f-4b84-4227-9b1b-21988fefacff 6 | AXIOM_DATASET=bun-pulse 7 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "esnext", 4 | "lib": ["ESNext"], 5 | "module": "esnext", 6 | "moduleResolution": "node", 7 | "declaration": true, 8 | "outDir": "./dist", 9 | "esModuleInterop": true, 10 | "skipLibCheck": true 11 | }, 12 | "include": ["src/**/*.ts"] 13 | } 14 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "timezone": "Asia/Manila", 3 | "configMigration": true, 4 | "extends": [ 5 | "config:recommended", 6 | "docker:pinDigests", 7 | "helpers:pinGitHubActionDigests", 8 | ":pinDevDependencies" 9 | ], 10 | "prHourlyLimit": 5, 11 | "schedule": ["before 3am on Monday"], 12 | "enabledManagers": ["npm", "bun"], 13 | "rangeStrategy": "bump", 14 | "updatePinnedDependencies": false, 15 | "packageRules": [ 16 | { 17 | "matchUpdateTypes": ["major", "pin"], 18 | "enabled": false 19 | }, 20 | { 21 | "groupName": "Bumped minor version of packages", 22 | "prHeader": "Bumped minor version of packages, check if builds are still passing.", 23 | "matchUpdateTypes": ["minor", "patch"], 24 | "matchDepTypes": ["dependencies", "devDependencies"] 25 | } 26 | ] 27 | } 28 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | export interface WebSocketData { 2 | createdAt: number 3 | channel: string 4 | auth: string 5 | socketId: string 6 | origin: string 7 | userAgent: string 8 | client: string 9 | version: string 10 | protocol: string 11 | lastPingPong?: number 12 | channel_data?: string | { 13 | user_id?: string 14 | user_info?: Record 15 | } 16 | [key: string]: any 17 | } 18 | 19 | export interface PusherEvent { 20 | name: string 21 | event: string 22 | channel: string 23 | data: WebSocketData 24 | } 25 | 26 | export const WebSocketReadyState = { CONNECTING: 0, OPEN: 1, CLOSING: 2, CLOSED: 3 } as const 27 | 28 | export interface Channels { 29 | [channel: string]: { 30 | [userId: string]: { 31 | user_info: Record 32 | sockets: Set 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/utils.test.ts: -------------------------------------------------------------------------------- 1 | import { describe, expect, it } from 'bun:test' 2 | import { generateHmacSHA256HexDigest, generateSocketId } from './utils' 3 | 4 | // Test Suite 5 | describe('Utility Functions Tests', () => { 6 | // Test the generateSocketId function 7 | it('should generate a valid socket ID', () => { 8 | const socketId = generateSocketId() 9 | expect(socketId).toMatch(/\d+\.\d+/) // Validate socket ID format 10 | }) 11 | 12 | // Test the generateHmacSHA256HexDigest function 13 | it('should generate a valid HMAC SHA-256 hex digest', () => { 14 | const socketIdChannel = 'test-socket-id:test-channel' 15 | const secret = 'test-secret' 16 | const digest = generateHmacSHA256HexDigest(socketIdChannel, secret) 17 | expect(digest).toHaveLength(64) // Validate the length of the SHA-256 hex digest 18 | expect(digest).toMatch(/^[a-f0-9]+$/) // Validate the format (hex characters) 19 | }) 20 | }) 21 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Semantic Release 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | - develop 8 | schedule: 9 | - cron: 0 16 * * 0 # Weekly pre-releases at midnight Monday GMT+8 10 | workflow_dispatch: 11 | 12 | jobs: 13 | release: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v4 18 | 19 | - name: Setup Node.js 20 | uses: actions/setup-node@v4 21 | with: 22 | node-version: 20 23 | 24 | - name: Setup bun 25 | uses: oven-sh/setup-bun@v1 26 | with: 27 | bun-version: latest 28 | 29 | - uses: actions/cache@v4 30 | name: Setup bun cache 31 | with: 32 | path: ~/.bun/install/cache 33 | key: "${{ runner.os }}-${{ hashFiles('**/bun.lockb') }}" 34 | restore-keys: | 35 | ${{ runner.os }}- 36 | 37 | - name: Install Project Dependencies 38 | run: bun install 39 | 40 | - name: Run semantic-release 41 | run: HUSKY=0 bunx semantic-release 42 | env: 43 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 44 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 45 | -------------------------------------------------------------------------------- /.releaserc.json: -------------------------------------------------------------------------------- 1 | { 2 | "repositoryUrl": "git@github.com:stephenjason89/bun-pulse.git", 3 | "branches": ["main", { "name": "develop", "prerelease": "beta" }], 4 | "plugins": [ 5 | "@semantic-release/commit-analyzer", 6 | [ 7 | "@semantic-release/release-notes-generator", 8 | { 9 | "preset": "conventionalcommits", 10 | "presetConfig": { 11 | "types": [ 12 | { "type": "feat", "section": "🚀 Features" }, 13 | { "type": "fix", "section": "🐛 Bug Fixes" }, 14 | { "type": "perf", "section": "⚡ Performance" }, 15 | { "type": "chore", "section": "📦 Chores" }, 16 | { "type": "docs", "section": "📚 Documentation" }, 17 | { "type": "style", "section": "💄 Code Style" }, 18 | { "type": "refactor", "section": "🛠️ Refactoring" }, 19 | { "type": "test", "section": "✅ Testing" }, 20 | { "type": "revert", "section": "⏪ Reverts" } 21 | ] 22 | } 23 | } 24 | ], 25 | "@semantic-release/changelog", 26 | "@semantic-release/github", 27 | [ 28 | "@semantic-release/git", 29 | { 30 | "assets": ["CHANGELOG.md", "package.json"], 31 | "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" 32 | } 33 | ], 34 | "@semantic-release/npm" 35 | ] 36 | } 37 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | import type { Channels } from './types' 2 | import { Axiom } from '@axiomhq/js' 3 | import { CryptoHasher } from 'bun' 4 | import { createConsola } from 'consola' 5 | 6 | // Simple utility to generate unique socket ID 7 | export function generateSocketId() { 8 | return `${Math.floor(Date.now() % 1e9)}.${Math.floor(Math.random() * 1e9)}` 9 | } 10 | 11 | // Generates a HMAC SHA-256 hex digest for the given message and secret. 12 | export function generateHmacSHA256HexDigest(socketIdChannel: string, secret: string): string { 13 | const hmac = new CryptoHasher('sha256', secret) 14 | hmac.update(socketIdChannel) 15 | return hmac.digest('hex') 16 | } 17 | 18 | export const messageLogger = createConsola({ 19 | fancy: true, 20 | formatOptions: { 21 | colors: true, 22 | compact: false, 23 | }, 24 | }) 25 | 26 | const axiomClient = import.meta.env.AXIOM_API_KEY && new Axiom({ 27 | token: import.meta.env.AXIOM_API_KEY, 28 | }) 29 | 30 | export const axiom = ({ 31 | log: (event: string, data: object) => { 32 | if (!axiomClient) 33 | return 34 | axiomClient.ingest(import.meta.env.AXIOM_DATASET ?? 'bun-pulse', [{ ...data, $event: event }]) 35 | }, 36 | }) 37 | 38 | export const getChannelConnections = (channel: string, channels: Channels): number => Object.values(channels[channel] ?? {}).reduce((total, { sockets }) => total + sockets.size, 0) 39 | export const getChannelType = (channel: string) => (['presence-', 'private-', 'public-']).find(prefix => channel.startsWith(prefix))?.slice(0, -1) || 'unknown' 40 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "bun-pulse", 3 | "type": "module", 4 | "version": "1.5.0", 5 | "description": "BunPulse is a lightweight, high-performance WebSocket server built on Bun, fully compatible with the Pusher protocol. Easily implement real-time communication for your applications with minimal setup.", 6 | "author": "Stephen Jason Wang", 7 | "license": "AGPL-3.0", 8 | "homepage": "https://github.com/stephenjason89/bun-pulse#readme", 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/stephenjason89/bun-pulse.git" 12 | }, 13 | "bugs": { 14 | "url": "https://github.com/stephenjason89/bun-pulse/issues" 15 | }, 16 | "keywords": [ 17 | "bun", 18 | "pusher", 19 | "websocket", 20 | "real-time", 21 | "pusher-protocol", 22 | "server", 23 | "bun-websocket", 24 | "pusher-alternative", 25 | "realtime-communication", 26 | "pubsub", 27 | "push-notifications" 28 | ], 29 | "main": "dist/index.js", 30 | "files": [ 31 | "dist" 32 | ], 33 | "scripts": { 34 | "test": "bun test", 35 | "build": "tsc", 36 | "prepublishOnly": "npm run build", 37 | "prepare": "husky", 38 | "commitlint": "commitlint --edit" 39 | }, 40 | "dependencies": { 41 | "@axiomhq/js": "^1.2.0", 42 | "consola": "^3.2.3" 43 | }, 44 | "devDependencies": { 45 | "@antfu/eslint-config": "^3.7.3", 46 | "@commitlint/cli": "^19.5.0", 47 | "@commitlint/config-conventional": "^19.5.0", 48 | "@semantic-release/changelog": "^6.0.3", 49 | "@semantic-release/commit-analyzer": "^13.0.0", 50 | "@semantic-release/git": "^10.0.1", 51 | "@semantic-release/github": "^11.0.0", 52 | "@semantic-release/npm": "^12.0.1", 53 | "@semantic-release/release-notes-generator": "^14.0.1", 54 | "@types/bun": "^1.1.11", 55 | "conventional-changelog-conventionalcommits": "^8.0.0", 56 | "eslint": "^9.11.1", 57 | "husky": "^9.1.6", 58 | "lint-staged": "^15.2.10" 59 | }, 60 | "lint-staged": { 61 | "*.{js,cjs,mjs,ts,jsx,json,json5,tsx,vue,md}": "eslint --fix" 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import type { ServeOptions, ServerWebSocket } from 'bun' 2 | import type { WebSocketData } from './types' 3 | import { consola } from 'consola' 4 | import { axiom } from './utils' 5 | import { 6 | handleEventPublishing, 7 | handleWebSocketMessage, 8 | handleWebSocketUpgrade, 9 | initializeWebSocketConnection, 10 | unsubscribeFromChannel, 11 | } from './websocket' 12 | 13 | interface BunPulseConfig { 14 | subscriptionVacancyUrl?: string 15 | heartbeat?: { 16 | interval?: number 17 | timeout?: number 18 | sendPing?: boolean 19 | } 20 | } 21 | 22 | export function startBunPulse(config: BunPulseConfig & Partial = { port: 6001 }) { 23 | const { subscriptionVacancyUrl, heartbeat = {}, ...serverOptions } = config 24 | const finalHeartbeat = { interval: 25000, timeout: 60000, sendPing: false, ...heartbeat } 25 | 26 | const server = Bun.serve({ 27 | ...serverOptions, 28 | fetch(req, server) { 29 | if (req.method === 'POST') { 30 | return handleEventPublishing(req, server) 31 | } 32 | return handleWebSocketUpgrade(req, server) 33 | }, 34 | websocket: { 35 | message(ws: ServerWebSocket, message) { 36 | handleWebSocketMessage(ws, message, server, subscriptionVacancyUrl) 37 | }, 38 | open: (ws) => { 39 | initializeWebSocketConnection(ws, finalHeartbeat) 40 | axiom.log('pusher_connection:open', { 41 | app: { id: import.meta.env.PUSHER_APP_ID }, 42 | connection: { socketId: ws.data.socketId, origin: ws.data.origin, userAgent: ws.data.userAgent, client: ws.data.client, version: ws.data.version, protocol: ws.data.protocol }, 43 | }) 44 | }, 45 | close(ws, code, reason) { 46 | consola.info(`Connection closed for Socket ID: ${ws.data.socketId}, Channel: ${ws.data.channel || 'No channel'}`) 47 | unsubscribeFromChannel(ws, ws.data.channel, server, subscriptionVacancyUrl) 48 | axiom.log('pusher_connection:close', { 49 | app: { id: import.meta.env.PUSHER_APP_ID }, 50 | close: { code, reason }, 51 | connection: { socketId: ws.data.socketId, duration: Date.now() - ws.data.createdAt }, 52 | }) 53 | }, 54 | }, 55 | }) 56 | consola.success(`WebSocket server listening on ${server.hostname}:${server.port}`) 57 | } 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Laravel files 2 | /storage/*.key 3 | /storage/app/public 4 | /storage/debugbar 5 | .phpunit.result.cache 6 | Homestead.json 7 | Homestead.yaml 8 | 9 | # Nuxt Files 10 | /public/dist 11 | 12 | # Playwright 13 | playwright 14 | 15 | # Package Manager logs 16 | npm-debug.log* 17 | yarn-debug.log* 18 | yarn-error.log* 19 | 20 | # IDE helpers 21 | .phpstorm.meta.php 22 | *ide_helper* 23 | 24 | # Unique secure certificates for laravel passport 25 | .rnd 26 | 27 | # Php cs fixer cache 28 | .php-cs-fixer.cache 29 | 30 | # Log files 31 | **/logs 32 | *.log 33 | 34 | # Runtime data 35 | pids 36 | *.pid 37 | *.seed 38 | *.pid.lock 39 | 40 | # Directory for instrumented libs generated by jscoverage/JSCover 41 | lib-cov 42 | 43 | # Coverage directory used by tools like istanbul 44 | coverage 45 | 46 | # nyc test coverage 47 | .nyc_output 48 | 49 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 50 | .grunt 51 | 52 | # Bower dependency directory (https://bower.io/) 53 | bower_components 54 | 55 | # node-waf configuration 56 | .lock-wscript 57 | 58 | # Compiled binary addons (https://nodejs.org/api/addons.html) 59 | build/Release 60 | 61 | # Dependency directories 62 | **/node_modules 63 | **/vendor 64 | jspm_packages/ 65 | 66 | # TypeScript v1 declaration files 67 | typings/ 68 | 69 | # Optional npm cache directory 70 | .npm 71 | 72 | # Optional eslint cache 73 | .eslintcache 74 | 75 | # Optional REPL history 76 | .node_repl_history 77 | 78 | # Output of 'npm pack' 79 | *.tgz 80 | 81 | # Yarn Integrity file 82 | .yarn-integrity 83 | 84 | # dotenv environment variables file 85 | .env 86 | .env.backup 87 | 88 | # parcel-bundler cache (https://parceljs.org/) 89 | .cache 90 | 91 | # next.js build output 92 | .next 93 | 94 | # nuxt.js build output 95 | .nuxt 96 | _nuxt 97 | .output 98 | 99 | # Nuxt generate 100 | dist 101 | out 102 | 103 | # vuepress build output 104 | .vuepress/dist 105 | 106 | # Serverless directories 107 | .serverless 108 | 109 | # IDE / Editor 110 | .idea 111 | 112 | # Service worker 113 | sw.* 114 | 115 | # macOS 116 | .DS_Store 117 | 118 | # Vim swap files 119 | *.swp 120 | 121 | # Android Capacitor 122 | android 123 | 124 | # IOS Capacitor 125 | ios 126 | 127 | # Lighthouse 128 | programmatic-types.graphql 129 | schema-directives.graphql 130 | _lighthouse_ide_helper.php 131 | 132 | # Vue styleguide 133 | public/styleguide 134 | 135 | # Auto imported components path 136 | .components.gen.js 137 | 138 | # Yarn Berry 139 | .pnp.* 140 | .yarn/* 141 | !.yarn/patches 142 | !.yarn/plugins 143 | !.yarn/releases 144 | !.yarn/sdks 145 | !.yarn/versions 146 | 147 | # VS code 148 | .vscode 149 | .history 150 | /test-results/ 151 | /playwright-report/ 152 | /blob-report/ 153 | /playwright/.cache/ 154 | \nplaywright/.auth 155 | 156 | /caddy 157 | frankenphp 158 | frankenphp-worker.php 159 | rr 160 | .rr.yaml 161 | -------------------------------------------------------------------------------- /src/websocket.test.ts: -------------------------------------------------------------------------------- 1 | import { beforeEach, describe, expect, it, mock, spyOn } from 'bun:test' 2 | import { handleEventPublishing, handleWebSocketMessage, initializeWebSocketConnection } from './websocket' 3 | import * as websocketModule from './websocket' 4 | 5 | describe('BunPulse WebSocket Tests', () => { 6 | beforeEach(() => { 7 | spyOn(websocketModule, 'isAuthorized').mockImplementation(() => true) 8 | }) 9 | 10 | // Test WebSocket Connection Initialization 11 | it('should send connection established message and start heartbeat', () => { 12 | const wsMock = { 13 | send: mock(() => {}), 14 | data: { socketId: 'socket-123' }, 15 | readyState: 1, 16 | close: mock(() => {}), 17 | } 18 | 19 | const heartbeat = { interval: 25000, timeout: 60000, sendPing: true } 20 | 21 | initializeWebSocketConnection(wsMock as any, heartbeat) 22 | 23 | expect(wsMock.send).toHaveBeenCalledWith(JSON.stringify({ 24 | event: 'pusher:connection_established', 25 | data: JSON.stringify({ socket_id: 'socket-123', activity_timeout: 25 }), 26 | })) 27 | expect(wsMock.send).toHaveBeenCalledTimes(1) 28 | }) 29 | 30 | // Test WebSocket Message Handling (ping-pong) 31 | it('should handle pusher:ping and respond with pusher:pong', () => { 32 | const wsMock = { 33 | send: mock(() => {}), 34 | data: { socketId: 'socket-123', lastPingPong: Date.now() }, 35 | } 36 | 37 | handleWebSocketMessage(wsMock as any, JSON.stringify({ event: 'pusher:ping' }), {} as any, '') 38 | 39 | expect(wsMock.send).toHaveBeenCalledWith(JSON.stringify({ event: 'pusher:pong' })) 40 | expect(wsMock.send).toHaveBeenCalledTimes(1) 41 | }) 42 | 43 | // Test WebSocket Subscription Handling 44 | it('should handle pusher:subscribe', () => { 45 | const wsMock = { 46 | send: mock(() => {}), 47 | close: mock(() => {}), 48 | data: { socketId: 'socket-123' }, 49 | subscribe: mock(() => {}), 50 | } 51 | 52 | const mockServer = { 53 | publish: mock(() => {}), 54 | } 55 | 56 | handleWebSocketMessage( 57 | wsMock as any, 58 | JSON.stringify({ 59 | event: 'pusher:subscribe', 60 | data: { channel: 'test-channel' }, 61 | }), 62 | mockServer as any, 63 | '', 64 | ) 65 | 66 | expect(wsMock.subscribe).toHaveBeenCalledWith('test-channel') 67 | expect(mockServer.publish).toHaveBeenCalledWith('test-channel', JSON.stringify({ 68 | event: 'pusher_internal:subscription_succeeded', 69 | channel: 'test-channel', 70 | })) 71 | }) 72 | 73 | // Test Event Publishing 74 | it('should publish an event successfully', async () => { 75 | const reqMock = { 76 | json: mock(async () => ({ 77 | name: 'my-event', 78 | channel: 'my-channel', 79 | data: { message: 'Hello World' }, 80 | })), 81 | } 82 | 83 | const serverMock = { 84 | publish: mock(() => {}), 85 | } 86 | 87 | const res = await handleEventPublishing(reqMock as any, serverMock as any) 88 | 89 | expect(serverMock.publish).toHaveBeenCalledWith( 90 | 'my-channel', 91 | JSON.stringify({ 92 | event: 'my-event', 93 | channel: 'my-channel', 94 | data: { message: 'Hello World' }, 95 | }), 96 | ) 97 | 98 | expect(res.status).toBe(200) 99 | }) 100 | }) 101 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## [1.5.1](https://github.com/stephenjason89/bun-pulse/compare/v1.5.0...v1.5.1) (2024-12-03) 2 | 3 | ### 🐛 Bug Fixes 4 | 5 | * disable axiomClient gracefully when no API key is provided ([ada6e53](https://github.com/stephenjason89/bun-pulse/commit/ada6e531ffda723f6f1cba9fd4e172880c2e6732)) 6 | 7 | ### 📦 Chores 8 | 9 | * include .env.example and support AXIOM_DATASET customization ([6bbfed3](https://github.com/stephenjason89/bun-pulse/commit/6bbfed32185c6532ae2392386c528179dd916c05)) 10 | * **release:** 1.5.1-beta.1 [skip ci] ([8d2d7ad](https://github.com/stephenjason89/bun-pulse/commit/8d2d7ad5c287becb779b5d7f174b5b307af0613f)) 11 | * updated releaserc ([110b1b8](https://github.com/stephenjason89/bun-pulse/commit/110b1b83e80faf3d255d23c09ead137ed73bf4be)) 12 | 13 | ## [1.5.1-beta.1](https://github.com/stephenjason89/bun-pulse/compare/v1.5.0...v1.5.1-beta.1) (2024-12-03) 14 | 15 | ### 🐛 Bug Fixes 16 | 17 | * disable axiomClient gracefully when no API key is provided ([ada6e53](https://github.com/stephenjason89/bun-pulse/commit/ada6e531ffda723f6f1cba9fd4e172880c2e6732)) 18 | 19 | ### 📦 Chores 20 | 21 | * include .env.example and support AXIOM_DATASET customization ([6bbfed3](https://github.com/stephenjason89/bun-pulse/commit/6bbfed32185c6532ae2392386c528179dd916c05)) 22 | * updated releaserc ([110b1b8](https://github.com/stephenjason89/bun-pulse/commit/110b1b83e80faf3d255d23c09ead137ed73bf4be)) 23 | 24 | # [1.5.0](https://github.com/stephenjason89/bun-pulse/compare/v1.4.0...v1.5.0) (2024-11-07) 25 | 26 | 27 | ### Bug Fixes 28 | 29 | * fire `channel_vacated` webhook solely for empty presence channels ([4ec5954](https://github.com/stephenjason89/bun-pulse/commit/4ec5954216c6f9f6e755d90b990f000e1ebe1283)) 30 | * update subscription logic to trigger notifyChannelVacancy for empty public and private channels ([e0e09ae](https://github.com/stephenjason89/bun-pulse/commit/e0e09ae517a30a080842c3ea0fbcdd06a7cdd1aa)) 31 | 32 | 33 | ### Features 34 | 35 | * add signature authentication to notifyChannelVacancy webhook ([d89be6d](https://github.com/stephenjason89/bun-pulse/commit/d89be6dc3987b53617c17c1969fa9cb663e72ccb)) 36 | * added Bun.serve options support to startBunPulse ([145f8f8](https://github.com/stephenjason89/bun-pulse/commit/145f8f81ce7e86c4336baba7092457dcf9dfe9c7)) 37 | * implement delay for channel vacated webhook ([7812a99](https://github.com/stephenjason89/bun-pulse/commit/7812a9932a2873b4a745324025df935d5c2e7876)) 38 | * implemented presence channel ([a6657d0](https://github.com/stephenjason89/bun-pulse/commit/a6657d0a4a42a5cfd3b1ec976c9cb87ea54a7803)) 39 | * initial implementation of WebSocket server with Pusher protocol support ([1736228](https://github.com/stephenjason89/bun-pulse/commit/173622816bfc3bf85d775ebdb90ab073c7ba64c1)) 40 | * integrate axiom logging for webSocket events ([3aafcf3](https://github.com/stephenjason89/bun-pulse/commit/3aafcf36dc68f8af273dfc40231c8b5e634e466a)) 41 | * support multiple connections per user in presence channels ([71b9678](https://github.com/stephenjason89/bun-pulse/commit/71b96785408563d27320550e41d3fee245dcbb92)) 42 | * supported public channels ([858e40d](https://github.com/stephenjason89/bun-pulse/commit/858e40d8adb7528b7200ae5e3415223c601bbf04)) 43 | * used bun CryptoHasher instead of node:crypto alternative ([0375ad5](https://github.com/stephenjason89/bun-pulse/commit/0375ad521393ee355d54d8e1e4ec5205793ff012)) 44 | * **utils:** add utilities for generating socket IDs, HMAC SHA-256 hex digests, & consola message logger ([45b1573](https://github.com/stephenjason89/bun-pulse/commit/45b157345e66bd2edc1fc64dc61f2b11b2fdd143)) 45 | -------------------------------------------------------------------------------- /src/websocket.ts: -------------------------------------------------------------------------------- 1 | import type { Server, ServerWebSocket } from 'bun' 2 | import type { Buffer } from 'node:buffer' 3 | import type { Channels, PusherEvent, WebSocketData } from './types' 4 | import { consola } from 'consola' 5 | import { WebSocketReadyState } from './types' 6 | import { 7 | axiom, 8 | generateHmacSHA256HexDigest, 9 | generateSocketId, 10 | getChannelConnections, 11 | getChannelType, 12 | messageLogger, 13 | } from './utils' 14 | 15 | const channels: Channels = {} 16 | const pendingVacatedWebhookTimeouts: Record = {} 17 | 18 | // Initializes a WebSocket connection with heartbeat settings 19 | export function initializeWebSocketConnection(ws: ServerWebSocket, heartbeat: { interval: number, timeout: number, sendPing: boolean }) { 20 | const connectionData = { 21 | event: 'pusher:connection_established', 22 | data: JSON.stringify({ socket_id: ws.data.socketId, activity_timeout: heartbeat.interval / 1000 }), 23 | } 24 | ws.send(JSON.stringify(connectionData)) 25 | consola.success(`Connection Established - Socket ID: ${ws.data.socketId}`) 26 | ws.data.lastPingPong = Date.now() 27 | 28 | const heartbeatInterval = setInterval(() => { 29 | if (ws.readyState === WebSocketReadyState.OPEN) { 30 | if (Date.now() - (ws.data.lastPingPong ?? 0) > heartbeat.timeout) { 31 | consola.warn(`Heartbeat Timeout - Socket ID: ${ws.data.socketId}, Closing connection`) 32 | ws.close() 33 | clearInterval(heartbeatInterval) 34 | } 35 | else if (heartbeat.sendPing) { 36 | ws.send(JSON.stringify({ event: 'pusher:ping' })) 37 | } 38 | } 39 | else { 40 | clearInterval(heartbeatInterval) 41 | } 42 | }, heartbeat.interval) 43 | } 44 | 45 | // Handles WebSocket upgrade requests 46 | export async function handleWebSocketUpgrade(req: Request, server: Server) { 47 | const url = req.url 48 | const urlParams = new URLSearchParams(url.split('?')[1]) 49 | 50 | const success = server.upgrade(req, { 51 | data: { 52 | createdAt: Date.now(), 53 | channel: '', 54 | auth: '', 55 | socketId: generateSocketId(), 56 | origin: req.headers.get('Origin') || 'N/A', 57 | userAgent: req.headers.get('User-Agent') || 'N/A', 58 | client: urlParams.get('client') || 'N/A', 59 | version: urlParams.get('version') || 'N/A', 60 | protocol: urlParams.get('protocol') || 'N/A', 61 | }, 62 | }) 63 | 64 | if (success) { 65 | consola.info(`WebSocket upgrade successful for ${url}`) 66 | return undefined // Bun handles the 101 Switching Protocols response 67 | } 68 | else { 69 | consola.error(`WebSocket upgrade failed for ${url}`) 70 | return new Response('{}', { headers: { 'Content-Type': 'application/json' } }) 71 | } 72 | } 73 | 74 | // Handles incoming WebSocket messages 75 | export function handleWebSocketMessage(ws: ServerWebSocket, message: string | Buffer, server: Server, subscriptionVacancyUrl: string) { 76 | try { 77 | consola.info(`Message Received - Socket ID: ${ws.data.socketId}`) 78 | const messageObj = JSON.parse(String(message)) as Omit 79 | messageLogger.box(messageObj) 80 | 81 | switch (messageObj.event) { 82 | case 'pusher:ping': 83 | ws.send(JSON.stringify({ event: 'pusher:pong' })) 84 | ws.data.lastPingPong = Date.now() 85 | break 86 | case 'pusher:pong': 87 | ws.data.lastPingPong = Date.now() 88 | break 89 | case 'pusher:subscribe': 90 | subscribeToChannel(ws, messageObj.data, server) 91 | break 92 | case 'pusher:unsubscribe': 93 | unsubscribeFromChannel(ws, messageObj.data.channel, server, subscriptionVacancyUrl) 94 | break 95 | default: 96 | consola.error(`Unhandled Event - Event: ${messageObj.event}`) 97 | } 98 | } 99 | catch (error) { 100 | consola.error(`Message Handling Error - ${error.message}`) 101 | } 102 | } 103 | 104 | // Handles event publishing for POST requests 105 | export async function handleEventPublishing(req: Request, server: Server) { 106 | try { 107 | const body = (await req.json()) as PusherEvent 108 | const eventData = { event: body.name, channel: body.channel, data: body.data } 109 | const startTime = Date.now() 110 | server.publish(body.channel, JSON.stringify(eventData)) 111 | 112 | axiom.log('pusher_channel:broadcast', { 113 | app: { id: import.meta.env.PUSHER_APP_ID }, 114 | channel: { name: body.channel, type: getChannelType(body.channel) }, 115 | broadcast: { 116 | event: body.name, 117 | sockedId: body.data.socketId, 118 | duration: Date.now() - startTime, 119 | connections: getChannelConnections(body.channel, channels), 120 | }, 121 | }) 122 | 123 | consola.success(`Event Published - Channel: ${body.channel}, Event: ${body.name}`) 124 | return new Response('{}', { headers: { 'Content-Type': 'application/json' } }) 125 | } 126 | catch (error) { 127 | consola.error(`Event Publishing Error - ${error.message}`) 128 | return new Response('Internal Server Error', { status: 500 }) 129 | } 130 | } 131 | 132 | // Subscribes the WebSocket to a channel 133 | function subscribeToChannel(ws: ServerWebSocket, subscriptionData: WebSocketData, server: Server) { 134 | const isRestrictedChannel = /^(?:private-|presence-)/.test(subscriptionData.channel) 135 | const isPresenceChannel = getChannelType(subscriptionData.channel) === 'presence' 136 | 137 | if (isRestrictedChannel && !isAuthorized(ws.data.socketId, subscriptionData)) { 138 | ws.send( 139 | JSON.stringify({ 140 | event: 'pusher:error', 141 | data: { 142 | message: 'Unauthorized', 143 | code: 4009, 144 | }, 145 | }), 146 | ) 147 | ws.close() 148 | consola.warn(`Unauthorized Access - Socket ID: ${ws.data.socketId}`) 149 | return 150 | } 151 | 152 | Object.assign(ws.data, subscriptionData) 153 | ws.subscribe(subscriptionData.channel) 154 | 155 | const channelData: Extract = typeof ws.data.channel_data === 'string' 156 | ? JSON.parse(ws.data.channel_data || '{}') 157 | : (ws.data.channel_data ?? {}) 158 | const user_id = channelData.user_id 159 | const user_info = channelData.user_info || {} 160 | 161 | // Ensure user_id is present for presence channels 162 | if (isPresenceChannel && !user_id) { 163 | ws.send(JSON.stringify({ 164 | event: 'pusher:error', 165 | data: { message: 'Missing user_id for presence channel', code: 4009 }, 166 | })) 167 | ws.close() 168 | return 169 | } 170 | 171 | if (!channels[subscriptionData.channel]) { 172 | channels[subscriptionData.channel] = {} 173 | } 174 | 175 | const user = channels[subscriptionData.channel][user_id ?? 'guest'] 176 | 177 | if (user) { 178 | // Add this socket to the user's existing connections 179 | user.sockets.add(ws.data.socketId) 180 | } 181 | else { 182 | // New user for this channel 183 | channels[subscriptionData.channel][user_id ?? 'guest'] = { user_info, sockets: new Set([ws.data.socketId]) } 184 | 185 | // Notify all members of the new member joining 186 | if (isPresenceChannel) { 187 | const startTime = Date.now() 188 | server.publish(subscriptionData.channel, JSON.stringify({ 189 | event: 'pusher_internal:member_added', 190 | channel: subscriptionData.channel, 191 | data: JSON.stringify({ user_id, user_info }), 192 | })) 193 | axiom.log('pusher_channel:broadcast', { 194 | app: { id: import.meta.env.PUSHER_APP_ID }, 195 | channel: { name: subscriptionData.channel, type: getChannelType(subscriptionData.channel) }, 196 | broadcast: { 197 | event: 'pusher_internal:member_added', 198 | sockedId: subscriptionData.socketId, 199 | duration: Date.now() - startTime, 200 | connections: getChannelConnections(subscriptionData.channel, channels), 201 | }, 202 | }) 203 | } 204 | } 205 | 206 | // Send the initial list of users to the new member 207 | const members = isPresenceChannel ? Object.values(channels[subscriptionData.channel]).map(({ user_info }, user_id) => ({ user_id, user_info })) : undefined 208 | 209 | ws.send(JSON.stringify({ 210 | event: 'pusher_internal:subscription_succeeded', 211 | channel: subscriptionData.channel, 212 | ...(isPresenceChannel && { data: JSON.stringify({ 213 | presence: { 214 | count: members.length, 215 | ids: members.map(m => m.user_id), 216 | hash: members.reduce((acc, m) => ({ ...acc, [m.user_id]: m.user_info }), {}), 217 | }, 218 | }) }), 219 | })) 220 | 221 | consola.success(`Subscribed - Socket ID: ${ws.data.socketId}, Channel: ${subscriptionData.channel}`) 222 | } 223 | 224 | // Unsubscribes the WebSocket from a channel 225 | export function unsubscribeFromChannel(ws: ServerWebSocket, channel: string, server: Server, subscriptionVacancyUrl: string) { 226 | if (!channel) 227 | return 228 | ws.unsubscribe(channel) 229 | consola.info(`Unsubscribed - Socket ID: ${ws.data.socketId}, Channel: ${channel}`) 230 | 231 | const user_id = Object.keys(channels[channel]).find(id => channels[channel][id].sockets.has(ws.data.socketId)) 232 | 233 | if (user_id) { 234 | const user = channels[channel][user_id] 235 | user.sockets.delete(ws.data.socketId) 236 | 237 | // If no more sockets for this user_id, remove user and fire `member_removed` 238 | if (user.sockets.size === 0) { 239 | delete channels[channel][user_id] 240 | if (getChannelType(channel) === 'presence') { 241 | const startTime = Date.now() 242 | server.publish(channel, JSON.stringify({ 243 | event: 'pusher_internal:member_removed', 244 | channel, 245 | data: JSON.stringify({ user_id }), 246 | })) 247 | axiom.log('pusher_channel:broadcast', { 248 | app: { id: import.meta.env.PUSHER_APP_ID }, 249 | channel: { name: channel, type: getChannelType(channel) }, 250 | broadcast: { 251 | event: 'pusher_internal:member_removed', 252 | sockedId: ws.data.socketId, 253 | duration: Date.now() - startTime, 254 | connections: getChannelConnections(channel, channels), 255 | }, 256 | }) 257 | } 258 | 259 | // If the channel is now empty, trigger the vacancy notification 260 | if (Object.keys(channels[channel]).length === 0) { 261 | delete channels[channel] 262 | if (subscriptionVacancyUrl) { 263 | notifyChannelVacancy(channel, subscriptionVacancyUrl) 264 | } 265 | } 266 | } 267 | } 268 | } 269 | 270 | // Notifies that a channel has been vacated 271 | async function notifyChannelVacancy(channel: string, subscriptionVacancyUrl: string, retries = 3, delay = 1000) { 272 | const payload = JSON.stringify({ events: [{ name: 'channel_vacated', channel }] }) 273 | 274 | // Check if PUSHER_APP_SECRET and PUSHER_APP_KEY are defined 275 | const secret = import.meta.env.PUSHER_APP_SECRET 276 | const appKey = import.meta.env.PUSHER_APP_KEY 277 | 278 | if (!secret || !appKey) { 279 | consola.error('Missing PUSHER_APP_SECRET or PUSHER_APP_KEY. Skipping webhook notification.') 280 | return 281 | } 282 | 283 | // Clear any existing pending webhook for this channel to avoid duplicate requests 284 | if (pendingVacatedWebhookTimeouts[channel]) { 285 | clearTimeout(pendingVacatedWebhookTimeouts[channel]) 286 | delete pendingVacatedWebhookTimeouts[channel] 287 | } 288 | 289 | // Set up a delayed webhook notification 290 | pendingVacatedWebhookTimeouts[channel] = setTimeout(async () => { 291 | for (let attempt = 0; attempt <= retries; attempt++) { 292 | try { 293 | const response = await fetch(subscriptionVacancyUrl, { 294 | method: 'POST', 295 | headers: { 296 | 'Content-Type': 'application/json', 297 | 'X-Pusher-Signature': generateHmacSHA256HexDigest(payload, secret), 298 | 'X-Pusher-Key': appKey, 299 | }, 300 | body: payload, 301 | }) 302 | 303 | if (response.ok) { 304 | consola.success(`Channel Vacated - Channel: ${channel}`) 305 | delete pendingVacatedWebhookTimeouts[channel] 306 | return 307 | } 308 | else { 309 | const errorText = await response.text() 310 | consola.error(`Channel Vacancy Error - Status: ${response.status}, Error: ${errorText}`) 311 | 312 | if (response.status >= 400 && response.status < 500) { 313 | // Do not retry for 4xx errors (client-side) 314 | consola.error('Client error occurred, not retrying...') 315 | break 316 | } 317 | } 318 | } 319 | catch (error) { 320 | consola.error(`Vacancy Notification Error - Channel: ${channel}, Attempt: ${attempt + 1}, Error: ${error.message}`) 321 | } 322 | 323 | // Retry with exponential backoff 324 | const backoffTime = delay * 2 ** attempt 325 | consola.info(`Retrying in ${backoffTime}ms...`) 326 | await new Promise(resolve => setTimeout(resolve, backoffTime)) 327 | } 328 | 329 | consola.error(`Failed to notify channel vacancy after ${retries + 1} attempts - Channel: ${channel}`) 330 | delete pendingVacatedWebhookTimeouts[channel] 331 | }, 1000) 332 | } 333 | 334 | // Authorizes WebSocket connections 335 | export function isAuthorized(socketId: string, data: WebSocketData): boolean { 336 | const sha256 = generateHmacSHA256HexDigest(`${socketId}:${data.channel}`, String(import.meta.env.PUSHER_APP_SECRET)) 337 | return data.auth === `${import.meta.env.PUSHER_APP_KEY}:${sha256}` 338 | } 339 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BunPulse 2 | 3 | **BunPulse** is a lightweight, high-performance WebSocket server built on Bun, fully compatible with the Pusher protocol. It serves as a drop-in replacement for applications using Pusher, allowing you to point your existing apps to **BunPulse** without the need for Pusher servers or fees. With **BunPulse**, real-time communication remains seamless, and the setup process remains minimal. 4 | 5 | ## Features 6 | 7 | - 🟢 **Pusher Protocol Compatibility**: Drop-in replacement for Pusher. Point your apps to BunPulse, and everything will continue working as before, including support for presence channels to track online users and their statuses. 8 | - ⚡ **Built on Bun**: Leverages Bun's high performance for WebSocket connections. 9 | - 🔄 **Real-time Communication**: Seamless real-time messaging and notifications. 10 | - 🔒 **Secure Connections**: HMAC-based authentication for secure WebSocket connections. 11 | - 🛠️ **Minimal Setup**: Get started with just a few lines of code. 12 | - 📝 **Enhanced Logging**: Detailed logging of connection events and broadcasting metrics for better analytics. 13 | - 🔗 **Webhook Support**: Notifies when channels are vacated or occupied, enhancing real-time communication monitoring. 14 | 15 | ## Table of Contents 16 | 17 | - [Installation](#installation) 18 | - [Usage](#usage) 19 | - [Configuration](#configuration) 20 | - [Authentication](#authentication) 21 | - [API Reference](#api-reference) 22 | - [Contributing](#contributing) 23 | - [External Resources](#external-resources) 24 | - [License](#license) 25 | 26 | ## Installation 27 | 28 | To install **BunPulse**, use your preferred package manager: 29 | 30 |
31 | npm 32 | 33 | ```bash 34 | npm install bun-pulse 35 | ``` 36 |
pnpm 37 | 38 | ```bash 39 | pnpm install bun-pulse 40 | ``` 41 |
bun 42 | 43 | ```bash 44 | bun add bun-pulse 45 | ``` 46 |
47 | 48 | Ensure you have **Bun** installed on your system. If you don't have it installed, follow the [Bun installation guide](https://bun.sh/docs/install). 49 | 50 | ## Usage 51 | 52 | Setting up **BunPulse** is quick and easy. Here's how you can start your own WebSocket server compatible with the Pusher protocol. 53 | 54 | ### Basic Example 55 | 56 | ```typescript 57 | import { startBunPulse } from 'bun-pulse' 58 | 59 | // Starts BunPulse on a custom port (default: 6001) 60 | const server = startBunPulse({ port: 7000 }) 61 | ``` 62 | 63 | then `bun run your-file.ts` to start the server. 64 | 65 | ### Handling Events and Forwarding Messages 66 | 67 | > **Note**: Typically, you won’t need to manually publish events with `server.publish()` since your backend (e.g., Laravel Broadcasting) automatically handles broadcasting events to clients via **BunPulse**. However, if you want to extend functionality or handle specific events (e.g., custom WebSocket events), you can manually manage these cases using `server.publish()` or `server.on()`. 68 | 69 | **BunPulse** automatically forwards events from your backend to all connected clients via WebSockets, using the Pusher protocol. It seamlessly handles event broadcasting, connection heartbeats, and secure HMAC-based authentication. 70 | 71 | When your backend triggers an event (e.g., via Laravel Broadcasting), BunPulse ensures it is delivered to all clients subscribed to the relevant channel. 72 | 73 | ### Usage in Laravel Broadcasting 74 | 75 | To integrate **BunPulse** with Laravel Broadcasting, configure the `broadcasting.php` file like this: 76 | 77 | ```php 78 | 'pusher' => [ 79 | 'driver' => 'pusher', 80 | 'key' => env('PUSHER_APP_KEY'), 81 | 'secret' => env('PUSHER_APP_SECRET'), 82 | 'app_id' => env('PUSHER_APP_ID'), 83 | 'options' => [ 84 | 'cluster' => env('PUSHER_APP_CLUSTER'), 85 | 'useTLS' => true, 86 | 'encrypted' => true, 87 | 'host' => env('WS_HOST', '127.0.0.1'), // bun-pulse host 88 | 'port' => env('WS_PORT', 6001), // bun-pulse port 89 | 'scheme' => env('WS_SCHEME', 'http'), 90 | ], 91 | ], 92 | ``` 93 | 94 | Alternatively, other methods to configure BunPulse can be found in the [Pusher documentation](https://pusher.com/docs/channels/channels_libraries/libraries/). 95 | 96 | ### Frontend: Using Pusher.js 97 | 98 | On the frontend, you can use the `pusher-js` package, which works seamlessly with **BunPulse**, or you can use Laravel Echo if you prefer. 99 | 100 | #### Example with Pusher.js 101 | 102 | ```javascript 103 | import Pusher from 'pusher-js' 104 | 105 | const pusher = new Pusher(process.env.PUSHER_APP_KEY, { 106 | cluster: process.env.PUSHER_APP_CLUSTER, 107 | wsHost: process.env.WS_HOST || '127.0.0.1', 108 | wsPort: process.env.WS_PORT || 6001, 109 | forceTLS: false, 110 | enabledTransports: ['ws', 'wss'], 111 | }) 112 | 113 | const channel = pusher.subscribe('my-channel') 114 | channel.bind('my-event', (data) => { 115 | console.log(data.message) 116 | }) 117 | ``` 118 | 119 | ## Configuration 120 | 121 | You can customize **BunPulse** by passing configuration options when starting the server. These options include: 122 | 123 | - `*`: All bun websocket server options are supported, see [bun docs](https://bun.sh/docs/api/http#bun-serve) for more info. 124 | - `port`: Specifies the port on which the WebSocket server listens (default: `6001`). 125 | - `subscriptionVacancyUrl`: An optional URL to notify when a channel is vacated (i.e., no more subscribers). 126 | - `heartbeatInterval`: The interval (in milliseconds) at which WebSocket heartbeat pings are sent to keep the connection alive (default: `25000`). 127 | - `heartbeatTimeout`: The timeout (in milliseconds) after which an inactive WebSocket connection is closed (default: `60000`). 128 | 129 | ### Example with Custom Config: 130 | 131 | ```typescript 132 | const server = startBunPulse({ 133 | port: 7000, 134 | subscriptionVacancyUrl: 'https://myserver.com/api/subscriptions/webhook', 135 | heartbeatInterval: 20000, // Heartbeat every 20 seconds 136 | heartbeatTimeout: 50000 // Timeout after 50 seconds of inactivity 137 | }) 138 | ``` 139 | 140 | ## Authentication 141 | 142 | **BunPulse** uses HMAC SHA256 authentication to ensure secure WebSocket connections. When clients subscribe to a channel, they must provide a valid `auth` token, which is verified by the server to authenticate the connection. 143 | 144 | ### How Authentication Works 145 | 146 | 1. **Token Generation**: 147 | - On the client side, an `auth` token is generated by your backend using HMAC SHA256. 148 | - The token is created using the `socketId` (provided when the WebSocket connection is established) and the channel name that the client wants to subscribe to. 149 | - Your backend signs this data with the `PUSHER_APP_SECRET` and sends it back to the client. 150 | 151 | 2. **Token Verification**: 152 | - When a client attempts to subscribe to a channel, the `auth` token is sent to **BunPulse**. 153 | - **BunPulse** verifies the token by recalculating the HMAC using the `socketId` and channel, and comparing it with the token received from the client. 154 | - This ensures that only authorized clients can subscribe to the channel. 155 | 156 | ### Setting up Pusher Authentication 157 | 158 | To set up **BunPulse** with Pusher-style authentication, configure the following environment variables: 159 | 160 | - `PUSHER_APP_KEY`: Your Pusher app key (used for client authentication). 161 | - `PUSHER_APP_SECRET`: Your Pusher app secret (used for HMAC SHA256 signing). 162 | 163 | Add these variables to your `.env` file or set them in your environment. Here's an example of the `.env` configuration: 164 | 165 | ```bash 166 | PUSHER_APP_KEY=your-app-key 167 | PUSHER_APP_SECRET=your-app-secret 168 | ``` 169 | 170 | ### Example Backend Code for Generating the `auth` Token 171 | 172 | In **BunPulse**, HMAC SHA256 is used to securely generate an `auth` token for client authentication. This ensures that only authorized clients can subscribe to WebSocket channels. Below is an example of how you can generate the `auth` token in your backend using Bun's `CryptoHasher`. 173 | 174 | > **Minimum requirement**: You need at least [Bun v1.1.30](https://bun.sh/blog/bun-v1.1.30#hmac-in-bun-cryptohasher) to use this feature. 175 | 176 | ```typescript 177 | import { CryptoHasher } from 'bun' 178 | 179 | export function generateHmacSHA256HexDigest(socketIdChannel: string, secret: string): string { 180 | // Initialize a new HMAC hasher with SHA256 algorithm and the provided secret 181 | const hmac = new CryptoHasher('sha256', secret) 182 | 183 | // Update the hasher with the socket ID and channel combined in the format: `${socketId}:${channel}` 184 | hmac.update(socketIdChannel) 185 | 186 | // Generate and return the HMAC digest as a hexadecimal string 187 | return hmac.digest('hex') 188 | } 189 | 190 | // Example usage: 191 | const socketId = 'socket-id' 192 | const channel = 'my-channel' 193 | const authToken = generateHmacSHA256HexDigest(`${socketId}:${channel}`, process.env.PUSHER_APP_SECRET) 194 | ``` 195 | 196 | ### Explanation: 197 | 198 | - **HMAC Generation**: This function uses Bun's `CryptoHasher` to generate an HMAC SHA256 digest from the combination of `socketId` and `channel`, signed with your `PUSHER_APP_SECRET`. The result is a hexadecimal-encoded `auth` token. 199 | 200 | - **Example Usage**: In the example, we generate an `auth` token for the socket ID `'socket-id'` and the channel `'my-channel'` using the secret stored in the environment variable `PUSHER_APP_SECRET`. 201 | 202 | By generating the `auth` token in this manner, you ensure secure communication between your backend and WebSocket clients. 203 | 204 | ### How BunPulse Verifies the Token 205 | 206 | When the client subscribes to a channel, **BunPulse** uses the following logic to verify the `auth` token: 207 | 208 | ```typescript 209 | function isAuthorized(socketId: string, data: WebSocketData): boolean { 210 | const expectedToken = generateHmacSHA256HexDigest( 211 | `${socketId}:${data.channel}`, 212 | String(import.meta.env.PUSHER_APP_SECRET) 213 | ) 214 | return data.auth === `${import.meta.env.PUSHER_APP_KEY}:${expectedToken}` 215 | } 216 | ``` 217 | 218 | In this verification: 219 | - The server calculates the expected token using the `socketId` and channel provided by the client, along with the `PUSHER_APP_SECRET`. 220 | - The token sent by the client (`data.auth`) must match the calculated token for the subscription to be authorized. 221 | 222 | ### Conclusion 223 | 224 | With this setup, **BunPulse** ensures that only authorized clients can subscribe to channels, providing secure and reliable WebSocket communication. 225 | 226 | ## API Reference 227 | 228 | ### `startBunPulse(config?: BunPulseConfig)` 229 | 230 | Starts the BunPulse WebSocket server. 231 | 232 | **Arguments**: 233 | - `config` (optional): An object containing configuration options such as: 234 | - `port`: Specifies the port on which the WebSocket server listens (default: `6001`). 235 | - `subscriptionVacancyUrl`: URL to notify when a channel is vacated. 236 | - `heartbeatInterval`: Interval for WebSocket heartbeats. 237 | - `heartbeatTimeout`: Timeout period for inactive WebSocket connections. 238 | 239 | **Returns**: The WebSocket server instance. 240 | 241 | --- 242 | 243 | Since **BunPulse** is primarily designed to forward messages from the backend using broadcasting tools (e.g., Laravel), you generally don't need to manually publish events or listen for specific WebSocket events. If you require manual publishing or event listening, here are the methods you can use: 244 | 245 | ### `server.publish(channel: string, event: PusherEvent)` 246 | 247 | Publishes an event to a specific channel. 248 | 249 | **Arguments**: 250 | - `channel`: The name of the channel to which the event is published. 251 | - `event`: An object containing the event name and data to be published. 252 | 253 | **Returns**: `void` 254 | 255 | > **Note**: In most cases, this is handled by your backend through broadcasting (e.g., Laravel Broadcasting) and is not required to be manually invoked. 256 | 257 | ### `server.on(event: string, callback: (ws, data) => void)` 258 | 259 | Listens for specific WebSocket or Pusher events (e.g., `pusher:subscribe`). 260 | 261 | **Arguments**: 262 | - `event`: The name of the event (e.g., subscription or connection event). 263 | - `callback`: The function to be executed when the event is triggered. 264 | 265 | **Returns**: `void` 266 | 267 | > **Note**: Event listening is generally handled through your frontend (e.g., Pusher.js or Laravel Echo) and doesn’t need to be manually configured in the server. 268 | 269 | ## Contributing 270 | 271 | We welcome contributions to **BunPulse**! If you're interested in improving the project, fixing bugs, or adding new features, we encourage you to submit a pull request. Below are some areas where contributions would be especially valuable: 272 | 273 | ### Areas for Improvement: 274 | 1. **Enhanced Logging**: 275 | - **Goal**: Expand logging capabilities to capture and report detailed metrics and events. 276 | - **What’s Needed**: 277 | - Implement logging for additional events, including error handling during message processing and publishing. 278 | - Ensure that logs are structured and sent to Axiom for analytics. 279 | - Capture relevant data such as payload sizes for messages, response durations, and specific event details. 280 | - Consider adding logging for connection metrics, such as the number of active connections and their respective channels. 281 | 282 | 2. **Client-Side Events (`client-*`)**: 283 | - **Goal**: Enable clients to broadcast custom events (`client-*` prefixed) to other clients in the same private channel, while excluding the sender from receiving the event. 284 | - **What’s Needed**: 285 | - Implement handling of `client-*` events. 286 | - Ensure that the event is only broadcast to other clients, not the sender, and only works for private channels. 287 | 288 | 3. **Encrypted Channels**: 289 | - **Goal**: Add support for end-to-end encryption for `private-encrypted-` prefixed channels using AES-GCM. 290 | - **What’s Needed**: 291 | - Implement message encryption/decryption. 292 | - Manage key sharing securely between the server and clients. 293 | 294 | 4. **Enhanced Error Handling**: 295 | - **Goal**: Improve the error reporting and handling for various edge cases, including invalid subscriptions, connection errors, and message handling failures. 296 | - **What’s Needed**: 297 | - Define and return more detailed error messages (`pusher:error` events). 298 | - Add more robust error handling mechanisms for connection issues and HTTP failures. 299 | 300 | 5. **Webhook Support**: 301 | - **Goal**: Enhance existing webhook functionality for key events. 302 | - **What’s Needed**: 303 | - Extend webhook support to cover additional events such as `channel_occupied` and other relevant events as needed. 304 | - Ensure robust error handling and logging for webhook notifications to improve reliability. 305 | --- 306 | 307 | ### How to Contribute: 308 | 1. **Fork the repository**. 309 | 2. **Create a new branch** (`git checkout -b feature/your-feature`). 310 | 3. **Make your changes** and add tests if necessary. 311 | 4. **Commit your changes** (`git commit -m 'feat: add new feature'`). 312 | 5. **Push to your branch** (`git push origin feature/your-feature`). 313 | 6. **Open a pull request**. 314 | 315 | ### Running Tests 316 | 317 | To run tests: 318 | 319 | ```bash 320 | npm run test 321 | ``` 322 | 323 | Please make sure your changes pass the tests before submitting a pull request. 324 | 325 | ## External Resources 326 | 327 | To better understand how **BunPulse** works and how it mirrors the Pusher protocol, here are some helpful resources: 328 | 329 | - [Pusher Official Documentation](https://pusher.com/docs) - Learn more about the Pusher protocol, event broadcasting, and real-time communication. 330 | - [WebSockets Overview](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) - A comprehensive guide to how WebSockets work, provided by MDN. 331 | - [Bun Documentation](https://bun.sh/docs) - Learn about Bun's features, including its high-performance server capabilities. 332 | - [HMAC SHA256 Authentication](https://en.wikipedia.org/wiki/HMAC) - Understand the HMAC-based authentication method used by **BunPulse** for secure WebSocket connections. 333 | - [Axiom Documentation](https://www.axiom.co/docs) - Learn more about using Axiom for logging and analytics. 334 | 335 | ## License 336 | 337 | BunPulse is dual-licensed to promote open-source use while supporting commercial options for hosted services. You may use BunPulse under the **GNU Affero General Public License (AGPL) v3.0** for open-source purposes, or you can obtain a **Commercial License** for proprietary or competitive hosted use. 338 | 339 | ### License Options 340 | 341 | - **AGPL-3.0 License**: This software is licensed under the AGPL-3.0. If you modify and provide BunPulse as a hosted service, you must share your modified source code under the same license. 342 | 343 | - **Commercial License**: For proprietary use or if you intend to host BunPulse as a service without sharing your modifications publicly, you may acquire a Commercial License. 344 | 345 | **To inquire about a Commercial License**, please contact us at stephenjasonwang@gmail.com. 346 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------