@honeybadger-io/js 6.4.3 → 6.5.1

package/README.md

@@ -25,10 +25,32 @@ However, since the package is isomorphic, TypeScript users will likely be writin
 
 ### Tests
 1. To run unit tests for both browser and server builds: `npm test`. Or separately: `npm run test:browser`, `npm run test:server`.
-2. To run integration tests across all supported platforms, set up a [BrowserStack](https://www.browserstack.com/)
-   account and use `BROWSERSTACK_USERNAME=your_username BROWSERSTACK_ACCESS_KEY=your-access-key npm run test:integration`.
+2. To run integration tests across all supported platforms, see [End-to-end tests with Playwright and Browserstack](#end-to-end-tests-with-playwright-and-browserstack-optional).
 3. To test the TypeScript type definitions: `npm run tsd`.
 
+#### End-to-end tests with Playwright and Browserstack (optional)
+We use [Playwright](https://playwright.dev) to run integration tests in a real browser.
+The config file is at `test/e2e/playwright.config.ts`.
+To run these tests locally, you'll need to install the browsers you want to test with.
+Open `test/e2e/browsers.ts` and enable the browsers you want to test with.
+Then, run `npx playwright install --with-deps` to install the browsers.
+Lastly, run `npm run test:integration`. 
+Additionally, if you want to run the tests on Browserstack:
+- enable Browserstack browsers in `browsers.ts`,
+- set up a [BrowserStack](https://www.browserstack.com/) account and 
+- use `BROWSERSTACK_USERNAME=your_username BROWSERSTACK_ACCESS_KEY=your-access-key npm run test:integration`.
+
+##### Architecture
+Inside `./test/e2e`, you will find a `server.js` file that runs a simple nodejs http server.
+This server is used to serve the test page, along with other static assets and to receive the error reports from the browser.
+The server is automatically started and stopped by Playwright, as you can see at the bottom of the `./test/e2e/playwright.config.ts` file.
+The test page is found in `./test/e2e/sandbox.html`.
+All tests are found in `./test/e2e/integration.spec.ts`.
+Two more configuration files, `./test/e2e/global-setup.ts` and `./test/e2e/global-teardown.ts` are used to start and stop
+a local browserstack executable, needed to run the tests on Browserstack. This executable will only be executed if you are testing on Browserstack.
+Finally, the `./test/e2e/browserstack.config.ts` file contains the configuration and helper functions to run the tests on Browserstack.
+
+
 ## Releasing
 
 This package comes with a `postpublish` script (`scripts/release-cdn.sh`) 

package/dist/browser/honeybadger.d.ts

@@ -9,6 +9,7 @@ declare class Honeybadger extends Client {
     factory(opts?: Partial<Types.BrowserConfig>): this;
     checkIn(_id: string): Promise<void>;
     showUserFeedbackForm(options?: Types.UserFeedbackFormOptions): Promise<void>;
+    private appendUserFeedbackScriptTag;
     private isUserFeedbackScriptUrlAlreadyVisible;
     private getUserFeedbackSubmitUrl;
 }

package/dist/browser/honeybadger.js

@@ -857,7 +857,7 @@
 	        this.__notifier = {
 	            name: '@honeybadger-io/core',
 	            url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/core',
-	            version: '6.4.3'
+	            version: '6.5.1'
 	        };
 	        this.config = __assign({ apiKey: null, endpoint: 'https://api.honeybadger.io', environment: null, hostname: null, projectRoot: null, component: null, action: null, revision: null, reportData: null, breadcrumbsEnabled: true, maxBreadcrumbs: 40, maxObjectDepth: 8, logger: console, developmentEnvironments: ['dev', 'development', 'test'], debug: false, tags: null, enableUncaught: true, enableUnhandledRejection: true, afterUncaught: function () { return true; }, filters: ['creditcard', 'password'], __plugins: [] }, opts);
 	        this.__initStore();
@@ -2175,7 +2175,7 @@
 		    Honeybadger.prototype.showUserFeedbackForm = function (options) {
 		        if (options === void 0) { options = {}; }
 		        return __awaiter(this, void 0, void 0, function () {
-		            var global, script;
+		            var global;
 		            return __generator(this, function (_a) {
 		                if (!this.config || !this.config.apiKey) {
 		                    this.logger.debug('Client not initialized');
@@ -2195,17 +2195,21 @@
 		                    return [2 /*return*/];
 		                }
 		                global['honeybadgerUserFeedbackOptions'] = __assign(__assign({}, options), { apiKey: this.config.apiKey, endpoint: this.config.userFeedbackEndpoint, noticeId: this.__lastNoticeId });
-		                script = global.document.createElement('script');
-		                script.setAttribute('src', this.getUserFeedbackSubmitUrl());
-		                script.setAttribute('async', 'true');
-		                if (options.onLoad) {
-		                    script.onload = options.onLoad;
-		                }
-		                (global.document.head || global.document.body).appendChild(script);
+		                this.appendUserFeedbackScriptTag(global, options);
 		                return [2 /*return*/];
 		            });
 		        });
 		    };
+		    Honeybadger.prototype.appendUserFeedbackScriptTag = function (window, options) {
+		        if (options === void 0) { options = {}; }
+		        var script = window.document.createElement('script');
+		        script.setAttribute('src', this.getUserFeedbackSubmitUrl());
+		        script.setAttribute('async', 'true');
+		        if (options.onLoad) {
+		            script.onload = options.onLoad;
+		        }
+		        (commonjsGlobal.document.head || commonjsGlobal.document.body).appendChild(script);
+		    };
 		    Honeybadger.prototype.isUserFeedbackScriptUrlAlreadyVisible = function () {
 		        var global = (0, util_1.globalThisOrWindow)();
 		        var feedbackScriptUrl = this.getUserFeedbackSubmitUrl();
@@ -2329,7 +2333,7 @@
 		var NOTIFIER = {
 		    name: '@honeybadger-io/js',
 		    url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/js',
-		    version: '6.4.3'
+		    version: '6.5.1'
 		};
 		singleton.setNotifier(NOTIFIER);
 		var core_2 = src;