Skip to content

Commit

Permalink
bump version and update docs (#278)
Browse files Browse the repository at this point in the history
  • Loading branch information
metal-messiah authored Oct 5, 2022
1 parent 45bebf2 commit 7faf3b5
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## v1219
## v1220

### Remove non-ASCII characters from builds
Polyfill dependencies were appending non-ASCII characters to build files. These characters were affecting older Python agent implementations downstream that worked to encode the agent snippet. The build files are now checked and cleaned of non-ASCII characters before shipping.
### Add feature detection supportability metrics for Web Workers & Service workers
Detecting the prevalence of Worker implementation and usage will help guide future development efforts.

## v1218
### Remove non-ASCII characters from builds
Certain dependencies were appending non-ASCII characters to build files. These characters were affecting older Python agent implementations downstream that worked to encode the agent snippet. The build files are now checked and cleaned of non-ASCII characters before shipping.

### Removed 3rd Party Cookies

Expand Down
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ To get started using the Browser agent in your own code, our Docs site is the be

## Building

We use gulp to automate builds of the agent. To build:
We use webpack to automate builds of the agent. To build:

```bash
npm install
npm run build
npm ci
npm run cdn:build:local
```

Build artifacts are placed in the `/build` directory.

To automatically rebuild the agent on each change:

```bash
npm run watch
npm run cdn:watch
```

## Running the agent locally
Expand Down Expand Up @@ -65,11 +65,11 @@ Pick an agent type and update the following files from the table below:
* The file loaded as the _Browser agent loader script_ from the HTML above using **loader filename**
* The file loaded under `NREUM.info.agent` in _Browser agent configuration_ from the HTML above using **agent filename**.

| Agent type | loader filename | agent filename |
|------------|-------------------|----------------|
| Lite | nr-loader-rum.js | nr.js |
| Pro | nr-loader-full.js | nr.js |
| Pro + SPA | nr-loader-spa.js | nr-spa.js |
| Agent type | loader filename |
|------------|-------------------|
| Lite | nr-loader-rum.js |
| Pro | nr-loader-full.js |
| Pro + SPA | nr-loader-spa.js |


## Testing
Expand Down Expand Up @@ -104,11 +104,14 @@ Here is an example of using your own Selenium server:
npm run test -- -b chrome@latest --selenium-server=localhost:4444
```

### Supported Browsers
- The browser agent is tested against this [list of browsers and environments](./tools/jil/util/browsers-supported.json). Use of the browser agent with untested browsers may lead to unexpected results.

**Important Notes:**
- `jil` does not handle building the agent automatically;
either run `npm run build` after each change, or use `npm run watch` to automatically rebuild on each change.
- To pass arguments to the testing suite using `npm run test` you must separate your arguments from the npm script using an empty `--` parameter as was exemplified above.
- The browser agent officially supports and is tested against this [list of browsers and environments](./tools/jil/util/browsers.json). Use of the browser agent with unsupported browsers may lead to unexpected results.


### Running a single test
To run a single test in isolation, pass the path to `jil`:
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1219
1220

0 comments on commit 7faf3b5

Please sign in to comment.