chore: Version 1.0.0 #233

miquelbeltran · 2024-05-23T05:41:38Z

Version 1.0.0

Description 📝

Purpose: Merge and publish v1.0.0
Approach:

Type of change

Release

Updates

Changelog:

feat: API: better send method #219 Better Send parameters (feat: #219 Better Send parameters #221) (2024-05-17)
feat: Breadcrumbs (feat: Breadcrumbs #210) (2024-05-15)
fix: Fix warning "module.parent.require is not supported by webpack" #138 New APM Bridge Setup (fix: #138 New APM Bridge Setup #222) (2024-05-20)
docs: Update status badge in README.md (docs: Update status badge in README.md #209) (2024-05-10)
refactor: codestyle: consistent use of backticks (string templates), quotes and double quotes. #205 Setup eslint style (refactor: #205 Setup eslint style #207) (2024-05-09)
refactor: Refactor raygun.transport.ts to use Promises instead of callbaks #197 Refactor to use Promises internally (refactor: #197 Refactor to use Promises internally #200) (2024-05-09)
refactor: Cleanup inconsistencies in logging/debug across SDK and examples #184 Cleanup debug/log messages and styles (refactor: #184 Cleanup debug/log messages and styles #194) (2024-05-08)
chore(deps-dev): bump typescript-eslint from 7.8.0 to 7.9.0 (chore(deps-dev): bump typescript-eslint from 7.8.0 to 7.9.0 #229) (2024-05-20)
chore(deps-dev): bump @eslint/js from 9.2.0 to 9.3.0 (chore(deps-dev): bump @eslint/js from 9.2.0 to 9.3.0 #228) (2024-05-20)
chore(deps-dev): bump @types/node from 20.12.11 to 20.12.12 (chore(deps-dev): bump @types/node from 20.12.11 to 20.12.12 #227) (2024-05-20)
chore(deps-dev): bump @stylistic/eslint-plugin from 2.0.0 to 2.1.0 (chore(deps-dev): bump @stylistic/eslint-plugin from 2.0.0 to 2.1.0 #214) (2024-05-13)
chore(deps-dev): bump tap from 18.7.2 to 18.8.0 (chore(deps-dev): bump tap from 18.7.2 to 18.8.0 #213) (2024-05-13)
chore(deps-dev): bump @types/node from 20.12.8 to 20.12.11 (chore(deps-dev): bump @types/node from 20.12.8 to 20.12.11 #212) (2024-05-13)
chore(deps-dev): bump semver from 7.6.0 to 7.6.2 (chore(deps-dev): bump semver from 7.6.0 to 7.6.2 #211) (2024-05-13)
chore: code cleanup (chore: code cleanup #225) (2024-05-20)
chore: apply prettier to all files in examples (chore: apply prettier to all files in examples #226) (2024-05-19)

Test plan 🧪

Tested with express example

Author to check 👓

Project and all contained modules builds successfully
Self-/dev-tested
Unit/UI/Automation/Integration tests provided where applicable
Code is written to standards
Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

Project and all contained modules builds successfully
Change has been dev-/reviewer-tested, where possible
Unit/UI/Automation/Integration tests provided where applicable
Code is written to standards
Appropriate documentation written (code comments, internal docs)

* rename legacy send method to sendWithCallback * implemented async send wrapper * add async send test suite * update domain example to use async send * prettier run * cleanup * fix test * wip updating expressHandler to use async send * fixing tests * format * replace sendWithCallback to send * wip update docs * cleanup of sendSync * add TODOs for refactor * update README * prettier * add send bind again * cleanup test * clenaup tests * change title * Update lib/raygun.ts Co-authored-by: Sumitra Manga <[email protected]> * wrap HTTP request in Promise * fix: #198 reject promise on error * cleanup * adapt batch transport to transport with Promise * tests are passing * tests are passing * WIP * fix test * fixes and cleanup * add tags to debug loglines * improve logs in raygun.transport * fix: #140 throw error on incoming message too large * improving error logs * error cleanup * package-lock.json changes --------- Co-authored-by: Sumitra Manga <[email protected]>

* setup eslint style * rules for quotes * add eslint plugin ts * wip configs * wip * add rules * define rules * add comment

Bumps [semver](https://github.com/npm/node-semver) from 7.6.0 to 7.6.2. - [Release notes](https://github.com/npm/node-semver/releases) - [Changelog](https://github.com/npm/node-semver/blob/main/CHANGELOG.md) - [Commits](npm/node-semver@v7.6.0...v7.6.2) --- updated-dependencies: - dependency-name: semver dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.12.8 to 20.12.11. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [tap](https://github.com/tapjs/tapjs) from 18.7.2 to 18.8.0. - [Release notes](https://github.com/tapjs/tapjs/releases) - [Commits](https://github.com/tapjs/tapjs/compare/[email protected]@18.8.0) --- updated-dependencies: - dependency-name: tap dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

) Bumps [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic/tree/HEAD/packages/eslint-plugin) from 2.0.0 to 2.1.0. - [Release notes](https://github.com/eslint-stylistic/eslint-stylistic/releases) - [Changelog](https://github.com/eslint-stylistic/eslint-stylistic/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint-stylistic/eslint-stylistic/commits/v2.1.0/packages/eslint-plugin) --- updated-dependencies: - dependency-name: "@stylistic/eslint-plugin" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* setup eslint style * rules for quotes * add eslint plugin ts * wip configs * wip * add rules * define rules * add comment * add implementation from old breadcrumbs branch * tests passing * add todo * WIP * cleaning up and adding docs * scoping breadcrumbs in error handler * improving tests * cleanup tests * fix eslint * prettier * moved method * add Breadcrumb object test * add Breadcrumb object test * fix test * expanded the express-example * prettier * prettier * add breadcrumbs to domains app * cleanup and test for clear breadcrumbs * prettier * rename * refactor debug statements * rename logger.js to raygun.client.js * prettier * rename * document Breadcrumbs and rename Breadcrumb type * improve docs * add word * removed commented out code

* add named parameters to send method * run prettier * update documentation * cleanup * test cleanup * prettier

* fix: New APM Bridge Setup removed ignored files * update package.json * fix indentation

* typo * fix favicon in express-sample * import only addRequestBreadcrumbs method * add comments on types.ts for breadcrumbs * update indentation config json * fix indentation * uncomment mistake * Change Raygun.io to Raygun.com * prettier fix * Update lib/types.ts Co-authored-by: Sumitra Manga <[email protected]> --------- Co-authored-by: Sumitra Manga <[email protected]>

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.12.11 to 20.12.12. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@eslint/js](https://github.com/eslint/eslint/tree/HEAD/packages/js) from 9.2.0 to 9.3.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/commits/v9.3.0/packages/js) --- updated-dependencies: - dependency-name: "@eslint/js" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) from 7.8.0 to 7.9.0. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.9.0/packages/typescript-eslint) --- updated-dependencies: - dependency-name: typescript-eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: Prepare Release 1.0.0 * chore: update changelog * add breaking change note to changelog * sorted changelog

sumitramanga

I've tested and code reviewed the majority! LGTM, nice work 🚀

miquelbeltran · 2024-05-23T11:37:05Z

@sumitramanga should I wait for more reviews to merge and publish?

sumitramanga · 2024-05-24T01:52:55Z

Waiting on Panos to review first ! @miquelbeltran

PanosNB

My main concern is introducing breaking changes. I'd like us to consider adding deprecated, backwards-compatible functions if possible. Let's discuss to reach a consensus on this :-)

Apart from that, great work!! I can see a lot was done!

PanosNB · 2024-05-24T01:43:51Z

CHANGELOG.md

+- chore: code cleanup (#225) (2024-05-20)
+- chore: apply prettier to all files in examples (#226) (2024-05-19)
+
+**BREAKING CHANGES**


Why don't we support a backwards-compatible but deprecated (and to be removed next) send method? With some additional checking logic, it could as simple as function send(error, customData={}, request,={} tags={}){ return send(error, {customData: customData, request: request, tags: tags});}

If it makes sense to add in the deprecation, we could do this now whilst we discuss the final decision. It looks like we've done something in the past about deprecating (which we may need to remove -

raygun4node/lib/raygun.ts

Line 159 in 8e37c10

// This function is deprecated, is provided for legacy apps and will be

)

We provide a backwards compatible method, is sendWithCallback().

raygun4node/lib/raygun.ts

Lines 292 to 318 in 8e37c10

/**

* @deprecated sendWithCallback is a deprecated method. Instead, use send, which supports async/await calls.

*/

sendWithCallback(

exception: Error | string,

customData?: CustomData,

callback?: Callback<IncomingMessage>,

request?: RequestParams,

tags?: Tag[],

) {

// call async send but redirect response to provided legacy callback

this.send(exception, {

customData,

request,

tags,

})

.then((response) => {

if (callback) {

callVariadicCallback(callback, null, response);

}

})

.catch((error) => {

if (callback) {

callVariadicCallback(callback, error, null);

}

});

}

it could as simple as function send(error, customData={}, request,={} tags={}){ return send(error, {customData: customData, request: request, tags: tags});}

JavaScript doesn't support overloading methods. There ware some workarounds but have limitations.

README.md

PanosNB · 2024-05-24T02:00:47Z

README.md

+
+Follow the instructions on https://raygun.com/platform/apm to set up your application.
+
+Then, call to `setApmBridge()` to connect both packages:


Add a full example of how this works. Something like:
require('raygun-apm/http'); const raygun = require('raygun'); raygun.setApmBridge();

It is already in examples/apm-sample/app.js

Ah you mean in the README, got it.

But I think the current text is correct. In other parts of the readme, we don't reference to the require for raygun client, and also the require('raygun-apm/http') is not required to set up the APM bridge. I also link to the official APM setup process.

PanosNB · 2024-05-24T02:01:18Z

CHANGELOG.md

+**BREAKING CHANGES**
+
+- `send()` method signature changed.
+- APM Bridge setup process changed.


What were we doing before and as above, can we support a deprecated version?

The previous setup process was causing compilation errors to some users and was not possible to properly unit test it, it is explained in detail here: #222

PanosNB · 2024-05-24T02:02:28Z

README.md

+Then, call to `setApmBridge()` to connect both packages:
+
+```js
+raygunClient.setApmBridge(require("raygun-apm/lib/src/crash_reporting"));


That looks like a nasty setup. Can we make it without arguments and infer it? Still have the explicit call with the argument as fallback

Can you take a look at the PR where we introduced this and review it? #222

PanosNB · 2024-05-24T02:03:44Z

examples/apm-sample/README.md

+
+To do so, navigate to the project root directory, then:
+
+    npm install


A customer yesterday was asking if we support pnpm instead. Investigate and please add to the docs as an alternative

Let's make this an issue to resolved outside of this release

PanosNB · 2024-05-24T02:04:36Z

examples/apm-sample/app.js

@@ -0,0 +1,25 @@
+var config = require("config");
+
+if (config.Raygun.Key === "YOUR_API_KEY") {


Should we be encouraging no API keys in code to set a good standard? Could be via .env

Because this is an example app, I would think this is not necessary to add in

raygun-apm gets the api key from env variable, which we should probably do as well eventually, out of scope for this release IMO.

PanosNB · 2024-05-24T02:06:18Z

examples/express-sample/bin/www


 /**
 * Get port from environment and store in Express.
 */

-var port = normalizePort(process.env.PORT || '3000');
-app.set('port', port);
+var port = normalizePort(process.env.PORT || "3000");


What if the user does not use process.env.PORT to set up Express? Should we be pulling this elsewhere, if possible?

Because this is an example app, we should not have to worry about this? 🤔 We are using the standard way to set up ports I would think. Happy to be challenged! Such as, what other way would people use commonly :)

process.env.PORT || "3000" works that if the user doesn't have a $PORT in their env vars, 3000 will be used by default.

Yes, agreed with @sumitramanga I guess this is standard express:

miquelbeltran · 2024-05-24T05:12:22Z

@PanosNB I will do a new PR with some of the suggestions.

I've also replied on Slack regarding the discussion on breaking changes in the send() method.

Please take a look at my other replies in your review, thanks!

* docs: update send params in README * docs: add Breadcrumbs info * docs: change should by must

* Revert "fix: #138 New APM Bridge Setup (#222)" This reverts commit c322f01. * docs: add webpack info in README

miquelbeltran · 2024-05-27T05:49:15Z

APM Bridge changes reverted

PanosNB

Thanks Miguel, great work!

miquelbeltran and others added 16 commits May 9, 2024 08:26

refactor: #205 Setup eslint style (#207)

f4ae131

* setup eslint style * rules for quotes * add eslint plugin ts * wip configs * wip * add rules * define rules * add comment

docs: Update status badge in README.md (#209)

e14deec

feat: #219 Better Send parameters (#221)

77b8229

* add named parameters to send method * run prettier * update documentation * cleanup * test cleanup * prettier

chore: apply prettier to all files in examples (#226)

ed8aee9

fix: #138 New APM Bridge Setup (#222)

c322f01

* fix: New APM Bridge Setup removed ignored files * update package.json * fix indentation

chore: Prepare Release 1.0.0 (#230)

8e37c10

* chore: Prepare Release 1.0.0 * chore: update changelog * add breaking change note to changelog * sorted changelog

miquelbeltran requested review from TheRealAgentK, Widdershin, a team, nikz, PanosNB and sumitramanga and removed request for a team and Widdershin May 23, 2024 05:42

miquelbeltran changed the title ~~Version 1.0.0~~ chore: Version 1.0.0 May 23, 2024

sumitramanga approved these changes May 23, 2024

View reviewed changes

PanosNB suggested changes May 24, 2024

View reviewed changes

miquelbeltran mentioned this pull request May 24, 2024

fix: Fixes in 1.0.0 release candidate #234

Merged

11 tasks

miquelbeltran added 2 commits May 24, 2024 08:01

fix: Fixes in 1.0.0 release candidate (#234)

f5c1307

* docs: update send params in README * docs: add Breadcrumbs info * docs: change should by must

chore: Revert PR #222 (fix: #138 New APM Bridge Setup) (#235)

188d9c9

* Revert "fix: #138 New APM Bridge Setup (#222)" This reverts commit c322f01. * docs: add webpack info in README

miquelbeltran requested a review from PanosNB May 27, 2024 05:48

PanosNB approved these changes May 27, 2024

View reviewed changes

miquelbeltran merged commit ca534df into master May 28, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Version 1.0.0 #233

chore: Version 1.0.0 #233

miquelbeltran commented May 23, 2024 •

edited by sumitramanga

Loading

sumitramanga left a comment

miquelbeltran commented May 23, 2024

sumitramanga commented May 24, 2024

PanosNB left a comment

PanosNB May 24, 2024

sumitramanga May 24, 2024

miquelbeltran May 24, 2024 •

edited

Loading

miquelbeltran May 24, 2024

PanosNB May 24, 2024

miquelbeltran May 24, 2024

miquelbeltran May 24, 2024

miquelbeltran May 24, 2024

PanosNB May 24, 2024

miquelbeltran May 24, 2024

PanosNB May 24, 2024

miquelbeltran May 24, 2024

PanosNB May 24, 2024

sumitramanga May 24, 2024

PanosNB May 24, 2024

sumitramanga May 24, 2024

miquelbeltran May 24, 2024

PanosNB May 24, 2024

sumitramanga May 24, 2024

miquelbeltran May 24, 2024

miquelbeltran commented May 24, 2024

miquelbeltran commented May 27, 2024

PanosNB left a comment

	/**
	* @deprecated sendWithCallback is a deprecated method. Instead, use send, which supports async/await calls.
	*/
	sendWithCallback(
	exception: Error \| string,
	customData?: CustomData,
	callback?: Callback<IncomingMessage>,
	request?: RequestParams,
	tags?: Tag[],
	) {
	// call async send but redirect response to provided legacy callback
	this.send(exception, {
	customData,
	request,
	tags,
	})
	.then((response) => {
	if (callback) {
	callVariadicCallback(callback, null, response);
	}
	})
	.catch((error) => {
	if (callback) {
	callVariadicCallback(callback, error, null);
	}
	});
	}


		Follow the instructions on https://raygun.com/platform/apm to set up your application.

		Then, call to `setApmBridge()` to connect both packages:


		To do so, navigate to the project root directory, then:

		npm install

		@@ -0,0 +1,25 @@
		var config = require("config");

		if (config.Raygun.Key === "YOUR_API_KEY") {

chore: Version 1.0.0 #233

chore: Version 1.0.0 #233

Conversation

miquelbeltran commented May 23, 2024 • edited by sumitramanga Loading

Version 1.0.0

Description 📝

Test plan 🧪

Author to check 👓

Reviewer to check ✔️

sumitramanga left a comment

Choose a reason for hiding this comment

miquelbeltran commented May 23, 2024

sumitramanga commented May 24, 2024

PanosNB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miquelbeltran May 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miquelbeltran commented May 24, 2024

miquelbeltran commented May 27, 2024

PanosNB left a comment

Choose a reason for hiding this comment

miquelbeltran commented May 23, 2024 •

edited by sumitramanga

Loading

miquelbeltran May 24, 2024 •

edited

Loading