feat(infra): livedata (#5562)

LiveData is a reactive data type.

## basic usage

@example
```ts
const livedata = new LiveData(0); // create livedata with initial value

livedata.next(1); // update value

console.log(livedata.value); // get current value

livedata.subscribe(v => { // subscribe to value changes
 console.log(v); // 1
});
```

## observable

LiveData is a rxjs observable, you can use rxjs operators.

@example
```ts
new LiveData(0).pipe(
  map(v => v + 1),
  filter(v => v > 1),
  ...
)
```

NOTICE: different from normal observable, LiveData will always emit the latest value when you subscribe to it.

## from observable

LiveData can be created from observable or from other livedata.

@example
```ts
const A = LiveData.from(
  of(1, 2, 3, 4), // from observable
  0 // initial value
);

const B = LiveData.from(
  A.pipe(map(v => 'from a ' + v)), // from other livedata
  '' // initial value
);
```

NOTICE: LiveData.from will not complete when the observable completes, you can use `spreadComplete` option to change
this behavior.

## Why is it called LiveData

This API is very similar to LiveData in Android, as both are based on Observable, so I named it LiveData.
This commit is contained in:
EYHN
2024-01-30 06:31:11 +00:00
parent 588b3bcf33
commit c9f8e49f75
6 changed files with 597 additions and 0 deletions
@@ -0,0 +1,188 @@
import type { Subscriber } from 'rxjs';
import { combineLatest, Observable, of } from 'rxjs';
import { describe, expect, test, vitest } from 'vitest';
import { LiveData } from '..';
describe('livedata', () => {
test('LiveData', async () => {
const livedata = new LiveData(0);
expect(livedata.value).toBe(0);
livedata.next(1);
expect(livedata.value).toBe(1);
let subscribed = 0;
livedata.subscribe(v => {
subscribed = v;
});
livedata.next(2);
expect(livedata.value).toBe(2);
await vitest.waitFor(() => subscribed === 2);
});
test('from', async () => {
{
const livedata = LiveData.from(of(1, 2, 3, 4), 0);
expect(livedata.value).toBe(4);
}
{
let subscriber: Subscriber<number> = null!;
const observable = new Observable<number>(s => {
subscriber = s;
});
const livedata = LiveData.from(observable, 0);
let value = 0;
livedata.subscribe(v => {
value = v;
});
expect(value).toBe(0);
subscriber.next(1);
expect(value).toBe(1);
subscriber.next(2);
expect(value).toBe(2);
}
{
let observableSubscribed = false;
let observableClosed = false;
const observable = new Observable(subscriber => {
observableSubscribed = true;
subscriber.next(1);
return () => {
observableClosed = true;
};
});
const livedata = LiveData.from(observable, 0);
expect(observableSubscribed).toBe(false);
const subscription = livedata.subscribe(_ => {});
expect(observableSubscribed).toBe(true);
expect(observableClosed).toBe(false);
subscription.unsubscribe();
expect(observableClosed).toBe(true);
}
{
let subscriber: Subscriber<number> = null!;
const observable = new Observable<number>(s => {
subscriber = s;
});
const livedata = LiveData.from(observable, 0);
let value1 = 0;
livedata.subscribe(v => {
value1 = v;
});
let value2 = 0;
livedata.subscribe(v => {
value2 = v;
});
expect(value1).toBe(0);
expect(value2).toBe(0);
subscriber.next(1);
expect(value1).toBe(1);
expect(value2).toBe(1);
subscriber.next(2);
expect(value1).toBe(2);
expect(value2).toBe(2);
}
{
let observableSubscribed = false;
let observableClosed = false;
const observable = new Observable(subscriber => {
observableSubscribed = true;
subscriber.next(1);
return () => {
observableClosed = true;
};
});
const livedata = LiveData.from(observable, 0);
expect(observableSubscribed).toBe(false);
const subscription1 = livedata.subscribe(_ => {});
const subscription2 = livedata.subscribe(_ => {});
expect(observableSubscribed).toBe(true);
expect(observableClosed).toBe(false);
subscription1.unsubscribe();
expect(observableClosed).toBe(false);
subscription2.unsubscribe();
expect(observableClosed).toBe(true);
}
{
let observerCount = 0;
const observable = new Observable(_ => {
observerCount++;
});
const livedata = LiveData.from(observable, 0);
livedata.subscribe(_ => {});
livedata.subscribe(_ => {});
expect(observerCount).toBe(1);
}
{
let value = 0;
const observable = new Observable<number>(subscriber => {
subscriber.next(value);
});
const livedata = LiveData.from(observable, 0);
expect(livedata.value).toBe(0);
value = 1;
expect(livedata.value).toBe(1);
}
});
test('map', () => {
{
const livedata = new LiveData(0);
const mapped = livedata.map(v => v + 1);
expect(mapped.value).toBe(1);
livedata.next(1);
expect(mapped.value).toBe(2);
}
{
const livedata = new LiveData(0);
const mapped = livedata.map(v => v + 1);
let value = 0;
mapped.subscribe(v => {
value = v;
});
expect(value).toBe(1);
livedata.next(1);
expect(value).toBe(2);
}
{
let observableSubscribed = false;
let observableClosed = false;
const observable = new Observable<number>(subscriber => {
observableSubscribed = true;
subscriber.next(1);
return () => {
observableClosed = true;
};
});
const livedata = LiveData.from(observable, 0);
const mapped = livedata.map(v => v + 1);
expect(observableSubscribed).toBe(false);
const subscription = mapped.subscribe(_ => {});
expect(observableSubscribed).toBe(true);
expect(observableClosed).toBe(false);
subscription.unsubscribe();
expect(observableClosed).toBe(true);
}
});
test('interop with rxjs', () => {
const ob = combineLatest([new LiveData(1)]);
let value = 0;
ob.subscribe(v => {
value = v[0];
});
expect(value).toBe(1);
});
});
@@ -0,0 +1,60 @@
/**
* @vitest-environment happy-dom
*/
import { render, screen } from '@testing-library/react';
import { useRef } from 'react';
import { Observable } from 'rxjs';
import { describe, expect, test, vi } from 'vitest';
import { LiveData, useLiveData } from '..';
describe('livedata', () => {
test('react', () => {
const livedata = new LiveData(0);
const Component = () => {
const renderCount = useRef(0);
renderCount.current++;
const value = useLiveData(livedata);
return (
<main>
{renderCount.current}:{value}
</main>
);
};
const { rerender } = render(<Component />);
expect(screen.getByRole('main').innerText).toBe('1:0');
livedata.next(1);
rerender(<Component />);
expect(screen.getByRole('main').innerText).toBe('3:1');
});
test('lifecycle', async () => {
let observableSubscribed = false;
let observableClosed = false;
const observable = new Observable<number>(subscriber => {
observableSubscribed = true;
subscriber.next(1);
console.log(1);
return () => {
observableClosed = true;
};
});
const livedata = LiveData.from(observable, 0);
const Component1 = () => {
const value = useLiveData(livedata);
return <main>{value}</main>;
};
expect(observableSubscribed).toBe(false);
const { rerender } = render(<Component1 />);
expect(observableSubscribed).toBe(true);
expect(observableClosed).toBe(false);
const Component2 = () => {
return <main></main>;
};
rerender(<Component2 />);
await vi.waitUntil(() => observableClosed);
});
});