forked from rrweb-io/rrweb
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
publish(repo): Publish forked rrweb packages to NPM (#20)
This patch adds the necessary configuration around our rrweb fork to publish our own `@sentry-internal/rr*` packages. This includes: - prefixing packages with `@sentry-internal` - adjusting licences and the readme - adding a craft config and a version bump script - adding artifact upload to our build&test GHA - adding the Sentry create release GHA
- Loading branch information
Showing
48 changed files
with
476 additions
and
402 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| github: | ||
| owner: getsentry | ||
| repo: rrweb | ||
| changelogPolicy: simple | ||
| preReleaseCommand: bash scripts/craft-pre-release.sh | ||
| requireNames: | ||
| - /^sentry-internal-rrweb-snapshot-.*\.tgz$/ | ||
| - /^sentry-internal-rrweb-player-.*\.tgz$/ | ||
| - /^sentry-internal-rrweb-.*\.tgz$/ | ||
| - /^sentry-internal-rrdom-.*\.tgz$/ | ||
| targets: | ||
| - name: github | ||
| includeNames: /^sentry-.*.tgz$/ | ||
| - name: npm | ||
| includeNames: /^sentry-.*.tgz$/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: Prepare Release | ||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: Version to release | ||
| required: true | ||
| force: | ||
| description: Force a release even when there are release-blockers (optional) | ||
| required: false | ||
| merge_target: | ||
| description: Target branch to merge into. Uses the default branch, sentry-v1, as a fallback (optional) | ||
| required: false | ||
| jobs: | ||
| release: | ||
| runs-on: ubuntu-latest | ||
| name: 'Release a new version' | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| token: ${{ secrets.GH_RELEASE_PAT }} | ||
| fetch-depth: 0 | ||
| - name: Prepare release | ||
| uses: getsentry/action-prepare-release@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }} | ||
| with: | ||
| version: ${{ github.event.inputs.version }} | ||
| force: ${{ github.event.inputs.force }} | ||
| merge_target: ${{ github.event.inputs.merge_target }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,14 @@ | ||
| MIT License | ||
| Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved. | ||
|
|
||
| Copyright (c) 2018 Contributors (https://github.com/rrweb-io/rrweb/graphs/contributors) and SmartX Inc. | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
| Software. | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
| WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,160 +1,28 @@ | ||
| <p align="center"> | ||
| <img width="100px" height="100px" src="https://www.rrweb.io/favicon.png"> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://www.rrweb.io/" style="font-weight: bold">Try rrweb</a> | ||
| <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank"> | ||
| <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84"> | ||
| </a> | ||
| </p> | ||
|
|
||
| # rrweb | ||
|
|
||
| **[The rrweb documentary (in Chinese, with English subtitles)](https://www.bilibili.com/video/BV1wL4y1B7wN?share_source=copy_web)** | ||
|
|
||
| [](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg) | ||
| [](https://twitter.com/rrweb_io) | ||
|  | ||
|  | ||
| [](https://www.jsdelivr.com/package/npm/rrweb) | ||
|
|
||
| [中文文档](./README.zh_CN.md) | ||
|
|
||
| > I have joined Github Sponsors and highly appreciate your sponsorship. | ||
| rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web. | ||
|
|
||
| ## Guide | ||
|
|
||
| [**📚 Read the rrweb guide here. 📚**](./guide.md) | ||
|
|
||
| [**🍳 Recipes 🍳**](./docs/recipes/index.md) | ||
|
|
||
| ## Project Structure | ||
|
|
||
| rrweb is mainly composed of 3 parts: | ||
|
|
||
| - **[rrweb-snapshot](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-snapshot/)**, including both snapshot and rebuilding features. The snapshot is used to convert the DOM and its state into a serializable data structure with a unique identifier; the rebuilding feature is to rebuild the snapshot into corresponding DOM. | ||
| - **[rrweb](https://github.com/rrweb-io/rrweb)**, including two functions, record and replay. The record function is used to record all the mutations in the DOM; the replay is to replay the recorded mutations one by one according to the corresponding timestamp. | ||
| - **[rrweb-player](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-player/)**, is a player UI for rrweb, providing GUI-based functions like pause, fast-forward, drag and drop to play at any time. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| - rrdom: an ad-hoc DOM for rrweb session data [#419](https://github.com/rrweb-io/rrweb/issues/419) | ||
| - storage engine: do deduplication on a large number of rrweb sessions | ||
| - more end-to-end tests | ||
| - compact mutation data in common patterns | ||
| - provide plugins via the new plugin API, including: | ||
| - XHR plugin | ||
| - fetch plugin | ||
| - GraphQL plugin | ||
| - ... | ||
| # Sentry rrweb Fork | ||
|
|
||
| ## Internal Design | ||
| This repo is a fork of [rrweb](https://github.com/rrweb-io/rrweb). The purpose is to apply patches and bugfixes to rrweb and release Sentry-internal packages with our patches included. All credits and attribution for rrweb go to the original creators of the library and all its contributors. | ||
|
|
||
| - [serialization](./docs/serialization.md) | ||
| - [incremental snapshot](./docs/observer.md) | ||
| - [replay](./docs/replay.md) | ||
| - [sandbox](./docs/sandbox.md) | ||
| From this monorepo, Sentry maintains and publishes the following NPM packages: | ||
|
|
||
| ## Contribute Guide | ||
| - `@sentry-internal/rrweb` (corresponds to the [original `rrweb` package](https://www.npmjs.com/package/rrweb)) | ||
| - `@sentry-internal/rrdom` (corresponds to the [original `rrdom` package](https://www.npmjs.com/package/rrdom)) | ||
| - `@sentry-internal/rrweb-player` (corresponds to the [original `rrweb-player` package](https://www.npmjs.com/package/rrweb-player)) | ||
| - `@sentry-internal/rrweb-snapshot` (corresponds to the [original `rrweb-snapshot` package](https://www.npmjs.com/package/rrweb-snapshot)) | ||
|
|
||
| Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support. | ||
|
|
||
| [Typescript handbook](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html) | ||
|
|
||
| 1. Fork this repository. | ||
| 2. Run `yarn install` in the root to install required dependencies for all sub-packages (note: `npm install` is _not_ recommended). | ||
| 3. Run `yarn dev` in the root to get auto-building for all the sub-packages whenever you modify anything. | ||
| 4. Navigate to one of the sub-packages (in the `packages` folder) where you'd like to make a change. | ||
| 5. Patch the code and run `yarn test` to run the tests, make sure they pass before you commit anything. | ||
| 6. Push the code and create a pull request. | ||
|
|
||
| Protip: You can run `yarn test` in the root folder to run all the tests. | ||
|
|
||
| In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool. | ||
|
|
||
| [Using the REPL tool](./guide.md#REPL-tool) | ||
|
|
||
| ## Core Team Members | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/Yuyz0112"> | ||
| <img | ||
| src="https://avatars.githubusercontent.com/u/13651389?s=100" | ||
| width="100px;" | ||
| alt="" | ||
| /> | ||
| <br /><sub><b>Yuyz0112</b></sub> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/Mark-Fenng"> | ||
| <img | ||
| src="https://avatars.githubusercontent.com/u/27533910?s=100" | ||
| width="100px;" | ||
| alt="" | ||
| /> | ||
| <br /><sub><b>Mark-Fenng</b></sub> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/eoghanmurray"> | ||
| <img | ||
| src="https://avatars.githubusercontent.com/u/156780?s=100" | ||
| width="100px;" | ||
| alt="" | ||
| /> | ||
| <br /><sub><b>eoghanmurray</b></sub> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/Juice10"> | ||
| <img | ||
| src="https://avatars.githubusercontent.com/u/4106?s=100" | ||
| width="100px;" | ||
| alt="" | ||
| /> | ||
| <br /><sub><b>Juice10</b></sub> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Who's using rrweb | ||
| # rrweb | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="http://www.smartx.com/" target="_blank"> | ||
| <img width="195px" src="https://www.rrweb.io/logos/smartx.png"> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://posthog.com?utm_source=rrweb&utm_medium=sponsorship&utm_campaign=open-source-sponsorship" target="_blank"> | ||
| <img width="195px" src="https://www.rrweb.io/logos/posthog.png"> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://statcounter.com/session-replay/" target="_blank"> | ||
| <img width="195px" src="https://statcounter.com/images/logo-statcounter-arc-blue.svg"> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://cux.io" target="_blank"> | ||
| <img style="padding: 8px" alt="The first ever UX automation tool" width="195px" src="https://static.cux.io/logo.svg"> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://recordonce.com/" target="_blank"> | ||
| <img width="195px" src="https://uploads-ssl.webflow.com/5f3d133183156245630d4446/5f3d1940abe8db8612c23521_Record-Once-logo-554x80px.svg"> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://remsupp.com" target="_blank"> | ||
| <img style="padding: 8px" alt="Remote Access & Co-Browsing" width="195px" src="https://remsupp.com/images/logo.png"> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <p align="center"> | ||
| <img width="100px" height="100px" src="https://www.rrweb.io/favicon.png"> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://github.com/rrweb-io/rrweb" style="font-weight: bold">Check out the original rrweb Repo</a> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://rrweb.io" style="font-weight: bold">rrweb.io</a> | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
| Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
| WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.