feat: more warnings on common test account filter mistakes (#13852)

* feat: more warnings on common test account filter mistakes * export the interface
PostHog · Jan 20, 2023 · 49c29c4 · 49c29c4
1 parent c30e399
commit 49c29c4
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 1 deletion.
diff --git a/frontend/src/scenes/project/Settings/TestAccountFiltersConfig.tsx b/frontend/src/scenes/project/Settings/TestAccountFiltersConfig.tsx
@@ -11,7 +11,8 @@ import { AlertMessage } from 'lib/components/AlertMessage'
 export function TestAccountFiltersConfig(): JSX.Element {
     const { updateCurrentTeam } = useActions(teamLogic)
     const { reportTestAccountFiltersUpdated } = useActions(eventUsageLogic)
-    const { currentTeam, currentTeamLoading, testAccountFilterWarningLabels } = useValues(teamLogic)
+    const { currentTeam, currentTeamLoading, testAccountFilterWarningLabels, testAccountFilterFrequentMistakes } =
+        useValues(teamLogic)
     const { groupsTaxonomicTypes } = useValues(groupsModel)
 
     const handleChange = (filters: AnyPropertyFilter[]): void => {
@@ -39,6 +40,18 @@ export function TestAccountFiltersConfig(): JSX.Element {
                         </ul>
                     </AlertMessage>
                 )}
+                {!!testAccountFilterFrequentMistakes && testAccountFilterFrequentMistakes.length > 0 && (
+                    <AlertMessage type="warning" className="m-2">
+                        <p>Your filter contains a setting that is likely to exclude or include unexpected users.</p>
+                        <ul className="list-disc">
+                            {testAccountFilterFrequentMistakes.map(({ key, type, fix }, i) => (
+                                <li key={i} className="ml-4">
+                                    {key} is a {type} property, but {fix}.
+                                </li>
+                            ))}
+                        </ul>
+                    </AlertMessage>
+                )}
                 {currentTeam && (
                     <PropertyFilters
                         pageKey="testaccountfilters"

diff --git a/frontend/src/scenes/teamLogic.tsx b/frontend/src/scenes/teamLogic.tsx
@@ -23,6 +23,12 @@ const parseUpdatedAttributeName = (attr: string | null): string => {
     return attr ? identifierToHuman(attr) : 'Project'
 }
 
+export interface FrequentMistakeAdvice {
+    key: string
+    type: 'event' | 'person'
+    fix: string
+}
+
 export const teamLogic = kea<teamLogicType>([
     path(['scenes', 'teamLogic']),
     connect({
@@ -172,6 +178,26 @@ export const teamLogic = kea<teamLogicType>([
                 })
             },
         ],
+        testAccountFilterFrequentMistakes: [
+            (selectors) => [selectors.currentTeam],
+            (currentTeam): FrequentMistakeAdvice[] => {
+                if (!currentTeam) {
+                    return []
+                }
+                const frequentMistakes: FrequentMistakeAdvice[] = []
+
+                for (const filter of currentTeam.test_account_filters) {
+                    if (filter.key === 'email' && filter.type === 'event') {
+                        frequentMistakes.push({
+                            key: 'email',
+                            type: 'event',
+                            fix: 'it is more common to filter email by person properties, not event properties',
+                        })
+                    }
+                }
+                return frequentMistakes
+            },
+        ],
     }),
     listeners(({ actions }) => ({
         deleteTeam: async ({ team }) => {