feat: Add Bun SDK #9029
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| module.exports = { | ||
| env: { | ||
| node: true, | ||
| }, | ||
| extends: ['../../.eslintrc.js'], | ||
| rules: { | ||
| '@sentry-internal/sdk/no-optional-chaining': 'off', | ||
| '@sentry-internal/sdk/no-nullish-coalescing': 'off', | ||
| '@sentry-internal/sdk/no-unsupported-es6-methods': 'off', | ||
| '@sentry-internal/sdk/no-class-field-initializers': 'off', | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
| Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
| WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| <p align="center"> | ||
| <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank"> | ||
| <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84"> | ||
| </a> | ||
| </p> | ||
|
|
||
| # Official Sentry SDK for Bun (Beta) | ||
|
|
||
| [](https://www.npmjs.com/package/@sentry/bun) | ||
| [](https://www.npmjs.com/package/@sentry/bun) | ||
| [](https://www.npmjs.com/package/@sentry/bun) | ||
|
|
||
| ## Links | ||
|
|
||
| - [Official SDK Docs](https://docs.sentry.io/quickstart/) | ||
| - [TypeDoc](http://getsentry.github.io/sentry-javascript/) | ||
|
|
||
| The Sentry Bun SDK is in beta. Please help us improve the SDK by [reporting any issues or giving us feedback](https://github.com/getsentry/sentry-javascript/issues). | ||
|
|
||
| ## Usage | ||
|
|
||
| To use this SDK, call `init(options)` as early as possible in the main entry module. This will initialize the SDK and | ||
| hook into the environment. Note that you can turn off almost all side effects using the respective options. | ||
|
|
||
| ```javascript | ||
| // ES5 Syntax | ||
| const Sentry = require('@sentry/bun'); | ||
| // ES6 Syntax | ||
| import * as Sentry from '@sentry/bun'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: '__DSN__', | ||
| // ... | ||
| }); | ||
| ``` | ||
|
|
||
| To set context information or send manual events, use the exported functions of `@sentry/bun`. Note that these | ||
| functions will not perform any action before you have called `init()`: | ||
|
|
||
| ```javascript | ||
| // Set user information, as well as tags and further extras | ||
| Sentry.configureScope(scope => { | ||
| scope.setExtra('battery', 0.7); | ||
| scope.setTag('user_mode', 'admin'); | ||
| scope.setUser({ id: '4711' }); | ||
| // scope.clear(); | ||
| }); | ||
|
|
||
| // Add a breadcrumb for future events | ||
| Sentry.addBreadcrumb({ | ||
| message: 'My Breadcrumb', | ||
| // ... | ||
| }); | ||
|
|
||
| // Capture exceptions, messages or manual events | ||
| Sentry.captureMessage('Hello, world!'); | ||
| Sentry.captureException(new Error('Good bye')); | ||
| Sentry.captureEvent({ | ||
| message: 'Manual', | ||
| stacktrace: [ | ||
| // ... | ||
| ], | ||
| }); | ||
| ``` | ||
|
|
||
| It's not possible to capture unhandled exceptions, unhandled promise rejections now - Bun is working on adding support for it. | ||
| [Github Issue](https://github.com/oven-sh/bun/issues/5091) follow this issue. To report errors to Sentry, you have to manually try-catch and call `Sentry.captureException` in the catch block. | ||
|
|
||
| ```ts | ||
| import * as Sentry from '@sentry/bun'; | ||
|
|
||
| try { | ||
| throw new Error('test'); | ||
| } catch (e) { | ||
| Sentry.captureException(e); | ||
| } | ||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| module.exports = require('../../jest/jest.config.js'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| { | ||
| "name": "@sentry/bun", | ||
| "version": "7.69.0", | ||
| "description": "Official Sentry SDK for bun", | ||
| "repository": "git://github.com/getsentry/sentry-javascript.git", | ||
| "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/bun", | ||
| "author": "Sentry", | ||
| "license": "MIT", | ||
| "engines": { | ||
| "node": ">=8" | ||
| }, | ||
| "main": "build/esm/index.js", | ||
| "module": "build/esm/index.js", | ||
| "types": "build/types/index.d.ts", | ||
| "typesVersions": { | ||
| "<4.9": { | ||
| "build/npm/types/index.d.ts": [ | ||
| "build/npm/types-ts3.8/index.d.ts" | ||
| ] | ||
| } | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
|
Comment on lines
+22
to
+24
There was a problem hiding this comment. This is fine (no action required) but just to note: With this PR we will not yet publish the Bun SDK because it's not configured in |
||
| "dependencies": { | ||
| "@sentry/core": "7.69.0", | ||
| "@sentry/node": "7.69.0", | ||
| "@sentry/types": "7.69.0", | ||
| "@sentry/utils": "7.69.0" | ||
| }, | ||
| "devDependencies": { | ||
| "bun-types": "latest" | ||
|
There was a problem hiding this comment. I wonder how we can say what versions of Bun we support 🤔 There was a problem hiding this comment. I wouldn't bother too much, let's lock in once we know 😬 |
||
| }, | ||
| "scripts": { | ||
| "build": "run-p build:transpile build:types", | ||
| "build:dev": "yarn build", | ||
| "build:transpile": "rollup -c rollup.npm.config.js", | ||
| "build:types": "run-s build:types:core build:types:downlevel", | ||
| "build:types:core": "tsc -p tsconfig.types.json", | ||
| "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8", | ||
| "build:watch": "run-p build:transpile:watch build:types:watch", | ||
| "build:dev:watch": "yarn build:watch", | ||
| "build:transpile:watch": "rollup -c rollup.npm.config.js --watch", | ||
| "build:types:watch": "tsc -p tsconfig.types.json --watch", | ||
| "build:tarball": "ts-node ../../scripts/prepack.ts && npm pack ./build", | ||
| "circularDepCheck": "madge --circular src/index.ts", | ||
| "clean": "rimraf build coverage sentry-node-*.tgz", | ||
| "fix": "run-s fix:eslint fix:prettier", | ||
| "fix:eslint": "eslint . --format stylish --fix", | ||
| "fix:prettier": "prettier --write \"{src,test,scripts}/**/**.ts\"", | ||
| "lint": "run-s lint:prettier lint:eslint", | ||
| "lint:eslint": "eslint . --format stylish", | ||
| "lint:prettier": "prettier --check \"{src,test,scripts}/**/**.ts\"", | ||
| "install:bun": "node ./scripts/install-bun.js", | ||
| "test": "run-s install:bun test:bun", | ||
| "test:bun": "bun test", | ||
| "test:watch": "bun test --watch", | ||
| "yalc:publish": "ts-node ../../scripts/prepack.ts && yalc publish build --push" | ||
| }, | ||
| "volta": { | ||
| "extends": "../../package.json" | ||
| }, | ||
| "sideEffects": false, | ||
| "madge":{ | ||
| "detectiveOptions": { | ||
| "ts": { | ||
| "skipTypeImports": true | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js'; | ||
|
|
||
| const config = makeNPMConfigVariants(makeBaseNPMConfig()); | ||
|
|
||
| // remove cjs from config array config[0].output.format == cjs | ||
| export default [config[1]]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* eslint-disable no-console */ | ||
| if (process.env.CI) { | ||
| // This script is not needed in CI we install bun via GH actions | ||
| return; | ||
| } | ||
| const { exec } = require('child_process'); | ||
| const https = require('https'); | ||
|
|
||
| // Define the URL of the Bash script for bun installation | ||
| const installScriptUrl = 'https://bun.sh/install'; | ||
|
|
||
| // Check if bun is installed | ||
| exec('bun -version', error => { | ||
| if (error) { | ||
| console.error('bun is not installed. Installing...'); | ||
| // Download and execute the installation script | ||
| https | ||
| .get(installScriptUrl, res => { | ||
| if (res.statusCode !== 200) { | ||
| console.error(`Failed to download the installation script (HTTP ${res.statusCode})`); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| res.setEncoding('utf8'); | ||
| let scriptData = ''; | ||
|
|
||
| res.on('data', chunk => { | ||
| scriptData += chunk; | ||
| }); | ||
|
|
||
| res.on('end', () => { | ||
| // Execute the downloaded script | ||
| exec(scriptData, installError => { | ||
Check failureCode scanning / CodeQL Uncontrolled command line |
||
| if (installError) { | ||
| console.error('Failed to install bun:', installError); | ||
| process.exit(1); | ||
| } | ||
| console.log('bun has been successfully installed.'); | ||
| }); | ||
| }); | ||
| }) | ||
| .on('error', e => { | ||
| console.error('Failed to download the installation script:', e); | ||
| process.exit(1); | ||
| }); | ||
| } else { | ||
| // Bun is installed | ||
| } | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import type { ServerRuntimeClientOptions } from '@sentry/core'; | ||
| import { SDK_VERSION, ServerRuntimeClient } from '@sentry/core'; | ||
| import * as os from 'os'; | ||
|
|
||
| import type { BunClientOptions } from './types'; | ||
|
|
||
| /** | ||
| * The Sentry Bun SDK Client. | ||
| * | ||
| * @see BunClientOptions for documentation on configuration options. | ||
| * @see SentryClient for usage documentation. | ||
| */ | ||
| export class BunClient extends ServerRuntimeClient<BunClientOptions> { | ||
| /** | ||
| * Creates a new Bun SDK instance. | ||
| * @param options Configuration options for this SDK. | ||
| */ | ||
| public constructor(options: BunClientOptions) { | ||
| options._metadata = options._metadata || {}; | ||
| options._metadata.sdk = options._metadata.sdk || { | ||
| name: 'sentry.javascript.bun', | ||
| packages: [ | ||
| { | ||
| name: 'npm:@sentry/bun', | ||
| version: SDK_VERSION, | ||
| }, | ||
| ], | ||
| version: SDK_VERSION, | ||
| }; | ||
|
|
||
| const clientOptions: ServerRuntimeClientOptions = { | ||
| ...options, | ||
| platform: 'bun', | ||
| runtime: { name: 'bun', version: Bun.version }, | ||
| serverName: options.serverName || global.process.env.SENTRY_NAME || os.hostname(), | ||
| }; | ||
|
|
||
| super(clientOptions); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.