Page MenuHomePhabricator
Differential D8144

[kayserver] Fix search endpoint failing when called with a stopword
ClosedPublic
Actions

Authored by inka on Jun 7 2023, 6:45 AM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Mar 12, 11:00 AM
Unknown Object (File)
Thu, Mar 6, 1:49 AM
Unknown Object (File)
Mar 4 2025, 1:25 AM
Unknown Object (File)
Mar 4 2025, 1:25 AM
Unknown Object (File)
Mar 4 2025, 1:25 AM
Unknown Object (File)
Mar 4 2025, 1:25 AM
Unknown Object (File)
Mar 4 2025, 1:19 AM
Unknown Object (File)
Feb 28 2025, 10:09 AM
View All 100 Files
Subscribers
ashoat
tomek

Details

Reviewers
kamil
bartek
Commits
rCOMM35b7721bd5aa: [kayserver] Fix search endpoint failing when called with a stopword
Summary

issue: https://linear.app/comm/issue/ENG-4055/search-endpoint-failing-when-called-with-only-a-stopword
When searchMessagesInSingleChat was passed a string with only stopwords, they were stripped away by processQueryForSearch and the pattern variable was '+', which is not a valid patter for MATCH AGAINST query

Test Plan

call the endpoint with a string that had only stopwords, checked that there are no errors. Called the endpoint with a string containing both a stopword and a non stopword, checked that it returns correct values. Checked he endpoint with a string containing only a non stopword.

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

inka created this revision.Jun 7 2023, 6:45 AM
Herald added subscribers: tomek, ashoat. · View Herald TranscriptJun 7 2023, 6:45 AM
inka edited the summary of this revision. (Show Details)Jun 7 2023, 6:45 AM
inka edited the test plan for this revision. (Show Details)

I could also just check if pattern === '+' and not change the processQueryForSearch function, but I like this approach better

Harbormaster completed remote builds in B20089: Diff 27524.Jun 7 2023, 7:02 AM
inka requested review of this revision.Jun 7 2023, 7:02 AM
kamil accepted this revision.Jun 12 2023, 1:27 AM
kamil added inline comments.
keyserver/src/database/search-utils.js
139 ↗(On Diff #27524)

maybe worth adding a test case with something like: expect(processQueryForSearch(stopWord)).toBe('');

This revision is now accepted and ready to land.Jun 12 2023, 1:27 AM
bartek accepted this revision.Jun 12 2023, 1:48 AM
inka updated this revision to Diff 27652.Jun 12 2023, 7:30 AM

Add a test

Harbormaster completed remote builds in B20186: Diff 27652.Jun 12 2023, 7:47 AM
Closed by commit rCOMM35b7721bd5aa: [kayserver] Fix search endpoint failing when called with a stopword (authored by • InkaSokolowska). · Explain WhyJun 12 2023, 10:58 PM
This revision was automatically updated to reflect the committed changes.
• InkaSokolowska added a commit: rCOMM35b7721bd5aa: [kayserver] Fix search endpoint failing when called with a stopword.

Revision Contents
Changeset List

PathSize
keyserver/
src/
database/
4 lines
5 lines
fetchers/
7 lines

Diff 27676

View Options

keyserver/src/database/search-utils.js

// @flow // @flow
import * as React from 'react'; import * as React from 'react';
import { Switch, Text, View } from 'react-native'; import { Alert, Switch, Text, View } from 'react-native';
import { ScrollView } from 'react-native-gesture-handler'; import { ScrollView } from 'react-native-gesture-handler';
import { useDispatch } from 'react-redux'; import { useDispatch } from 'react-redux';
import { getMessageForException } from 'lib/utils/errors.js';
import { entries } from 'lib/utils/objects.js';
import { useClientBackup } from '../backup/use-client-backup.js';
import Button from '../components/button.react.js';
import { setLocalSettingsActionType } from '../redux/action-types.js'; import { setLocalSettingsActionType } from '../redux/action-types.js';
import { useSelector } from '../redux/redux-utils.js'; import { useSelector } from '../redux/redux-utils.js';
import { useStyles } from '../themes/colors.js'; import { useColors, useStyles } from '../themes/colors.js';
// eslint-disable-next-line no-unused-vars // eslint-disable-next-line no-unused-vars
function BackupMenu(props: { ... }): React.Node { function BackupMenu(props: { ... }): React.Node {
const styles = useStyles(unboundStyles); const styles = useStyles(unboundStyles);
const dispatch = useDispatch(); const dispatch = useDispatch();
const colors = useColors();
const userStore = useSelector(state => state.userStore);
const isBackupEnabled = useSelector( const isBackupEnabled = useSelector(
state => state.localSettings.isBackupEnabled, state => state.localSettings.isBackupEnabled,
); );
const { restoreBackupProtocol } = useClientBackup();
const testRestore = React.useCallback(async () => {
let message;
try {
const result = await restoreBackupProtocol({ userStore });
message = entries(result)
.map(([key, value]) => `${key}: ${String(value)}`)
.join('\n');
} catch (e) {
console.error(`Backup uploading error: ${e}`);
message = `Backup restore error: ${String(getMessageForException(e))}`;
}
Alert.alert('Restore protocol result', message);
}, [restoreBackupProtocol, userStore]);
const onBackupToggled = React.useCallback( const onBackupToggled = React.useCallback(
value => { value => {
dispatch({ dispatch({
type: setLocalSettingsActionType, type: setLocalSettingsActionType,
payload: { isBackupEnabled: value }, payload: { isBackupEnabled: value },
}); });
}, },
[dispatch], [dispatch],
); );
return ( return (
<ScrollView <ScrollView
contentContainerStyle={styles.scrollViewContentContainer} contentContainerStyle={styles.scrollViewContentContainer}
style={styles.scrollView} style={styles.scrollView}
> >
<Text style={styles.header}>SETTINGS</Text> <Text style={styles.header}>SETTINGS</Text>
<View style={styles.section}> <View style={styles.section}>
<View style={styles.submenuButton}> <View style={styles.submenuButton}>
<Text style={styles.submenuText}>Toggle automatic backup</Text> <Text style={styles.submenuText}>Toggle automatic backup</Text>
<Switch value={isBackupEnabled} onValueChange={onBackupToggled} /> <Switch value={isBackupEnabled} onValueChange={onBackupToggled} />
</View> </View>
</View> </View>
<Text style={styles.header}>ACTIONS</Text>
<View style={styles.section}>
<Button
onPress={testRestore}
style={styles.row}
iosFormat="highlight"
iosHighlightUnderlayColor={colors.panelIosHighlightUnderlay}
iosActiveOpacity={0.85}
>
<Text style={styles.submenuText}>Test backup restore protocol</Text>
</Button>
</View>
</ScrollView> </ScrollView>
); );
} }
const unboundStyles = { const unboundStyles = {
scrollViewContentContainer: { scrollViewContentContainer: {
paddingTop: 24, paddingTop: 24,
}, },
Show All 21 Lines submenuButton: {
paddingVertical: 10, paddingVertical: 10,
alignItems: 'center', alignItems: 'center',
}, },
submenuText: { submenuText: {
color: 'panelForegroundLabel', color: 'panelForegroundLabel',
flex: 1, flex: 1,
fontSize: 16, fontSize: 16,
}, },
row: {
flexDirection: 'row',
justifyContent: 'space-between',
paddingHorizontal: 24,
paddingVertical: 14,
},
}; };
export default BackupMenu; export default BackupMenu;
View Options

keyserver/src/database/search-utils.test.js

// @flow // @flow
import * as React from 'react'; import * as React from 'react';
import { Switch, Text, View } from 'react-native'; import { Alert, Switch, Text, View } from 'react-native';
import { ScrollView } from 'react-native-gesture-handler'; import { ScrollView } from 'react-native-gesture-handler';
import { useDispatch } from 'react-redux'; import { useDispatch } from 'react-redux';
import { getMessageForException } from 'lib/utils/errors.js';
import { entries } from 'lib/utils/objects.js';
import { useClientBackup } from '../backup/use-client-backup.js';
import Button from '../components/button.react.js';
import { setLocalSettingsActionType } from '../redux/action-types.js'; import { setLocalSettingsActionType } from '../redux/action-types.js';
import { useSelector } from '../redux/redux-utils.js'; import { useSelector } from '../redux/redux-utils.js';
import { useStyles } from '../themes/colors.js'; import { useColors, useStyles } from '../themes/colors.js';
// eslint-disable-next-line no-unused-vars // eslint-disable-next-line no-unused-vars
function BackupMenu(props: { ... }): React.Node { function BackupMenu(props: { ... }): React.Node {
const styles = useStyles(unboundStyles); const styles = useStyles(unboundStyles);
const dispatch = useDispatch(); const dispatch = useDispatch();
const colors = useColors();
const userStore = useSelector(state => state.userStore);
const isBackupEnabled = useSelector( const isBackupEnabled = useSelector(
state => state.localSettings.isBackupEnabled, state => state.localSettings.isBackupEnabled,
); );
const { restoreBackupProtocol } = useClientBackup();
const testRestore = React.useCallback(async () => {
let message;
try {
const result = await restoreBackupProtocol({ userStore });
message = entries(result)
.map(([key, value]) => `${key}: ${String(value)}`)
.join('\n');
} catch (e) {
console.error(`Backup uploading error: ${e}`);
message = `Backup restore error: ${String(getMessageForException(e))}`;
}
Alert.alert('Restore protocol result', message);
}, [restoreBackupProtocol, userStore]);
const onBackupToggled = React.useCallback( const onBackupToggled = React.useCallback(
value => { value => {
dispatch({ dispatch({
type: setLocalSettingsActionType, type: setLocalSettingsActionType,
payload: { isBackupEnabled: value }, payload: { isBackupEnabled: value },
}); });
}, },
[dispatch], [dispatch],
); );
return ( return (
<ScrollView <ScrollView
contentContainerStyle={styles.scrollViewContentContainer} contentContainerStyle={styles.scrollViewContentContainer}
style={styles.scrollView} style={styles.scrollView}
> >
<Text style={styles.header}>SETTINGS</Text> <Text style={styles.header}>SETTINGS</Text>
<View style={styles.section}> <View style={styles.section}>
<View style={styles.submenuButton}> <View style={styles.submenuButton}>
<Text style={styles.submenuText}>Toggle automatic backup</Text> <Text style={styles.submenuText}>Toggle automatic backup</Text>
<Switch value={isBackupEnabled} onValueChange={onBackupToggled} /> <Switch value={isBackupEnabled} onValueChange={onBackupToggled} />
</View> </View>
</View> </View>
<Text style={styles.header}>ACTIONS</Text>
<View style={styles.section}>
<Button
onPress={testRestore}
style={styles.row}
iosFormat="highlight"
iosHighlightUnderlayColor={colors.panelIosHighlightUnderlay}
iosActiveOpacity={0.85}
>
<Text style={styles.submenuText}>Test backup restore protocol</Text>
</Button>
</View>
</ScrollView> </ScrollView>
); );
} }
const unboundStyles = { const unboundStyles = {
scrollViewContentContainer: { scrollViewContentContainer: {
paddingTop: 24, paddingTop: 24,
}, },
Show All 21 Lines submenuButton: {
paddingVertical: 10, paddingVertical: 10,
alignItems: 'center', alignItems: 'center',
}, },
submenuText: { submenuText: {
color: 'panelForegroundLabel', color: 'panelForegroundLabel',
flex: 1, flex: 1,
fontSize: 16, fontSize: 16,
}, },
row: {
flexDirection: 'row',
justifyContent: 'space-between',
paddingHorizontal: 24,
paddingVertical: 14,
},
}; };
export default BackupMenu; export default BackupMenu;
View Options

keyserver/src/fetchers/message-fetchers.js

// @flow // @flow
import * as React from 'react'; import * as React from 'react';
import { Switch, Text, View } from 'react-native'; import { Alert, Switch, Text, View } from 'react-native';
import { ScrollView } from 'react-native-gesture-handler'; import { ScrollView } from 'react-native-gesture-handler';
import { useDispatch } from 'react-redux'; import { useDispatch } from 'react-redux';
import { getMessageForException } from 'lib/utils/errors.js';
import { entries } from 'lib/utils/objects.js';
import { useClientBackup } from '../backup/use-client-backup.js';
import Button from '../components/button.react.js';
import { setLocalSettingsActionType } from '../redux/action-types.js'; import { setLocalSettingsActionType } from '../redux/action-types.js';
import { useSelector } from '../redux/redux-utils.js'; import { useSelector } from '../redux/redux-utils.js';
import { useStyles } from '../themes/colors.js'; import { useColors, useStyles } from '../themes/colors.js';
// eslint-disable-next-line no-unused-vars // eslint-disable-next-line no-unused-vars
function BackupMenu(props: { ... }): React.Node { function BackupMenu(props: { ... }): React.Node {
const styles = useStyles(unboundStyles); const styles = useStyles(unboundStyles);
const dispatch = useDispatch(); const dispatch = useDispatch();
const colors = useColors();
const userStore = useSelector(state => state.userStore);
const isBackupEnabled = useSelector( const isBackupEnabled = useSelector(
state => state.localSettings.isBackupEnabled, state => state.localSettings.isBackupEnabled,
); );
const { restoreBackupProtocol } = useClientBackup();
const testRestore = React.useCallback(async () => {
let message;
try {
const result = await restoreBackupProtocol({ userStore });
message = entries(result)
.map(([key, value]) => `${key}: ${String(value)}`)
.join('\n');
} catch (e) {
console.error(`Backup uploading error: ${e}`);
message = `Backup restore error: ${String(getMessageForException(e))}`;
}
Alert.alert('Restore protocol result', message);
}, [restoreBackupProtocol, userStore]);
const onBackupToggled = React.useCallback( const onBackupToggled = React.useCallback(
value => { value => {
dispatch({ dispatch({
type: setLocalSettingsActionType, type: setLocalSettingsActionType,
payload: { isBackupEnabled: value }, payload: { isBackupEnabled: value },
}); });
}, },
[dispatch], [dispatch],
); );
return ( return (
<ScrollView <ScrollView
contentContainerStyle={styles.scrollViewContentContainer} contentContainerStyle={styles.scrollViewContentContainer}
style={styles.scrollView} style={styles.scrollView}
> >
<Text style={styles.header}>SETTINGS</Text> <Text style={styles.header}>SETTINGS</Text>
<View style={styles.section}> <View style={styles.section}>
<View style={styles.submenuButton}> <View style={styles.submenuButton}>
<Text style={styles.submenuText}>Toggle automatic backup</Text> <Text style={styles.submenuText}>Toggle automatic backup</Text>
<Switch value={isBackupEnabled} onValueChange={onBackupToggled} /> <Switch value={isBackupEnabled} onValueChange={onBackupToggled} />
</View> </View>
</View> </View>
<Text style={styles.header}>ACTIONS</Text>
<View style={styles.section}>
<Button
onPress={testRestore}
style={styles.row}
iosFormat="highlight"
iosHighlightUnderlayColor={colors.panelIosHighlightUnderlay}
iosActiveOpacity={0.85}
>
<Text style={styles.submenuText}>Test backup restore protocol</Text>
</Button>
</View>
</ScrollView> </ScrollView>
); );
} }
const unboundStyles = { const unboundStyles = {
scrollViewContentContainer: { scrollViewContentContainer: {
paddingTop: 24, paddingTop: 24,
}, },
Show All 21 Lines submenuButton: {
paddingVertical: 10, paddingVertical: 10,
alignItems: 'center', alignItems: 'center',
}, },
submenuText: { submenuText: {
color: 'panelForegroundLabel', color: 'panelForegroundLabel',
flex: 1, flex: 1,
fontSize: 16, fontSize: 16,
}, },
row: {
flexDirection: 'row',
justifyContent: 'space-between',
paddingHorizontal: 24,
paddingVertical: 14,
},
}; };
export default BackupMenu; export default BackupMenu;