Skip to content
This repository was archived by the owner on May 24, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
8a59985
FrequencyObservable as a function returning a observable
amaury1093 Sep 7, 2018
f113991
Fix tests
amaury1093 Sep 7, 2018
5e613d4
Test a new api
amaury1093 Sep 12, 2018
9ecae21
Make frequency observables work
amaury1093 Sep 13, 2018
660c5ef
Fix tests
amaury1093 Sep 13, 2018
6e99b67
Remove overview
amaury1093 Sep 13, 2018
e4298fa
Don't cover index.ts
amaury1093 Sep 13, 2018
bb5509c
Fix a lot of stuff
amaury1093 Sep 13, 2018
1008d5a
Remove useless import
amaury1093 Sep 13, 2018
3aa360b
Change testRegex for jest
amaury1093 Sep 13, 2018
ea75324
Add ambient for packages with no typigns
amaury1093 Sep 13, 2018
7c03c5c
Generate docs
amaury1093 Sep 13, 2018
80b283f
Remove NullProvider
amaury1093 Sep 13, 2018
a46b19a
Remove NullProvider
amaury1093 Sep 13, 2018
3447e95
Regenerate docs
amaury1093 Sep 13, 2018
1f0c25a
Silent jest on CI
amaury1093 Sep 13, 2018
b4404e2
Fix makeContract and post
amaury1093 Sep 13, 2018
165df16
Regen docs
amaury1093 Sep 13, 2018
9b8edd8
Update summary
amaury1093 Sep 13, 2018
fb89a94
Update ambient
amaury1093 Sep 13, 2018
439d3bd
Export post$ too
amaury1093 Sep 13, 2018
18e640f
Fix makeContract
amaury1093 Sep 13, 2018
431fe51
Fix memoization for frequency observables
amaury1093 Sep 17, 2018
44dde4a
Don't lint lib
amaury1093 Sep 17, 2018
15caa62
Fix bugs with rpc$
amaury1093 Sep 17, 2018
0cbe22a
Remove useless packages
amaury1093 Sep 17, 2018
85f8fb9
Generate docs
amaury1093 Sep 17, 2018
c5e0c56
Update withoutLoading syntax
amaury1093 Sep 17, 2018
82fca45
Use json.stringify for normalizer
amaury1093 Sep 17, 2018
4893e97
Fix bug normalizer
amaury1093 Sep 17, 2018
e449a57
Remove withApi in docs
amaury1093 Sep 17, 2018
3a885fe
Fix bug memoization
amaury1093 Sep 17, 2018
c6ee32e
Remove onEvery2Blocks
amaury1093 Sep 17, 2018
041441b
Options then args
amaury1093 Sep 17, 2018
8a066db
CreateRpc in makeContract fix
amaury1093 Sep 17, 2018
d2bb3c7
Fix getContract memoization
amaury1093 Sep 17, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
FrequencyObservable as a function returning a observable
  • Loading branch information
amaury1093 committed Sep 13, 2018
commit 8a599851c2772804a5136100edd5f6c7bd9f2e42
18 changes: 9 additions & 9 deletions packages/light.js/src/frequency/accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@

import { AccountsInfo, Address, FrequencyObservable } from '../types';
import api from '../api';
import createOnFromPubsub from './utils/createOnFromPubsub';
import createPubsubObservable from './utils/createPubsubObservable';

/**
* Observable that emits each time the default account changes
*/
export const onAccountsChanged$ = createOnFromPubsub<Address[]>(
'eth_accounts',
api
);
export const onAccountsChanged$ = (() =>
createPubsubObservable('eth_accounts', api)) as FrequencyObservable<
Address[]
>;
onAccountsChanged$.metadata = { name: 'onAccountsChanged$' };

/**
* Observable that emits each time the default account changes
*/
export const onAccountsInfoChanged$ = createOnFromPubsub<AccountsInfo>(
'parity_accountsInfo',
api
);
export const onAccountsInfoChanged$ = (() =>
createPubsubObservable('parity_accountsInfo', api)) as FrequencyObservable<
AccountsInfo
>;
onAccountsInfoChanged$.metadata = { name: 'onAccountsInfoChanged$' };
24 changes: 13 additions & 11 deletions packages/light.js/src/frequency/blocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,32 @@ import BigNumber from 'bignumber.js';
import { filter } from 'rxjs/operators';

import api from '../api';
import createOnFromPubsub from './utils/createOnFromPubsub';
import createPubsubObservable from './utils/createPubsubObservable';
import { FrequencyObservable } from '../types';

/**
* Observable that emits on every new block.
*/
export const onEveryBlock$ = createOnFromPubsub<BigNumber>(
'eth_blockNumber',
api
);
export const onEveryBlock$ = (() =>
createPubsubObservable('eth_blockNumber', api)) as FrequencyObservable<
BigNumber
>;
onEveryBlock$.metadata = { name: 'onEveryBlock$' };

/**
* Observable that emits on every 2nd block.
*/
export const onEvery2Blocks$ = onEveryBlock$.pipe(
filter(n => +n % 2 === 0) // Around ~30s on mainnet // TODO Use isEqualTo and mod from bignumber.js
) as FrequencyObservable<BigNumber>;
export const onEvery2Blocks$ = (() =>
onEveryBlock$().pipe(
filter(n => +n % 2 === 0) // Around ~30s on mainnet // TODO Use isEqualTo and mod from bignumber.js
)) as FrequencyObservable<BigNumber>;
onEvery2Blocks$.metadata = { name: 'onEvery2Blocks$' };

/**
* Observable that emits on every 4th block.
*/
export const onEvery4Blocks$ = onEveryBlock$.pipe(
filter(n => +n % 4 === 0) // Around ~1min on mainnet // TODO Use isEqualTo and mod from bignumber.js
) as FrequencyObservable<BigNumber>;
export const onEvery4Blocks$ = (() =>
onEveryBlock$().pipe(
filter(n => +n % 4 === 0) // Around ~1min on mainnet // TODO Use isEqualTo and mod from bignumber.js
)) as FrequencyObservable<BigNumber>;
onEvery4Blocks$.metadata = { name: 'onEvery4Blocks$' };
13 changes: 7 additions & 6 deletions packages/light.js/src/frequency/health.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
// SPDX-License-Identifier: MIT

import api from '../api';
import createOnFromPubsub from './utils/createOnFromPubsub';
import createPubsubObservable from './utils/createPubsubObservable';
import { FrequencyObservable } from '../types';

/**
* Observable that emits when syncing status changes.
*/
// TODO Pubsub doesn't exist on `net_peerCount`
// export const onPeersChange$ = createOnFromPubsub<number>('net_peerCount', api);
// export const onPeersChange$ = createPubsubObservable<number>('net_peerCount', api);
// onPeersChange$.metadata = {
// calls: ['net_peerCount'],
// name: 'onPeersChange$'
Expand All @@ -19,10 +20,10 @@ import createOnFromPubsub from './utils/createOnFromPubsub';
/**
* Observable that emits when syncing status changes.
*/
export const onSyncingChanged$ = createOnFromPubsub<object | boolean>(
'eth_syncing',
api
);
export const onSyncingChanged$ = (() =>
createPubsubObservable('eth_syncing', api)) as FrequencyObservable<
object | boolean
>;
onSyncingChanged$.metadata = {
calls: ['eth_syncing'],
name: 'onSyncingChanged$'
Expand Down
2 changes: 1 addition & 1 deletion packages/light.js/src/frequency/other.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ import { FrequencyObservable } from '../types';
/**
* Observable that emits only once.
*/
export const onStartup$ = of(0) as FrequencyObservable<number>;
export const onStartup$ = (() => of(0)) as FrequencyObservable<number>;
onStartup$.metadata = { name: 'onStartup$' };
12 changes: 9 additions & 3 deletions packages/light.js/src/frequency/time.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,23 @@ import { FrequencyObservable } from '../types';
/**
* Observable that emits on every second.
*/
export const onEverySecond$ = timer(0, 1000) as FrequencyObservable<number>;
export const onEverySecond$ = (() => timer(0, 1000)) as FrequencyObservable<
number
>;
onEverySecond$.metadata = { name: 'onEverySecond$' };

/**
* Observable that emits on every other second.
*/
export const onEvery2Seconds$ = timer(0, 2000) as FrequencyObservable<number>;
export const onEvery2Seconds$ = (() => timer(0, 2000)) as FrequencyObservable<
number
>;
onEvery2Seconds$.metadata = { name: 'onEvery2Seconds$' };

/**
* Observable that emits every five seconds.
*/
export const onEvery5Seconds$ = timer(0, 5000) as FrequencyObservable<number>;
export const onEvery5Seconds$ = (() => timer(0, 5000)) as FrequencyObservable<
number
>;
onEvery5Seconds$.metadata = { name: 'onEvery5Seconds$' };
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,32 @@
//
// SPDX-License-Identifier: MIT

import createOnFromPubsub from './createOnFromPubsub';
import createPubsubObservable from './createPubsubObservable';
import isObservable from '../../utils/isObservable';
import { rejectApi, resolveApi } from '../../utils/testHelpers/mockApi';

it('should return an Observable', () => {
expect(isObservable(createOnFromPubsub('fake_method', resolveApi))).toBe(
expect(isObservable(createPubsubObservable('fake_method', resolveApi))).toBe(
true
);
});

it('should fire an event when pubsub publishes', done => {
createOnFromPubsub('fake_method', resolveApi).subscribe(data => {
createPubsubObservable('fake_method', resolveApi).subscribe(data => {
expect(data).toBe('foo');
done();
});
});

it('should fire an error when pubsub errors', done => {
createOnFromPubsub('fake_method', rejectApi).subscribe(null, err => {
createPubsubObservable('fake_method', rejectApi).subscribe(null, err => {
expect(err).toEqual(new Error('bar'));
done();
});
});

it('should fire an event when polling pubsub publishes', done => {
createOnFromPubsub('fake_method', () =>
createPubsubObservable('fake_method', () =>
resolveApi(undefined, false)
).subscribe(data => {
expect(data).toBe('foo');
Expand All @@ -37,7 +37,7 @@ it('should fire an event when polling pubsub publishes', done => {
});

it('should fire an error when polling pubsub errors', done => {
createOnFromPubsub('fake_method', () =>
createPubsubObservable('fake_method', () =>
rejectApi(undefined, false)
).subscribe(null, err => {
expect(err).toEqual(new Error('bar'));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
// SPDX-License-Identifier: MIT

import * as debug from 'debug';
import { FrequencyObservable } from '../../types';
import { Observable, Observer, timer } from 'rxjs';
import { switchMap } from 'rxjs/operators';

Expand All @@ -16,10 +15,10 @@ import { distinctReplayRefCount } from '../../utils/operators/distinctReplayRefC
* @ignore
* @example onAccountsChanged$, onEveryBlock$...
*/
const createOnFromPubsub = <T>(
const createPubsubObservable = <T>(
pubsub: string,
api: any // TODO @parity/api
): FrequencyObservable<T> => {
): Observable<T> => {
const [namespace, method] = pubsub.split('_');

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to memoize at this point based on pubsub and api

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for example

const createPubsubObservable = <T>(
  pubsub: string,
  { provider }: FrequencyObservableOptions = {}
) => {
  const [namespace, method] = pubsub.split('_');
  const api = provider ? createApiFromProvider(provider) : getApi();

  return memoize(createPubsubObservableWithApi)(pubsub, api);
};

and put the rest of the code in createPubsubObservableWithApi

// There's a chance the provider doesn't support pubsub, for example
Expand All @@ -33,14 +32,12 @@ const createOnFromPubsub = <T>(
: 'current Api provider'
}, polling "${pubsub}" every second.`
);
return timer(0, 1000).pipe(
switchMap(() => api()[namespace][method]())
) as FrequencyObservable<T>;
return timer(0, 1000).pipe(switchMap(() => api()[namespace][method]()));
}

return Observable.create((observer: Observer<T>) => {
const subscription = api().pubsub[namespace][method](
(error: Error, result: any) => {
(error: Error, result: T) => {
// TODO use @parity/api type for result
if (error) {
observer.error(error);
Expand All @@ -56,4 +53,4 @@ const createOnFromPubsub = <T>(
}).pipe(distinctReplayRefCount());
};

export default createOnFromPubsub;
export default createPubsubObservable;
2 changes: 1 addition & 1 deletion packages/light.js/src/rpc/utils/createRpc.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ it('should contain frequencyMixins', () => {
});

it('should set correct frequency', () => {
const frequency = timer(0, 1000);
const frequency = () => timer(0, 1000);
const rpc$ = createRpc({});
rpc$.setFrequency([frequency]);
expect(rpc$.metadata.frequency).toEqual([frequency]);
Expand Down
17 changes: 12 additions & 5 deletions packages/light.js/src/rpc/utils/createRpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { merge, ReplaySubject, Observable, OperatorFunction } from 'rxjs';
import { multicast, refCount } from 'rxjs/operators';
import * as prune from 'json-prune';

import { getApi, NullProvider } from '../../api';
import { Metadata, RpcObservable } from '../../types';
import { distinctValues, withoutLoading } from '../../utils/operators';

Expand Down Expand Up @@ -57,16 +58,16 @@ const createRpc = <Source, Out>(metadata: Metadata<Source, Out>) => {
// FrequencyObservables
const source$ = metadata.dependsOn
? metadata.dependsOn(...args)
: merge(...metadata.frequency);
: merge(...metadata.frequency.map(f => f()));

// The last arguments is an options, if it's an object
// TODO What if we pass a single object as argument, which is not options?
const options: { withoutLoading?: boolean } =
args && args.length && isObject(args[args.length - 1]) ? args.pop() : {};

// A RpcObservable is a source$ Observable, a single subject$ that
// subscribesthis source, and this subject$ multicasts the fired values to
// all Observers.
// A RpcObservable is: a source$ Observable, a single subject$ that
// subscribes to this source, and this subject$ multicasts the fired values
// to all Observers.
const subject$ = new ReplaySubject<Out>(1);

// The pipes to add
Expand All @@ -91,7 +92,13 @@ const createRpc = <Source, Out>(metadata: Metadata<Source, Out>) => {
return source$.pipe(...pipes);
};

let memoizedRpc$ = memoizee(rpc$, { primitive: true, length: false });
// We memoize only if the api has been already set by the user. The reason
// is: at startup the NullProvider is used. If we memoized, then this
// provider will be used all the time
const memoizedRpc$ =
getApi() instanceof NullProvider
? rpc$
: memoizee(rpc$, { primitive: true, length: false });

Object.assign(memoizedRpc$, frequencyMixins, { metadata });

Expand Down
3 changes: 2 additions & 1 deletion packages/light.js/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ export interface Metadata<Source, Out> {
pipes?: (...args: any[]) => OperatorFunction<Source, Out>[];
}

export interface FrequencyObservable<T> extends Observable<T> {
export interface FrequencyObservable<T> {
(): Observable<T>;
metadata?: { calls?: string[]; name: string };
}

Expand Down