Module: Users::CalloutsHelper

Defined in:
app/helpers/users/callouts_helper.rb

Constant Summary collapse

GKE_CLUSTER_INTEGRATION = 
'gke_cluster_integration'
GCP_SIGNUP_OFFER = 
'gcp_signup_offer'
SUGGEST_POPOVER_DISMISSED = 
'suggest_popover_dismissed'
TABS_POSITION_HIGHLIGHT = 
'tabs_position_highlight'
FEATURE_FLAGS_NEW_VERSION = 
'feature_flags_new_version'
OPENSSL_CALLOUT = 
'openssl_callout'
UNFINISHED_TAG_CLEANUP_CALLOUT = 
'unfinished_tag_cleanup_callout'
SECURITY_NEWSLETTER_CALLOUT = 
'security_newsletter_callout'
PAGES_MOVED_CALLOUT = 
'pages_moved_callout'
REGISTRATION_ENABLED_CALLOUT_ALLOWED_CONTROLLER_PATHS = 
[/^root/, /^dashboard\S*/, /^admin\S*/].freeze
WEB_HOOK_DISABLED = 
'web_hook_disabled'
BRANCH_RULES_INFO_CALLOUT = 
'branch_rules_info_callout'
BRANCH_RULES_TIP_CALLOUT = 
'branch_rules_tip_callout'
TRANSITION_TO_JIHU_CALLOUT = 
'transition_to_jihu_callout'
PERIOD_IN_TERRAFORM_STATE_NAME_ALERT = 
'period_in_terraform_state_name_alert'
NEW_MR_DASHBOARD_BANNER = 
'new_mr_dashboard_banner'
PRODUCT_USAGE_DATA_COLLECTION_CHANGES = 
'product_usage_data_collection_changes'
EMAIL_OTP_ENROLLMENT_CALLOUT = 
'email_otp_enrollment_callout'

Instance Method Summary collapse

Instance Method Details

#dismiss_two_factor_auth_recovery_settings_check ⇒ Object 



74
 
# File 'app/helpers/users/callouts_helper.rb', line 74

def dismiss_two_factor_auth_recovery_settings_check; end

#render_dashboard_ultimate_trial(user) ⇒ Object 



42
 
# File 'app/helpers/users/callouts_helper.rb', line 42

def render_dashboard_ultimate_trial(user); end

#render_product_usage_data_collection_changes(current_user) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'app/helpers/users/callouts_helper.rb', line 24

def render_product_usage_data_collection_changes(current_user)
  return unless current_user &&
    current_user.can_admin_all_resources? &&
    !user_dismissed?(PRODUCT_USAGE_DATA_COLLECTION_CHANGES)

  render 'shared/product_usage_data_collection_changes_callout'
end

#render_two_factor_auth_recovery_settings_check ⇒ Object 



44
 
# File 'app/helpers/users/callouts_helper.rb', line 44

def render_two_factor_auth_recovery_settings_check; end

#show_branch_rules_info? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
 
# File 'app/helpers/users/callouts_helper.rb', line 87

def show_branch_rules_info?
  !user_dismissed?(BRANCH_RULES_INFO_CALLOUT)
end

#show_branch_rules_tip? ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'app/helpers/users/callouts_helper.rb', line 91

def show_branch_rules_tip?
  !user_dismissed?(BRANCH_RULES_TIP_CALLOUT)
end

#show_email_otp_enrollment_callout? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
113
114
115
116
117
118
119
120
 
# File 'app/helpers/users/callouts_helper.rb', line 110

def show_email_otp_enrollment_callout?
  return false unless current_user
  return false unless Feature.enabled?(:email_based_mfa, current_user)
  return false if user_dismissed?(EMAIL_OTP_ENROLLMENT_CALLOUT)
  return false unless current_user.email_otp_required_after.present?
  # Only show for users who can log in with a password and don't have 2FA
  return false if current_user.password_automatically_set? || current_user.two_factor_enabled?

  days_until_enrollment = (current_user.email_otp_required_after.to_date - Date.current).to_i
  days_until_enrollment.between?(8, 14)
end

#show_feature_flags_new_version? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'app/helpers/users/callouts_helper.rb', line 50

def show_feature_flags_new_version?
  !user_dismissed?(FEATURE_FLAGS_NEW_VERSION)
end

#show_gcp_signup_offer? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'app/helpers/users/callouts_helper.rb', line 38

def 
  !user_dismissed?(GCP_SIGNUP_OFFER)
end

#show_gke_cluster_integration_callout?(project) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
36
 
# File 'app/helpers/users/callouts_helper.rb', line 32

def show_gke_cluster_integration_callout?(project)
  active_nav_link?(controller: sidebar_operations_paths) &&
    can?(current_user, :create_cluster, project) &&
    !user_dismissed?(GKE_CLUSTER_INTEGRATION)
end

#show_new_mr_dashboard_banner? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'app/helpers/users/callouts_helper.rb', line 106

def show_new_mr_dashboard_banner?
  !user_dismissed?(NEW_MR_DASHBOARD_BANNER)
end

#show_openssl_callout? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
68
69
70
71
72
 
# File 'app/helpers/users/callouts_helper.rb', line 65

def show_openssl_callout?
  return false unless Gitlab.version_info >= Gitlab::VersionInfo.new(17, 1) &&
    Gitlab.version_info < Gitlab::VersionInfo.new(17, 7)

  current_user&.can_admin_all_resources? &&
    !user_dismissed?(OPENSSL_CALLOUT) &&
    controller.controller_path.match?(%r{^admin(/\S*)?$})
end

#show_period_in_terraform_state_name_alert_callout? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'app/helpers/users/callouts_helper.rb', line 102

def show_period_in_terraform_state_name_alert_callout?
  !user_dismissed?(PERIOD_IN_TERRAFORM_STATE_NAME_ALERT)
end

#show_registration_enabled_user_callout? ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
61
62
63
 
# File 'app/helpers/users/callouts_helper.rb', line 58

def show_registration_enabled_user_callout?
  !Gitlab.com? &&
    current_user&.can_admin_all_resources? &&
     &&
    REGISTRATION_ENABLED_CALLOUT_ALLOWED_CONTROLLER_PATHS.any? { |path| controller.controller_path.match?(path) }
end

#show_security_newsletter_user_callout? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
79
 
# File 'app/helpers/users/callouts_helper.rb', line 76

def show_security_newsletter_user_callout?
  current_user&.can_admin_all_resources? &&
    !user_dismissed?(SECURITY_NEWSLETTER_CALLOUT)
end

#show_suggest_popover? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'app/helpers/users/callouts_helper.rb', line 46

def show_suggest_popover?
  !user_dismissed?(SUGGEST_POPOVER_DISMISSED)
end

#show_transition_to_jihu_callout? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
98
99
100
 
# File 'app/helpers/users/callouts_helper.rb', line 95

def show_transition_to_jihu_callout?
  !Gitlab.jh? &&
    current_user&.can_admin_all_resources? &&
    %w[Asia/Hong_Kong Asia/Shanghai Asia/Macau Asia/Chongqing].include?(current_user.timezone) &&
    !user_dismissed?(TRANSITION_TO_JIHU_CALLOUT)
end

#show_unfinished_tag_cleanup_callout? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'app/helpers/users/callouts_helper.rb', line 54

def show_unfinished_tag_cleanup_callout?
  !user_dismissed?(UNFINISHED_TAG_CLEANUP_CALLOUT)
end

#web_hook_disabled_dismissed?(object) ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
84
85
 
# File 'app/helpers/users/callouts_helper.rb', line 81

def web_hook_disabled_dismissed?(object)
  return false unless object.is_a?(::WebHooks::HasWebHooks)

  user_dismissed?(WEB_HOOK_DISABLED, object.last_webhook_failure, object: object)
end