Make search related project archival features compatible with group archival

Prerequisite

Before you start, please check out the parent epic description to get the full context: Make project archival features compatible with ... (&19690)

Description

We ran a search for "archive" and "archival" in the codebase and pulled together the following relevant results for the search domain. We'd need your help with:

1. Review the search results and update the code to use our new ancestor-aware methods and scopes wherever needed
2. Creating new services/workers wherever they're needed
3. Note: Not all "archive" mentions are about project archival – feel free to skip anything that's not relevant!

Archive/Archival Occurrences

Search

1. ee/app/models/ee/project.rb

   • elastic_index_dependant_association :issues, on_change: :archived
   • elastic_index_dependant_association :work_items, on_change: :archived
   • elastic_index_dependant_association :merge_requests, on_change: :archived
   • elastic_index_dependant_association :notes, on_change: :archived
   • elastic_index_dependant_association :milestones, on_change: :archived

2. ee/lib/elastic/latest/merge_request_instance_proxy.rb

   • data['archived'] = target.project.archived?

3. ee/lib/elastic/latest/note_config.rb

   • indexes :archived, type: :boolean

4. ee/lib/elastic/latest/commit_config.rb

   • indexes :archived, type: :boolean

5. ee/lib/elastic/latest/merge_request_config.rb

   • indexes :archived, type: :boolean

6. ee/lib/elastic/latest/wiki_config.rb

   • indexes :archived, type: :boolean

7. ee/lib/elastic/latest/issue_instance_proxy.rb

   • data['archived'] = target.project.archived?

8. ee/lib/elastic/latest/project_config.rb

   • indexes :archived, type: :boolean

9. ee/lib/elastic/latest/milestone_instance_proxy.rb

   • data['archived'] = target.project.archived if target.project

10. ee/lib/elastic/latest/git_class_proxy.rb

    • if archived_filter_applicable_for_commit_search?(options)
    • query_hash = context.name(:archived) { archived_filter(query_hash) }
    • def archived_filter_applicable_for_commit_search?(options)
    • !options[:include_archived] && options[:search_level] != 'project'
    • if type == 'blob' && archived_filter_applicable_for_blob_search?(options)
    • query_hash = archived_filter(query_hash)
    • def archived_filter_applicable_for_blob_search?(options)
    • !options[:include_archived] && options[:search_level] != 'project'

11. ee/lib/elastic/latest/config.rb

    • indexes :archived, type: :boolean
    • indexes :archived, type: :boolean

12. ee/lib/elastic/latest/note_class_proxy.rb

    • query_hash = context.name(:archived) { archived_filter(query_hash) } if archived_filter_applicable?(options)
    • def archived_filter_applicable?(options)
    • !(options[:include_archived] || options[:search_level] == 'project')

13. ee/lib/elastic/latest/issue_config.rb

    • indexes :archived, type: :boolean

14. ee/lib/elastic/latest/note_instance_proxy.rb

    • archived: target.project.archived

15. ee/lib/elastic/latest/application_class_proxy.rb

    • def archived_filter(query_hash)
    • archived_false_query = { bool: { filter: { term: { archived: { value: false } } } } }
    • archived_missing_query = { bool: { must_not: { exists: { field: 'archived' } } } }
    • exclude_archived_query = { bool: { _name: context.name(:non_archived),
    • should: [archived_false_query, archived_missing_query] } }
    • query_hash[:query][:bool][:filter] << exclude_archived_query

16. ee/lib/elastic/latest/project_instance_proxy.rb

    • :archived,

17. ee/lib/elastic/latest/wiki_class_proxy.rb

    • query_hash = archived_filter(query_hash) if archived_filter_applicable_on_wiki?(options)
    • def archived_filter_applicable_on_wiki?(options)
    • !options[:include_archived] && options[:search_level] != 'project'

18. ee/lib/search/elastic/references/vulnerability.rb

    • has_remediations archived has_vulnerability_resolution auto_resolved

19. ee/lib/search/elastic/types/work_item.rb

    • archived: { type: 'boolean' },

20. ee/lib/search/elastic/milestone_query_builder.rb

    • query_hash = ::Search::Elastic::Filters.by_archived(query_hash: query_hash, options: options)

21. ee/lib/search/elastic/filters.rb

    • def by_archived(query_hash:, options:)
    • include_archived = !!options[:include_archived]
    • return query_hash if include_archived
    • archived_false_filter = { bool: { filter: { term: { archived: { value: false } } } } }
    • archived_missing_filter = { bool: { must_not: { exists: { field: 'archived' } } } }
    • exclude_archived_filter = { bool: { _name: context.name(:non_archived),
    • should: [archived_false_filter, archived_missing_filter] } }
    • exclude_archived_filter

22. ee/lib/search/elastic/references/work_item.rb

    • include_archived
    • archived: target.project.archived?,

23. ee/lib/search/elastic/project_query_builder.rb

    • query_hash = ::Search::Elastic::Filters.by_archived(query_hash: query_hash, options: options)

24. ee/lib/search/elastic/work_item_query_builder.rb

    • query_hash = ::Search::Elastic::Filters.by_archived(query_hash: query_hash, options: options)

25. ee/lib/search/elastic/merge_request_query_builder.rb

    • query_hash = ::Search::Elastic::Filters.by_archived(query_hash: query_hash, options: options)

26. ee/app/models/concerns/elastic/projects_search.rb

    • BLOB_AND_COMMIT_TRACKED_FIELDS = %i[archived visibility_level].freeze
    • WIKI_TRACKED_FIELDS = %i[archived visibility_level].freeze

27. ee/lib/gitlab/elastic/indexer.rb

    • c << "--archived=#{project.archived}" if project
    • c << "--archived=#{project.archived}"

28. ee/lib/gitlab/elastic/project_search_results.rb

    • options: base_options.merge(filters.slice(:include_archived), count_only: count_only))

29. ee/lib/gitlab/elastic/search_results.rb

    • base_options.merge(filters.slice(:include_archived))
    • filters.slice(:order_by, :sort, :confidential, :state, :label_name, :include_archived), klass: Issue)
    • base_options.merge({ features: [:issues, :merge_requests] }, filters.slice(:include_archived))
    • base_options.merge(filters.slice(:language, :include_archived, :num_context_lines))
    • base_options.merge(root_ancestor_ids: root_ancestor_ids).merge(filters.slice(:include_archived))
    • :include_archived,

30. ee/lib/ee/search/advanced_finders/work_items_finder.rb

    • :include_archived
    • include_archived: params[:include_archived]

31. ee/lib/search/zoekt/filters.rb

    • def by_archived(value, context: nil)
    • by_meta(key: 'archived', value: value ? 't' : 'f', context: context)

32. ee/lib/search/zoekt/search_results.rb

    • filtered_projects = filtered_projects.non_archived unless filters[:include_archived]

33. ee/lib/search/zoekt/code_query_builder.rb

    • children << Filters.by_archived(false) unless filters[:include_archived] == true

34. app/helpers/search_helper.rb

    • ).sorted_by_stars_desc.non_archived.limit(limit)

35. app/services/concerns/search/filter.rb

    • include_archived: params[:include_archived],

36. ee/app/graphql/resolvers/search/blob/blob_search_resolver.rb

    • argument :include_archived, GraphQL::Types::Boolean, required: false, default_value: false,
    • description: 'Includes archived projects in the search. Always true for project search. Default is false.'
    • include_archived: args[:include_archived],

37. ee/app/workers/search/zoekt/project_marked_as_archived_event_worker.rb

    • class ProjectMarkedAsArchivedEventWorker
    • log_extra_metadata_on_done(:project_id_archived_and_reindexed, project_id)

38. ee/app/services/ee/search/project_service.rb

    • # project search always includes archived and forked projects
    • super.merge(include_archived: true, exclude_forks: false)

39. ee/app/services/search/zoekt/task_serializer_service.rb

    • archived: project.archived? ? "t" : "f"

40. ee/app/services/concerns/search/zoekt_searchable.rb

    • params.slice(:language, :include_archived, :exclude_forks)

41. lib/gitlab/search_results.rb

    • scope = scope.non_archived unless filters[:include_archived]
    • project_ids = project_ids.non_archived unless filters[:include_archived]
    • project_ids = project_ids.non_archived unless filters[:include_archived]
    • candidate_project_ids = candidate_project_ids.non_archived unless filters[:include_archived]

42. lib/gitlab/search/params.rb

    • BOOLEAN_PARAMS = %i[confidential exclude_forks include_archived].freeze