Paths

Table of Contentst

-
services/backup/docker-server/contents/server/src/
-
backup/
-
docker-server/
-
contents/
-
server/
-
src/
-
DatabaseManager.h
-
DatabaseManager.cpp

[services] Backup - add Database Manager base
ClosedPublic
Actions

Authored by • karol on Feb 3 2022, 6:49 AM.

Details

Reviewers

tomek
• max
varun
ashoat
• jim

Commits

rCOMM34f2b5fee085: [services] Backup - add Database Manager base

Summary

Base/inner functions for the database manager. This diff may be beneficial for this task https://linear.app/comm/issue/ENG-324/avoid-repetitions-in-services-code because this is the mutual code that may be put in a separate place.

Depends on D3081

Test Plan

cd services
yarn run-backup-service

Still builds

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

• karol created this revision.Feb 3 2022, 6:49 AM

Herald added subscribers: atul, • adrian, tomek, ashoat. · View Herald TranscriptFeb 3 2022, 6:49 AM

• karol published this revision for review.Feb 3 2022, 7:09 AM

• karol edited the summary of this revision. (Show Details)

• karol edited the test plan for this revision. (Show Details)

• karol added reviewers: tomek, • max, varun.

Harbormaster completed remote builds in B6480: Diff 9212.Feb 3 2022, 8:33 AM

I guess this code was tested with later diffs, but it would be nice if test plan was not just . for arc to allow creating a diff, but some explanation. Even if it's hard to test a diff in isolation (which we should aim for), we can describe which parts of the whole testing procedure specifically verified the given diff.

This revision is now accepted and ready to land.Feb 7 2022, 3:10 AM

Herald added a reviewer: ashoat. · View Herald TranscriptFeb 7 2022, 3:10 AM

Herald added a subscriber: • benschac. · View Herald Transcript

This revision now requires review to proceed.Feb 7 2022, 3:10 AM

I agree – the test plan should always be included. In my most recent stack (React Native upgrade) I had a test plan that I copy-pasted for many of the diffs, but for each diff I thought about the test plan. In many cases I specified something more specific than the copy-paste, and only used the copy-paste when it actually applied.

services/backup/docker-server/contents/server/src/DatabaseManager.h
56 ↗	(On Diff #9212)	I thought we had concluded that this is an anti-pattern? We don't have to prioritize removing all of the current cases, but we should avoid introducing new ones

This revision now requires changes to proceed.Feb 7 2022, 9:45 AM

• karol edited the summary of this revision. (Show Details)Feb 8 2022, 1:25 AM

• karol added a parent revision: D3081: [services] Backup - add Database Entities Tools.

• karol added a child revision: D3083: [services] Backup - Database - add Item.

• karol added a child revision: D3084: [services] Backup - Database - add Log Item.Feb 8 2022, 1:39 AM

update

• karol edited the summary of this revision. (Show Details)Feb 8 2022, 1:46 AM

Harbormaster completed remote builds in B6609: Diff 9365.Feb 8 2022, 1:58 AM

tomek accepted this revision.Feb 8 2022, 8:17 AM

tomek added inline comments.

services/backup/docker-server/contents/server/src/DatabaseManager.h
56 ↗	(On Diff #9365)	Please do not use `std::move` https://linear.app/comm/issue/ENG-619/get-rid-of-stdmove-in-the-services-codebase

My feedback that I requested changes for above was not addressed

This revision now requires changes to proceed.Feb 8 2022, 8:14 PM

Sorry about not addressing the comments.

So the main problem here is the test plan. I'm not really sure what I could do as a test for this change. There are just some template functions. Once they're used in some specialized examples, it will be easier to come up with a testing plan for them.
The reason I didn't put a test plan at all is I couldn't see any other way to test this but just to check if it builds successfully. And I assumed that is concluded automatically by putting a diff up.
Will it suffice to write in the test plan something like this?

cd services
yarn run-backup-service

Still builds

Otherwise I don't really know what to put there.

services/backup/docker-server/contents/server/src/DatabaseManager.h
56 ↗	(On Diff #9365)	Right, thanks.

• karol planned changes to this revision.Feb 9 2022, 3:29 AM

• karol edited the test plan for this revision. (Show Details)

remove redundant std::move

Harbormaster completed remote builds in B6668: Diff 9439.Feb 9 2022, 4:11 AM

That test plan is certainly better than nothing :)

I think some of the DynamoDB stuff would need to be tested, but hoping/assuming that gets handled down the line.

This revision is now accepted and ready to land.Feb 9 2022, 9:34 PM

ashoat added a reviewer: • jim.Feb 9 2022, 9:34 PM

• karol edited the summary of this revision. (Show Details)Feb 10 2022, 6:32 AM

Database tests are coming in the future diffs.

Closed by commit rCOMM34f2b5fee085: [services] Backup - add Database Manager base (authored by • karol). · Explain WhyMar 4 2022, 3:55 AM

This revision was automatically updated to reflect the committed changes.

• karol added a commit: rCOMM34f2b5fee085: [services] Backup - add Database Manager base.

Revision Contents
Changeset List

Path

Size

services/

backup/

docker-server/

contents/

server/

src/

DatabaseManager.h

61 lines

DatabaseManager.cpp

47 lines

Diff 10056

View Options

services/backup/docker-server/contents/server/src/DatabaseManager.h

// @flow		// @flow

import type {		import type {
StackNavigationEventMap,		StackNavigationEventMap,
StackNavigationState,		StackNavigationState,
StackOptions,		StackOptions,
} from '@react-navigation/core';		} from '@react-navigation/core';
import invariant from 'invariant';		import invariant from 'invariant';
import * as React from 'react';		import * as React from 'react';
import { Text, View } from 'react-native';		import { Text, View } from 'react-native';

import { setDataLoadedActionType } from 'lib/actions/client-db-store-actions.js';		import { setDataLoadedActionType } from 'lib/actions/client-db-store-actions.js';
import { useENSName } from 'lib/hooks/ens-cache.js';		import { useENSName } from 'lib/hooks/ens-cache.js';
import { useWalletLogIn } from 'lib/hooks/login-hooks.js';		import { useWalletLogIn } from 'lib/hooks/login-hooks.js';
		import type { SIWEBackupData } from 'lib/types/backup-types.js';
import type { SIWEResult } from 'lib/types/siwe-types.js';		import type { SIWEResult } from 'lib/types/siwe-types.js';
import { getMessageForException } from 'lib/utils/errors.js';		import { getMessageForException } from 'lib/utils/errors.js';
import { useDispatch } from 'lib/utils/redux-utils.js';		import { useDispatch } from 'lib/utils/redux-utils.js';
import { usingCommServicesAccessToken } from 'lib/utils/services-utils.js';		import {
		usingCommServicesAccessToken,
		usingRestoreFlow,
		} from 'lib/utils/services-utils.js';

import type { AuthNavigationProp } from './auth-navigator.react.js';		import type { AuthNavigationProp } from './auth-navigator.react.js';
import { RegistrationContext } from './registration-context.js';		import { RegistrationContext } from './registration-context.js';
		import LinkButton from '../../components/link-button.react.js';
import PrimaryButton from '../../components/primary-button.react.js';		import PrimaryButton from '../../components/primary-button.react.js';
import type { RootNavigationProp } from '../../navigation/root-navigator.react.js';		import type { RootNavigationProp } from '../../navigation/root-navigator.react.js';
import type {		import {
NavigationRoute,		type NavigationRoute,
ScreenParamList,		type ScreenParamList,
		QRCodeScreenRouteName,
		RestoreSIWEBackupRouteName,
} from '../../navigation/route-names.js';		} from '../../navigation/route-names.js';
import { useStyles } from '../../themes/colors.js';		import { useStyles } from '../../themes/colors.js';
import {		import {
unknownErrorAlertDetails,		unknownErrorAlertDetails,
appOutOfDateAlertDetails,		appOutOfDateAlertDetails,
} from '../../utils/alert-messages.js';		} from '../../utils/alert-messages.js';
import Alert from '../../utils/alert.js';		import Alert from '../../utils/alert.js';
import AuthButtonContainer from '../auth-components/auth-button-container.react.js';		import AuthButtonContainer from '../auth-components/auth-button-container.react.js';
import AuthContainer from '../auth-components/auth-container.react.js';		import AuthContainer from '../auth-components/auth-container.react.js';
import AuthContentContainer from '../auth-components/auth-content-container.react.js';		import AuthContentContainer from '../auth-components/auth-content-container.react.js';
import { useLegacySIWEServerCall } from '../siwe-hooks.js';		import { useLegacySIWEServerCall } from '../siwe-hooks.js';

export type ExistingEthereumAccountParams = SIWEResult;		export type ExistingEthereumAccountParams = $ReadOnly<{
		...SIWEResult,
		+backupData: ?SIWEBackupData,
		}>;

type Props = {		type Props = {
+navigation: AuthNavigationProp<'ExistingEthereumAccount'>,		+navigation: AuthNavigationProp<'ExistingEthereumAccount'>,
+route: NavigationRoute<'ExistingEthereumAccount'>,		+route: NavigationRoute<'ExistingEthereumAccount'>,
};		};
function ExistingEthereumAccount(props: Props): React.Node {		function ExistingEthereumAccount(props: Props): React.Node {
const legacySiweServerCall = useLegacySIWEServerCall();		const legacySiweServerCall = useLegacySIWEServerCall();
const walletLogIn = useWalletLogIn();		const walletLogIn = useWalletLogIn();

const [logInPending, setLogInPending] = React.useState(false);		const [logInPending, setLogInPending] = React.useState(false);

const registrationContext = React.useContext(RegistrationContext);		const registrationContext = React.useContext(RegistrationContext);
invariant(registrationContext, 'registrationContext should be set');		invariant(registrationContext, 'registrationContext should be set');
const { setCachedSelections } = registrationContext;		const { setCachedSelections } = registrationContext;

const { params } = props.route;		const { params } = props.route;
		const { address, message, signature, backupData } = params;
const dispatch = useDispatch();		const dispatch = useDispatch();
const { navigation } = props;		const { navigation } = props;
const goBackToHome = navigation.getParent<		const goBackToHome = navigation.getParent<
ScreenParamList,		ScreenParamList,
'Auth',		'Auth',
StackNavigationState,		StackNavigationState,
StackOptions,		StackOptions,
StackNavigationEventMap,		StackNavigationEventMap,
RootNavigationProp<'Auth'>,		RootNavigationProp<'Auth'>,
>()?.goBack;		>()?.goBack;

const onProceedToLogIn = React.useCallback(async () => {		const onProceedToLogIn = React.useCallback(async () => {
if (logInPending) {		if (logInPending) {
return;		return;
}		}
setLogInPending(true);		setLogInPending(true);
try {		try {
if (usingCommServicesAccessToken) {		if (usingCommServicesAccessToken) {
await walletLogIn(params.address, params.message, params.signature);		await walletLogIn(params.address, params.message, params.signature);
▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines	const onProceedToLogIn = React.useCallback(async () => {
legacySiweServerCall,		legacySiweServerCall,
walletLogIn,		walletLogIn,
params,		params,
dispatch,		dispatch,
goBackToHome,		goBackToHome,
setCachedSelections,		setCachedSelections,
]);		]);

const { address } = params;		const useLegacyFlow = !backupData \|\| !usingRestoreFlow;

		const openRestoreFlow = React.useCallback(() => {
		if (useLegacyFlow \|\| !backupData) {
		return;
		}
		const {
		siweBackupMsgNonce,
		siweBackupMsgIssuedAt,
		siweBackupMsgStatement,
		} = backupData;
		navigation.navigate(RestoreSIWEBackupRouteName, {
		siweNonce: siweBackupMsgNonce,
		siweStatement: siweBackupMsgStatement,
		siweIssuedAt: siweBackupMsgIssuedAt,
		userIdentifier: address,
		signature,
		message,
		});
		}, [address, backupData, message, navigation, signature, useLegacyFlow]);

		const openQRScreen = React.useCallback(() => {
		navigation.navigate(QRCodeScreenRouteName);
		}, [navigation]);

const walletIdentifier = useENSName(address);		const walletIdentifier = useENSName(address);
const walletIdentifierTitle =		const walletIdentifierTitle =
walletIdentifier === address ? 'Ethereum wallet' : 'ENS name';		walletIdentifier === address ? 'Ethereum wallet' : 'ENS name';

const { goBack } = navigation;		const { goBack } = navigation;
const styles = useStyles(unboundStyles);		const styles = useStyles(unboundStyles);

		let newFlowSection = null;
		if (!useLegacyFlow) {
		newFlowSection = (
		<>
		<Text style={styles.section}>
		If you still have access to your logged-in device, you can use it to
		log in by scanning the QR code.
		</Text>
		<Text style={styles.section}>
		If you’ve lost access to your logged-in device, you can try recovering
		your Comm account. Note that after completing the recovery flow, you
		will be logged out from all of your other devices.
		</Text>
		<View style={styles.linkButton}>
		<LinkButton
		text="Not logged in on another phone?"
		onPress={openRestoreFlow}
		/>
		</View>
		</>
		);
		}

		const primaryAction = React.useMemo(() => {
		if (useLegacyFlow) {
		return (
		<PrimaryButton
		onPress={onProceedToLogIn}
		label="Log in to account"
		variant={logInPending ? 'loading' : 'enabled'}
		/>
		);
		}
		return (
		<PrimaryButton
		onPress={openQRScreen}
		label="Log in via QR code"
		variant="enabled"
		/>
		);
		}, [logInPending, onProceedToLogIn, openQRScreen, useLegacyFlow]);

return (		return (
<AuthContainer>		<AuthContainer>
<AuthContentContainer>		<AuthContentContainer>
<Text style={styles.header}>Account already exists for wallet</Text>		<Text style={styles.header}>Account already exists for wallet</Text>
<Text style={styles.body}>		<Text style={styles.body}>
You can proceed to log in with this wallet, or go back and use a		You can proceed to log in with this wallet, or go back and use a
different wallet.		different wallet.
</Text>		</Text>
<View style={styles.walletTile}>		<View style={styles.walletTile}>
<Text style={styles.walletIdentifierTitleText}>		<Text style={styles.walletIdentifierTitleText}>
{walletIdentifierTitle}		{walletIdentifierTitle}
</Text>		</Text>
<View style={styles.walletIdentifier}>		<View style={styles.walletIdentifier}>
<Text style={styles.walletIdentifierText} numberOfLines={1}>		<Text style={styles.walletIdentifierText} numberOfLines={1}>
{walletIdentifier}		{walletIdentifier}
</Text>		</Text>
</View>		</View>
</View>		</View>
		{newFlowSection}
</AuthContentContainer>		</AuthContentContainer>
<AuthButtonContainer>		<AuthButtonContainer>
<PrimaryButton		{primaryAction}
onPress={onProceedToLogIn}
label="Log in to account"
variant={logInPending ? 'loading' : 'enabled'}
/>
<PrimaryButton		<PrimaryButton
onPress={goBack}		onPress={goBack}
label="Use a different wallet"		label="Use a different wallet"
variant="outline"		variant="outline"
/>		/>
</AuthButtonContainer>		</AuthButtonContainer>
</AuthContainer>		</AuthContainer>
);		);
}		}

const unboundStyles = {		const unboundStyles = {
header: {		header: {
fontSize: 24,		fontSize: 24,
color: 'panelForegroundLabel',		color: 'panelForegroundLabel',
paddingBottom: 16,		paddingBottom: 16,
},		},
body: {		body: {
fontFamily: 'Arial',		fontFamily: 'Arial',
fontSize: 15,		fontSize: 15,
lineHeight: 20,		lineHeight: 20,
color: 'panelForegroundSecondaryLabel',		color: 'panelForegroundSecondaryLabel',
paddingBottom: 40,
},		},
walletTile: {		walletTile: {
backgroundColor: 'panelForeground',		backgroundColor: 'panelForeground',
borderRadius: 8,		borderRadius: 8,
padding: 24,		padding: 24,
alignItems: 'center',		alignItems: 'center',
		marginTop: 40,
		marginBottom: 40,
},		},
walletIdentifierTitleText: {		walletIdentifierTitleText: {
fontSize: 17,		fontSize: 17,
color: 'panelForegroundLabel',		color: 'panelForegroundLabel',
textAlign: 'center',		textAlign: 'center',
},		},
walletIdentifier: {		walletIdentifier: {
backgroundColor: 'panelSecondaryForeground',		backgroundColor: 'panelSecondaryForeground',
paddingVertical: 8,		paddingVertical: 8,
paddingHorizontal: 24,		paddingHorizontal: 24,
borderRadius: 56,		borderRadius: 56,
marginTop: 8,		marginTop: 8,
alignItems: 'center',		alignItems: 'center',
},		},
walletIdentifierText: {		walletIdentifierText: {
fontSize: 15,		fontSize: 15,
color: 'panelForegroundLabel',		color: 'panelForegroundLabel',
},		},
		section: {
		fontFamily: 'Arial',
		fontSize: 15,
		lineHeight: 20,
		color: 'panelForegroundSecondaryLabel',
		paddingBottom: 16,
		},
		linkButton: {
		alignItems: 'center',
		},
};		};

export default ExistingEthereumAccount;		export default ExistingEthereumAccount;