2926: Fallback language in search function #3024

LeandraH · 2024-12-11T11:55:10Z

Short description

When your app is set to e.g. English and you look for a German term that you got a letter about like "Bürgergeld", you get zero results because we only search for English results. This PR adds a fallback language (the one that we translate from, i.e. German), so in this case, if there are no results in English, we then look in German.

The feedback screens have not been updated yet, that will be a separate ~~issue~~ PR.

Proposed changes

Also load all possible search results in the fallback language
The search stays in the app language, if there are results. If there are no results, we search through all the possible results in the fallback language.

Side effects

The behavior when following a link from the fallback language is different in web and native:
- In web, you open the link in the fallback language and are then in the app in the fallback language. If you use the browser history, you can go back to the selected language
- In native, you open the link in the fallback language in the inAppBrowser. When you close that, you're back in the app in the selected language.

Testing

You can switch the app to English and search for "alleinerziehend".

Resolved issues

Partially fixes: #2926

steffenkleinle · 2024-12-17T10:36:33Z

The feedback screens have not been updated yet, that will be a separate ticket.

Does this issue already exist? Could you please link it here? Thanks :)

steffenkleinle

Tested on firefox and android.

One thing I noticed: If the native app is still loading possible search results, the search bar is not shown. Even though this was already the case before, this change makes it more visible since there are two hooks loaded now at the same time. I also experienced it to disappear during typing alleinerziehend as probably the German results where not yet available. We can also create a separate issue for this though.

steffenkleinle · 2024-12-17T10:38:44Z

native/src/routes/SearchModal.tsx

+  const mainResults = useSearch(allPossibleResults, query)
+  const fallbackResults = useSearch(allPossibleFallbackResults, query)
+
+  const searchResults = mainResults?.length === 0 ? fallbackResults : mainResults


🤔 Hmmm.... I think minisearch often returns search results even if there are no direct matches in the content. What is the reason to not always returning both (main results first, fallback concatenated afterwards)?

Mainly that the issue description said to show the fallback ones if there aren't any in the selected language. Since Steffi opened the issue and she's been in charge of the target group, I assumed that that had been discussed.

But yes, we currently have set minisearch to use a slightly fuzzy search, so it does often return results even without exact matches.

We could think about some kind of hierarchy that we would want results to show up in, e.g. 1. exact results in the selected language, 2. exact results in German, 3. fuzzy results in the selected language, 4. fuzzy results in German. Or maybe no fuzzy results in German? 🤔

Hmm, perhaps e.g. @hauf-toni has some opinion on this. Personally I think it would definitely not hurt to always append German search results. That way, the focus is still on results in the users language but it is also easy to get German results if needed without needing any complicated hierarchy or similar. Just my personal thoughts though, curious if Toni has another opinion on this.

steffenkleinle · 2024-12-17T10:41:01Z

native/src/routes/SearchModalContainer.tsx

+const useMemoizeResults = (
+  categories?: CategoriesMapModel | null,
+  events?: EventModel[] | null,
+  pois?: PoiModel[] | null,
+) => useMemo(() => formatPossibleSearchResults(categories, events, pois), [categories, events, pois])


💭 Do we really have to memoize this? Doesn't really look calculation intense at all 🙈

Good point, that is probably not necessary at all 😅

Turns out we do need to memoize this because of JS checking for equality for arrays (/ objects) only by reference and not by content. Without memoization, the page keeps refreshing because React thinks we have a new list of results.

But miraculously, this is only an issue in web, not in native. So we need the memoization in web to avoid an infinite re-rendering loop, but not in native. I am confused.

I can have a look some time the next few days, perhaps I have an idea why this leads to rerendering otherwise

steffenkleinle · 2024-12-17T10:42:19Z

web/src/routes/SearchPage.tsx

+  })
+  const fallbackResults = useSearch(allPossibleFallbackResults, query)
+
+  const results = mainResults?.length === 0 ? fallbackResults : mainResults


🤔 See native above

web/src/routes/SearchPage.tsx

steffenkleinle · 2024-12-17T10:46:42Z

web/src/hooks/useAllPossibleSearchResults.ts

  const allPossibleResults = useMemo(
-    () => [...(categories?.toArray().filter(category => !category.isRoot()) || []), ...(events || []), ...(pois || [])],
-    [categories, events, pois],
+    () => formatPossibleSearchResults(categories.data, events.data, pois.data),
+    [categories.data, events.data, pois.data],
  )


🔧 Same as for native

steffenkleinle · 2024-12-17T10:48:03Z

web/src/hooks/useAllPossibleSearchResults.ts

-  const { data: categories, ...categoriesReturn } = useLoadFromEndpoint(createCategoriesEndpoint, cmsApiBaseUrl, params)
-  const { data: events, ...eventsReturn } = useLoadFromEndpoint(createEventsEndpoint, cmsApiBaseUrl, params)
-  const { data: pois, ...poisReturn } = useLoadFromEndpoint(createPOIsEndpoint, cmsApiBaseUrl, params)
+  const categories = useLoadFromEndpoint(createCategoriesEndpoint, cmsApiBaseUrl, params)


💭 In theory we could perhaps add a parameter include root set to true as default or something to the categories endpoint so we don't have to filter it out after again?

Probably only really works well for web though, so not sure if its a good idea.

Good point, why are we filtering out isRoot anyway?

Because the root is manually added by us to allow for our tree-based navigation structure. However, we don't want to display an empty category without title/icon/content in the search. Does that make sense?

LeandraH · 2025-01-07T15:07:25Z

The feedback screens have not been updated yet, that will be a separate ticket.

Does this issue already exist? Could you please link it here? Thanks :)

Sorry, I didn't mean that it will be a separate issue but a separate PR. I'll continue with that next.

LeandraH · 2025-01-07T17:45:58Z

One thing I noticed: If the native app is still loading possible search results, the search bar is not shown. Even though this was already the case before, this change makes it more visible since there are two hooks loaded now at the same time. I also experienced it to disappear during typing alleinerziehend as probably the German results where not yet available. We can also create a separate issue for this though.

I fixed the first part of the issue, the search bar is now shown during loading. This should also have fixed the second part, the short disappearance while typing a German word, but can you check again?

LeandraH added 7 commits November 27, 2024 17:31

2926: Add a fallback language in web

04f8710

2926: Refactoring

f4cd441

2926: More refactoring

78170ac

2926: Even more refactoring

d111ff7

2926: Add a fallback language in native

eb6cf41

2926: Fix tests

0245b3f

2926: Cleaning up

0696cb9

LeandraH requested review from steffenkleinle, ztefanie and f1sh1918 as code owners December 11, 2024 11:55

Merge branch 'main' into 2926-fallback-language-in-search

5b6bf61

steffenkleinle reviewed Dec 17, 2024

View reviewed changes

LeandraH added 2 commits January 7, 2025 17:09

2926: Refactoring

17cbbd2

2926: Show search bar when loading results first

4c04e45

2926: Fix rerendering loop in web

abe32c0

LeandraH mentioned this pull request Jan 8, 2025

Search function should have german fallback #2926

Open

LeandraH force-pushed the 2926-fallback-language-in-search branch from b836450 to abe32c0 Compare January 8, 2025 14:58

Merge branch 'main' into 2926-fallback-language-in-search

3f4f5f6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2926: Fallback language in search function #3024

2926: Fallback language in search function #3024

LeandraH commented Dec 11, 2024 •

edited

Loading

steffenkleinle commented Dec 17, 2024

steffenkleinle left a comment

steffenkleinle Dec 17, 2024

LeandraH Jan 7, 2025

LeandraH Jan 7, 2025

steffenkleinle Jan 13, 2025

steffenkleinle Dec 17, 2024

LeandraH Jan 7, 2025

LeandraH Jan 8, 2025

LeandraH Jan 8, 2025

steffenkleinle Jan 13, 2025

steffenkleinle Dec 17, 2024

steffenkleinle Dec 17, 2024

steffenkleinle Dec 17, 2024

LeandraH Jan 7, 2025

steffenkleinle Jan 13, 2025

LeandraH commented Jan 7, 2025

LeandraH commented Jan 7, 2025

2926: Fallback language in search function #3024

Are you sure you want to change the base?

2926: Fallback language in search function #3024

Conversation

LeandraH commented Dec 11, 2024 • edited Loading

Short description

Proposed changes

Side effects

Testing

Resolved issues

steffenkleinle commented Dec 17, 2024

steffenkleinle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LeandraH commented Jan 7, 2025

LeandraH commented Jan 7, 2025

LeandraH commented Dec 11, 2024 •

edited

Loading