sentry-testkit 3.3.6 → 3.3.7

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.
 
+### [3.3.7](https://github.com/wix/sentry-testkit/compare/v3.3.6...v3.3.7) (2021-10-27)
+
 ### [3.3.6](https://github.com/wix/sentry-testkit/compare/v3.3.5...v3.3.6) (2021-10-18)
 
 ### [3.3.5](https://github.com/wix/sentry-testkit/compare/v3.3.4...v3.3.5) (2021-10-13)

package/README.md

@@ -126,3 +126,12 @@ See full API description and documentation here: https://wix.github.io/sentry-te
 
 ## 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
+
+## 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
+```

package/dist/browser.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var _require = require('./testkit'),
+    createTestkit = _require.createTestkit;
+
+var _require2 = require('./initNetworkInterceptor'),
+    createInitNetworkInterceptor = _require2.createInitNetworkInterceptor;
+
+var _require3 = require('./sentryTransport'),
+    createSentryTransport = _require3.createSentryTransport;
+
+module.exports = function () {
+  var testkit = createTestkit();
+  var sentryTransport = createSentryTransport(testkit);
+  var initNetworkInterceptor = createInitNetworkInterceptor(testkit);
+  return {
+    sentryTransport: sentryTransport,
+    testkit: testkit,
+    initNetworkInterceptor: initNetworkInterceptor
+  };
+};

package/dist/index.js

@@ -1,271 +1,26 @@
 'use strict';
 
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+var _require = require('./testkit'),
+    createTestkit = _require.createTestkit;
 
-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."); }
+var _require2 = require('./localServerApi'),
+    createLocalServerApi = _require2.createLocalServerApi;
 
-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); }
+var _require3 = require('./initNetworkInterceptor'),
+    createInitNetworkInterceptor = _require3.createInitNetworkInterceptor;
 
-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; }
-
-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; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-var express = require('express');
-
-var bodyParser = require('body-parser');
-
-var http = require('http');
-
-var _require = require('./parseDsn'),
-    parseDsn = _require.parseDsn;
-
-function getException(report) {
-  return report.error;
-}
-
-function transformReport(report) {
-  var exception = report.exception && report.exception.values && report.exception.values[0];
-  var error = exception ? {
-    name: exception.type,
-    message: exception.value,
-    stacktrace: exception.stacktrace
-  } : undefined;
-  return {
-    breadcrumbs: report.breadcrumbs || [],
-    error: error,
-    message: report.message,
-    extra: report.extra,
-    level: report.level || 'error',
-    release: report.release,
-    user: report.user,
-    tags: report.tags || {},
-    originalReport: report
-  };
-}
-
-function parseEnvelopeRequest(reqBody) {
-  var _reqBody$split = reqBody.split('\n'),
-      _reqBody$split2 = _slicedToArray(_reqBody$split, 3),
-      _header = _reqBody$split2[0],
-      itemHeader = _reqBody$split2[1],
-      itemPayload = _reqBody$split2[2];
-
-  return {
-    type: JSON.parse(itemHeader).type,
-    payload: JSON.parse(itemPayload)
-  };
-}
-
-function transformTransaction(item) {
-  return {
-    name: item.transaction,
-    traceId: item.contexts.trace.trace_id,
-    release: item.release,
-    tags: item.tags || {},
-    extra: item.extra,
-    spans: item.spans.map(function (span) {
-      return {
-        id: span.span_id || span.spanId,
-        op: span.op,
-        parentSpanId: span.parent_span_id || span.parentSpanId,
-        description: span.description
-      };
-    })
-  };
-}
+var _require4 = require('./sentryTransport'),
+    createSentryTransport = _require4.createSentryTransport;
 
 module.exports = function () {
-  var _reports = [];
-  var _transactions = [];
-  var puppeteerHandler = null;
-
-  var createPuppeteerHandler = function createPuppeteerHandler(baseUrl) {
-    return function (request) {
-      var url = request.url();
-
-      if (!url.startsWith(baseUrl)) {
-        return;
-      }
-
-      var path = url.substring(baseUrl.length);
-
-      if (/\/api\/[0-9]*\/store/.test(path)) {
-        _reports.push(transformReport(JSON.parse(request.postData())));
-      }
-
-      if (/\/api\/[0-9]*\/envelope/.test(path)) {
-        var _parseEnvelopeRequest = parseEnvelopeRequest(request.postData()),
-            type = _parseEnvelopeRequest.type,
-            payload = _parseEnvelopeRequest.payload;
-
-        if (type === 'transaction') {
-          _transactions.push(transformTransaction(payload));
-        }
-      }
-    };
-  };
-
-  var createLocalServerApi = function createLocalServerApi() {
-    var runningServer = null;
-    var localDsn = null;
-
-    var start = function start(userDsn) {
-      if (runningServer !== null) {
-        throw new Error('Local server is already running');
-      }
-
-      var _parseDsn = parseDsn(userDsn),
-          project = _parseDsn.project;
-
-      var app = express(); // the performance endpoint uses a custom non-json payload so
-      // we can't use bodyParser.json() directly
-
-      app.use(bodyParser.text({
-        type: ['application/json', 'application/x-sentry-envelope']
-      }));
-      app.post("/api/".concat(project, "/store/"), function (req, res) {
-        _reports.push(transformReport(JSON.parse(req.body)));
-
-        res.sendStatus(200);
-      });
-      app.post("/api/".concat(project, "/envelope/"), function (req, res) {
-        var _parseEnvelopeRequest2 = parseEnvelopeRequest(req.body),
-            type = _parseEnvelopeRequest2.type,
-            payload = _parseEnvelopeRequest2.payload;
-
-        if (type === 'transaction') {
-          _transactions.push(transformTransaction(payload));
-        }
-
-        res.sendStatus(200);
-      });
-      runningServer = http.createServer(app);
-      return new Promise(function (resolve) {
-        runningServer.listen(function () {
-          var port = runningServer.address().port;
-          localDsn = "http://acacaeaccacacacabcaacdacdacadaca@localhost:".concat(port, "/").concat(project);
-          resolve();
-        });
-      });
-    };
-
-    var stop = function stop() {
-      if (runningServer === null) {
-        throw new Error('Local server is not running');
-      }
-
-      return new Promise(function (resolve, reject) {
-        runningServer.close(function (error) {
-          return error ? reject(error) : resolve();
-        });
-        runningServer = null;
-        localDsn = null;
-      });
-    };
-
-    var getDsn = function getDsn() {
-      if (runningServer === null) {
-        throw new Error('Local server is not running');
-      }
-
-      return localDsn;
-    };
-
-    return {
-      start: start,
-      stop: stop,
-      getDsn: getDsn
-    };
-  };
-
+  var testkit = createTestkit();
+  var sentryTransport = createSentryTransport(testkit);
+  var initNetworkInterceptor = createInitNetworkInterceptor(testkit);
+  var localServer = createLocalServerApi(testkit);
   return {
-    sentryTransport: function sentryTransport(options) {
-      var sendEvent = function sendEvent(event) {
-        if (event.type === 'transaction') {
-          _transactions.push(transformTransaction(event));
-        } else {
-          _reports.push(transformReport(event));
-        }
-
-        return Promise.resolve({
-          status: 'success',
-          event: event
-        });
-      };
-
-      var close = function close() {
-        return Promise.resolve(true);
-      };
-
-      return {
-        // captureEvent(event: SentryEvent): Promise<SentryResponse>;
-        captureEvent: sendEvent,
-        // support for v4 API
-        sendEvent: sendEvent,
-        // support for v5 API
-        // close(timeout?: number): Promise<boolean>;
-        close: close
-      };
-    },
-    initNetworkInterceptor: function initNetworkInterceptor(dsn, cb) {
-      var _parseDsn2 = parseDsn(dsn),
-          protocol = _parseDsn2.protocol,
-          host = _parseDsn2.host;
-
-      var baseUrl = "".concat(protocol, "://").concat(host);
-
-      var handleRequestBody = function handleRequestBody(requestBody) {
-        return _reports.push(transformReport(requestBody));
-      };
-
-      var handleEnvelopeRequestBody = function handleEnvelopeRequestBody(requestBody) {
-        var _parseEnvelopeRequest3 = parseEnvelopeRequest(requestBody),
-            type = _parseEnvelopeRequest3.type,
-            payload = _parseEnvelopeRequest3.payload;
-
-        if (type === 'transaction') {
-          _transactions.push(transformTransaction(payload));
-        }
-      };
-
-      return cb(baseUrl, handleRequestBody, handleEnvelopeRequestBody);
-    },
-    localServer: createLocalServerApi(),
-    testkit: {
-      puppeteer: {
-        startListening: function startListening(page) {
-          var baseUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'https://sentry.io';
-          puppeteerHandler = createPuppeteerHandler(baseUrl);
-          page.on('request', puppeteerHandler);
-        },
-        stopListening: function stopListening(page) {
-          page.removeListener('request', puppeteerHandler);
-        }
-      },
-      reports: function reports() {
-        return _reports;
-      },
-      transactions: function transactions() {
-        return _transactions;
-      },
-      reset: function reset() {
-        _reports = [];
-        _transactions = [];
-      },
-      getExceptionAt: function getExceptionAt(index) {
-        return getException(_reports[index]);
-      },
-      findReport: function findReport(e) {
-        return _reports.find(function (r) {
-          var err = getException(r);
-          return err.name === e.name && err.message === e.message;
-        });
-      },
-      isExist: function isExist(e) {
-        return this.findReport(e) !== undefined;
-      }
-    }
+    sentryTransport: sentryTransport,
+    testkit: testkit,
+    initNetworkInterceptor: initNetworkInterceptor,
+    localServer: localServer
   };
 };

package/dist/initNetworkInterceptor.js

@@ -0,0 +1,37 @@
+'use strict';
+
+var _require = require('./parsers'),
+    parseDsn = _require.parseDsn,
+    parseEnvelopeRequest = _require.parseEnvelopeRequest;
+
+var _require2 = require('./transformers'),
+    transformReport = _require2.transformReport,
+    transformTransaction = _require2.transformTransaction;
+
+var createInitNetworkInterceptor = function createInitNetworkInterceptor(testkit) {
+  return function (dsn, cb) {
+    var _parseDsn = parseDsn(dsn),
+        protocol = _parseDsn.protocol,
+        host = _parseDsn.host;
+
+    var baseUrl = "".concat(protocol, "://").concat(host);
+
+    var handleRequestBody = function handleRequestBody(requestBody) {
+      return testkit.reports().push(transformReport(requestBody));
+    };
+
+    var handleEnvelopeRequestBody = function handleEnvelopeRequestBody(requestBody) {
+      var _parseEnvelopeRequest = parseEnvelopeRequest(requestBody),
+          type = _parseEnvelopeRequest.type,
+          payload = _parseEnvelopeRequest.payload;
+
+      if (type === 'transaction') {
+        testkit.transactions().push(transformTransaction(payload));
+      }
+    };
+
+    return cb(baseUrl, handleRequestBody, handleEnvelopeRequestBody);
+  };
+};
+
+module.exports.createInitNetworkInterceptor = createInitNetworkInterceptor;

package/dist/localServerApi.js

@@ -0,0 +1,89 @@
+'use strict';
+
+var express = require('express');
+
+var bodyParser = require('body-parser');
+
+var http = require('http');
+
+var _require = require('./parsers'),
+    parseDsn = _require.parseDsn,
+    parseEnvelopeRequest = _require.parseEnvelopeRequest;
+
+var _require2 = require('./transformers'),
+    transformReport = _require2.transformReport,
+    transformTransaction = _require2.transformTransaction;
+
+var createLocalServerApi = function createLocalServerApi(testkit) {
+  var runningServer = null;
+  var localDsn = null;
+
+  var start = function start(userDsn) {
+    if (runningServer !== null) {
+      throw new Error('Local server is already running');
+    }
+
+    var _parseDsn = parseDsn(userDsn),
+        project = _parseDsn.project;
+
+    var app = express(); // the performance endpoint uses a custom non-json payload so
+    // we can't use bodyParser.json() directly
+
+    app.use(bodyParser.text({
+      type: ['application/json', 'application/x-sentry-envelope']
+    }));
+    app.post("/api/".concat(project, "/store/"), function (req, res) {
+      testkit.reports().push(transformReport(JSON.parse(req.body)));
+      res.sendStatus(200);
+    });
+    app.post("/api/".concat(project, "/envelope/"), function (req, res) {
+      var _parseEnvelopeRequest = parseEnvelopeRequest(req.body),
+          type = _parseEnvelopeRequest.type,
+          payload = _parseEnvelopeRequest.payload;
+
+      if (type === 'transaction') {
+        testkit.transactions().push(transformTransaction(payload));
+      }
+
+      res.sendStatus(200);
+    });
+    runningServer = http.createServer(app);
+    return new Promise(function (resolve) {
+      runningServer.listen(function () {
+        var port = runningServer.address().port;
+        localDsn = "http://acacaeaccacacacabcaacdacdacadaca@localhost:".concat(port, "/").concat(project);
+        resolve();
+      });
+    });
+  };
+
+  var stop = function stop() {
+    if (runningServer === null) {
+      throw new Error('Local server is not running');
+    }
+
+    return new Promise(function (resolve, reject) {
+      runningServer.close(function (error) {
+        return error ? reject(error) : resolve();
+      });
+      runningServer = null;
+      localDsn = null;
+    });
+  };
+
+  var getDsn = function getDsn() {
+    if (runningServer === null) {
+      throw new Error('Local server is not running');
+    }
+
+    return localDsn;
+  };
+
+  return {
+    start: start,
+    stop: stop,
+    getDsn: getDsn
+  };
+};
+
+module.exports.createLocalServerApi = createLocalServerApi;

package/dist/parsers.js

@@ -0,0 +1,50 @@
+'use strict';
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+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."); }
+
+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); }
+
+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; }
+
+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; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+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; }
+
+var dsnKeys = 'source protocol user pass host port path'.split(' ');
+var dsnPattern = /^(?:(\w+):)?\/\/(?:(\w+)(:\w+)?@)?([\w\.-]+)(?::(\d+))?(\/.*)/; //eslint-disable-line no-useless-escape
+
+var parseDsn = function parseDsn(dsn) {
+  var _dsn$match$reduce = dsn.match(dsnPattern).reduce(function (parsed, current, index) {
+    return Object.assign({}, parsed, _defineProperty({}, dsnKeys[index], current));
+  }, {}),
+      protocol = _dsn$match$reduce.protocol,
+      host = _dsn$match$reduce.host,
+      path = _dsn$match$reduce.path;
+
+  var project = path.substr(path.lastIndexOf('/') + 1);
+  return {
+    protocol: protocol,
+    project: project,
+    host: host
+  };
+};
+
+var parseEnvelopeRequest = function parseEnvelopeRequest(reqBody) {
+  var _reqBody$split = reqBody.split('\n'),
+      _reqBody$split2 = _slicedToArray(_reqBody$split, 3),
+      _header = _reqBody$split2[0],
+      itemHeader = _reqBody$split2[1],
+      itemPayload = _reqBody$split2[2];
+
+  return {
+    type: JSON.parse(itemHeader).type,
+    payload: JSON.parse(itemPayload)
+  };
+};
+
+module.exports.parseDsn = parseDsn;
+module.exports.parseEnvelopeRequest = parseEnvelopeRequest;

package/dist/sentryTransport.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var _require = require('./transformers'),
+    transformReport = _require.transformReport,
+    transformTransaction = _require.transformTransaction;
+
+var createSentryTransport = function createSentryTransport(testkit) {
+  return function (options) {
+    var sendEvent = function sendEvent(event) {
+      if (event.type === 'transaction') {
+        testkit.transactions().push(transformTransaction(event));
+      } else {
+        testkit.reports().push(transformReport(event));
+      }
+
+      return Promise.resolve({
+        status: 'success',
+        event: event
+      });
+    };
+
+    var close = function close() {
+      return Promise.resolve(true);
+    };
+
+    return {
+      // captureEvent(event: SentryEvent): Promise<SentryResponse>;
+      captureEvent: sendEvent,
+      // support for v4 API
+      sendEvent: sendEvent,
+      // support for v5 API
+      // close(timeout?: number): Promise<boolean>;
+      close: close
+    };
+  };
+};
+
+module.exports.createSentryTransport = createSentryTransport;

package/dist/testkit.js

@@ -0,0 +1,79 @@
+'use strict';
+
+var _require = require('./parsers'),
+    parseEnvelopeRequest = _require.parseEnvelopeRequest;
+
+var _require2 = require('./transformers'),
+    transformReport = _require2.transformReport,
+    transformTransaction = _require2.transformTransaction;
+
+function getException(report) {
+  return report.error;
+}
+
+module.exports.createTestkit = function () {
+  var _reports = [];
+  var _transactions = [];
+  var puppeteerHandler = null;
+
+  var createPuppeteerHandler = function createPuppeteerHandler(baseUrl) {
+    return function (request) {
+      var url = request.url();
+
+      if (!url.startsWith(baseUrl)) {
+        return;
+      }
+
+      var path = url.substring(baseUrl.length);
+
+      if (/\/api\/[0-9]*\/store/.test(path)) {
+        _reports.push(transformReport(JSON.parse(request.postData())));
+      }
+
+      if (/\/api\/[0-9]*\/envelope/.test(path)) {
+        var _parseEnvelopeRequest = parseEnvelopeRequest(request.postData()),
+            type = _parseEnvelopeRequest.type,
+            payload = _parseEnvelopeRequest.payload;
+
+        if (type === 'transaction') {
+          _transactions.push(transformTransaction(payload));
+        }
+      }
+    };
+  };
+
+  return {
+    puppeteer: {
+      startListening: function startListening(page) {
+        var baseUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'https://sentry.io';
+        puppeteerHandler = createPuppeteerHandler(baseUrl);
+        page.on('request', puppeteerHandler);
+      },
+      stopListening: function stopListening(page) {
+        page.removeListener('request', puppeteerHandler);
+      }
+    },
+    reports: function reports() {
+      return _reports;
+    },
+    transactions: function transactions() {
+      return _transactions;
+    },
+    reset: function reset() {
+      _reports = [];
+      _transactions = [];
+    },
+    getExceptionAt: function getExceptionAt(index) {
+      return getException(_reports[index]);
+    },
+    findReport: function findReport(e) {
+      return _reports.find(function (r) {
+        var err = getException(r);
+        return err.name === e.name && err.message === e.message;
+      });
+    },
+    isExist: function isExist(e) {
+      return this.findReport(e) !== undefined;
+    }
+  };
+};

package/dist/transformers.js

@@ -0,0 +1,42 @@
+'use strict';
+
+function transformReport(report) {
+  var exception = report.exception && report.exception.values && report.exception.values[0];
+  var error = exception ? {
+    name: exception.type,
+    message: exception.value,
+    stacktrace: exception.stacktrace
+  } : undefined;
+  return {
+    breadcrumbs: report.breadcrumbs || [],
+    error: error,
+    message: report.message,
+    extra: report.extra,
+    level: report.level || 'error',
+    release: report.release,
+    user: report.user,
+    tags: report.tags || {},
+    originalReport: report
+  };
+}
+
+function transformTransaction(item) {
+  return {
+    name: item.transaction,
+    traceId: item.contexts.trace.trace_id,
+    release: item.release,
+    tags: item.tags || {},
+    extra: item.extra,
+    spans: item.spans.map(function (span) {
+      return {
+        id: span.span_id || span.spanId,
+        op: span.op,
+        parentSpanId: span.parent_span_id || span.parentSpanId,
+        description: span.description
+      };
+    })
+  };
+}
+
+module.exports.transformReport = transformReport;
+module.exports.transformTransaction = transformTransaction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sentry-testkit",
-  "version": "3.3.6",
+  "version": "3.3.7",
   "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.",
   "main": "dist/index.js",
   "types": "index.d.ts",