Class: Admin::BackgroundMigrationsController

Inherits:
CrmController show all
Defined in:
app/controllers/admin/background_migrations_controller.rb

Overview

Controller: background data migrations dashboard for online_migrations 0.33+.

Wraps OnlineMigrations::BackgroundDataMigrations::Migration, which since the
0.27 rewrite uses Sidekiq IterableJob (no per-batch DB job rows). Lifecycle
actions delegate to the model's state-machine-style methods (pause,
resume, cancel) rather than poking status directly.

Constant Summary collapse

TERMINAL_STATUSES =

Statuses beyond which a migration can no longer transition — required to
allow #destroy.

%w[succeeded failed cancelled].freeze

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

#cancel ⇒ void

This method returns an undefined value.

POST /admin/background_migrations/:id/cancel — cancels a running migration.



56
57
58
59
60
61
62
63
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 56

def cancel
  if @migration.cancel
    flash[:success] = 'Migration has been cancelled'
  else
    flash[:warning] = 'Cannot cancel a completed migration'
  end
  redirect_to admin_background_migration_path(@migration)
end

#destroy ⇒ void

This method returns an undefined value.

DELETE /admin/background_migrations/:id — deletes the migration record,
only once it's in a TERMINAL_STATUSES status.



69
70
71
72
73
74
75
76
77
78
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 69

def destroy
  if TERMINAL_STATUSES.include?(@migration.status)
    @migration.destroy
    flash[:success] = 'Migration record has been deleted'
    redirect_to admin_background_migrations_path
  else
    flash[:warning] = "Cannot delete migration in '#{@migration.status}' status — cancel it first"
    redirect_to admin_background_migration_path(@migration)
  end
end

#index ⇒ void

This method returns an undefined value.

GET /admin/background_migrations — every migration, newest first.



20
21
22
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 20

def index
  @migrations = migration_model.order(created_at: :desc)
end

#pause ⇒ void

This method returns an undefined value.

POST /admin/background_migrations/:id/pause — pauses the migration.



32
33
34
35
36
37
38
39
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 32

def pause
  if @migration.pause
    flash[:success] = 'Migration has been paused'
  else
    flash[:warning] = "Cannot pause migration in '#{@migration.status}' status"
  end
  redirect_to admin_background_migration_path(@migration)
end

#resume ⇒ void

This method returns an undefined value.

POST /admin/background_migrations/:id/resume — resumes a paused migration.



44
45
46
47
48
49
50
51
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 44

def resume
  if @migration.resume
    flash[:success] = 'Migration has been resumed'
  else
    flash[:warning] = "Cannot resume migration in '#{@migration.status}' status"
  end
  redirect_to admin_background_migration_path(@migration)
end

#show ⇒ void

This method returns an undefined value.

GET /admin/background_migrations/:id — a single migration's detail page.



27
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 27

def show; end

#trigger_scheduler ⇒ void

This method returns an undefined value.

POST /admin/background_migrations/trigger_scheduler — manually enqueues
OnlineMigrationsSchedulerWorker instead of waiting for its cron tick.



84
85
86
87
88
 
# File 'app/controllers/admin/background_migrations_controller.rb', line 84

def trigger_scheduler
  OnlineMigrationsSchedulerWorker.perform_async
  flash[:success] = 'Background migration scheduler has been triggered'
  redirect_to admin_background_migrations_path
end