Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jchiatt/react-chaos
Chaos Engineering for your React apps.
https://github.com/jchiatt/react-chaos
chaos-engineering chaos-theory react ui-testing ux-testing
Last synced: 2 months ago
JSON representation
Chaos Engineering for your React apps.
- Host: GitHub
- URL: https://github.com/jchiatt/react-chaos
- Owner: jchiatt
- License: mit
- Created: 2019-05-20T21:00:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T05:49:07.000Z (over 1 year ago)
- Last Synced: 2024-01-26T07:02:24.157Z (5 months ago)
- Topics: chaos-engineering, chaos-theory, react, ui-testing, ux-testing
- Language: TypeScript
- Size: 1.86 MB
- Stars: 597
- Watchers: 6
- Forks: 9
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-chaos-engineering - react-chaos - A chaos engineering tool for your React apps (Notable Tools)
- awesome-stars - react-chaos
- awesome-chaos-engineering - React Chaos - Chaos Engineering for your React apps. (3. Fault Injection / Languages)
README
# 🔥🐒💥 React Chaos
Chaos Engineering for your React applications.
## What It Does
React Chaos is currently a higher order component that will randomly throw `Error`s in the component it wraps. The likelihood for the error to throw is based on a `level` you set when you wrap a component.
Blog post: [Announcing React Chaos](https://jchiatt.com/announcing-react-chaos/)
Demo: [https://react-chaos.netlify.com/](https://react-chaos.netlify.com/)
## 🛑 Pre-Installation Notes
- This is currently WIP and a proof-of-concept.
- There is nothing in place to help ensure good performance practices. Use at your own risk.
## Installation
```js
npm i --save-dev react-chaos
```
## Usage
First, import the Chaos:
```js
import withChaos from 'react-chaos';
```
Wrap any component with the Chaos:
```js
const ComponentToWrap = () =>
I may have chaos.
;
const ComponentWithChaos = withChaos(ComponentToWrap);
```
You can optionally set a Chaos level between 1 and 10 (the higher the number, the more Chaos 😈) as well as a custom error message:
```js
const ComponentWithChaos = withChaos(ComponentToWrap);
const ComponentWithChaos = withChaos(
ComponentToWrap,
10,
'This error message will almost certainly be shown since we are at Chaos level 10.'
);
```
Note: The default Chaos level is 5.
## Chaos in Production
By default, React Chaos _will not_ run in production. If you want to override this by passing in `true` as a 4th parameter like this:
```js
const ComponentWithChaos2 = withChaos(
ComponentWillHaveChaos2,
3,
'a custom error message, level 3',
true
);
```
## Why
- Because simple UI errors shouldn't bring down your app.
- This library can help expose areas of your component tree that don't handle errors very gracefully. Used in conjunction with [Error Boundaries](https://reactjs.org/docs/error-boundaries.html), this can be a powerful tool to improve the resiliency of your UI components.
## What is Chaos Engineering?
Chaos Engineering is the practice of experimenting with entropy on a software system to test its resiliency. You can [read more about it here](https://en.wikipedia.org/wiki/Chaos_engineering).
## Inspiration
- [Brandon Dail's post on React Error Boundaries and Fault Tolerance](https://aweary.dev/fault-tolerance-react/)
- [Brian Holt's talk on Chaos Engineering in the Browser](https://www.youtube.com/watch?v=A4_rRj-4Mv0)
- Also inspired by watching Jurassic Park the night before writing this
## Other Notes
This project uses TSDX.