sentry-testkit 3.3.6 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,8 +6,8 @@
6
6
  [![npm version](https://img.shields.io/npm/v/sentry-testkit.svg)](https://npmjs.org/package/sentry-testkit)
7
7
  [![npm downloads](https://img.shields.io/npm/dm/sentry-testkit.svg)](https://npmjs.org/package/sentry-testkit)
8
8
  [![Test](https://github.com/wix/sentry-testkit/workflows/Test/badge.svg)](https://github.com/wix/sentry-testkit/actions)
9
- ![sentry version 5](https://img.shields.io/badge/Compatible%20with%20Sentry-v5-blue)
10
9
  ![sentry version 6](https://img.shields.io/badge/Compatible%20with%20Sentry-v6-blue)
10
+ ![sentry version 7](https://img.shields.io/badge/Compatible%20with%20Sentry-v7-blue)
11
11
 
12
12
  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.<br>
13
13
  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.
@@ -126,3 +126,12 @@ See full API description and documentation here: https://wix.github.io/sentry-te
126
126
 
127
127
  ## Raven-Testkit
128
128
  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
129
+
130
+ ## Running in browser
131
+ `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.
132
+ ```javascript
133
+ const sentryTestkit = require('sentry-testkit/browser');
134
+
135
+ const {testkit} = sentryTestkit()
136
+ // Your code for browser
137
+ ```
@@ -0,0 +1,21 @@
1
+ 'use strict';
2
+
3
+ var _require = require('./testkit'),
4
+ createTestkit = _require.createTestkit;
5
+
6
+ var _require2 = require('./initNetworkInterceptor'),
7
+ createInitNetworkInterceptor = _require2.createInitNetworkInterceptor;
8
+
9
+ var _require3 = require('./sentryTransport'),
10
+ createSentryTransport = _require3.createSentryTransport;
11
+
12
+ module.exports = function () {
13
+ var testkit = createTestkit();
14
+ var sentryTransport = createSentryTransport(testkit);
15
+ var initNetworkInterceptor = createInitNetworkInterceptor(testkit);
16
+ return {
17
+ sentryTransport: sentryTransport,
18
+ testkit: testkit,
19
+ initNetworkInterceptor: initNetworkInterceptor
20
+ };
21
+ };
package/dist/index.js CHANGED
@@ -1,271 +1,26 @@
1
1
  'use strict';
2
2
 
3
- function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
3
+ var _require = require('./testkit'),
4
+ createTestkit = _require.createTestkit;
4
5
 
5
- function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
6
+ var _require2 = require('./localServerApi'),
7
+ createLocalServerApi = _require2.createLocalServerApi;
6
8
 
7
- function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
9
+ var _require3 = require('./initNetworkInterceptor'),
10
+ createInitNetworkInterceptor = _require3.createInitNetworkInterceptor;
8
11
 
9
- function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
10
-
11
- function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
12
-
13
- function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
14
-
15
- var express = require('express');
16
-
17
- var bodyParser = require('body-parser');
18
-
19
- var http = require('http');
20
-
21
- var _require = require('./parseDsn'),
22
- parseDsn = _require.parseDsn;
23
-
24
- function getException(report) {
25
- return report.error;
26
- }
27
-
28
- function transformReport(report) {
29
- var exception = report.exception && report.exception.values && report.exception.values[0];
30
- var error = exception ? {
31
- name: exception.type,
32
- message: exception.value,
33
- stacktrace: exception.stacktrace
34
- } : undefined;
35
- return {
36
- breadcrumbs: report.breadcrumbs || [],
37
- error: error,
38
- message: report.message,
39
- extra: report.extra,
40
- level: report.level || 'error',
41
- release: report.release,
42
- user: report.user,
43
- tags: report.tags || {},
44
- originalReport: report
45
- };
46
- }
47
-
48
- function parseEnvelopeRequest(reqBody) {
49
- var _reqBody$split = reqBody.split('\n'),
50
- _reqBody$split2 = _slicedToArray(_reqBody$split, 3),
51
- _header = _reqBody$split2[0],
52
- itemHeader = _reqBody$split2[1],
53
- itemPayload = _reqBody$split2[2];
54
-
55
- return {
56
- type: JSON.parse(itemHeader).type,
57
- payload: JSON.parse(itemPayload)
58
- };
59
- }
60
-
61
- function transformTransaction(item) {
62
- return {
63
- name: item.transaction,
64
- traceId: item.contexts.trace.trace_id,
65
- release: item.release,
66
- tags: item.tags || {},
67
- extra: item.extra,
68
- spans: item.spans.map(function (span) {
69
- return {
70
- id: span.span_id || span.spanId,
71
- op: span.op,
72
- parentSpanId: span.parent_span_id || span.parentSpanId,
73
- description: span.description
74
- };
75
- })
76
- };
77
- }
12
+ var _require4 = require('./sentryTransport'),
13
+ createSentryTransport = _require4.createSentryTransport;
78
14
 
79
15
  module.exports = function () {
80
- var _reports = [];
81
- var _transactions = [];
82
- var puppeteerHandler = null;
83
-
84
- var createPuppeteerHandler = function createPuppeteerHandler(baseUrl) {
85
- return function (request) {
86
- var url = request.url();
87
-
88
- if (!url.startsWith(baseUrl)) {
89
- return;
90
- }
91
-
92
- var path = url.substring(baseUrl.length);
93
-
94
- if (/\/api\/[0-9]*\/store/.test(path)) {
95
- _reports.push(transformReport(JSON.parse(request.postData())));
96
- }
97
-
98
- if (/\/api\/[0-9]*\/envelope/.test(path)) {
99
- var _parseEnvelopeRequest = parseEnvelopeRequest(request.postData()),
100
- type = _parseEnvelopeRequest.type,
101
- payload = _parseEnvelopeRequest.payload;
102
-
103
- if (type === 'transaction') {
104
- _transactions.push(transformTransaction(payload));
105
- }
106
- }
107
- };
108
- };
109
-
110
- var createLocalServerApi = function createLocalServerApi() {
111
- var runningServer = null;
112
- var localDsn = null;
113
-
114
- var start = function start(userDsn) {
115
- if (runningServer !== null) {
116
- throw new Error('Local server is already running');
117
- }
118
-
119
- var _parseDsn = parseDsn(userDsn),
120
- project = _parseDsn.project;
121
-
122
- var app = express(); // the performance endpoint uses a custom non-json payload so
123
- // we can't use bodyParser.json() directly
124
-
125
- app.use(bodyParser.text({
126
- type: ['application/json', 'application/x-sentry-envelope']
127
- }));
128
- app.post("/api/".concat(project, "/store/"), function (req, res) {
129
- _reports.push(transformReport(JSON.parse(req.body)));
130
-
131
- res.sendStatus(200);
132
- });
133
- app.post("/api/".concat(project, "/envelope/"), function (req, res) {
134
- var _parseEnvelopeRequest2 = parseEnvelopeRequest(req.body),
135
- type = _parseEnvelopeRequest2.type,
136
- payload = _parseEnvelopeRequest2.payload;
137
-
138
- if (type === 'transaction') {
139
- _transactions.push(transformTransaction(payload));
140
- }
141
-
142
- res.sendStatus(200);
143
- });
144
- runningServer = http.createServer(app);
145
- return new Promise(function (resolve) {
146
- runningServer.listen(function () {
147
- var port = runningServer.address().port;
148
- localDsn = "http://acacaeaccacacacabcaacdacdacadaca@localhost:".concat(port, "/").concat(project);
149
- resolve();
150
- });
151
- });
152
- };
153
-
154
- var stop = function stop() {
155
- if (runningServer === null) {
156
- throw new Error('Local server is not running');
157
- }
158
-
159
- return new Promise(function (resolve, reject) {
160
- runningServer.close(function (error) {
161
- return error ? reject(error) : resolve();
162
- });
163
- runningServer = null;
164
- localDsn = null;
165
- });
166
- };
167
-
168
- var getDsn = function getDsn() {
169
- if (runningServer === null) {
170
- throw new Error('Local server is not running');
171
- }
172
-
173
- return localDsn;
174
- };
175
-
176
- return {
177
- start: start,
178
- stop: stop,
179
- getDsn: getDsn
180
- };
181
- };
182
-
16
+ var testkit = createTestkit();
17
+ var sentryTransport = createSentryTransport(testkit);
18
+ var initNetworkInterceptor = createInitNetworkInterceptor(testkit);
19
+ var localServer = createLocalServerApi(testkit);
183
20
  return {
184
- sentryTransport: function sentryTransport(options) {
185
- var sendEvent = function sendEvent(event) {
186
- if (event.type === 'transaction') {
187
- _transactions.push(transformTransaction(event));
188
- } else {
189
- _reports.push(transformReport(event));
190
- }
191
-
192
- return Promise.resolve({
193
- status: 'success',
194
- event: event
195
- });
196
- };
197
-
198
- var close = function close() {
199
- return Promise.resolve(true);
200
- };
201
-
202
- return {
203
- // captureEvent(event: SentryEvent): Promise<SentryResponse>;
204
- captureEvent: sendEvent,
205
- // support for v4 API
206
- sendEvent: sendEvent,
207
- // support for v5 API
208
- // close(timeout?: number): Promise<boolean>;
209
- close: close
210
- };
211
- },
212
- initNetworkInterceptor: function initNetworkInterceptor(dsn, cb) {
213
- var _parseDsn2 = parseDsn(dsn),
214
- protocol = _parseDsn2.protocol,
215
- host = _parseDsn2.host;
216
-
217
- var baseUrl = "".concat(protocol, "://").concat(host);
218
-
219
- var handleRequestBody = function handleRequestBody(requestBody) {
220
- return _reports.push(transformReport(requestBody));
221
- };
222
-
223
- var handleEnvelopeRequestBody = function handleEnvelopeRequestBody(requestBody) {
224
- var _parseEnvelopeRequest3 = parseEnvelopeRequest(requestBody),
225
- type = _parseEnvelopeRequest3.type,
226
- payload = _parseEnvelopeRequest3.payload;
227
-
228
- if (type === 'transaction') {
229
- _transactions.push(transformTransaction(payload));
230
- }
231
- };
232
-
233
- return cb(baseUrl, handleRequestBody, handleEnvelopeRequestBody);
234
- },
235
- localServer: createLocalServerApi(),
236
- testkit: {
237
- puppeteer: {
238
- startListening: function startListening(page) {
239
- var baseUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'https://sentry.io';
240
- puppeteerHandler = createPuppeteerHandler(baseUrl);
241
- page.on('request', puppeteerHandler);
242
- },
243
- stopListening: function stopListening(page) {
244
- page.removeListener('request', puppeteerHandler);
245
- }
246
- },
247
- reports: function reports() {
248
- return _reports;
249
- },
250
- transactions: function transactions() {
251
- return _transactions;
252
- },
253
- reset: function reset() {
254
- _reports = [];
255
- _transactions = [];
256
- },
257
- getExceptionAt: function getExceptionAt(index) {
258
- return getException(_reports[index]);
259
- },
260
- findReport: function findReport(e) {
261
- return _reports.find(function (r) {
262
- var err = getException(r);
263
- return err.name === e.name && err.message === e.message;
264
- });
265
- },
266
- isExist: function isExist(e) {
267
- return this.findReport(e) !== undefined;
268
- }
269
- }
21
+ sentryTransport: sentryTransport,
22
+ testkit: testkit,
23
+ initNetworkInterceptor: initNetworkInterceptor,
24
+ localServer: localServer
270
25
  };
271
26
  };
@@ -0,0 +1,41 @@
1
+ 'use strict';
2
+
3
+ var _require = require('./parsers'),
4
+ parseDsn = _require.parseDsn,
5
+ parseEnvelopeRequest = _require.parseEnvelopeRequest;
6
+
7
+ var _require2 = require('./transformers'),
8
+ transformReport = _require2.transformReport,
9
+ transformTransaction = _require2.transformTransaction;
10
+
11
+ var createInitNetworkInterceptor = function createInitNetworkInterceptor(testkit) {
12
+ return function (dsn, cb) {
13
+ var _parseDsn = parseDsn(dsn),
14
+ protocol = _parseDsn.protocol,
15
+ host = _parseDsn.host;
16
+
17
+ var baseUrl = "".concat(protocol, "://").concat(host);
18
+
19
+ var handleRequestBody = function handleRequestBody(requestBody) {
20
+ return testkit.reports().push(transformReport(requestBody));
21
+ };
22
+
23
+ var handleEnvelopeRequestBody = function handleEnvelopeRequestBody(requestBody) {
24
+ var _parseEnvelopeRequest = parseEnvelopeRequest(requestBody),
25
+ type = _parseEnvelopeRequest.type,
26
+ payload = _parseEnvelopeRequest.payload;
27
+
28
+ if (type === 'transaction') {
29
+ testkit.transactions().push(transformTransaction(payload));
30
+ }
31
+
32
+ if (type === 'event') {
33
+ testkit.reports().push(transformReport(payload));
34
+ }
35
+ };
36
+
37
+ return cb(baseUrl, handleRequestBody, handleEnvelopeRequestBody);
38
+ };
39
+ };
40
+
41
+ module.exports.createInitNetworkInterceptor = createInitNetworkInterceptor;
@@ -0,0 +1,111 @@
1
+ 'use strict';
2
+
3
+ var express = require('express');
4
+
5
+ var bodyParser = require('body-parser');
6
+
7
+ var http = require('http');
8
+
9
+ var _require = require('./parsers'),
10
+ parseDsn = _require.parseDsn,
11
+ parseEnvelopeRequest = _require.parseEnvelopeRequest;
12
+
13
+ var _require2 = require('./transformers'),
14
+ transformReport = _require2.transformReport,
15
+ transformTransaction = _require2.transformTransaction;
16
+
17
+ var createLocalServerApi = function createLocalServerApi(testkit) {
18
+ var runningServer = null;
19
+ var localDsn = null;
20
+
21
+ var start = function start(userDsn) {
22
+ if (runningServer !== null) {
23
+ throw new Error('Local server is already running');
24
+ }
25
+
26
+ var _parseDsn = parseDsn(userDsn),
27
+ project = _parseDsn.project;
28
+
29
+ var app = express(); // the performance endpoint uses a custom non-json payload so
30
+ // we can't use bodyParser.json() directly
31
+
32
+ app.use(bodyParser.text({
33
+ type: ['application/json', 'application/x-sentry-envelope']
34
+ }));
35
+ app.post("/api/".concat(project, "/store/"), function (req, res) {
36
+ testkit.reports().push(transformReport(JSON.parse(req.body)));
37
+ res.sendStatus(200);
38
+ });
39
+ app.post("/api/".concat(project, "/envelope/"), function (req, res) {
40
+ if (req.headers['transfer-encoding'] === 'chunked') {
41
+ var rawData = '';
42
+ req.on('data', function (chunk) {
43
+ rawData += chunk;
44
+ });
45
+ req.on('end', function () {
46
+ var _parseEnvelopeRequest = parseEnvelopeRequest(rawData),
47
+ type = _parseEnvelopeRequest.type,
48
+ payload = _parseEnvelopeRequest.payload;
49
+
50
+ if (type === 'transaction') {
51
+ testkit.transactions().push(transformTransaction(payload));
52
+ }
53
+
54
+ if (type === 'event') {
55
+ testkit.reports().push(transformReport(payload));
56
+ }
57
+
58
+ res.sendStatus(200);
59
+ });
60
+ } else {
61
+ var _parseEnvelopeRequest2 = parseEnvelopeRequest(req.body),
62
+ type = _parseEnvelopeRequest2.type,
63
+ payload = _parseEnvelopeRequest2.payload;
64
+
65
+ if (type === 'transaction') {
66
+ testkit.transactions().push(transformTransaction(payload));
67
+ }
68
+
69
+ res.sendStatus(200);
70
+ }
71
+ });
72
+ runningServer = http.createServer(app);
73
+ return new Promise(function (resolve) {
74
+ runningServer.listen(function () {
75
+ var port = runningServer.address().port;
76
+ localDsn = "http://acacaeaccacacacabcaacdacdacadaca@localhost:".concat(port, "/").concat(project);
77
+ resolve();
78
+ });
79
+ });
80
+ };
81
+
82
+ var stop = function stop() {
83
+ if (runningServer === null) {
84
+ throw new Error('Local server is not running');
85
+ }
86
+
87
+ return new Promise(function (resolve, reject) {
88
+ runningServer.close(function (error) {
89
+ return error ? reject(error) : resolve();
90
+ });
91
+ runningServer = null;
92
+ localDsn = null;
93
+ });
94
+ };
95
+
96
+ var getDsn = function getDsn() {
97
+ if (runningServer === null) {
98
+ throw new Error('Local server is not running');
99
+ }
100
+
101
+ return localDsn;
102
+ };
103
+
104
+ return {
105
+ start: start,
106
+ stop: stop,
107
+ getDsn: getDsn
108
+ };
109
+ };
110
+
111
+ module.exports.createLocalServerApi = createLocalServerApi;
@@ -0,0 +1,50 @@
1
+ 'use strict';
2
+
3
+ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
4
+
5
+ function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
6
+
7
+ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
8
+
9
+ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
10
+
11
+ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
12
+
13
+ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
14
+
15
+ function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
16
+
17
+ var dsnKeys = 'source protocol user pass host port path'.split(' ');
18
+ var dsnPattern = /^(?:(\w+):)?\/\/(?:(\w+)(:\w+)?@)?([\w\.-]+)(?::(\d+))?(\/.*)/; //eslint-disable-line no-useless-escape
19
+
20
+ var parseDsn = function parseDsn(dsn) {
21
+ var _dsn$match$reduce = dsn.match(dsnPattern).reduce(function (parsed, current, index) {
22
+ return Object.assign({}, parsed, _defineProperty({}, dsnKeys[index], current));
23
+ }, {}),
24
+ protocol = _dsn$match$reduce.protocol,
25
+ host = _dsn$match$reduce.host,
26
+ path = _dsn$match$reduce.path;
27
+
28
+ var project = path.substr(path.lastIndexOf('/') + 1);
29
+ return {
30
+ protocol: protocol,
31
+ project: project,
32
+ host: host
33
+ };
34
+ };
35
+
36
+ var parseEnvelopeRequest = function parseEnvelopeRequest(reqBody) {
37
+ var _reqBody$split = reqBody.split('\n'),
38
+ _reqBody$split2 = _slicedToArray(_reqBody$split, 3),
39
+ _header = _reqBody$split2[0],
40
+ itemHeader = _reqBody$split2[1],
41
+ itemPayload = _reqBody$split2[2];
42
+
43
+ return {
44
+ type: JSON.parse(itemHeader).type,
45
+ payload: JSON.parse(itemPayload)
46
+ };
47
+ };
48
+
49
+ module.exports.parseDsn = parseDsn;
50
+ module.exports.parseEnvelopeRequest = parseEnvelopeRequest;
@@ -0,0 +1,74 @@
1
+ 'use strict';
2
+
3
+ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
4
+
5
+ function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
6
+
7
+ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
8
+
9
+ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
10
+
11
+ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
12
+
13
+ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
14
+
15
+ var _require = require('./transformers'),
16
+ transformReport = _require.transformReport,
17
+ transformTransaction = _require.transformTransaction;
18
+
19
+ var createSentryTransport = function createSentryTransport(testkit) {
20
+ return function () {
21
+ // Send transport for API < v7
22
+ var sendEvent = function sendEvent(event) {
23
+ if (event.type === 'transaction') {
24
+ testkit.transactions().push(transformTransaction(event));
25
+ } else {
26
+ testkit.reports().push(transformReport(event));
27
+ }
28
+
29
+ return Promise.resolve({
30
+ status: 'success',
31
+ event: event
32
+ });
33
+ }; // Send transport for API v7
34
+
35
+
36
+ var send = function send(envelope) {
37
+ var _envelope = _slicedToArray(envelope, 2),
38
+ items = _envelope[1];
39
+
40
+ items.forEach(function (_ref, index) {
41
+ var _ref2 = _slicedToArray(_ref, 2),
42
+ headers = _ref2[0],
43
+ data = _ref2[1];
44
+
45
+ if (headers.type === 'transaction') {
46
+ testkit.transactions().push(transformTransaction(data));
47
+ } else if (headers.type === 'event') {
48
+ testkit.reports().push(transformReport(data));
49
+ }
50
+ });
51
+ return Promise.resolve();
52
+ };
53
+
54
+ var close = function close() {
55
+ return Promise.resolve(true);
56
+ };
57
+
58
+ return {
59
+ // captureEvent(event: SentryEvent): Promise<SentryResponse>;
60
+ captureEvent: sendEvent,
61
+ // support for v4 API
62
+ sendEvent: sendEvent,
63
+ // support for v5 API
64
+ send: send,
65
+ // support for v7 API
66
+ // close(timeout?: number): Promise<boolean>;
67
+ close: close,
68
+ flush: close // support for v7 API
69
+
70
+ };
71
+ };
72
+ };
73
+
74
+ module.exports.createSentryTransport = createSentryTransport;
@@ -0,0 +1,79 @@
1
+ 'use strict';
2
+
3
+ var _require = require('./parsers'),
4
+ parseEnvelopeRequest = _require.parseEnvelopeRequest;
5
+
6
+ var _require2 = require('./transformers'),
7
+ transformReport = _require2.transformReport,
8
+ transformTransaction = _require2.transformTransaction;
9
+
10
+ function getException(report) {
11
+ return report.error;
12
+ }
13
+
14
+ module.exports.createTestkit = function () {
15
+ var _reports = [];
16
+ var _transactions = [];
17
+ var puppeteerHandler = null;
18
+
19
+ var createPuppeteerHandler = function createPuppeteerHandler(baseUrl) {
20
+ return function (request) {
21
+ var url = request.url();
22
+
23
+ if (!url.startsWith(baseUrl)) {
24
+ return;
25
+ }
26
+
27
+ var path = url.substring(baseUrl.length);
28
+
29
+ if (/\/api\/[0-9]*\/store/.test(path)) {
30
+ _reports.push(transformReport(JSON.parse(request.postData())));
31
+ }
32
+
33
+ if (/\/api\/[0-9]*\/envelope/.test(path)) {
34
+ var _parseEnvelopeRequest = parseEnvelopeRequest(request.postData()),
35
+ type = _parseEnvelopeRequest.type,
36
+ payload = _parseEnvelopeRequest.payload;
37
+
38
+ if (type === 'transaction') {
39
+ _transactions.push(transformTransaction(payload));
40
+ }
41
+ }
42
+ };
43
+ };
44
+
45
+ return {
46
+ puppeteer: {
47
+ startListening: function startListening(page) {
48
+ var baseUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'https://sentry.io';
49
+ puppeteerHandler = createPuppeteerHandler(baseUrl);
50
+ page.on('request', puppeteerHandler);
51
+ },
52
+ stopListening: function stopListening(page) {
53
+ page.removeListener('request', puppeteerHandler);
54
+ }
55
+ },
56
+ reports: function reports() {
57
+ return _reports;
58
+ },
59
+ transactions: function transactions() {
60
+ return _transactions;
61
+ },
62
+ reset: function reset() {
63
+ _reports = [];
64
+ _transactions = [];
65
+ },
66
+ getExceptionAt: function getExceptionAt(index) {
67
+ return getException(_reports[index]);
68
+ },
69
+ findReport: function findReport(e) {
70
+ return _reports.find(function (r) {
71
+ var err = getException(r);
72
+ return err.name === e.name && err.message === e.message;
73
+ });
74
+ },
75
+ isExist: function isExist(e) {
76
+ return this.findReport(e) !== undefined;
77
+ }
78
+ };
79
+ };
@@ -0,0 +1,42 @@
1
+ 'use strict';
2
+
3
+ function transformReport(report) {
4
+ var exception = report.exception && report.exception.values && report.exception.values[0];
5
+ var error = exception ? {
6
+ name: exception.type,
7
+ message: exception.value,
8
+ stacktrace: exception.stacktrace
9
+ } : undefined;
10
+ return {
11
+ breadcrumbs: report.breadcrumbs || [],
12
+ error: error,
13
+ message: report.message,
14
+ extra: report.extra,
15
+ level: report.level || 'error',
16
+ release: report.release,
17
+ user: report.user,
18
+ tags: report.tags || {},
19
+ originalReport: report
20
+ };
21
+ }
22
+
23
+ function transformTransaction(item) {
24
+ return {
25
+ name: item.transaction,
26
+ traceId: item.contexts.trace.trace_id,
27
+ release: item.release,
28
+ tags: item.tags || {},
29
+ extra: item.extra,
30
+ spans: item.spans.map(function (span) {
31
+ return {
32
+ id: span.span_id || span.spanId,
33
+ op: span.op,
34
+ parentSpanId: span.parent_span_id || span.parentSpanId,
35
+ description: span.description
36
+ };
37
+ })
38
+ };
39
+ }
40
+
41
+ module.exports.transformReport = transformReport;
42
+ module.exports.transformTransaction = transformTransaction;
package/index.d.ts CHANGED
@@ -1,13 +1,20 @@
1
- import { Event, Breadcrumb, User, Severity, StackFrame, Transport, TransportOptions } from '@sentry/types';
1
+ import {
2
+ Event,
3
+ Breadcrumb,
4
+ User,
5
+ SeverityLevel,
6
+ StackFrame,
7
+ Transport,
8
+ } from '@sentry/types'
2
9
 
3
- export = sentryTestkit;
10
+ export = sentryTestkit
4
11
 
5
- declare function sentryTestkit(): sentryTestkit.TestkitResult;
12
+ declare function sentryTestkit(): sentryTestkit.TestkitResult
6
13
 
7
14
  declare namespace sentryTestkit {
8
15
  interface Page {
9
- on(event: string, handler: (...args: any[]) => any): void;
10
- removeListener(event: string, handler: (...args: any[]) => any): void;
16
+ on(event: string, handler: (...args: any[]) => any): void
17
+ removeListener(event: string, handler: (...args: any[]) => any): void
11
18
  }
12
19
 
13
20
  interface ReportError {
@@ -21,7 +28,7 @@ declare namespace sentryTestkit {
21
28
  error?: ReportError
22
29
  message?: string
23
30
  extra?: { [key: string]: any }
24
- level: Severity
31
+ level: SeverityLevel
25
32
  release?: string
26
33
  user?: User
27
34
  tags: { [key: string]: string }
@@ -34,7 +41,7 @@ declare namespace sentryTestkit {
34
41
  description?: string
35
42
  parentSpanId: string
36
43
  }
37
-
44
+
38
45
  interface Transaction {
39
46
  name: string
40
47
  traceId: string
@@ -46,29 +53,35 @@ declare namespace sentryTestkit {
46
53
 
47
54
  export interface Testkit {
48
55
  puppeteer: {
49
- startListening(page: Page, baseUrl?: String): void;
50
- stopListening(page: Page): void;
51
- };
52
- reports(): Report[];
53
- transactions(): Transaction[];
54
- reset(): void;
55
- getExceptionAt(index: number): ReportError;
56
- findReport(e: Error): Report;
57
- isExist(e: Error): boolean;
56
+ startListening(page: Page, baseUrl?: String): void
57
+ stopListening(page: Page): void
58
+ }
59
+ reports(): Report[]
60
+ transactions(): Transaction[]
61
+ reset(): void
62
+ getExceptionAt(index: number): ReportError
63
+ findReport(e: Error): Report
64
+ isExist(e: Error): boolean
58
65
  }
59
66
 
60
67
  export interface LocalServer {
61
- start: (dsn: string) => Promise<void>;
62
- stop: () => Promise<void>;
63
- getDsn: () => string;
68
+ start: (dsn: string) => Promise<void>
69
+ stop: () => Promise<void>
70
+ getDsn: () => string
64
71
  }
65
72
 
66
73
  export interface TestkitResult {
67
- testkit: Testkit;
74
+ testkit: Testkit
68
75
  sentryTransport: {
69
- new (options: TransportOptions): Transport;
70
- };
71
- initNetworkInterceptor<T>(dsn: string, initCallback: (baseUrl: string, handleRequestBody: (requestBody: { [key: string]: any }) => void) => T): T;
76
+ new (): Transport
77
+ }
78
+ initNetworkInterceptor<T>(
79
+ dsn: string,
80
+ initCallback: (
81
+ baseUrl: string,
82
+ handleRequestBody: (requestBody: { [key: string]: any }) => void
83
+ ) => T
84
+ ): T
72
85
  localServer: LocalServer
73
86
  }
74
87
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sentry-testkit",
3
- "version": "3.3.6",
3
+ "version": "4.0.1",
4
4
  "description": "Sentry Testkit enables Sentry to work natively in your application while running tests. The report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched for your own verification or any other purpose in your local development environment.",
5
5
  "main": "dist/index.js",
6
6
  "types": "index.d.ts",
@@ -12,7 +12,7 @@
12
12
  "start": "docsify serve ./docs",
13
13
  "build": "babel src --out-dir dist",
14
14
  "test": "jest --config jest.config.json",
15
- "prepublish": "npm run-script build",
15
+ "prepare": "npm run-script build",
16
16
  "release": "standard-version"
17
17
  },
18
18
  "publishConfig": {
@@ -45,8 +45,10 @@
45
45
  "devDependencies": {
46
46
  "@babel/cli": "^7.15.7",
47
47
  "@babel/preset-env": "^7.15.8",
48
- "@sentry/browser": "^6.13.3",
49
- "@sentry/node": "^6.13.3",
48
+ "@sentry/browser": "^7.5.0",
49
+ "@sentry/node": "^7.5.0",
50
+ "@sentry/tracing": "^7.5.0",
51
+ "@sentry/types": "^7.5.0",
50
52
  "docsify-cli": "^4.4.3",
51
53
  "eslint": "^8.0.1",
52
54
  "eslint-plugin-prettier": "^3.4.1",
@@ -55,7 +57,7 @@
55
57
  "jest": "^27.2.5",
56
58
  "lint-staged": "^10.5.4",
57
59
  "nock": "^10.0.6",
58
- "node-fetch": "^2.6.5",
60
+ "node-fetch": "^2.6.7",
59
61
  "prettier": "^1.19.1",
60
62
  "standard-version": "^9.3.1",
61
63
  "wait-for-expect": "^1.3.0"
package/CHANGELOG.md DELETED
@@ -1,32 +0,0 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
-
5
- ### [3.3.6](https://github.com/wix/sentry-testkit/compare/v3.3.5...v3.3.6) (2021-10-18)
6
-
7
- ### [3.3.5](https://github.com/wix/sentry-testkit/compare/v3.3.4...v3.3.5) (2021-10-13)
8
-
9
- ### Bug Fixes
10
- * items other than transform sent in an envelope request cause an error ([#89](https://github.com/wix/sentry-testkit/issues/89))
11
-
12
- ### [3.3.4](https://github.com/wix/sentry-testkit/compare/v3.3.2...v3.3.4) (2021-06-20)
13
-
14
-
15
- ### Bug Fixes
16
-
17
- * typo in usage section of README ([#79](https://github.com/wix/sentry-testkit/issues/79)) ([c756be7](https://github.com/wix/sentry-testkit/commit/c756be7c7a2b93970709aa5d7e91cf30111ed78d))
18
-
19
- ### [3.3.3](https://github.com/wix/sentry-testkit/compare/v3.3.2...v3.3.3) (2021-06-18)
20
-
21
- ### [3.3.2](https://github.com/wix/sentry-testkit/compare/v3.3.0...v3.3.2) (2021-02-22)
22
-
23
- ## [3.3.0](https://github.com/wix/sentry-testkit/compare/v3.2.4...v3.3.0) (2021-02-04)
24
-
25
-
26
- ### Features
27
-
28
- * add ready-to-use jest mock with testkit builtin ([80e602c](https://github.com/wix/sentry-testkit/commit/80e602c2597464c80721993e73c251d65b03ad22))
29
-
30
- ### [3.2.4](https://github.com/wix/sentry-testkit/compare/v3.2.3...v3.2.4) (2021-01-29)
31
-
32
- ### 3.2.3 (2021-01-29)
package/dist/parseDsn.js DELETED
@@ -1,24 +0,0 @@
1
- 'use strict';
2
-
3
- function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
4
-
5
- var dsnKeys = 'source protocol user pass host port path'.split(' ');
6
- var dsnPattern = /^(?:(\w+):)?\/\/(?:(\w+)(:\w+)?@)?([\w\.-]+)(?::(\d+))?(\/.*)/; //eslint-disable-line no-useless-escape
7
-
8
- var parseDsn = function parseDsn(dsn) {
9
- var _dsn$match$reduce = dsn.match(dsnPattern).reduce(function (parsed, current, index) {
10
- return Object.assign({}, parsed, _defineProperty({}, dsnKeys[index], current));
11
- }, {}),
12
- protocol = _dsn$match$reduce.protocol,
13
- host = _dsn$match$reduce.host,
14
- path = _dsn$match$reduce.path;
15
-
16
- var project = path.substr(path.lastIndexOf('/') + 1);
17
- return {
18
- protocol: protocol,
19
- project: project,
20
- host: host
21
- };
22
- };
23
-
24
- module.exports.parseDsn = parseDsn;