The API search filtered all notes when showCompletedTodos is set to false

[JackGruber]

When searching for notes via the API and the showCompletedTodos is set to false and the fields is_todo and todo_completed should not be returned then all notes are filternd.

overviewNotes = await joplin.data.get(["search"], {
  query: "joplin",
  fields: "id, title, body",
});

Environment

Joplin 2.0.1 (dev, win32)

Client ID: 3786010df4424355b5ac92d208168602
Sync Version: 2
Profile Version: 37
Keychain Supported: Yes

Revision: 68b5169 (test)

Steps to reproduce

1. Set Show completed to-dos to disable
2. Run a search query in a plugin or API without the todo fields
   http://localhost:27583/search?query=joplin&type=note&token=
3. No search results returned
4. Set Show completed to-dos to enable
5. run query again and the search results are returned

Describe what you expected to happen

1. The API search does not consider the option showCompletedTodos and always returns all matches
   or
2. The API search does consider the option showCompletedTodos and filterd the notes accordingly

@laurent22 what do you think is the best option for the API search to handel this behavior?
I think for the API is almost the option 1 the best?

The behavior occurs since #4951

joplin/packages/lib/services/searchengine/SearchEngineUtils.ts

Line 54 in 68b5169

filteredNotes = sortedNotes.filter(note => note.is_todo === 0 || (note.is_todo === 1 && note.todo_completed === 0));

[laurent22]

Hmm, in fact what's returned by the API should not be affected by the settings, so I think it was a mistake to add this "showCompletedTodos" condition to SearchEngineUtils. Or maybe it's a mistake to use SearchEngineUtils in routes/search.ts

Actually we have a filter iscomplete:0/1, so is it not sufficient to filter based on whether a to-do is completed or not? Why do we need this support for showCompletedTodos in search?

[JackGruber]

The PR was not meant to filter notes based on the option, but to hide the notes after a search.

In the BaseApplication.ts and refreshSearch.js the SearchEngineUtils.notesForQuery is used for selecting the notes.
Therefore I thought this function is only used for displaying the notes, but the other place this function is used is routes/search.ts.

[laurent22]

Right, on the UI side it does make sense. So I guess the bug could be that it's used in routes/search.ts. Maybe some option could be added like "applyUserSettings", and if "false" we don't filter based on "showCompletedTodos". Would that fix the original issue?

[JackGruber]

Yes, I prepare fix.