├── .eslintrc.json ├── .github └── blunderbuss.yml ├── .gitignore ├── .travis.yml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── demo ├── demo-angular.html ├── demo-angular.js ├── demo.html ├── demo.js └── maps │ └── demo.min.js.map ├── gulpfile.js ├── package-lock.json ├── package.json ├── stackdriver-errors.d.ts ├── stackdriver-errors.js └── test ├── setup.js ├── test.html └── test.js /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "commonjs": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended" 8 | ], 9 | "parserOptions": { 10 | "ecmaVersion": 5 11 | }, 12 | "globals" : { 13 | "Promise": false 14 | }, 15 | "rules": { 16 | "array-bracket-spacing": "error", 17 | "block-scoped-var": "error", 18 | "brace-style": "error", 19 | "camelcase": ["error", {"properties": "never"}], 20 | "comma-dangle": ["error", "always-multiline"], 21 | "comma-spacing": "error", 22 | "complexity": ["error", 10], 23 | "computed-property-spacing": "error", 24 | "curly": "error", 25 | "eqeqeq": ["error", "smart"], 26 | "eol-last": "error", 27 | "func-call-spacing": "error", 28 | "indent": ["error", 2], 29 | "key-spacing": "error", 30 | "keyword-spacing": "error", 31 | "linebreak-style": "error", 32 | "new-cap": "error", 33 | "no-array-constructor": "error", 34 | "no-multiple-empty-lines": ["error", {"max": 2}], 35 | "no-tabs": "error", 36 | "no-trailing-spaces": "error", 37 | "object-curly-spacing": "error", 38 | "padded-blocks": ["error", "never"], 39 | "quote-props": ["error", "as-needed"], 40 | "quotes": ["error", "single"], 41 | "semi": "error", 42 | "semi-spacing": "error", 43 | "space-before-blocks": "error", 44 | "space-before-function-paren": ["error", { 45 | "anonymous": "never", 46 | "named": "never" 47 | }], 48 | "spaced-comment": ["error", "always"], 49 | "switch-colon-spacing": "error", 50 | "unicode-bom": ["error", "never"], 51 | "valid-jsdoc": ["error", { 52 | "requireReturn": false 53 | }] 54 | }, 55 | "overrides": [{ 56 | "files": ["test/*.js"], 57 | "env": { 58 | "mocha": true 59 | }, 60 | "globals": { 61 | "chai": false, 62 | "nise": false, 63 | "StackdriverErrorReporter": false 64 | }, 65 | "plugins": [ 66 | "mocha" 67 | ], 68 | "rules": { 69 | "mocha/handle-done-callback": "error", 70 | "mocha/no-exclusive-tests": "warn", 71 | "mocha/no-nested-tests": "error", 72 | "mocha/no-return-and-callback": "error" 73 | } 74 | }] 75 | } 76 | -------------------------------------------------------------------------------- /.github/blunderbuss.yml: -------------------------------------------------------------------------------- 1 | assign_issues: 2 | - GoogleCloudPlatform/observability-devx 3 | assign_prs: 4 | - GoogleCloudPlatform/observability-devx 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | node_modules/ 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "10" 4 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Want to contribute? Great! First, read this page — including the section on 2 | licensing your contribution. 3 | 4 | ## Developing 5 | 6 | After cloning the repository, use [npm] or [yarn] to install dependencies and 7 | run package commands. Examples using npm but the same commands work with yarn: 8 | 9 | * Run `npm install` to get all the dependencies. 10 | * Run `npm test` to lint and test your changes. 11 | * Run `npm run dist` to generate the minified version. 12 | * Run `npm start` to spawn a web server and load the demo in a browser. 13 | 14 | The demo allows you to test reporting errors from the local library with your 15 | own API key and project ID, see the network tab of your browser dev tools for 16 | the specific requests that get sent. Note you can expect to see 17 | [CORS preflight requests] but the behavior once deployed can vary. 18 | 19 | ## Code reviews 20 | 21 | All submissions, including submissions by project members, require review. We 22 | use Github pull requests for this purpose. Once submitted, [Travis CI] will 23 | automatically run the tests on your change, please check that this passes. 24 | 25 | Before you start working on a larger contribution, you should get in touch with 26 | us first through the issue tracker with your idea so that we can help out and 27 | possibly guide you. Coordinating up front makes it much easier to avoid 28 | frustration later on. 29 | 30 | ## Licensing your contribution 31 | 32 | Before we can use your code, you must sign the 33 | [Google Individual Contributor License Agreement] or 'CLA', which you can do 34 | online. 35 | 36 | The CLA is necessary mainly because you own the copyright to your changes, even 37 | after your contribution becomes part of our codebase, so we need your 38 | permission to use and distribute your code. We also need to be sure of various 39 | other things — for instance that you'll tell us if you know that your code 40 | infringes on other people's patents. You don't have to sign the CLA until after 41 | you've submitted your code for review and a member has approved it, but you 42 | must do it before we can put your code into our codebase. 43 | 44 | ### Contributions by corporations 45 | 46 | Contributions made by corporations are covered by a different agreement than 47 | the one above, the [Software Grant and Corporate Contributor License Agreement]. 48 | 49 | ## Creating a new release 50 | 51 | From master branch with all required changes landed and pulled: 52 | 53 | * Run `npm version minor -m 'Release %s'` with semver component as needed. 54 | * Push commit and new tag with `git push --follow-tags`. 55 | * Create a [GitHub Release]. 56 | * Publish new package to npm registry with `npm publish`. 57 | 58 | 59 | [npm]: https://www.npmjs.com/ 60 | [yarn]: https://yarnpkg.com/ 61 | [CORS preflight requests]: https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request 62 | [Travis CI]: https://docs.travis-ci.com/ 63 | [Google Individual Contributor License Agreement]: https://cla.developers.google.com/about/google-individual 64 | [Software Grant and Corporate Contributor License Agreement]: https://cla.developers.google.com/about/google-corporate 65 | [GitHub Release]: https://github.com/GoogleCloudPlatform/stackdriver-errors-js/releases 66 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2017 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Experimental Client-side JavaScript library for Cloud Error Reporting 2 | 3 | > **This is not an official Google product.** This module is experimental and may not be ready for use. 4 | 5 | This **experimental** library provides Cloud Error Reporting support for client-side web JavaScript applications. [Cloud Error Reporting](https://cloud.google.com/error-reporting/) is a feature of Google Cloud Platform that allows in-depth monitoring and viewing of errors reported by applications running in almost any environment. For server-side Node.js error reporting, use [cloud-errors-nodejs](https://github.com/GoogleCloudPlatform/cloud-errors-nodejs) instead. 6 | 7 | Here's an introductory video: 8 | 9 | [![Learn about Cloud Error Reporting][video thumbnail]][video link] 10 | 11 | ## Prerequisites 12 | 13 | 1. You need a [Google Cloud project](https://console.cloud.google.com). 14 | 15 | 2. [Enable the Cloud Error Reporting API](https://console.cloud.google.com/apis/api/clouderrorreporting.googleapis.com/overview) for your project. We highly recommend to restrict the usage of the key to your website URL only using an 'HTTP referrer' restriction. 16 | 17 | 3. Create a browser API key: 18 | - Follow [using api keys instructions](https://support.google.com/cloud/answer/6158862) to get an API key for your project. 19 | - Recommended: Use **Application restrictions** to restrict this key to your website. 20 | - Recommended: Use **API restrictions** to limit this key to the *Cloud Error Reporting API*. 21 | 22 | If API keys are not an option for your team, [use a custom url]( 23 | #configuring-without-an-api-key) to send your errors to your backend. 24 | 25 | ## Quickstart 26 | 27 | The library can either be used as a standalone script, or incorporated as a module into a larger javascript application. 28 | 29 | For use in any HTML page or without a specific framework, include the standalone script from CDN and set up the error handler in a page load event. 30 | For instance, use include the following HTML in the page `` and replace: 31 | 32 | * `` with the [latest version of the NPM package](https://www.npmjs.com/package/stackdriver-errors-js) 33 | * `` with your API key 34 | * `` with and Google Cloud project ID string: 35 | 36 | ```HTML 37 | 38 | 39 | 49 | ``` 50 | And that's all you need to do! Unhandled exceptions will now automatically be reported to your project. 51 | 52 | ### Test your setup 53 | 54 | Open the page that you instrumented, open the Developer Tools console and enter the following to trigger an unhandled exception: 55 | 56 | ```javascript 57 | (function testErrorReporting() { 58 | window.onerror(null, null, null, null, new Error('Test: Something broke!')); 59 | })(); 60 | ``` 61 | 62 | Open [Cloud Error Reporting](https://console.cloud.google.com/errors) to view the error and opt-in to notifications on new errors. 63 | 64 | 65 | ## Setup for JavaScript 66 | 67 | ### Installing 68 | 69 | We recommend using npm: `npm install stackdriver-errors-js --save`. 70 | 71 | ### Initialization 72 | 73 | Create a file that is included in your application entry point and has access to variables `myApiKey` and `myProjectId`. For ES6 projects it can be in the form: 74 | 75 | ```javascript 76 | // Warning: Experimental library, do not use in production environments. 77 | import StackdriverErrorReporter from 'stackdriver-errors-js'; 78 | 79 | const errorHandler = new StackdriverErrorReporter(); 80 | errorHandler.start({ 81 | key: myApiKey, 82 | projectId: myProjectId, 83 | 84 | // The following optional arguments can also be provided: 85 | 86 | // service: myServiceName, 87 | // Name of the service reporting the error, defaults to 'web'. 88 | 89 | // version: myServiceVersion, 90 | // Version identifier of the service reporting the error. 91 | 92 | // reportUncaughtExceptions: false 93 | // Set to false to prevent reporting unhandled exceptions, default: `true`. 94 | 95 | // reportUnhandledPromiseRejections: false 96 | // Set to false to prevent reporting unhandled promise rejections, default: `true`. 97 | 98 | // disabled: true 99 | // Set to true to not send error reports, this can be used when developing locally, default: `false`. 100 | 101 | // context: {user: 'user1'} 102 | // You can set the user later using setUser() 103 | }); 104 | ``` 105 | 106 | Note this uses the ES6 import syntax, if your project does not use a compilation step, instead the source with dependencies and polyfills bundled can be used directly: 107 | 108 | ```javascript 109 | var StackdriverErrorReporter = require('stackdriver-errors-js/dist/stackdriver-errors-concat.min.js'); 110 | 111 | var errorHandler = new StackdriverErrorReporter(); 112 | errorHandler.start({ 113 | key: myApiKey, 114 | projectId: myProjectId, 115 | // Other optional arguments can be supplied, see above. 116 | }); 117 | ``` 118 | 119 | ### Usage 120 | 121 | Unhandled exception will now automatically be sent to Stackdriver Error Reporting. 122 | 123 | You can also change your application code to report errors: 124 | 125 | ```javascript 126 | try { 127 | ... 128 | } catch(e) { 129 | errorHandler.report(e); 130 | } 131 | ``` 132 | 133 | Or simply: 134 | 135 | ```javascript 136 | errorHandler.report('Something broke!'); 137 | ``` 138 | 139 | You can set a user identifier at any time using: 140 | 141 | ```javascript 142 | errorHandler.setUser('userId') 143 | ``` 144 | 145 | ## Setup for AngularJS 146 | 147 | ### Initialization 148 | 149 | 1. Load the `dist/stackdriver-errors-concat.min.js` JavaScript module. 150 | 151 | 2. Implement a new [AngularJS exception handler](https://docs.angularjs.org/api/ng/service/$exceptionHandler) for your application: 152 | 153 | ```javascript 154 | angular.module('myAngularApp', []) 155 | 156 | .factory('$exceptionHandler', ['$log', '$window', function($log, $window) { 157 | var StackdriverErrors = new $window.StackdriverErrorReporter(); 158 | StackdriverErrors.start({ 159 | key: '', 160 | projectId: '', 161 | // Other optional arguments can be supplied, see above. 162 | }); 163 | 164 | return function(exception, cause) { 165 | StackdriverErrors.report(exception); 166 | $log.warn('Reported error:', exception, cause); 167 | }; 168 | }]) 169 | ``` 170 | 171 | ### Usage 172 | 173 | Uncaught exception in angular expressions will now be reported to Stackdriver Error Reporting. 174 | 175 | If you wish, you can manually delegate exceptions, for instance: 176 | ```javascript 177 | try { ... } catch(e) { $exceptionHandler(e); } 178 | ``` 179 | Or simply: 180 | ```javascript 181 | $exceptionHandler('Something broke!'); 182 | ``` 183 | 184 | ## Setup for ReactJS 185 | 186 | Follow the general instructions denoted in _Setup for JavaScript_ to load and initialize the library. 187 | 188 | There is nothing specific that needs to be done with React, other than making sure to initialize the library in your root entry point (typically `index.js`). 189 | 190 | ## Source maps 191 | 192 | Only publicly available JavaScript source maps are supported. 193 | 194 | Your minified file need to be appended with a comment directive to your source map file: 195 | 196 | ```javascript 197 | //# sourceMappingURL=http://example.com/path/to/your/sourcemap.map 198 | ``` 199 | 200 | ## Configuring without an API key 201 | 202 | If you are in a situation where an API key is not an option but you already have an acceptable way to communicate with the Stackdriver API (e.g., a secure back end service running in App Engine), you can configure the endpoint that errors are sent to with the following: 203 | 204 | ```javascript 205 | const errorHandler = new StackdriverErrorReporter(); 206 | errorHandler.start({ 207 | targetUrl: '', 208 | service: '', // (optional) 209 | version: '' // (optional) 210 | }); 211 | ``` 212 | 213 | where `targetUrl` is the url you'd like to send errors to and can be relative or absolute. This endpoint will need to support the [Report API endpoint](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report). 214 | 215 | ## Custom message dispatching 216 | 217 | If you can't use HTTP Post requests for reporting your errors, or in need for some more complicated customizations, you may provide a custom function to handle the reporting. 218 | 219 | The function will be called with a payload argument (the same one that would have been sent on the HTTP Post request) and should return a Promise. 220 | 221 | ```javascript 222 | const errorHandler = new StackdriverErrorReporter(); 223 | function myCustomFunction(payload) { 224 | console.log("custom reporting function called with payload:", payload); 225 | return Promise.resolve(); 226 | } 227 | errorHandler.start({ 228 | customReportingFunction: myCustomFunction, 229 | }); 230 | ``` 231 | 232 | ## Best Practices 233 | 234 | ### Only reporting in the production environment with Webpack 235 | 236 | If using webpack and the `DefinePlugin`, it is advisable to wrap the initialization logic to only occur in your production environment. Otherwise, with local development you will receive 403s if you restricted your API key to your production environment(which is _HIGHLY_ recommended). The code for this would look something along these lines: 237 | 238 | ```javascript 239 | // webpack.production.js 240 | 241 | module.exports = { 242 | // ... 243 | plugins: [ 244 | new webpack.DefinePlugin({ 245 | 'process.env.NODE_ENV': JSON.stringify('production') 246 | }), 247 | ], 248 | // ... 249 | } 250 | ``` 251 | 252 | ```javascript 253 | // index.js 254 | 255 | if (process.env.NODE_ENV === 'production') { 256 | const errorHandler = new StackdriverErrorReporter(); 257 | errorHandler.start({ 258 | key: '', 259 | projectId: '', 260 | }); 261 | } 262 | ``` 263 | 264 | ### Usage as a utility 265 | 266 | If you would like to use the error logger throughout your application, there are many options that exist. The simplest is to pull the initialization logic into its own file and reference it as necessary throughout your application as a module. An example would be as follows: 267 | 268 | ```javascript 269 | // errorHandlerUtility.js 270 | import StackdriverErrorReporter from 'stackdriver-errors-js'; 271 | 272 | let errorHandler; 273 | 274 | if (process.env.NODE_ENV === 'production') { 275 | errorHandler = new StackdriverErrorReporter(); 276 | errorHandler.start({ 277 | key: '', 278 | projectId: '', 279 | // Other optional arguments can be supplied, see above. 280 | }); 281 | } else { 282 | errorHandler = {report: console.error}; 283 | } 284 | 285 | export default errorHandler; 286 | ``` 287 | 288 | Consumption of `errorHandlerUtility` would essentially follow the following pattern: 289 | 290 | ```javascript 291 | import errorHandler from './errorHandlerUtility'; 292 | 293 | try { 294 | someFunctionThatThrows(); 295 | } catch (error) { 296 | errorHandler.report(error); 297 | } 298 | ``` 299 | 300 | If the call to report has additional levels of wrapping code, extra frames can be trimmed from the top of generated stacks by using a number greater than one for the `skipLocalFrames` option: 301 | 302 | ```javascript 303 | import errorHandler from './errorHandlerUtility'; 304 | 305 | function backendReport (string) { 306 | // Skipping the two frames, for report() and for backendReport() 307 | errorHandler.report(error, {skipLocalFrames: 2}); 308 | } 309 | ``` 310 | 311 | ## FAQ 312 | 313 | **Q: Should I use this code in my production application?** 314 | A: This is an experimental library provided without any guarantee or official support. We do not recommend using it on production without performing a review of its code. 315 | 316 | **Q: Are private source maps supported?** 317 | A: No, see [issue #4](https://github.com/GoogleCloudPlatform/stackdriver-errors-js/issues/4). 318 | 319 | **Q: Can I propose changes to the library?** 320 | A: Yes, see [the Contributing documentation](CONTRIBUTING.md) for more details. 321 | 322 | 323 | [video thumbnail]: https://img.youtube.com/vi/cVpWVD75Hs8/0.jpg 324 | [video link]: https://www.youtube.com/watch?v=cVpWVD75Hs8 325 | -------------------------------------------------------------------------------- /demo/demo-angular.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |

Angular App

11 |
12 |
13 | 14 |
15 |
16 | 17 | -------------------------------------------------------------------------------- /demo/demo-angular.js: -------------------------------------------------------------------------------- 1 | angular.module('demoApp', []) // eslint-disable-line no-undef 2 | 3 | .factory('$exceptionHandler', ['$log', '$window', function($log, $window) { 4 | var StackdriverErrors = new $window.StackdriverErrorReporter(); 5 | StackdriverErrors.start({ 6 | projectId: '', 7 | key: '', 8 | }); 9 | 10 | return function(exception, cause) { 11 | StackdriverErrors.report(exception); 12 | $log.warn('Reported error:', exception, cause); 13 | }; 14 | }]) 15 | 16 | .controller('DemoController', function() { 17 | var demo = this; 18 | demo.starUser = function() { 19 | demo.user.star(); 20 | }; 21 | }); 22 | -------------------------------------------------------------------------------- /demo/demo.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 |
13 |
14 |
15 | stackdriver-errors.js 16 |
17 | 22 |
23 |
24 |
25 | stackdriver-errors.js 26 | 31 |
32 | 33 |
34 |
35 |
36 |

Generate client side JS errors

37 |

38 | Clicking these buttons will trigger JavaScript error in the browser. 39 |

40 |

41 | 42 |

43 |

44 | 45 |

46 |

47 | 48 |

49 | 50 |

Parameters

51 |

52 |

53 | 54 | 55 |
56 |

57 |

58 |

59 | 60 | 61 |
62 |

63 |

64 | 65 |

66 | 67 |
68 |
69 |
70 |
71 | 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /demo/demo.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2016 Google Inc. All Rights Reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | // eslint-disable-next-line no-undef 17 | var StackdriverErrors = new StackdriverErrorReporter(); 18 | 19 | function updateConfig() { 20 | var key = document.getElementById('input-apikey').value; 21 | var projectId = document.getElementById('input-projectid').value; 22 | 23 | localStorage.setItem('key', key); 24 | localStorage.setItem('projectId', projectId); 25 | 26 | StackdriverErrors.start({ 27 | key: key, 28 | projectId: projectId, 29 | service: 'webapp', 30 | version: 'demo', 31 | }); 32 | } 33 | 34 | function loadFromLocalStorage() { 35 | var key = localStorage.getItem('key'); 36 | var projectId = localStorage.getItem('projectId'); 37 | document.getElementById('input-apikey').value = key; 38 | document.getElementById('input-projectid').value = projectId; 39 | 40 | if (key && projectId) { 41 | updateConfig(); 42 | } else { 43 | // eslint-disable-next-line no-console 44 | console.warn('No API key provided, Stackdriver not started.'); 45 | } 46 | } 47 | loadFromLocalStorage(); 48 | 49 | 50 | // Fake application code 51 | var users; 52 | function vanillaCrash() { // eslint-disable-line no-unused-vars 53 | starUsers(); 54 | } 55 | function starUsers() { 56 | for (var i = 0; i < users.length; i++) { 57 | users.starred = true; 58 | } 59 | } 60 | function displayUserInfo() { 61 | if (!users) { 62 | StackdriverErrors.report('No user information to display'); 63 | } 64 | } 65 | function addUser(name) { 66 | var user = new User(name); // eslint-disable-line no-undef 67 | users.push(user); 68 | } 69 | 70 | 71 | // Buttons logic 72 | function reportErrorMessage() { // eslint-disable-line no-unused-vars 73 | displayUserInfo(); 74 | } 75 | function catchCrashAndReport() { // eslint-disable-line no-unused-vars 76 | try { 77 | addUser('Keyser Söze'); 78 | } catch (e) { 79 | StackdriverErrors.report(e); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /demo/maps/demo.min.js.map: -------------------------------------------------------------------------------- 1 | {"version":3,"sources":["demo.js"],"names":["updateConfig","key","document","getElementById","value","projectId","localStorage","setItem","StackdriverErrors","start","service","version","loadFromLocalStorage","getItem","console","warn","vanillaCrash","starUsers","i","users","length","starred","displayUserInfo","report","addUser","name","user","User","push","reportErrorMessage","catchCrashAndReport","e","StackdriverErrorReporter"],"mappings":"AAiBA,QAASA,gBACP,GAAIC,GAAMC,SAASC,eAAe,gBAAgBC,MAC9CC,EAAYH,SAASC,eAAe,mBAAmBC,KAE3DE,cAAaC,QAAQ,MAAON,GAC5BK,aAAaC,QAAQ,YAAaF,GAElCG,kBAAkBC,OAChBR,IAAKA,EACLI,UAAWA,EACXK,QAAS,SACTC,QAAS,SAIb,QAASC,wBACP,GAAIX,GAAMK,aAAaO,QAAQ,OAC3BR,EAAYC,aAAaO,QAAQ,YACrCX,UAASC,eAAe,gBAAgBC,MAAQH,EAChDC,SAASC,eAAe,mBAAmBC,MAAQC,EAEhDJ,GAAOI,EACRL,eAEAc,QAAQC,KAAK,iDAQjB,QAASC,gBACPC,YAEF,QAASA,aACP,IAAI,GAAIC,GAAI,EAAGA,EAAIC,MAAMC,OAAQF,IAC/BC,MAAME,SAAU,EAGpB,QAASC,mBACHH,OACFX,kBAAkBe,OAAO,kCAG7B,QAASC,SAAQC,GACf,GAAIC,GAAO,GAAIC,KACfR,OAAMS,KAAKF,GAKb,QAASG,sBACPP,kBAEF,QAASQ,uBACP,IACEN,QAAQ,eACR,MAAOO,GACPvB,kBAAkBe,OAAOQ,IA7D7B,GAAIvB,mBAAoB,GAAIwB,yBA6B5BpB,uBAIA,IAAIO","file":"../demo.min.js","sourcesContent":["/**\n * Copyright 2016 Google Inc. All Rights Reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nvar StackdriverErrors = new StackdriverErrorReporter();\n\nfunction updateConfig() {\n var key = document.getElementById('input-apikey').value;\n var projectId = document.getElementById('input-projectid').value;\n\n localStorage.setItem('key', key);\n localStorage.setItem('projectId', projectId);\n\n StackdriverErrors.start({\n key: key,\n projectId: projectId,\n service: 'webapp',\n version: 'demo'\n });\n}\n\nfunction loadFromLocalStorage() {\n var key = localStorage.getItem('key');\n var projectId = localStorage.getItem('projectId');\n document.getElementById('input-apikey').value = key;\n document.getElementById('input-projectid').value = projectId;\n\n if(key && projectId) {\n updateConfig();\n } else {\n console.warn('No API key provided, Stackdriver not started.');\n }\n}\nloadFromLocalStorage();\n\n\n// Fake application code\nvar users;\nfunction vanillaCrash() {\n starUsers();\n}\nfunction starUsers() {\n for(var i = 0; i < users.length; i++) {\n users.starred = true;\n }\n}\nfunction displayUserInfo() {\n if(!users) {\n StackdriverErrors.report('No user information to display');\n }\n}\nfunction addUser(name) {\n var user = new User();\n users.push(user);\n}\n\n\n// Buttons logic\nfunction reportErrorMessage() {\n displayUserInfo();\n}\nfunction catchCrashAndReport() {\n try {\n addUser('Keyser Söze');\n } catch (e) {\n StackdriverErrors.report(e);\n }\n}\n"]} -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2016 Google Inc. All Rights Reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | var browserify = require('browserify'); 17 | var gulp = require('gulp'); 18 | var rename = require('gulp-rename'); 19 | var replace = require('gulp-replace'); 20 | var uglify = require('gulp-uglify'); 21 | var sourcemaps = require('gulp-sourcemaps'); 22 | var buffer = require('vinyl-buffer'); 23 | var source = require('vinyl-source-stream'); 24 | 25 | var SRC_FILE = 'stackdriver-errors.js'; 26 | var DEST = 'dist/'; 27 | 28 | gulp.task('lib-concat', function() { 29 | return browserify({ 30 | debug: true, 31 | entries: SRC_FILE, 32 | standalone: 'StackdriverErrorReporter', 33 | }) 34 | .plugin('browser-pack-flat/plugin') 35 | .bundle() 36 | .pipe(source(SRC_FILE)) 37 | .pipe(rename({suffix: '-concat'})) 38 | .pipe(buffer()) 39 | .pipe(sourcemaps.init({loadMaps: true})) 40 | // This will output the non-minified version 41 | .pipe(gulp.dest(DEST)) 42 | // This will minify and rename to stackdriver-errors.min.js 43 | .pipe(uglify()) 44 | .pipe(rename({extname: '.min.js'})) 45 | .pipe(sourcemaps.write('maps')) 46 | .pipe(gulp.dest(DEST)); 47 | }); 48 | 49 | gulp.task('demo-html', function() { 50 | return gulp.src('demo/demo.html') 51 | .pipe(replace(/..\/dist\//g, '')) 52 | .pipe(replace(/..\/demo\/demo\.js/g, 'demo.min.js')) 53 | .pipe(rename('index.html')) 54 | .pipe(gulp.dest('dist')); 55 | }); 56 | 57 | gulp.task('demo-js', function() { 58 | return gulp.src('demo/demo.js') 59 | .pipe(sourcemaps.init()) 60 | .pipe(uglify()) 61 | .pipe(rename({extname: '.min.js'})) 62 | .pipe(sourcemaps.write('maps')) 63 | .pipe(gulp.dest('dist')); 64 | }); 65 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "stackdriver-errors-js", 3 | "version": "0.12.0", 4 | "description": "Experimental client-side JavaScript library to report errors to Stackdriver Error Reporting", 5 | "main": "stackdriver-errors.js", 6 | "types": "stackdriver-errors.d.ts", 7 | "scripts": { 8 | "clean": "rimraf dist/", 9 | "dist": "gulp lib-concat", 10 | "lint": "eslint --ignore-path .gitignore .", 11 | "prepare": "npm run clean && npm run dist", 12 | "pretest": "npm run lint", 13 | "start": "gulp lib-concat demo-js demo-html && http-server ./dist -o", 14 | "test": "mocha -r test/setup.js test/test.js" 15 | }, 16 | "repository": { 17 | "type": "git", 18 | "url": "https://github.com/GoogleCloudPlatform/stackdriver-errors-js" 19 | }, 20 | "files": [ 21 | "dist/", 22 | "stackdriver-errors.d.ts" 23 | ], 24 | "keywords": [ 25 | "stackdriver", 26 | "error", 27 | "crash", 28 | "reporting", 29 | "javascript", 30 | "web" 31 | ], 32 | "author": "steren@google.com", 33 | "license": "Apache-2.0", 34 | "devDependencies": { 35 | "browser-pack-flat": "^3.4.2", 36 | "browserify": "^16.5.2", 37 | "chai": "^4.3.4", 38 | "eslint": "^5.16.0", 39 | "eslint-plugin-mocha": "^5.3.0", 40 | "gulp": "^4.0.2", 41 | "gulp-rename": "^1.4.0", 42 | "gulp-replace": "^1.1.2", 43 | "gulp-sourcemaps": "^2.6.5", 44 | "gulp-uglify": "^3.0.2", 45 | "http-server": "^0.12.3", 46 | "mocha": "^9.0.2", 47 | "nise": "^1.5.3", 48 | "rimraf": "^2.7.1", 49 | "vinyl-buffer": "^1.0.1", 50 | "vinyl-source-stream": "^2.0.0" 51 | }, 52 | "dependencies": { 53 | "stacktrace-js": "^2.0.2" 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /stackdriver-errors.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'stackdriver-errors-js' { 2 | /** 3 | * Context to be sent along with the error 4 | */ 5 | interface Context { 6 | /** 7 | * User who caused or was affected by the error 8 | */ 9 | userId?: string; 10 | 11 | [x: string]: any; 12 | } 13 | 14 | /** 15 | * Context to be sent along with the error 16 | */ 17 | interface PayloadContext extends Context { 18 | httpRequest: { 19 | /** 20 | * Requesting agent 21 | */ 22 | userAgent: string; 23 | 24 | /** 25 | * Website URL 26 | */ 27 | url: string; 28 | }; 29 | } 30 | 31 | /** 32 | * Service context 33 | */ 34 | interface ServiceContext { 35 | /** 36 | * Name of the service reporting the error 37 | */ 38 | service: string; 39 | 40 | /** 41 | * Version identifier of the service reporting the error 42 | */ 43 | version: string; 44 | } 45 | 46 | /** 47 | * Payload passed to the custom reporting function 48 | */ 49 | interface Payload { 50 | /** 51 | * Context related to this error 52 | */ 53 | context: PayloadContext; 54 | 55 | /** 56 | * Error message 57 | */ 58 | message: string; 59 | 60 | /** 61 | * Service context 62 | */ 63 | serviceContext: ServiceContext; 64 | } 65 | 66 | /** 67 | * Initial configuration 68 | */ 69 | interface InitialConfiguration { 70 | /** 71 | * Overwrite endpoint that errors are reported to. 72 | */ 73 | targetUrl?: string; 74 | 75 | /** 76 | * The context in which the error occurred 77 | */ 78 | context?: Context; 79 | 80 | /** 81 | * Custom function to be called with the error payload for reporting, 82 | * instead of HTTP request 83 | * 84 | * @param payload Error payload 85 | */ 86 | customReportingFunction?: (payload: Payload) => Promise; 87 | 88 | /** 89 | * Set to true to not send error reports, this can be used when 90 | * developing locally 91 | * 92 | * @default false 93 | */ 94 | disabled?: boolean; 95 | 96 | /** 97 | * The API key to use to call the API 98 | */ 99 | key: string; 100 | 101 | /** 102 | * The Google Cloud Platform project ID to report errors to 103 | */ 104 | projectId: string; 105 | 106 | /** 107 | * Set to false to prevent reporting unhandled exceptions 108 | * 109 | * @default true 110 | */ 111 | reportUncaughtExceptions?: boolean; 112 | 113 | /** 114 | * Set to false to prevent reporting unhandled promise rejections 115 | * 116 | * @default true 117 | */ 118 | reportUnhandledPromiseRejections?: boolean; 119 | 120 | /** 121 | * Name of the service reporting the error 122 | * 123 | * @default "web" 124 | */ 125 | service?: string; 126 | 127 | /** 128 | * Version identifier of the service reporting the error 129 | */ 130 | version?: string; 131 | } 132 | 133 | /** 134 | * Error report options 135 | */ 136 | interface ReportOptions { 137 | /** 138 | * Omit number of frames if creating stack 139 | * 140 | * @default 1 141 | */ 142 | skipLocalFrames?: number; 143 | } 144 | 145 | /** 146 | * An Error handler that sends errors to the Stackdriver Error Reporting API 147 | */ 148 | class StackdriverErrorReporter { 149 | /** 150 | * Initializes the client 151 | * 152 | * @param options Initial configuration 153 | */ 154 | start(options: InitialConfiguration): void; 155 | 156 | /** 157 | * Report an error to the Stackdriver Error Reporting API 158 | * 159 | * @param error The Error object or message string to report 160 | * @param options Configuration for this report 161 | */ 162 | report(error: string | Error, options?: ReportOptions): Promise; 163 | 164 | /** 165 | * Set the user for the current context. 166 | * 167 | * @param user The unique identifier of the user (can be ID, email or 168 | * custom token) or undefined if not logged in 169 | */ 170 | setUser(user?: string): void; 171 | } 172 | 173 | export default StackdriverErrorReporter; 174 | } 175 | -------------------------------------------------------------------------------- /stackdriver-errors.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2016 Google Inc. All Rights Reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | var StackTrace = require('stacktrace-js'); 18 | 19 | /** 20 | * URL endpoint of the Stackdriver Error Reporting report API. 21 | */ 22 | var baseAPIUrl = 'https://clouderrorreporting.googleapis.com/v1beta1/projects/'; 23 | 24 | /** 25 | * An Error handler that sends errors to the Stackdriver Error Reporting API. 26 | */ 27 | var StackdriverErrorReporter = function() {}; 28 | 29 | /** 30 | * Initialize the StackdriverErrorReporter object. 31 | * @param {Object} config - the init configuration. 32 | * @param {Object} [config.context={}] - the context in which the error occurred. 33 | * @param {string} [config.context.user] - the user who caused or was affected by the error. 34 | * @param {String} config.key - the API key to use to call the API. 35 | * @param {String} config.projectId - the Google Cloud Platform project ID to report errors to. 36 | * @param {Function} config.customReportingFunction - Custom function to be called with the error payload for reporting, instead of HTTP request. The function should return a Promise. 37 | * @param {String} [config.service=web] - service identifier. 38 | * @param {String} [config.version] - version identifier. 39 | * @param {Boolean} [config.reportUncaughtExceptions=true] - Set to false to stop reporting unhandled exceptions. 40 | * @param {Boolean} [config.disabled=false] - Set to true to not report errors when calling report(), this can be used when developping locally. 41 | */ 42 | StackdriverErrorReporter.prototype.start = function(config) { 43 | if (!config.key && !config.targetUrl && !config.customReportingFunction) { 44 | throw new Error('Cannot initialize: No API key, target url or custom reporting function provided.'); 45 | } 46 | if (!config.projectId && !config.targetUrl && !config.customReportingFunction) { 47 | throw new Error('Cannot initialize: No project ID, target url or custom reporting function provided.'); 48 | } 49 | 50 | this.customReportingFunction = config.customReportingFunction; 51 | this.apiKey = config.key; 52 | this.projectId = config.projectId; 53 | this.targetUrl = config.targetUrl; 54 | this.context = config.context || {}; 55 | this.serviceContext = {service: config.service || 'web'}; 56 | if (config.version) { 57 | this.serviceContext.version = config.version; 58 | } 59 | this.reportUncaughtExceptions = config.reportUncaughtExceptions !== false; 60 | this.reportUnhandledPromiseRejections = config.reportUnhandledPromiseRejections !== false; 61 | this.disabled = !!config.disabled; 62 | 63 | registerHandlers(this); 64 | }; 65 | 66 | function registerHandlers(reporter) { 67 | // Register as global error handler if requested 68 | var noop = function() {}; 69 | if (reporter.reportUncaughtExceptions) { 70 | var oldErrorHandler = window.onerror || noop; 71 | 72 | window.onerror = function(message, source, lineno, colno, error) { 73 | if (error) { 74 | reporter.report(error).catch(noop); 75 | } 76 | oldErrorHandler(message, source, lineno, colno, error); 77 | return true; 78 | }; 79 | } 80 | if (reporter.reportUnhandledPromiseRejections) { 81 | var oldPromiseRejectionHandler = window.onunhandledrejection || noop; 82 | 83 | window.onunhandledrejection = function(promiseRejectionEvent) { 84 | if (promiseRejectionEvent) { 85 | reporter.report(promiseRejectionEvent.reason).catch(noop); 86 | } 87 | oldPromiseRejectionHandler(promiseRejectionEvent); 88 | return true; 89 | }; 90 | } 91 | } 92 | 93 | /** 94 | * Report an error to the Stackdriver Error Reporting API 95 | * @param {Error|String} err - The Error object or message string to report. 96 | * @param {Object} options - Configuration for this report. 97 | * @param {number} [options.skipLocalFrames=1] - Omit number of frames if creating stack. 98 | * @returns {Promise} A promise that completes when the report has been sent. 99 | */ 100 | StackdriverErrorReporter.prototype.report = function(err, options) { 101 | if (this.disabled) { 102 | return Promise.resolve(null); 103 | } 104 | if (!err) { 105 | return Promise.reject(new Error('no error to report')); 106 | } 107 | options = options || {}; 108 | 109 | var payload = {}; 110 | payload.serviceContext = this.serviceContext; 111 | payload.context = this.context; 112 | payload.context.httpRequest = { 113 | userAgent: window.navigator.userAgent, 114 | url: window.location.href, 115 | }; 116 | 117 | var firstFrameIndex = 0; 118 | if (typeof err == 'string' || err instanceof String) { 119 | // Transform the message in an error, use try/catch to make sure the stacktrace is populated. 120 | try { 121 | throw new Error(err); 122 | } catch (e) { 123 | err = e; 124 | } 125 | // the first frame when using report() is always this library 126 | firstFrameIndex = options.skipLocalFrames || 1; 127 | } 128 | 129 | var reportUrl = this.targetUrl || ( 130 | baseAPIUrl + this.projectId + '/events:report?key=' + this.apiKey); 131 | 132 | var customFunc = this.customReportingFunction; 133 | 134 | return resolveError(err, firstFrameIndex) 135 | .then(function(message) { 136 | payload.message = message; 137 | if (customFunc) { 138 | return customFunc(payload); 139 | } 140 | return sendErrorPayload(reportUrl, payload); 141 | }); 142 | }; 143 | 144 | function resolveError(err, firstFrameIndex) { 145 | // This will use sourcemaps and normalize the stack frames 146 | return StackTrace.fromError(err).then(function(stack) { 147 | var lines = [err.toString()]; 148 | // Reconstruct to a JS stackframe as expected by Error Reporting parsers. 149 | for (var s = firstFrameIndex; s < stack.length; s++) { 150 | // Cannot use stack[s].source as it is not populated from source maps. 151 | lines.push([ 152 | ' at ', 153 | // If a function name is not available '' will be used. 154 | stack[s].getFunctionName() || '', ' (', 155 | stack[s].getFileName(), ':', 156 | stack[s].getLineNumber(), ':', 157 | stack[s].getColumnNumber(), ')', 158 | ].join('')); 159 | } 160 | return lines.join('\n'); 161 | }, function(reason) { 162 | // Failure to extract stacktrace 163 | return [ 164 | 'Error extracting stack trace: ', reason, '\n', 165 | err.toString(), '\n', 166 | ' (', err.file, ':', err.line, ':', err.column, ')', 167 | ].join(''); 168 | }); 169 | } 170 | 171 | function sendErrorPayload(url, payload) { 172 | var xhr = new XMLHttpRequest(); 173 | xhr.open('POST', url, true); 174 | xhr.setRequestHeader('Content-Type', 'application/json; charset=UTF-8'); 175 | 176 | return new Promise(function(resolve, reject) { 177 | xhr.onreadystatechange = function() { 178 | if (xhr.readyState === 4) { 179 | var code = xhr.status; 180 | if (code >= 200 && code < 300) { 181 | resolve({message: payload.message}); 182 | } else if (code === 429) { 183 | // HTTP 429 responses are returned by Stackdriver when API quota 184 | // is exceeded. We should not try to reject these as unhandled errors 185 | // or we may cause an infinite loop with 'reportUncaughtExceptions'. 186 | reject( 187 | { 188 | message: 'quota or rate limiting error on stackdriver report', 189 | name: 'Http429FakeError', 190 | }); 191 | } else { 192 | var condition = code ? code + ' http response' : 'network error'; 193 | reject(new Error(condition + ' on stackdriver report')); 194 | } 195 | } 196 | }; 197 | xhr.send(JSON.stringify(payload)); 198 | }); 199 | } 200 | 201 | /** 202 | * Set the user for the current context. 203 | * 204 | * @param {string} user - the unique identifier of the user (can be ID, email or custom token) or `undefined` if not logged in. 205 | */ 206 | StackdriverErrorReporter.prototype.setUser = function(user) { 207 | this.context.user = user; 208 | }; 209 | 210 | module.exports = StackdriverErrorReporter; 211 | -------------------------------------------------------------------------------- /test/setup.js: -------------------------------------------------------------------------------- 1 | // Setup for tests to run outside of a browser environment 2 | global.chai = require('chai'); 3 | global.nise = require('nise'); 4 | 5 | global.StackdriverErrorReporter = require('../stackdriver-errors'); 6 | 7 | global.window = { 8 | location: {href: 'http://stackdriver-errors.test/'}, 9 | navigator: {userAgent: 'FakeAgent'}, 10 | }; 11 | global.XMLHttpRequest = nise.fakeXhr.FakeXMLHttpRequest; 12 | -------------------------------------------------------------------------------- /test/test.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | stackdriver-errors-js tests 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /test/test.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2016 Google Inc. All Rights Reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | var expect = chai.expect; 17 | var fakeXhr = nise.fakeXhr; 18 | 19 | var errorHandler; 20 | var xhr, requests, requestHandler; 21 | var WAIT_FOR_STACKTRACE_FROMERROR = 15; 22 | 23 | /** 24 | * Helper function testing if a given message has been reported 25 | * @param {string} [message] - Substring that message must contain. 26 | */ 27 | function expectRequestWithMessage(message) { 28 | expect(requests.length).to.equal(1); 29 | var sentBody = JSON.parse(requests[0].requestBody); 30 | expect(sentBody).to.include.keys('message'); 31 | expect(sentBody.message).to.contain(message); 32 | } 33 | 34 | /** 35 | * Helper function testing if a given message has been reported inside a payload 36 | * @param {string} [payload] - payload 37 | * @param {string} [message] - Substring that message must contain. 38 | */ 39 | function expectPayloadWithMessage(payload, message) { 40 | var sentBody = payload; 41 | expect(sentBody).to.include.keys('message'); 42 | expect(sentBody.message).to.contain(message); 43 | } 44 | 45 | /** 46 | * Helper for testing call stack reporting 47 | * @param {string} [message] - Contents of error to throw. 48 | */ 49 | function throwError(message) { 50 | throw new TypeError(message); 51 | } 52 | 53 | beforeEach(function() { 54 | window.onerror= function() {}; 55 | window.onunhandledrejection = function() {}; 56 | errorHandler = new StackdriverErrorReporter(); 57 | 58 | xhr = fakeXhr.useFakeXMLHttpRequest(); 59 | xhr.useFilters = true; 60 | xhr.addFilter(function(method, url) { 61 | return !url.match('clouderrorreporting'); 62 | }); 63 | 64 | requests = []; 65 | requestHandler = function(req) { 66 | req.respond(200, {'Content-Type': 'application/json'}, '{}'); 67 | }; 68 | xhr.onCreate = function(req) { 69 | // Allow `onCreate` to complete so `xhr` can finish instantiating. 70 | setTimeout(function() { 71 | if (req.url.match('clouderrorreporting')) { 72 | requests.push(req); 73 | requestHandler(req); 74 | } 75 | }, 1); 76 | }; 77 | }); 78 | 79 | describe('Initialization', function() { 80 | it('should have default service', function() { 81 | errorHandler.start({key: 'key', projectId: 'projectId'}); 82 | expect(errorHandler.serviceContext.service).to.equal('web'); 83 | }); 84 | 85 | it('should by default report uncaught exceptions', function() { 86 | errorHandler.start({key: 'key', projectId: 'projectId'}); 87 | expect(errorHandler.reportUncaughtExceptions).to.equal(true); 88 | }); 89 | 90 | it('should by default report unhandled promise rejections', function() { 91 | errorHandler.start({key: 'key', projectId: 'projectId'}); 92 | expect(errorHandler.reportUnhandledPromiseRejections).to.equal(true); 93 | }); 94 | 95 | it('should fail if no API key or custom url or custom func', function() { 96 | expect(function() { 97 | errorHandler.start({projectId: 'projectId'}); 98 | }).to.throw(Error, /API/); 99 | }); 100 | 101 | it('should fail if no project ID or custom url or custom func', function() { 102 | expect(function() { 103 | errorHandler.start({key: 'key'}); 104 | }).to.throw(Error, /project/); 105 | }); 106 | 107 | it('should succeed if custom target url provided without API key or project id', function() { 108 | expect(function() { 109 | errorHandler.start({targetUrl: 'custom-url'}); 110 | }).to.not.throw(); 111 | }); 112 | 113 | it('should succeed if custom function provided without API key or project id', function() { 114 | expect(function() { 115 | function f() { 116 | 117 | } 118 | errorHandler.start({customReportingFunction: f}); 119 | }).to.not.throw(); 120 | }); 121 | 122 | it('should have default context', function() { 123 | errorHandler.start({key: 'key', projectId: 'projectId'}); 124 | expect(errorHandler.context).to.eql({}); 125 | }); 126 | 127 | it('should allow to specify a default context', function() { 128 | errorHandler.start({context: {user: '1234567890'}, key: 'key', projectId: 'projectId'}); 129 | expect(errorHandler.context).to.eql({user: '1234567890'}); 130 | }); 131 | }); 132 | 133 | describe('Disabling', function() { 134 | it('should not report errors if disabled', function() { 135 | errorHandler.start({key: 'key', projectId: 'projectId', disabled: true}); 136 | return errorHandler.report('do not report').then(function() { 137 | expect(requests.length).to.equal(0); 138 | }); 139 | }); 140 | }); 141 | 142 | describe('Reporting errors', function() { 143 | describe('Default configuration', function() { 144 | beforeEach(function() { 145 | errorHandler.start({key: 'key', projectId: 'projectId'}); 146 | }); 147 | 148 | it('should report error messages with location', function() { 149 | var message = 'Something broke!'; 150 | return errorHandler.report(message).then(function() { 151 | expectRequestWithMessage(message); 152 | }); 153 | }); 154 | 155 | it('should include report origin by default', function() { 156 | var helper = function helperFn(handler) { 157 | return handler.report('common message'); 158 | }; 159 | return helper(errorHandler).then(function() { 160 | expectRequestWithMessage(': common message\n at helperFn ('); 161 | }); 162 | }); 163 | 164 | it('should skip number of frames if option is given', function() { 165 | var helper = function outerFn(handler) { 166 | return (function innerFn() { 167 | return handler.report('common message', {skipLocalFrames: 2}); 168 | })(); 169 | }; 170 | return helper(errorHandler).then(function() { 171 | expectRequestWithMessage(': common message\n at outerFn ('); 172 | }); 173 | }); 174 | 175 | it('should extract and send stack traces from Errors', function() { 176 | var message = 'custom message'; 177 | // Throw and catch error to attach a stacktrace 178 | try { 179 | throw new TypeError(message); 180 | } catch (e) { 181 | return errorHandler.report(e).then(function() { 182 | expectRequestWithMessage(message); 183 | }); 184 | } 185 | }); 186 | 187 | it('should extract and send functionName in stack traces', function() { 188 | var message = 'custom message'; 189 | // Throw and catch error to attach a stacktrace 190 | try { 191 | throwError(message); 192 | } catch (e) { 193 | return errorHandler.report(e).then(function() { 194 | expectRequestWithMessage('throwError'); 195 | }); 196 | } 197 | }); 198 | 199 | it('should set in stack traces when frame is anonymous', function() { 200 | var message = 'custom message'; 201 | // Throw and catch error to attach a stacktrace 202 | try { 203 | (function() { 204 | throw new TypeError(message); 205 | })(); 206 | } catch (e) { 207 | return errorHandler.report(e).then(function() { 208 | expectRequestWithMessage(''); 209 | }); 210 | } 211 | }); 212 | 213 | it('should resolve with stacktrace in message', function() { 214 | try { 215 | throwError('mystery problem'); 216 | } catch (e) { 217 | return errorHandler.report(e).then(function(details) { 218 | var expected = ': mystery problem\n at throwError ('; 219 | expectRequestWithMessage(expected); 220 | expect(details.message).to.contain(expected); 221 | }); 222 | } 223 | }); 224 | 225 | describe('XHR error handling', function() { 226 | it('should handle network error', function() { 227 | requestHandler = function(req) { 228 | req.error(); 229 | }; 230 | var message = 'News that will fail to send'; 231 | return errorHandler.report(message).then(function() { 232 | throw new Error('unexpected fulfilled report'); 233 | }, function(err) { 234 | expectRequestWithMessage(message); 235 | expect(err.message).to.equal('network error on stackdriver report'); 236 | }); 237 | }); 238 | 239 | it('should handle http error', function() { 240 | requestHandler = function(req) { 241 | req.respond(503, {'Content-Type': 'text/plain'}, ''); 242 | }; 243 | errorHandler.start({key: 'key', projectId: 'projectId'}); 244 | var message = 'News that was rejected on send'; 245 | return errorHandler.report(message).then(function() { 246 | throw new Error('unexpected fulfilled report'); 247 | }, function(err) { 248 | expectRequestWithMessage(message); 249 | expect(err.message).to.equal('503 http response on stackdriver report'); 250 | }); 251 | }); 252 | 253 | it('should not handle quota exceeded error responses', function() { 254 | requestHandler = function(req) { 255 | // HTTP 429 returned from Stackdriver after reaching reporting quota. 256 | req.respond(429, {'Content-Type': 'text/plain'}, ''); 257 | }; 258 | errorHandler.start({key: 'key', projectId: 'projectId'}); 259 | var message = 'News that will be rejected on send'; 260 | return errorHandler.report(message).then(function() { 261 | throw new Error('unexpected fulfilled report'); 262 | }, function(fakeErr) { 263 | expectRequestWithMessage(message); 264 | // We don't expect an Error to be returned in this case. 265 | expect(fakeErr.name).to.equal('Http429FakeError'); 266 | expect(fakeErr.message).to.equal( 267 | 'quota or rate limiting error on stackdriver report'); 268 | }); 269 | }); 270 | }); 271 | }); 272 | 273 | describe('Custom target url configuration', function() { 274 | it('should report error messages with custom url config', function() { 275 | var targetUrl = 'config-uri-clouderrorreporting'; 276 | errorHandler.start({targetUrl: targetUrl}); 277 | 278 | var message = 'Something broke!'; 279 | return errorHandler.report(message).then(function() { 280 | expectRequestWithMessage(message); 281 | expect(requests[0].url).to.equal(targetUrl); 282 | }); 283 | }); 284 | }); 285 | 286 | describe('Custom reporting function', function() { 287 | it('should report error messages only to custom function', function() { 288 | var funcResult = null; 289 | function customFunc(payload) { 290 | funcResult = payload; 291 | return Promise.resolve(); 292 | } 293 | errorHandler.start({customReportingFunction: customFunc}); 294 | 295 | var message = 'Something broke!'; 296 | return errorHandler.report(message).then(function() { 297 | expectPayloadWithMessage(funcResult, message); 298 | expect(requests.length).to.equal(0); 299 | }); 300 | }); 301 | }); 302 | }); 303 | 304 | describe('Unhandled exceptions', function() { 305 | it('should be reported by default', function(done) { 306 | errorHandler.start({key: 'key', projectId: 'projectId'}); 307 | 308 | var message = 'custom message'; 309 | try { 310 | throw new TypeError(message); 311 | } catch (e) { 312 | window.onerror(message, 'test.js', 42, 42, e); 313 | 314 | setTimeout(function() { 315 | expectRequestWithMessage(message); 316 | done(); 317 | }, WAIT_FOR_STACKTRACE_FROMERROR); 318 | } 319 | }); 320 | 321 | it('should keep calling previous error handler if already present', function(done) { 322 | var originalOnErrorCalled = false; 323 | window.onerror = function() { 324 | originalOnErrorCalled = true; 325 | }; 326 | 327 | errorHandler.start({key: 'key', projectId: 'projectId'}); 328 | 329 | var message = 'custom message'; 330 | try { 331 | throw new TypeError(message); 332 | } catch (e) { 333 | window.onerror(message, 'test.js', 42, 42, e); 334 | 335 | setTimeout(function() { 336 | expect(originalOnErrorCalled).to.be.true; 337 | done(); 338 | }, WAIT_FOR_STACKTRACE_FROMERROR); 339 | } 340 | }); 341 | }); 342 | 343 | describe('Unhandled promise rejections', function() { 344 | it('should be reported by default', function(done) { 345 | errorHandler.start({key: 'key', projectId: 'projectId'}); 346 | 347 | var message = 'custom promise rejection message'; 348 | try { 349 | throwError(message); 350 | } catch (e) { 351 | var promiseRejectionEvent = {reason: e}; 352 | 353 | window.onunhandledrejection(promiseRejectionEvent); 354 | 355 | setTimeout(function() { 356 | expectRequestWithMessage(message); 357 | done(); 358 | }, WAIT_FOR_STACKTRACE_FROMERROR); 359 | } 360 | }); 361 | 362 | it('should keep calling previous promise rejection handler if already present', function(done) { 363 | var originalOnUnhandledRejectionCalled = false; 364 | window.onunhandledrejection = function() { 365 | originalOnUnhandledRejectionCalled = true; 366 | }; 367 | 368 | errorHandler.start({key: 'key', projectId: 'projectId'}); 369 | 370 | var message = 'custom promise rejection message'; 371 | var promiseRejectionEvent = {reason: new TypeError(message)}; 372 | 373 | window.onunhandledrejection(promiseRejectionEvent); 374 | 375 | setTimeout(function() { 376 | expect(originalOnUnhandledRejectionCalled).to.be.true; 377 | done(); 378 | }, WAIT_FOR_STACKTRACE_FROMERROR); 379 | }); 380 | }); 381 | 382 | describe('Setting user', function() { 383 | it('should set the user in the context', function() { 384 | errorHandler.start({key: 'key', projectId: 'projectId'}); 385 | errorHandler.setUser('1234567890'); 386 | expect(errorHandler.context.user).to.equal('1234567890'); 387 | errorHandler.setUser(); 388 | expect(errorHandler.context.user).to.equal(undefined); 389 | }); 390 | }); 391 | 392 | afterEach(function() { 393 | xhr.restore(); 394 | }); 395 | --------------------------------------------------------------------------------