digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-17 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

react: let user specify reconnectThreshold (#7566)

Browse Source 
* react: let user specify reconnectThreshold

Requested by a user on [the forum].

[the forum]: https://discuss.daml.com/t/usestreamquery-disconnecting/1325

CHANGELOG_BEGIN
  * JavaScript Client Libraries: Users of the React wrapper can now
    specify the `reconnectThreshold` parameter of the underlying Ledger
    through LedgerProps. This adds an optional attribute to the
    LedgerProps type, so existing code does not need any change to keep
    working as before (i.e. using the default 30s value).
CHANGELOG_END

* add test
This commit is contained in:
Gary Verhaegen 2020-10-05 17:05:52 +02:00 committed by GitHub
parent c0aee099a1
commit 3bf0a82023
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
language-support/ts/daml-react/README.md
View File

@ -30,6 +30,7 @@ const App: React.FC = () => {
token: <your authentication token>
httpBaseUrl?: <optional http base url>
wsBaseUrl?: <optional websocket base url>
reconnectThreshold?: <optional delay in ms>
party: <the logged in party>
>
<MainScreen />

5
language-support/ts/daml-react/createLedgerContext.ts
View File

@ -23,6 +23,7 @@ export type LedgerProps = {
httpBaseUrl?: string;
wsBaseUrl?: string;
party: Party;
reconnectThreshold?: number;
}
/**
@ -86,9 +87,9 @@ export function createLedgerContext(contextName="DamlLedgerContext"): LedgerCont
// not make a new network request although they are required to refresh data.
const ledgerContext = React.createContext<DamlLedgerState | undefined>(undefined);
const DamlLedger: React.FC<LedgerProps> = ({token, httpBaseUrl, wsBaseUrl, party, children}) => {
const DamlLedger: React.FC<LedgerProps> = ({token, httpBaseUrl, wsBaseUrl, reconnectThreshold, party, children}) => {
const [reloadToken, setReloadToken] = useState(0);
const ledger = useMemo(() => new Ledger({token, httpBaseUrl, wsBaseUrl}), [token, httpBaseUrl, wsBaseUrl]);
const ledger = useMemo(() => new Ledger({token, httpBaseUrl, wsBaseUrl, reconnectThreshold}), [token, httpBaseUrl, wsBaseUrl, reconnectThreshold]);
const state: DamlLedgerState = useMemo(() => ({
reloadToken,
triggerReload: (): void => setReloadToken(x => x + 1),

4
language-support/ts/daml-react/index.test.ts
View File

@ -69,7 +69,7 @@ const TOKEN = 'test_token';
const PARTY = 'test_party';
function renderDamlHook<P, R>(callback: (props: P) => R): RenderHookResult<P, R> {
const wrapper: ComponentType = ({children}) => React.createElement(DamlLedger, {token: TOKEN, party: PARTY}, children);
const wrapper: ComponentType = ({children}) => React.createElement(DamlLedger, {token: TOKEN, party: PARTY, reconnectThreshold: 1337}, children);
return renderHook(callback, {wrapper});
}
@ -86,7 +86,7 @@ beforeEach(() => {
test('DamlLedger', () => {
renderDamlHook(() => { return; });
expect(mockConstructor).toHaveBeenCalledTimes(1);
expect(mockConstructor).toHaveBeenLastCalledWith({token: TOKEN, httpBaseUrl: undefined, wsBaseUrl: undefined});
expect(mockConstructor).toHaveBeenLastCalledWith({token: TOKEN, httpBaseUrl: undefined, wsBaseUrl: undefined, reconnectThreshold: 1337});
});
test('useParty', () => {