AO3-5367 Bookmarks of unrevealed works appear in search results

[ReverM]

Issue

https://otwarchive.atlassian.net/browse/AO3-5367

Purpose

This makes it so it is impossible to search for hidden (via unrevealed) information with bookmarks by making the json returned for the bookmarked item be empty if the item is unrevealed.

Credit

Danaël / Rever ( they / he )
Danaël Villeneuve on jira

[ReverM]

To note, this will require reindexing

[Bilka2]

Could you explain why it doesn't work to use a filter in the bookmarkable query similar to hidden_filter?

otwarchive/app/models/search/bookmarkable_query.rb

Lines 282 to 287 in b23fe62

	# Exclude items hidden by admin from bookmarkable search results.
	# Note that this is used as an exclusion filter, not an inclusion filter, so
	# the boolean is flipped from the way you might expect.
	def hidden_filter
	term_filter(:hidden_by_admin, "true")
	end

[ReverM]

Could you explain why it doesn't work to use a filter in the bookmarkable query similar to hidden_filter?

otwarchive/app/models/search/bookmarkable_query.rb

Lines 282 to 287 in b23fe62

	# Exclude items hidden by admin from bookmarkable search results.
	# Note that this is used as an exclusion filter, not an inclusion filter, so
	# the boolean is flipped from the way you might expect.
	def hidden_filter
	term_filter(:hidden_by_admin, "true")
	end

This will work for making sure we cannot search using the information on the work that is not visible. However, this would also make it so that it is impossible to search for the visible information on the bookmark. The second step of the added test would fail as this would just exclude every bookmark that is of an unrevealed bookmarkable.

[Bilka2]

Thank you for the explanation! I reconfirmed that we indeed want to keep the bookmarks themselves searchable, so this current approach is good

For the reindexing, this doesn't change the mapping so we we don't need to rebuild the whole index. So, ideally we would update only the bookmarkables that are unrevealed works, without needing downtime. Could you add a rake task that does that? reindex_hidden_unrevealed_tags is an example of a similar task

[Bilka2]

For the reindexing, this doesn't change the mapping so we don't need to rebuild the whole index. So, ideally we would update only the bookmarkables that are unrevealed works, without needing downtime. Could you add a rake task that does that? reindex_hidden_unrevealed_tags is an example of a similar task

[ReverM]

For the reindexing, this doesn't change the mapping so we don't need to rebuild the whole index. So, ideally we would update only the bookmarkables that are unrevealed works, without needing downtime. Could you add a rake task that does that? reindex_hidden_unrevealed_tags is an example of a similar task

Oh sorry about that. It totally slipped out of my mind. Going to do this today.

I see that reindex_hidden_unrevealed_tags is mentionned in the .rake_taks~ file but it seems part of the git ignore. Do I need to modify this file?

[Bilka2]

I see that reindex_hidden_unrevealed_tags is mentionned in the .rake_taks~ file but it seems part of the git ignore. Do I need to modify this file?

That seems like a temporary file, so you shouldn't modify it, no. The real task you can use for reference is in after_tasks.rake, which is also where the task for this PR should be added

[ReverM]

I see that reindex_hidden_unrevealed_tags is mentionned in the .rake_taks~ file but it seems part of the git ignore. Do I need to modify this file?

That seems like a temporary file, so you shouldn't modify it, no. The real task you can use for reference is in after_tasks.rake, which is also where the task for this PR should be added

Got it! One last question, if a work is reindexed as a bookmarkable, does it need to be reindex as a work as well?

[Bilka2]

Got it! One last question, if a work is reindexed as a bookmarkable, does it need to be reindex as a work as well?

No, only the bookmarks needs to be reindexed by this task, since we're not changing the work index. Basically, I think we can get all unrevealed works, similar to what reindex_hidden_unrevealed_tags did and then call update_bookmarks_index on them

[Bilka2]

Thank you!