UNPKG

@dash0hq/sdk-web

Version:

Dash0's Web SDK to collect telemetry from end-users' web browsers

github.com/dash0hq/dash0-sdk-web

dash0hq/dash0-sdk-web

64 lines (44 loc) • 2.02 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Dash0 Web SDK ## Releases We automatically release new versions of this package whenever a PR is merged to main and the ci is able to detect a valid version increase from the merge commit. It uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to calculate the version increase and to generate additional messaging such as changelogs. Please make sure PR merge commits are formatted accordingly, not matching messages will create a PATCH release, but no changelog entry. Examples: - A PATCH release: ``` fix: Include missing user.name attribute ``` - A MINOR release: ``` feat: Add instrumentation for fetch() The sdk now supports automatic instrumentation of the fetch api ``` - A MAJOR release: ``` feat: Add version two of page-load instrumentation BREAKING CHANGE: This adds a new updated instrumentation for page-loads, it is no longer compatible with the previous version. For instructions on how to update see: https://example.com ``` or: ``` feat!: Add version two of page-load instrumentation This adds a new updated instrumentation for page-loads, it is no longer compatible with the previous version. For instructions on how to update see: https://example.com ``` - NO changelog entry, PATCH release: ``` chore: Improve spelling of README ``` ## Development ### E2E Tests We run e2e tests via webdriverIO and sauce labs. They currently don't have a fully local setup, but can be executed locally against sauce labs. #### Setup - Get a sauce labs account - Create a `.env` file based on `.env.example` and provide your sauce labs credentials. - Run the tests via `pnpm run test:e2e` #### Why do tests run on ports 8010, 8011 and 8012? We need multiple ports to properly test cors behaviour. 8010 to 8012 are specifically chosen for their [behaviour in combination with localhost proxies](https://docs.saucelabs.com/secure-connections/sauce-connect-5/specifications/localhost-ports/#ports-for-proxying-localhost-traffic)