Skip to content

Commit

Permalink
Merge branch 'develop' into ryan953/feedback-tests
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan953 committed Jun 24, 2024
2 parents 38624a6 + c49c9f3 commit d63238a
Show file tree
Hide file tree
Showing 197 changed files with 6,001 additions and 1,198 deletions.
38 changes: 22 additions & 16 deletions .craft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -160,28 +160,34 @@ targets:
# Sentry Release Registry Target
- name: registry
sdks:
'npm:@sentry/angular':
onlyIfPresent: /^sentry-angular-\d.*\.tgz$/
'npm:@sentry/astro':
onlyIfPresent: /^sentry-astro-\d.*\.tgz$/
'npm:@sentry/aws-serverless':
onlyIfPresent: /^sentry-aws-serverless-\d.*\.tgz$/
'npm:@sentry/browser':
onlyIfPresent: /^sentry-browser-\d.*\.tgz$/
includeNames: /\.js$/
checksums:
- algorithm: sha384
format: base64
'npm:@sentry/node':
onlyIfPresent: /^sentry-node-\d.*\.tgz$/
'npm:@sentry/react':
onlyIfPresent: /^sentry-react-\d.*\.tgz$/
'npm:@sentry/vue':
onlyIfPresent: /^sentry-vue-\d.*\.tgz$/
'npm:@sentry/bun':
onlyIfPresent: /^sentry-bun-\d.*\.tgz$/
'npm:@sentry/deno':
onlyIfPresent: /^sentry-deno-\d.*\.tgz$/
'npm:@sentry/ember':
onlyIfPresent: /^sentry-ember-\d.*\.tgz$/
'npm:@sentry/gatsby':
onlyIfPresent: /^sentry-gatsby-\d.*\.tgz$/
'npm:@sentry/angular':
onlyIfPresent: /^sentry-angular-\d.*\.tgz$/
'npm:@sentry/astro':
onlyIfPresent: /^sentry-astro-\d.*\.tgz$/
'npm:@sentry/wasm':
onlyIfPresent: /^sentry-wasm-\d.*\.tgz$/
'npm:@sentry/google-cloud-serverless':
onlyIfPresent: /^sentry-google-cloud-serverless-\d.*\.tgz$/
'npm:@sentry/nextjs':
onlyIfPresent: /^sentry-nextjs-\d.*\.tgz$/
'npm:@sentry/node':
onlyIfPresent: /^sentry-node-\d.*\.tgz$/
'npm:@sentry/react':
onlyIfPresent: /^sentry-react-\d.*\.tgz$/
'npm:@sentry/remix':
onlyIfPresent: /^sentry-remix-\d.*\.tgz$/
'npm:@sentry/solid':
Expand All @@ -190,9 +196,9 @@ targets:
onlyIfPresent: /^sentry-svelte-\d.*\.tgz$/
'npm:@sentry/sveltekit':
onlyIfPresent: /^sentry-sveltekit-\d.*\.tgz$/
'npm:@sentry/bun':
onlyIfPresent: /^sentry-bun-\d.*\.tgz$/
'npm:@sentry/vercel-edge':
onlyIfPresent: /^sentry-vercel-edge-\d.*\.tgz$/
'npm:@sentry/ember':
onlyIfPresent: /^sentry-ember-\d.*\.tgz$/
'npm:@sentry/vue':
onlyIfPresent: /^sentry-vue-\d.*\.tgz$/
'npm:@sentry/wasm':
onlyIfPresent: /^sentry-wasm-\d.*\.tgz$/
18 changes: 9 additions & 9 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ jobs:
runs-on: ubuntu-20.04
if: |
github.event_name == 'pull_request'
&& (github.action == 'opened' || github.action == 'reopened')
&& (github.event.action == 'opened' || github.event.action == 'reopened')
&& github.event.pull_request.author_association != 'COLLABORATOR'
&& github.event.pull_request.author_association != 'MEMBER'
&& github.event.pull_request.author_association != 'OWNER'
Expand Down Expand Up @@ -1477,33 +1477,33 @@ jobs:
node: 22

# macos x64
- os: macos-11
- os: macos-13
node: 16
arch: x64
- os: macos-11
- os: macos-13
node: 18
arch: x64
- os: macos-11
- os: macos-13
node: 20
arch: x64
- os: macos-11
- os: macos-13
node: 22
arch: x64

# macos arm64
- os: macos-12
- os: macos-13
arch: arm64
node: 16
target_platform: darwin
- os: macos-12
- os: macos-13
arch: arm64
node: 18
target_platform: darwin
- os: macos-12
- os: macos-13
arch: arm64
node: 20
target_platform: darwin
- os: macos-12
- os: macos-13
arch: arm64
node: 22
target_platform: darwin
Expand Down
71 changes: 71 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,77 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

## 8.11.0

### Important Changes

- **feat(core): Add `parentSpan` option to `startSpan*` APIs (#12567)**

We've made it easier to create a span as a child of a specific span via the startSpan\* APIs. This should allow you to
explicitly manage the parent-child relationship of your spans better.

```js
Sentry.startSpan({ name: 'root' }, parent => {
const span = Sentry.startInactiveSpan({ name: 'xxx', parentSpan: parent });

Sentry.startSpan({ name: 'xxx', parentSpan: parent }, () => {});

Sentry.startSpanManual({ name: 'xxx', parentSpan: parent }, () => {});
});
```

### Other Changes

- feat(node): Detect release from more providers (#12529)
- fix(profiling-node): Use correct getGlobalScope import (#12564)
- fix(profiling-node) sample timestamps need to be in seconds (#12563)
- ref: Align `@sentry/node` exports from framework SDKs. (#12589)

## 8.10.0

### Important Changes

- **feat(remix): Migrate to `opentelemetry-instrumentation-remix`. (#12110)**

You can now simplify your remix instrumentation by opting-in like this:

```js
const Sentry = require('@sentry/remix');

Sentry.init({
dsn: YOUR_DSN
// opt-in to new auto instrumentation
autoInstrumentRemix: true,
});
```

With this setup, you do not need to add e.g. `wrapExpressCreateRequestHandler` anymore. Additionally, the quality of the
captured data improves. The old way to use `@sentry/remix` continues to work, but it is encouraged to use the new setup.

### Other Changes

- feat(browser): Export `thirdPartyErrorFilterIntegration` from `@sentry/browser` (#12512)
- feat(feedback): Allow passing `tags` field to any feedback config param (#12197)
- feat(feedback): Improve screenshot quality for retina displays (#12487)
- feat(feedback): Screenshots don't resize after cropping (#12481)
- feat(node) add max lineno and colno limits (#12514)
- feat(profiling) add global profile context while profiler is running (#12394)
- feat(react): Add React version to events (#12390)
- feat(replay): Add url to replay hydration error breadcrumb type (#12521)
- fix(core): Ensure standalone spans respect sampled flag (#12533)
- fix(core): Use maxValueLength in extra error data integration (#12174)
- fix(feedback): Fix scrolling after feedback submission (#12499)
- fix(feedback): Send feedback rejects invalid responses (#12518)
- fix(nextjs): Update @rollup/plugin-commonjs (#12527)
- fix(node): Ensure status is correct for http server span errors (#12477)
- fix(node): Unify`getDynamicSamplingContextFromSpan` (#12522)
- fix(profiling): continuous profile chunks should be in seconds (#12532)
- fix(remix): Add nativeFetch support for accessing request headers (#12479)
- fix(remix): Export no-op as `captureRemixServerException` from client SDK (#12497)
- ref(node) refactor contextlines to use readline (#12221)

Work in this release was contributed by @AndreyKovanov and @kiliman. Thank you for your contributions!

## 8.9.2

- fix(profiling): Update exports so types generate properly (#12469)
Expand Down
82 changes: 13 additions & 69 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,9 @@ To test local versions of SDK packages, for instance in test projects, you have

**Any nontrivial fixes/features should include tests.** You'll find a `test` folder in each package.

Note that _for the `browser` package only_, if you add a new file to the
[integration test suite](https://github.com/getsentry/sentry-javascript/tree/master/packages/browser/test/integration/suites),
you also need to add it to
[the list in `shell.js`](https://github.com/getsentry/sentry-javascript/blob/b74e199254147fd984e7bb1ea24193aee70afa74/packages/browser/test/integration/suites/shell.js#L25)
as well. Adding tests to existing files will work out of the box in all packages.
For browser related changes, you may also add tests in `dev-packages/browser-integration-tests`. Similarly, for node
integration tests can be added in `dev-packages/node-integration-tests`. Finally, we also have E2E test apps in
`dev-packages/e2e-tests`.

## Running Tests

Expand Down Expand Up @@ -112,79 +110,25 @@ Similar to building and testing, linting can be done in the project root or in i

Note: you must run `yarn build` before `yarn lint` will work.

## Considerations Before Sending Your First PR
## External Contributors

When contributing to the codebase, please note:

- Make sure to follow the [Commit, Issue & PR guidelines](#commit-issue--pr-guidelines)
- Non-trivial PRs will not be accepted without tests (see above).
- Please do not bump version numbers yourself.
- [`raven-js`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-js) and
[`raven-node`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-node) are deprecated, and only
bug and security fix PRs will be accepted targeting the
[3.x branch](https://github.com/getsentry/sentry-javascript/tree/3.x). Any new features and improvements should be to
our new SDKs (`browser`, `node`, and framework-specific packages like `react` and `nextjs`) and the packages which
support them (`core`, `utils`, `integrations`, and the like).

## PR reviews

For feedback in PRs, we use the [LOGAF scale](https://blog.danlew.net/2020/04/15/the-logaf-scale/) to specify how
important a comment is:

- `l`: low - nitpick. You may address this comment, but you don't have to.
- `m`: medium - normal comment. Worth addressing and fixing.
- `h`: high - Very important. We must not merge this PR without addressing this issue.
We highly appreciate external contributions to the SDK. If you want to contribute something, you can just open a PR
against `develop`.

You only need one approval from a maintainer to be able to merge. For some PRs, asking specific or multiple people for
review might be adequate.
The SDK team will check out your PR shortly!

Our different types of reviews:
When contributing to the codebase, please note:

1. **LGTM without any comments.** You can merge immediately.
2. **LGTM with low and medium comments.** The reviewer trusts you to resolve these comments yourself, and you don't need
to wait for another approval.
3. **Only comments.** You must address all the comments and need another review until you merge.
4. **Request changes.** Only use if something critical is in the PR that absolutely must be addressed. We usually use
`h` comments for that. When someone requests changes, the same person must approve the changes to allow merging. Use
this sparingly.
- Make sure to follow the [Commit, Issue & PR guidelines](./docs/commit-issue-pr-guidelines.md)
- Non-trivial PRs will not be accepted without tests (see above).

## Commit, Issue & PR guidelines

### Commits

For commit messages, we use the format:

```
<type>(<scope>): <subject> (<github-id>)
```

For example: `feat(core): Set custom transaction source for event processors (#5722)`.

See [commit message format](https://develop.sentry.dev/commit-messages/#commit-message-format) for details.

The Github-ID can be left out until the PR is merged.

### Issues

Issues should at least be categorized by package, for example `package: Node`. Additional labels for categorization can
be added, and the Sentry SDK team may also add further labels as needed.

### Pull Requests (PRs)

PRs are merged via `Squash and merge`. This means that all commits on the branch will be squashed into a single commit,
and committed as such onto master.

- The PR name can generally follow the commit name (e.g.
`feat(core): Set custom transaction source for event processors`)
- Make sure to rebase the branch on `master` before squashing it
- Make sure to update the commit message of the squashed branch to follow the commit guidelines - including the PR
number

### Gitflow
See [Commit, Issue & PR guidelines](./docs/commit-issue-pr-guidelines.md).

We use [Gitflow](https://docs.github.com/en/get-started/quickstart/github-flow) as a branching model.
## PR Reviews

For more details, [see our Gitflow docs](./docs/gitflow.md).
See [PR Reviews](./docs/pr-reviews.md).

## Publishing a Release

Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ convenient interface and improved consistency between various JavaScript environ

## Contents

- [Contributing](https://github.com/getsentry/sentry-javascript/blob/master/CONTRIBUTING.md)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
- [Supported Platforms](#supported-platforms)
- [Installation and Usage](#installation-and-usage)
- [Other Packages](#other-packages)
Expand All @@ -40,7 +40,6 @@ For each major JavaScript platform, there is a specific high-level SDK that prov
package. Please refer to the README and instructions of those SDKs for more detailed information:

- [`@sentry/browser`](https://github.com/getsentry/sentry-javascript/tree/master/packages/browser): SDK for Browsers
- [`@sentry/bun`](https://github.com/getsentry/sentry-javascript/tree/master/packages/bun): SDK for Bun
- [`@sentry/node`](https://github.com/getsentry/sentry-javascript/tree/master/packages/node): SDK for Node including
integrations for Express
- [`@sentry/angular`](https://github.com/getsentry/sentry-javascript/tree/master/packages/angular): Browser SDK for
Expand All @@ -52,6 +51,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/sveltekit`](https://github.com/getsentry/sentry-javascript/tree/master/packages/sveltekit): SDK for
SvelteKit
- [`@sentry/vue`](https://github.com/getsentry/sentry-javascript/tree/master/packages/vue): Browser SDK for Vue
- [`@sentry/solid`](https://github.com/getsentry/sentry-javascript/tree/master/packages/solid): Browser SDK for Solid
- [`@sentry/gatsby`](https://github.com/getsentry/sentry-javascript/tree/master/packages/gatsby): SDK for Gatsby
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
Expand All @@ -64,6 +64,13 @@ package. Please refer to the README and instructions of those SDKs for more deta
native crashes
- [`@sentry/capacitor`](https://github.com/getsentry/sentry-capacitor): SDK for Capacitor Apps and Ionic with support
for native crashes
- [`@sentry/bun`](https://github.com/getsentry/sentry-javascript/tree/master/packages/bun): SDK for Bun
- [`@sentry/deno`](https://github.com/getsentry/sentry-javascript/tree/master/packages/deno): SDK for Deno

## Version Support Policy

The current version of the SDK is 8.x. Version 7.x of the SDK will continue to receive critical bugfixes until end
of 2024.

## Installation and Usage

Expand All @@ -77,14 +84,14 @@ yarn add @sentry/browser
Setup and usage of these SDKs always follows the same principle.

```javascript
import { init, captureMessage } from '@sentry/browser';
import * as Sentry from '@sentry/browser';

init({
Sentry.init({
dsn: '__DSN__',
// ...
});

captureMessage('Hello, world!');
Sentry.captureMessage('Hello, world!');
```

## Other Packages
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
window.sentryOnLoad = function () {
Sentry.init({});

window.__sentryLoaded = true;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Sentry.forceLoad();

Sentry.captureException('Test exception');
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<script>
window.Sentry = {_customThingOnSentry: 'customThingOnSentry' };
</script>
</head>
<body></body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import { envelopeRequestParser, waitForErrorRequestOnUrl } from '../../../../utils/helpers';

sentryTest('keeps data on window.Sentry intact', async ({ getLocalTestUrl, page }) => {
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const url = await getLocalTestUrl({ testDir: __dirname });
const req = await waitForErrorRequestOnUrl(page, url);

const eventData = envelopeRequestParser(req);

expect(eventData.message).toBe('Test exception');

const customThingy = await page.evaluate('window.Sentry._customThingOnSentry');
expect(customThingy).toBe('customThingOnSentry');
});
Loading

0 comments on commit d63238a

Please sign in to comment.