Page MenuHomePhabricator
Differential D10694

[lib] Introduce global BoundSingleKeyserverActionFunc cache
ClosedPublic
Actions

Authored by ashoat on Jan 18 2024, 12:49 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Mar 28, 11:09 AM
Unknown Object (File)
Fri, Mar 28, 5:42 AM
Unknown Object (File)
Fri, Mar 14, 6:39 AM
Unknown Object (File)
Mon, Mar 3, 5:16 PM
Unknown Object (File)
Feb 27 2025, 8:21 PM
Unknown Object (File)
Feb 27 2025, 8:21 PM
Unknown Object (File)
Feb 27 2025, 8:21 PM
Unknown Object (File)
Feb 27 2025, 8:21 PM
View All 65 Files
Subscribers
None

Details

Reviewers
tomek
inka
atul
Commits
rCOMM06161583e6bd: [lib] Introduce global BoundSingleKeyserverActionFunc cache
Summary

In cases where we don't have a custom paramOverride, we can have a single cached SingleKeyserverActionFunc for each keyserver.

Depends on D10693

Test Plan

I tested this stack using the following procedure:

  1. I tested primarily on native
    1. I compiled a dev build and deployed it to an iOS simulator
    2. I created a brand new account on my local keyserver using the iOS app
    3. I ran Redux dev tools: cd native && yarn redux-devtools
    4. I added a 30s sleep at the start of resolveKeyserverSessionInvalidation
    5. I made KeyserverConnectionsHandler return null so that the socket wouldn’t automatically recover the session prior to my testing
    6. I killed the app
    7. I deleted all of the test user’s cookie
    8. I then opened the app again and navigated to a chat and sent two messages
    9. By following the Redux monitor, I was able to see that the keyserver session invalidation recovery was successful, and both messages were eventually sent after the 30s sleep concluded
  2. On web, we don’t support keyserver session invalidation. However, I tested to make sure that the web app still loaded after my changes

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Revision Contents
Changeset List

PathSize
lib/
keyserver-conn/
105 lines
utils/
35 lines

Diff 35830

View Options

lib/keyserver-conn/call-keyserver-endpoint-provider.react.js

Show All 16 Lines
import type { CurrentUserInfo } from '../types/user-types.js'; import type { CurrentUserInfo } from '../types/user-types.js';
import type { import type {
CallServerEndpoint, CallServerEndpoint,
CallServerEndpointOptions, CallServerEndpointOptions,
} from '../utils/call-server-endpoint.js'; } from '../utils/call-server-endpoint.js';
import callServerEndpoint from '../utils/call-server-endpoint.js'; import callServerEndpoint from '../utils/call-server-endpoint.js';
export type ActionFunc<F> = (callServerEndpoint: CallServerEndpoint) => F; export type ActionFunc<F> = (callServerEndpoint: CallServerEndpoint) => F;
type CreateBoundServerCallsSelectorType = ( type CreateCallSingleKeyserverEndpointSelector = (
keyserverID: string, keyserverID: string,
) => <F>(ActionFunc<F>) => ServerCallSelectorParams => F; ) => ServerCallSelectorParams => CallServerEndpoint;
type CallKeyserverEndpointContextType = { type CallKeyserverEndpointContextType = {
+bindCookieAndUtilsIntoCallServerEndpoint: ( +bindCookieAndUtilsIntoCallServerEndpoint: (
params: BindServerCallsParams, params: BindServerCallsParams,
) => CallServerEndpoint, ) => CallServerEndpoint,
+createBoundServerCallsSelector: CreateBoundServerCallsSelectorType, +createCallSingleKeyserverEndpointSelector: CreateCallSingleKeyserverEndpointSelector,
}; };
const CallKeyserverEndpointContext: React.Context<?CallKeyserverEndpointContextType> = const CallKeyserverEndpointContext: React.Context<?CallKeyserverEndpointContextType> =
React.createContext(); React.createContext();
type OngoingRecoveryAttempt = { type OngoingRecoveryAttempt = {
+waitingCalls: Array<(callServerEndpoint: ?CallServerEndpoint) => mixed>, +waitingCalls: Array<(callServerEndpoint: ?CallServerEndpoint) => mixed>,
}; };
▲ Show 20 Lines • Show All 145 Lines • ▼ Show 20 Lines ) =>
data, data,
dispatch, dispatch,
options, options,
loggedIn, loggedIn,
keyserverID, keyserverID,
); );
}, []); }, []);
// All server calls needs to include some information from the Redux state // For each keyserver, we have a set of params that configure our connection
// (namely, the cookie). This information is used deep in the server call, // to it. These params get bound into callServerEndpoint before it's passed to
// at the point where callServerEndpoint is called. We don't want to bother // an ActionFunc. This helper function lets us create a selector for a given
// propagating the cookie (and any future config info that callServerEndpoint // keyserverID that will regenerate the bound callServerEndpoint function only
// needs) through to the server calls so they can pass it to // if one of the params changes. This lets us skip some React render cycles.
// callServerEndpoint. Instead, we "curry" the cookie onto callServerEndpoint const createCallSingleKeyserverEndpointSelector = React.useCallback(
// within react-redux's connect's mapStateToProps function, and then pass that (keyserverID: string): (ServerCallSelectorParams => CallServerEndpoint) =>
// "bound" callServerEndpoint that no longer needs the cookie as a parameter
// on to the server call.
const createBoundServerCallsSelector = React.useCallback(
(
keyserverID: string,
): (<F>(actionFunc: ActionFunc<F>) => ServerCallSelectorParams => F) =>
actionFunc =>
createSelector( createSelector(
(state: ServerCallSelectorParams) => state.dispatch, (params: ServerCallSelectorParams) => params.dispatch,
(state: ServerCallSelectorParams) => state.cookie, (params: ServerCallSelectorParams) => params.cookie,
(state: ServerCallSelectorParams) => state.urlPrefix, (params: ServerCallSelectorParams) => params.urlPrefix,
(state: ServerCallSelectorParams) => state.sessionID, (params: ServerCallSelectorParams) => params.sessionID,
(state: ServerCallSelectorParams) => state.currentUserInfo, (params: ServerCallSelectorParams) => params.currentUserInfo,
(state: ServerCallSelectorParams) => state.isSocketConnected, (params: ServerCallSelectorParams) => params.isSocketConnected,
(state: ServerCallSelectorParams) => (params: ServerCallSelectorParams) =>
state.lastCommunicatedPlatformDetails, params.lastCommunicatedPlatformDetails,
( (
dispatch: Dispatch, dispatch: Dispatch,
cookie: ?string, cookie: ?string,
urlPrefix: string, urlPrefix: string,
sessionID: ?string, sessionID: ?string,
currentUserInfo: ?CurrentUserInfo, currentUserInfo: ?CurrentUserInfo,
isSocketConnected: boolean, isSocketConnected: boolean,
lastCommunicatedPlatformDetails: ?PlatformDetails, lastCommunicatedPlatformDetails: ?PlatformDetails,
) => { ) =>
const boundCallServerEndpoint =
bindCookieAndUtilsIntoCallServerEndpoint({ bindCookieAndUtilsIntoCallServerEndpoint({
dispatch, dispatch,
cookie, cookie,
urlPrefix, urlPrefix,
sessionID, sessionID,
currentUserInfo, currentUserInfo,
isSocketConnected, isSocketConnected,
lastCommunicatedPlatformDetails, lastCommunicatedPlatformDetails,
keyserverID, keyserverID,
}); }),
return actionFunc(boundCallServerEndpoint);
},
), ),
[bindCookieAndUtilsIntoCallServerEndpoint], [bindCookieAndUtilsIntoCallServerEndpoint],
); );
const value = React.useMemo( const value = React.useMemo(
() => ({ () => ({
bindCookieAndUtilsIntoCallServerEndpoint, bindCookieAndUtilsIntoCallServerEndpoint,
createBoundServerCallsSelector, createCallSingleKeyserverEndpointSelector,
}), }),
[bindCookieAndUtilsIntoCallServerEndpoint, createBoundServerCallsSelector], [
bindCookieAndUtilsIntoCallServerEndpoint,
createCallSingleKeyserverEndpointSelector,
],
); );
return ( return (
<CallKeyserverEndpointContext.Provider value={value}> <CallKeyserverEndpointContext.Provider value={value}>
{props.children} {props.children}
</CallKeyserverEndpointContext.Provider> </CallKeyserverEndpointContext.Provider>
); );
} }
Show All 22 Lines
View Options

lib/utils/action-utils.js

Show All 16 Lines
import type { CurrentUserInfo } from '../types/user-types.js'; import type { CurrentUserInfo } from '../types/user-types.js';
import type { import type {
CallServerEndpoint, CallServerEndpoint,
CallServerEndpointOptions, CallServerEndpointOptions,
} from '../utils/call-server-endpoint.js'; } from '../utils/call-server-endpoint.js';
import callServerEndpoint from '../utils/call-server-endpoint.js'; import callServerEndpoint from '../utils/call-server-endpoint.js';
export type ActionFunc<F> = (callServerEndpoint: CallServerEndpoint) => F; export type ActionFunc<F> = (callServerEndpoint: CallServerEndpoint) => F;
type CreateBoundServerCallsSelectorType = ( type CreateCallSingleKeyserverEndpointSelector = (
keyserverID: string, keyserverID: string,
) => <F>(ActionFunc<F>) => ServerCallSelectorParams => F; ) => ServerCallSelectorParams => CallServerEndpoint;
type CallKeyserverEndpointContextType = { type CallKeyserverEndpointContextType = {
+bindCookieAndUtilsIntoCallServerEndpoint: ( +bindCookieAndUtilsIntoCallServerEndpoint: (
params: BindServerCallsParams, params: BindServerCallsParams,
) => CallServerEndpoint, ) => CallServerEndpoint,
+createBoundServerCallsSelector: CreateBoundServerCallsSelectorType, +createCallSingleKeyserverEndpointSelector: CreateCallSingleKeyserverEndpointSelector,
}; };
const CallKeyserverEndpointContext: React.Context<?CallKeyserverEndpointContextType> = const CallKeyserverEndpointContext: React.Context<?CallKeyserverEndpointContextType> =
React.createContext(); React.createContext();
type OngoingRecoveryAttempt = { type OngoingRecoveryAttempt = {
+waitingCalls: Array<(callServerEndpoint: ?CallServerEndpoint) => mixed>, +waitingCalls: Array<(callServerEndpoint: ?CallServerEndpoint) => mixed>,
}; };
▲ Show 20 Lines • Show All 145 Lines • ▼ Show 20 Lines ) =>
data, data,
dispatch, dispatch,
options, options,
loggedIn, loggedIn,
keyserverID, keyserverID,
); );
}, []); }, []);
// All server calls needs to include some information from the Redux state // For each keyserver, we have a set of params that configure our connection
// (namely, the cookie). This information is used deep in the server call, // to it. These params get bound into callServerEndpoint before it's passed to
// at the point where callServerEndpoint is called. We don't want to bother // an ActionFunc. This helper function lets us create a selector for a given
// propagating the cookie (and any future config info that callServerEndpoint // keyserverID that will regenerate the bound callServerEndpoint function only
// needs) through to the server calls so they can pass it to // if one of the params changes. This lets us skip some React render cycles.
// callServerEndpoint. Instead, we "curry" the cookie onto callServerEndpoint const createCallSingleKeyserverEndpointSelector = React.useCallback(
// within react-redux's connect's mapStateToProps function, and then pass that (keyserverID: string): (ServerCallSelectorParams => CallServerEndpoint) =>
// "bound" callServerEndpoint that no longer needs the cookie as a parameter
// on to the server call.
const createBoundServerCallsSelector = React.useCallback(
(
keyserverID: string,
): (<F>(actionFunc: ActionFunc<F>) => ServerCallSelectorParams => F) =>
actionFunc =>
createSelector( createSelector(
(state: ServerCallSelectorParams) => state.dispatch, (params: ServerCallSelectorParams) => params.dispatch,
(state: ServerCallSelectorParams) => state.cookie, (params: ServerCallSelectorParams) => params.cookie,
(state: ServerCallSelectorParams) => state.urlPrefix, (params: ServerCallSelectorParams) => params.urlPrefix,
(state: ServerCallSelectorParams) => state.sessionID, (params: ServerCallSelectorParams) => params.sessionID,
(state: ServerCallSelectorParams) => state.currentUserInfo, (params: ServerCallSelectorParams) => params.currentUserInfo,
(state: ServerCallSelectorParams) => state.isSocketConnected, (params: ServerCallSelectorParams) => params.isSocketConnected,
(state: ServerCallSelectorParams) => (params: ServerCallSelectorParams) =>
state.lastCommunicatedPlatformDetails, params.lastCommunicatedPlatformDetails,
( (
dispatch: Dispatch, dispatch: Dispatch,
cookie: ?string, cookie: ?string,
urlPrefix: string, urlPrefix: string,
sessionID: ?string, sessionID: ?string,
currentUserInfo: ?CurrentUserInfo, currentUserInfo: ?CurrentUserInfo,
isSocketConnected: boolean, isSocketConnected: boolean,
lastCommunicatedPlatformDetails: ?PlatformDetails, lastCommunicatedPlatformDetails: ?PlatformDetails,
) => { ) =>
const boundCallServerEndpoint =
bindCookieAndUtilsIntoCallServerEndpoint({ bindCookieAndUtilsIntoCallServerEndpoint({
dispatch, dispatch,
cookie, cookie,
urlPrefix, urlPrefix,
sessionID, sessionID,
currentUserInfo, currentUserInfo,
isSocketConnected, isSocketConnected,
lastCommunicatedPlatformDetails, lastCommunicatedPlatformDetails,
keyserverID, keyserverID,
}); }),
return actionFunc(boundCallServerEndpoint);
},
), ),
[bindCookieAndUtilsIntoCallServerEndpoint], [bindCookieAndUtilsIntoCallServerEndpoint],
); );
const value = React.useMemo( const value = React.useMemo(
() => ({ () => ({
bindCookieAndUtilsIntoCallServerEndpoint, bindCookieAndUtilsIntoCallServerEndpoint,
createBoundServerCallsSelector, createCallSingleKeyserverEndpointSelector,
}), }),
[bindCookieAndUtilsIntoCallServerEndpoint, createBoundServerCallsSelector], [
bindCookieAndUtilsIntoCallServerEndpoint,
createCallSingleKeyserverEndpointSelector,
],
); );
return ( return (
<CallKeyserverEndpointContext.Provider value={value}> <CallKeyserverEndpointContext.Provider value={value}>
{props.children} {props.children}
</CallKeyserverEndpointContext.Provider> </CallKeyserverEndpointContext.Provider>
); );
} }
Show All 22 Lines