Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zivl/sentry-testkit
A Sentry plugin to allow Sentry report interception and further inspection of the data being sent
https://github.com/zivl/sentry-testkit
error-handling error-monitoring error-reporting hacktoberfest hacktoberfest2024 raven raven-js raven-node raven-test-kit sentry sentry-io sentry-testkit
Last synced: 11 days ago
JSON representation
A Sentry plugin to allow Sentry report interception and further inspection of the data being sent
- Host: GitHub
- URL: https://github.com/zivl/sentry-testkit
- Owner: zivl
- License: mit
- Created: 2017-10-09T18:00:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T19:14:37.000Z (about 1 month ago)
- Last Synced: 2024-10-13T23:33:15.482Z (about 1 month ago)
- Topics: error-handling, error-monitoring, error-reporting, hacktoberfest, hacktoberfest2024, raven, raven-js, raven-node, raven-test-kit, sentry, sentry-io, sentry-testkit
- Language: TypeScript
- Homepage: https://zivl.github.io/sentry-testkit/
- Size: 5.98 MB
- Stars: 112
- Watchers: 217
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Sentry is an open-source JavaScript SDK published by [Sentry](https://sentry.io/welcome/) to enable error tracking that helps developers monitor and fix crashes in real time.
However, when building tests for your application, you want to assert that the right flow-tracking or error is being sent to _Sentry_, **but** without really sending it to _Sentry_ servers. This way you won't swamp Sentry with false reports during test running and other CI operations.
## Sentry Testkit - to the rescue
_Sentry Testkit_ enables Sentry to work natively in your application, and by overriding the default Sentry transport mechanism, the report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched later for your own usage, verification, or any other use you may have in your local developing/testing environment.
## Installation
**npm:**
```
npm install sentry-testkit --save-dev
```
**yarn:**
```
yarn add sentry-testkit --dev
```
## Usage
```javascript
// some.spec.js
const sentryTestkit = require('sentry-testkit')
const {testkit, sentryTransport} = sentryTestkit()
// initialize your Sentry instance with sentryTransport
Sentry.init({
dsn: 'some_dummy_dsn',
transport: sentryTransport,
//... other configurations
})
test('collect error events', function () {
// run any scenario that eventually calls Sentry.captureException(...)
expect(testkit.reports()).toHaveLength(1)
const report = testkit.reports()[0]
expect(report).toHaveProperty(...)
});
// Similarly for performance events
test('collect performance events', function () {
// run any scenario that eventually calls Sentry.startTransaction(...)
expect(testkit.transactions()).toHaveLength(1)
});
```
## Testkit API
See full API description and documentation here: https://zivl.github.io/sentry-testkit/
## Running in browser
`sentry-testkit` relies on `express` and `http` packages from NodeJS. We have separated entry `sentry-testkit/browser` where we not include any NodeJS-related code.
```javascript
const sentryTestkit = require('sentry-testkit/browser')
const { testkit } = sentryTestkit()
// Your code for browser
```
## Raven-Testkit
The good old legacy `raven-testkit` documentation can be found [here](LEGACY_API.md). It it still there to serve `Raven` which is the old legacy SDK of _Sentry_ for JavaScript/Node.js platforms
## Change Log
We're constantly and automatically updating our [CHANGELOG](./CHANGELOG.md) file, so its always a good spot to checkout what have we been up to...
## Contribution
We'd love any kind of contribution, to get better, improve our capabilities, fix bugs and bring more features as Sentry expanding their tools as well. Please check our [CONTRIBUTING](./CONTRIBUTING.md) guidelines for more info and how to get started.
## License
Sentry Testkit is [MIT licensed](./LICENSE).