Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(vercel-edge): add Vercel Edge Runtime package#9041
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
93f8d6f
feat(vercel-edge): add Vercel Edge Runtime package
AbhiPrasad 7cd898a
only install legacy deps when define
AbhiPrasad fc1e03e
clean up types
AbhiPrasad 9bf9d33
vercel-edge in e2e
AbhiPrasad 320c7aa
skip ts imports for madge
AbhiPrasad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
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,64 @@ | ||
| <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 Vercel Edge Runtime [ALPHA] | ||
| [](https://www.npmjs.com/package/@sentry/vercel-edge) | ||
| [](https://www.npmjs.com/package/@sentry/vercel-edge) | ||
| [](https://www.npmjs.com/package/@sentry/vercel-edge) | ||
| ## Links | ||
| - [Official SDK Docs](https://docs.sentry.io/quickstart/) | ||
| - [TypeDoc](http://getsentry.github.io/sentry-javascript/) | ||
| **Note: This SDK is still in an alpha state. Breaking changes can occur at any time.** | ||
| ## 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/vercel-edge'); | ||
| // ES6 Syntax | ||
| import * as Sentry from '@sentry/vercel-edge'; | ||
| Sentry.init({ | ||
| dsn: '__DSN__', | ||
| // ... | ||
| }); | ||
| ``` | ||
| To set context information or send manual events, use the exported functions of `@sentry/vercel-edge`. 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: [ | ||
| // ... | ||
| ], | ||
| }); | ||
| ``` |
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,7 @@ | ||
| const baseConfig = require('../../jest/jest.config.js'); | ||
| module.exports = { | ||
| ...baseConfig, | ||
| // TODO: Fix tests to work with the Edge environment | ||
| // testEnvironment: '@edge-runtime/jest-environment', | ||
| }; |
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/vercel-edge", | ||
| "version": "7.69.0", | ||
| "description": "Offical Sentry SDK for the Vercel Edge Runtime", | ||
| "repository": "git://github.com/getsentry/sentry-javascript.git", | ||
| "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/vercel-edge", | ||
| "author": "Sentry", | ||
| "license": "MIT", | ||
| "engines": { | ||
| "node": ">=8" | ||
| }, | ||
| "main": "build/cjs/index.js", | ||
| "module": "build/esm/index.js", | ||
| "types": "build/types/index.d.ts", | ||
| "typesVersions": { | ||
| "<4.9": { | ||
| "build/types/index.d.ts": [ | ||
| "build/types-ts3.8/index.d.ts" | ||
| ] | ||
| } | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "dependencies": { | ||
| "@sentry/core": "7.69.0", | ||
| "@sentry/types": "7.69.0", | ||
| "@sentry/utils": "7.69.0", | ||
| "tslib": "^2.4.1 || ^1.9.3" | ||
| }, | ||
| "devDependencies": { | ||
| "@edge-runtime/jest-environment": "2.2.3", | ||
| "@edge-runtime/types": "2.2.3" | ||
| }, | ||
| "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-core-*.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\"", | ||
| "test": "jest", | ||
| "test:watch": "jest --watch", | ||
| "version": "node ../../scripts/versionbump.js src/version.ts", | ||
| "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,3 @@ | ||
| import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js'; | ||
| export default makeNPMConfigVariants(makeBaseNPMConfig()); |
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,59 @@ | ||
| import type { Carrier, Hub, RunWithAsyncContextOptions } from '@sentry/core'; | ||
| import { ensureHubOnCarrier, getHubFromCarrier, setAsyncContextStrategy } from '@sentry/core'; | ||
| import { GLOBAL_OBJ, logger } from '@sentry/utils'; | ||
| interface AsyncLocalStorage<T> { | ||
| getStore(): T | undefined; | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| run<R, TArgs extends any[]>(store: T, callback: (...args: TArgs) => R, ...args: TArgs): R; | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any | ||
| const MaybeGlobalAsyncLocalStorage = (GLOBAL_OBJ as any).AsyncLocalStorage; | ||
| let asyncStorage: AsyncLocalStorage<Hub>; | ||
| /** | ||
| * Sets the async context strategy to use AsyncLocalStorage which should be available in the edge runtime. | ||
| */ | ||
| export function setAsyncLocalStorageAsyncContextStrategy(): void { | ||
| if (!MaybeGlobalAsyncLocalStorage) { | ||
| __DEBUG_BUILD__ && | ||
| logger.warn( | ||
| "Tried to register AsyncLocalStorage async context strategy in a runtime that doesn't support AsyncLocalStorage.", | ||
| ); | ||
| return; | ||
| } | ||
| if (!asyncStorage) { | ||
| asyncStorage = new MaybeGlobalAsyncLocalStorage(); | ||
| } | ||
| function getCurrentHub(): Hub | undefined { | ||
| return asyncStorage.getStore(); | ||
| } | ||
| function createNewHub(parent: Hub | undefined): Hub { | ||
| const carrier: Carrier = {}; | ||
| ensureHubOnCarrier(carrier, parent); | ||
| return getHubFromCarrier(carrier); | ||
| } | ||
| function runWithAsyncContext<T>(callback: () => T, options: RunWithAsyncContextOptions): T { | ||
| const existingHub = getCurrentHub(); | ||
| if (existingHub && options?.reuseExisting) { | ||
| // We're already in an async context, so we don't need to create a new one | ||
| // just call the callback with the current hub | ||
| return callback(); | ||
| } | ||
| const newHub = createNewHub(existingHub); | ||
| return asyncStorage.run(newHub, () => { | ||
| return callback(); | ||
| }); | ||
| } | ||
| setAsyncContextStrategy({ getCurrentHub, runWithAsyncContext }); | ||
| } |
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,44 @@ | ||
| import type { ServerRuntimeClientOptions } from '@sentry/core'; | ||
| import { SDK_VERSION, ServerRuntimeClient } from '@sentry/core'; | ||
| import type { VercelEdgeClientOptions } from './types'; | ||
| declare const process: { | ||
| env: Record<string, string>; | ||
| }; | ||
| /** | ||
| * The Sentry Vercel Edge Runtime SDK Client. | ||
| * | ||
| * @see VercelEdgeClientOptions for documentation on configuration options. | ||
| * @see ServerRuntimeClient for usage documentation. | ||
| */ | ||
| export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOptions> { | ||
| /** | ||
| * Creates a new Vercel Edge Runtime SDK instance. | ||
| * @param options Configuration options for this SDK. | ||
| */ | ||
| public constructor(options: VercelEdgeClientOptions) { | ||
| options._metadata = options._metadata || {}; | ||
| options._metadata.sdk = options._metadata.sdk || { | ||
| name: 'sentry.javascript.vercel-edge', | ||
| packages: [ | ||
| { | ||
| name: 'npm:@sentry/vercel-edge', | ||
| version: SDK_VERSION, | ||
| }, | ||
| ], | ||
| version: SDK_VERSION, | ||
| }; | ||
| const clientOptions: ServerRuntimeClientOptions = { | ||
| ...options, | ||
| platform: 'vercel-edge', | ||
| // TODO: Grab version information | ||
| runtime: { name: 'vercel-edge' }, | ||
| serverName: options.serverName || process.env.SENTRY_NAME, | ||
| }; | ||
| super(clientOptions); | ||
| } | ||
| } |
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,73 @@ | ||
| export type { | ||
| Breadcrumb, | ||
| BreadcrumbHint, | ||
| PolymorphicRequest, | ||
| Request, | ||
| SdkInfo, | ||
| Event, | ||
| EventHint, | ||
| Exception, | ||
| Session, | ||
| // eslint-disable-next-line deprecation/deprecation | ||
| Severity, | ||
| SeverityLevel, | ||
| Span, | ||
| StackFrame, | ||
| Stacktrace, | ||
| Thread, | ||
| Transaction, | ||
| User, | ||
| } from '@sentry/types'; | ||
| export type { AddRequestDataToEventOptions } from '@sentry/utils'; | ||
| export type { VercelEdgeOptions } from './types'; | ||
| export { | ||
| addGlobalEventProcessor, | ||
| addBreadcrumb, | ||
| captureException, | ||
| captureEvent, | ||
| captureMessage, | ||
| close, | ||
| configureScope, | ||
| createTransport, | ||
| extractTraceparentData, | ||
| flush, | ||
| getActiveTransaction, | ||
| getHubFromCarrier, | ||
| getCurrentHub, | ||
| Hub, | ||
| lastEventId, | ||
| makeMain, | ||
| runWithAsyncContext, | ||
| Scope, | ||
| startTransaction, | ||
| SDK_VERSION, | ||
| setContext, | ||
| setExtra, | ||
| setExtras, | ||
| setTag, | ||
| setTags, | ||
| setUser, | ||
| spanStatusfromHttpCode, | ||
| trace, | ||
| withScope, | ||
| captureCheckIn, | ||
| setMeasurement, | ||
| getActiveSpan, | ||
| startSpan, | ||
| startInactiveSpan, | ||
| startSpanManual, | ||
| } from '@sentry/core'; | ||
| export type { SpanStatusType } from '@sentry/core'; | ||
| export { VercelEdgeClient } from './client'; | ||
| export { defaultIntegrations, init } from './sdk'; | ||
| import { Integrations as CoreIntegrations } from '@sentry/core'; | ||
| const INTEGRATIONS = { | ||
| ...CoreIntegrations, | ||
| }; | ||
| export { INTEGRATIONS as Integrations }; |
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: Probably not too important but is this even relevant for edge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to set this to
>=16, same as what the edge runtime itself uses https://github.com/vercel/edge-runtime/blob/b28aa3b4f671e39ea19b4f70c1d695010b06ab7e/packages/vm/package.json#L26C19-L26C19There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually wait I'm not, let's stick with making this the same as nextjs for now.