gitlab-org--gitlab-foss/app/helpers/learn_gitlab_helper.rb

108 lines
3.0 KiB
Ruby

# frozen_string_literal: true
module LearnGitlabHelper
IMAGE_PATH_PLAN = "learn_gitlab/section_plan.svg"
IMAGE_PATH_DEPLOY = "learn_gitlab/section_deploy.svg"
IMAGE_PATH_WORKSPACE = "learn_gitlab/section_workspace.svg"
LICENSE_SCANNING_RUN_URL = 'https://docs.gitlab.com/ee/user/compliance/license_compliance/index.html'
def learn_gitlab_enabled?(project)
return false unless current_user
learn_gitlab_onboarding_available?(project)
end
def learn_gitlab_data(project)
{
actions: onboarding_actions_data(project).to_json,
sections: onboarding_sections_data.to_json,
project: onboarding_project_data(project).to_json
}
end
def learn_gitlab_onboarding_available?(project)
Onboarding::Progress.onboarding?(project.namespace) &&
Onboarding::LearnGitlab.new(current_user).available?
end
private
def onboarding_actions_data(project)
attributes = onboarding_progress(project).attributes.symbolize_keys
action_urls(project).to_h do |action, url|
[
action,
{
url: url,
completed: attributes[Onboarding::Progress.column_name(action)].present?,
svg: image_path("learn_gitlab/#{action}.svg"),
enabled: true
}
]
end
end
def onboarding_sections_data
{
workspace: {
svg: image_path(IMAGE_PATH_WORKSPACE)
},
plan: {
svg: image_path(IMAGE_PATH_PLAN)
},
deploy: {
svg: image_path(IMAGE_PATH_DEPLOY)
}
}
end
def onboarding_project_data(project)
{ name: project.name }
end
def action_urls(project)
action_issue_urls.merge(
issue_created: project_issues_path(project),
git_write: project_path(project),
merge_request_created: project_merge_requests_path(project),
user_added: project_members_url(project),
**deploy_section_action_urls(project)
)
end
def action_issue_urls
Onboarding::Completion::ACTION_ISSUE_IDS.transform_values do |id|
project_issue_url(learn_gitlab_project, id)
end
end
def deploy_section_action_urls(project)
experiment(
:security_actions_continuous_onboarding,
namespace: project.namespace,
user: current_user,
sticky_to: current_user
) do |e|
e.control { { security_scan_enabled: project_security_configuration_path(project) } }
e.candidate do
{
license_scanning_run: LICENSE_SCANNING_RUN_URL,
secure_dependency_scanning_run: project_security_configuration_path(project, anchor: 'dependency-scanning'),
secure_dast_run: project_security_configuration_path(project, anchor: 'dast')
}
end
end.run
end
def learn_gitlab_project
@learn_gitlab_project ||= Onboarding::LearnGitlab.new(current_user).project
end
def onboarding_progress(project)
Onboarding::Progress.find_by(namespace: project.namespace) # rubocop: disable CodeReuse/ActiveRecord
end
end
LearnGitlabHelper.prepend_mod_with('LearnGitlabHelper')