Class: Crm::PartyResearchRunsController

Inherits:
CrmController show all
Defined in:
app/controllers/crm/party_research_runs_controller.rb

Overview

CRM controller for the Lead Enrichment feature. Each "run" is one click of
the Enrich button on a Party page — Customer (whole org) or Contact (a
specific person at the org). The user picks which adapters to call, this
controller enqueues the PartyEnrichmentWorker, and the show page tails
the Sidekiq job for progress before rendering the accept/reject findings
table.

The same routes accept either parent via parallel nesting:
customers/:customer_id/party_research_runs/... and
contacts/:contact_id/party_research_runs/.... load_party picks the
right one off params. show is a shallow top-level route shared by both.

Apply / reject actions for individual findings live in
PartyResearchFindingsController; this controller only owns the
run-level lifecycle.

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#create ⇒ void

This method returns an undefined value.

Creates a PartyResearchRun from the selected adapters (plus any
forced arbiter adapters) and enqueues PartyEnrichmentWorker.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'app/controllers/crm/party_research_runs_controller.rb', line 51

def create
  # Adapter names come from form params — only accept ones the
  # registry actually knows about. Drops any tampered/unknown names
  # before we hit the orchestrator and burn paid API attempts.
  allowed = registered_adapter_names
  selected = Array(params.dig(:party_research_run, :adapters)).map(&:to_s).reject(&:blank?) & allowed
  # Arbiter adapters always run — they're the synthesis layer, not a
  # user-toggleable data source. Force them in regardless of form
  # input. The picker UI already renders them as locked / not
  # user-selectable.
  adapters = (selected + arbiter_adapter_names).uniq
  raw_data_pullers = selected - arbiter_adapter_names

  if raw_data_pullers.empty?
    # `[:new, @party, :party_research_run]` resolves to either
    # new_customer_... or new_contact_... depending on @party's class
    # — same trick used in `guard_enrichable` below.
    redirect_to [:new, @party, :party_research_run],
                alert: 'Pick at least one data source to query.'
    return
  end

  @run = PartyResearchRun.create!(
    party: @party,
    requested_by_id: .id,
    adapters: adapters
  )
  jid = PartyEnrichmentWorker.perform_async(@run.id)
  @run.update!(sidekiq_jid: jid)

  redirect_to party_research_run_path(@run)
end

#index ⇒ void

This method returns an undefined value.

Lists past enrichment runs for the party.



27
28
29
30
31
32
33
 
# File 'app/controllers/crm/party_research_runs_controller.rb', line 27

def index
  # Preload findings so the run-history partial's `run.findings.size`
  # is an array length (no per-row COUNT).
  @runs = PartyResearchRun.where(party_id: @party.id)
                          .includes(:findings, requested_by: :party)
                          .order(created_at: :desc)
end

#new ⇒ void

This method returns an undefined value.

Renders the adapter picker for starting a new enrichment run.



38
39
40
41
42
43
44
45
 
# File 'app/controllers/crm/party_research_runs_controller.rb', line 38

def new
  @run = PartyResearchRun.new(party: @party)
  @available_adapters = available_adapters
  @runs = PartyResearchRun.where(party_id: @party.id)
                          .includes(:findings, requested_by: :party)
                          .order(created_at: :desc)
                          .limit(10)
end

#show ⇒ void

This method returns an undefined value.

Shows a run's findings, gated on arbiter curation per the state machine
described above.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'app/controllers/crm/party_research_runs_controller.rb', line 88

def show
  all = @run.findings.order(:category, :id)
  @arbiter_findings = all.select(&:arbiter?)
  @raw_findings = all.reject(&:arbiter?)

  # The arbiter (Gemini) curates raw findings — and the user must
  # only get accept/reject buttons on the curated set. Until the run
  # reaches a terminal state we can't tell whether Gemini just
  # hasn't finished yet or wasn't selected, so don't surface any
  # actionable findings mid-run:
  #
  #   - Arbiter findings exist → show those (curated)
  #   - Run completed/failed and no arbiter findings →
  #     fall back to raw (Gemini wasn't selected or returned nothing)
  #   - Run still queued/running and no arbiter findings yet → []
  #     (the show page will keep polling and re-render when Gemini
  #     finishes)
  @findings = if @arbiter_findings.any?
                @arbiter_findings
              elsif @run.state.in?(%w[completed failed])
                @raw_findings
              else
                []
              end
  @awaiting_arbiter = @findings.empty? && @run.state.in?(%w[queued running])
end