Version 1.0.0

Author: konraddysput

.gitignore

@@ -1 +1,3 @@
 node_modules/
+lib/
+dist/

.npmignore

@@ -1 +0,0 @@
-test/

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 120,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "always"
+}

.vscode/launch.json

@@ -7,17 +7,55 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Mocha Tests",
+      "name": "Mocha",
       "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
       "args": [
-        "-u",
-        "tdd",
-        "--timeout",
-        "999999",
+        "--no-timeouts",
         "--colors",
-        "${workspaceFolder}/test"
+        "--require",
+        "ts-node/register",
+        "--project",
+        "${workspaceFolder}/tsconfig.json",
+        "${workspaceFolder}/test/**/*.ts"
       ],
-      "internalConsoleOptions": "openOnSessionStart"
+      "console": "integratedTerminal",
+      "sourceMaps": true,
+      "preLaunchTask": "tsc-watch",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Electron TypeScript sample",
+      "preLaunchTask": "build-electron",
+      "runtimeExecutable": "${workspaceFolder}//examples/typescript/electron/node_modules/.bin/electron",
+      "program": "${workspaceFolder}//examples/typescript/electron/source/main.ts",
+      "protocol": "inspector",
+      "outFiles": ["${workspaceFolder}//examples/typescript/electron/dist/main.js"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Electron sample",
+      "runtimeExecutable": "${workspaceFolder}//examples/javascript/electron/node_modules/.bin/electron",
+      "program": "${workspaceFolder}/examples/javascript/electron/source/main.js",
+      "protocol": "inspector"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Node TypeScript sample",
+      "preLaunchTask": "build-node",
+      "program": "${workspaceFolder}//examples/typescript/node/source/main.ts",
+      "protocol": "inspector",
+      "outFiles": ["${workspaceFolder}//examples/typescript/node/dist/main.js"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Node sample",
+      "program": "${workspaceFolder}//examples/javascript/node/source/main.js",
+      "protocol": "inspector"
     }
   ]
 }

.vscode/tasks.json

@@ -0,0 +1,40 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "tsc-watch",
+      "command": "npm",
+      "args": ["run", "build"],
+      "type": "shell",
+      "isBackground": true,
+      "group": "build",
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "build-electron",
+      "dependsOn":["tsc-watch"],
+      "command": "npm",
+      "options": {
+        "cwd": "${workspaceFolder}/examples/typescript/electron"
+      },
+      "args": ["run", "build"],
+      "type": "shell",
+      "isBackground": true,
+      "group": "build",
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "build-node",
+      "dependsOn":["tsc-watch"],
+      "command": "npm",
+      "options": {
+        "cwd": "${workspaceFolder}/examples/typescript/node"
+      },
+      "args": ["run", "build"],
+      "type": "shell",
+      "isBackground": true,
+      "group": "build",
+      "problemMatcher": "$tsc-watch"
+    }
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Backtrace Node Release Notes
+
+## Version 1.0.0 04.06.2019
+
+* `Backtrace-node` now supports TypeScript. We care about your applications that using Backtrace-Node library so we prepared compatible API for you. If you still want to use modern API please use `BacktraceClient` instead.
+* `Backtrace-node` options now support sampling and client rate limiting.
+    - sampling allows you to drop random reports generated by your application depends on sampling value,
+    - client rate limit allows you to set up client limit. By setting this value you will tell library how many reports per minute, client can send to Backtrace
+* `Backtrace-node` send methods accept new paramtere - `fileAttachment`. If you pass array of strings `backtrace-node` will try to read each file from hard drive and add this as attachment to `backtraceReport`.
+* `Backtrace-node` allows you to use `eventEmmiter` events! Now when you can use events like:  `'before-send'`, `'after-send'` and others!
+* Modern Promise API is here! `Backtrace-node` allows you to use `async/await` syntax to send reports to Backtrace!
+* `reportSync` and `reportAsync` methods now returns `BacktraceResult` object that allows you to understand what happend with report. If you have connection/configuration problems `BacktraceResult` allows you to learn what happend inside library!
+* Backtrace prepare a lot sample application for you! If you want to learn how to use Backtrace in your nodejs application (no matter if you using JavaScript/TypeScript) please check examples directory! 

README.md

@@ -41,7 +41,7 @@ Sets the HTTP/HTTPS endpoint that error reports will be sent to.
 
 ##### `token`
 
-Required.
+Required if you're not using integration via submit.backtrace.io.
 
 Example: `51cc8e69c5b62fa8c72dc963e730f1e8eacbd243aeafc35d08d05ded9a024121`.
 
@@ -111,6 +111,18 @@ how many spaces they should be indented to correctly display the source code.
 Therefore the error report can override this number to specify how many spaces
 a hard tab should be represented by when viewing source code.
 
+#### `sampling`
+
+Now, Backtrace-node supports sampling attribute. By using this argument, you can prevent sending reports to the server. You can define sampling value in the BacktraceClientOptions.Sampling option which accepts values from 0 to 1, where 1 means sampling algorithm will skill all reports. If you want to know when Backtrace-node skips a report, please check BacktraceResult object, or use 'sampling-hit' event.
+
+#### `rateLimit`
+
+Backtrace-node supports client rate limiting! You can define how many reports per one minute you want to send to Backtrace by adding the additional option to the BacktraceClientOptions object. Now, when you reach the defined limit, the client will skip the current report. You can still learn which report won’t be available on the server by using event-emitter and ‘rate-limit’ events or by checking BacktraceResult – object that will return the reportSync/reportAsync method.
+
+### bt.getBacktraceClient()
+
+Returns a new `BacktraceClient` instance that you can use to send data to Backtrace. You can create new `BacktraceClient` manually and then replace existing default `BacktraceClient` with yours by using `use` method.
+
 ### bt.report([error], [attributes], [callback])
 
 Sends an error report to the endpoint specified in `initialize`.
@@ -266,7 +278,7 @@ such as the error message and stack trace and send this information along with
 the report.
 
 #### report.trace()
-
+[Deprecated]
 This function captures a stack trace at the current location. Due to the event
 loop, errors in Node.js sometimes are missing part of the stack trace.
 
@@ -281,6 +293,7 @@ trace is automatically called when you call createReport and when you call
 setError.
 
 #### report.log(...)
+[Deprecated]
 
 Adds a timestamped log message to the report. Log output is available when you
 view a report. The arguments to report.log are the same as the arguments to

appveyor.yml

@@ -1,10 +1,11 @@
-version: 0.7.{build}
+version: 1.0.{build}
 environment:
   nodejs_version: '6'
 branches:
   only:
     - /master
     - /dev
+    - /feature/typescript
 build: off
 init:
   # Good practise, because Windows line endings are different from Unix/Linux ones
@@ -13,7 +14,7 @@ before_build:
   - ps: Install-Product node $env:nodejs_version
 install:
   - npm install
-  - npm install -g mocha
+  - npm install -g mocha ts-node
 test_script:
   # Output useful info for debugging.
   - node --version

examples/javascript/electron/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "backtrace-ts-electron-sample",
+  "version": "1.0.0",
+  "description": "Backtrace sample Electron application with TypeScript support",
+  "main": "index.js",
+  "scripts": {
+    "start": "./node_modules/.bin/electron ./source/main.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/backtrace-labs/backtrace-node.git"
+  },
+  "keywords": [
+    "Backtrace",
+    "Error",
+    "reporting",
+    "exception"
+  ],
+  "author": "[email protected]",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/backtrace-labs/backtrace-node/issues"
+  },
+  "homepage": "https://github.com/backtrace-labs/backtrace-node#readme",
+  "devDependencies": {
+    "electron": "^4.1.4"
+  },
+  "dependencies": {
+    "backtrace-node": "file:../../.."
+  }
+}

examples/javascript/electron/source/main.js

@@ -0,0 +1,92 @@
+const bt = require('backtrace-node');
+const electron = require('electron');
+const fs = require('fs');
+const path = require('path');
+
+function ElectronExample() {
+  this.initializeRemoteLogging = function() {
+    const token = 'token';
+    const endpoint = `https://submit.backtrace.io/universe/${token}`;
+    this._backtraceClient = bt.initialize({
+      endpoint: endpoint + '/json',
+      timeout: 20000,
+    });
+
+    electron.crashReporter.start({
+      productName: 'Your product name',
+      companyName: 'My Company, Inc',
+      submitURL: endpoint + '/minidump',
+      uploadToServer: true,
+    });
+  };
+
+  this.readDataFromFileStorage = async function() {
+    this._backtraceClient.memorize('ipc-method::invoke-main', this);
+    try {
+      this._backtraceClient.memorize('ipc-method::invoke-main', 'before reading');
+      this.readFile();
+    } catch (e) {
+      await this._backtraceClient.reportAsync(
+        e,
+        {
+          attribute: 'attribute',
+          numberAttribute: 123132,
+          foo: false,
+        },
+        ['path', 'to', 'my', 'files'],
+      );
+    }
+  };
+
+  function forwardMessage(msg) {
+    this.ipcReply(msg);
+  }
+  function ipcReply(msg) {
+    electron.ipcRenderer.send(msg);
+  }
+
+  function readFile() {
+    fs.readFileSync('path to not existing file');
+  }
+
+  this.invokeInvalidIpcCommunication = async function() {
+    try {
+      this.forwardMessage('msg');
+    } catch (err) {
+      await this._backtraceClient.reportAsync(err);
+    }
+  };
+}
+
+async function createWindow() {
+  win = new electron.BrowserWindow({
+    width: 400,
+    height: 500,
+    darkTheme: true,
+  });
+  win.loadURL(path.join(__dirname, 'renderer', 'index.html'));
+
+  electron.app.setBadgeCount(1);
+  electron.ipcMain.on('invoke-main', async () => {
+    await electronExample.readDataFromFileStorage();
+  });
+
+  electron.ipcMain.on('invoke-main-2', async () => {
+    await electronExample.invokeInvalidIpcCommunication();
+  });
+
+  electron.ipcMain.on('crash-process', () => {
+    process.crash();
+  });
+}
+
+const electronExample = new ElectronExample();
+electronExample.initializeRemoteLogging();
+let win;
+
+electron.app.on('ready', createWindow);
+electron.app.on('activate', () => {
+  if (win === null) {
+    createWindow();
+  }
+});