sonarqube/server/sonar-web/src/main/js/components/tutorials/TutorialSelectionRenderer.tsx

/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

import {
  Breadcrumbs,
  FlagMessage,
  GreyCard,
  HoverLink,
  LightLabel,
  LightPrimary,
  StandoutLink,
  SubTitle,
  Title,
} from 'design-system';
import * as React from 'react';
import { AnalysisStatus } from '../../apps/overview/components/AnalysisStatus';
import { isMainBranch } from '../../helpers/branch-like';
import { translate } from '../../helpers/l10n';
import { getBaseUrl } from '../../helpers/system';
import { getProjectTutorialLocation } from '../../helpers/urls';
import { useBranchesQuery } from '../../queries/branch';
import { AlmKeys, AlmSettingsInstance, ProjectAlmBindingResponse } from '../../types/alm-settings';
import { MainBranch } from '../../types/branch-like';
import { Component } from '../../types/types';
import { LoggedInUser } from '../../types/users';
import AzurePipelinesTutorial from './azure-pipelines/AzurePipelinesTutorial';
import BitbucketPipelinesTutorial from './bitbucket-pipelines/BitbucketPipelinesTutorial';
import GitHubActionTutorial from './github-action/GitHubActionTutorial';
import GitLabCITutorial from './gitlabci/GitLabCITutorial';
import JenkinsTutorial from './jenkins/JenkinsTutorial';
import OtherTutorial from './other/OtherTutorial';
import { TutorialModes } from './types';

const DEFAULT_MAIN_BRANCH_NAME = 'main';

export interface TutorialSelectionRendererProps {
  almBinding?: AlmSettingsInstance;
  baseUrl: string;
  component: Component;
  currentUser: LoggedInUser;
  currentUserCanScanProject: boolean;
  loading: boolean;
  projectBinding?: ProjectAlmBindingResponse;
  selectedTutorial?: TutorialModes;
  willRefreshAutomatically?: boolean;
}

function renderAlm(mode: TutorialModes, project: string, icon?: React.ReactNode) {
  return (
    <GreyCard className="sw-col-span-4 sw-p-4">
      <StandoutLink icon={icon} to={getProjectTutorialLocation(project, mode)}>
        {translate('onboarding.tutorial.choose_method', mode)}
      </StandoutLink>

      {mode === TutorialModes.Local && (
        <LightLabel as="p" className="sw-mt-3">
          {translate('onboarding.mode.help.manual')}
        </LightLabel>
      )}

      {mode === TutorialModes.OtherCI && (
        <LightLabel as="p" className="sw-mt-3">
          {translate('onboarding.mode.help.otherci')}
        </LightLabel>
      )}
    </GreyCard>
  );
}

export default function TutorialSelectionRenderer(props: TutorialSelectionRendererProps) {
  const {
    almBinding,
    baseUrl,
    component,
    currentUser,
    currentUserCanScanProject,
    loading,
    projectBinding,
    selectedTutorial,
    willRefreshAutomatically,
  } = props;

  const { data: { branchLikes } = { branchLikes: [] } } = useBranchesQuery(component);

  const mainBranchName =
    (branchLikes.find((b) => isMainBranch(b)) as MainBranch | undefined)?.name ||
    DEFAULT_MAIN_BRANCH_NAME;

  if (loading) {
    return <i aria-label={translate('loading')} className="spinner" />;
  }

  if (!currentUserCanScanProject) {
    return (
      <FlagMessage className="sw-w-full" variant="warning">
        {translate('onboarding.tutorial.no_scan_rights')}
      </FlagMessage>
    );
  }

  let showGitHubActions = true;
  let showGitLabCICD = true;
  let showBitbucketPipelines = true;
  let showAzurePipelines = true;
  let showJenkins = true;

  if (projectBinding != null) {
    showGitHubActions = projectBinding.alm === AlmKeys.GitHub;
    showGitLabCICD = projectBinding.alm === AlmKeys.GitLab;
    showBitbucketPipelines = projectBinding.alm === AlmKeys.BitbucketCloud;
    showAzurePipelines = [AlmKeys.Azure, AlmKeys.GitHub].includes(projectBinding.alm);

    showJenkins = [
      AlmKeys.BitbucketCloud,
      AlmKeys.BitbucketServer,
      AlmKeys.GitHub,
      AlmKeys.GitLab,
    ].includes(projectBinding.alm);
  }

  return (
    <div className="sw-body-sm">
      <AnalysisStatus component={component} className="sw-mb-4 sw-w-max" />

      {selectedTutorial === undefined && (
        <div className="sw-flex sw-flex-col">
          <Title className="sw-mb-6 sw-heading-lg">
            {translate('onboarding.tutorial.page.title')}
          </Title>

          <LightPrimary>{translate('onboarding.tutorial.page.description')}</LightPrimary>

          <SubTitle className="sw-mt-12 sw-mb-4 sw-heading-md">
            {translate('onboarding.tutorial.choose_method')}
          </SubTitle>

          <div className="it__tutorial-selection sw-grid sw-gap-6 sw-grid-cols-12">
            {showJenkins &&
              renderAlm(
                TutorialModes.Jenkins,
                component.key,
                <img
                  alt="" // Should be ignored by screen readers
                  className="sw-h-4 sw-w-4"
                  src={`${getBaseUrl()}/images/tutorials/jenkins.svg`}
                />,
              )}

            {showGitHubActions &&
              renderAlm(
                TutorialModes.GitHubActions,
                component.key,
                <img
                  alt="" // Should be ignored by screen readers
                  className="sw-h-4 sw-w-4"
                  src={`${getBaseUrl()}/images/tutorials/github-actions.svg`}
                />,
              )}

            {showBitbucketPipelines &&
              renderAlm(
                TutorialModes.BitbucketPipelines,
                component.key,
                <img
                  alt="" // Should be ignored by screen readers
                  className="sw-h-4 sw-w-4"
                  src={`${getBaseUrl()}/images/alm/bitbucket.svg`}
                />,
              )}

            {showGitLabCICD &&
              renderAlm(
                TutorialModes.GitLabCI,
                component.key,
                <img
                  alt="" // Should be ignored by screen readers
                  className="sw-h-4 sw-w-4"
                  src={`${getBaseUrl()}/images/alm/gitlab.svg`}
                />,
              )}

            {showAzurePipelines &&
              renderAlm(
                TutorialModes.AzurePipelines,
                component.key,
                <img
                  alt="" // Should be ignored by screen readers
                  className="sw-h-4 sw-w-4"
                  src={`${getBaseUrl()}/images/tutorials/azure-pipelines.svg`}
                />,
              )}

            {renderAlm(TutorialModes.OtherCI, component.key)}

            {renderAlm(TutorialModes.Local, component.key)}
          </div>
        </div>
      )}

      {selectedTutorial && (
        <Breadcrumbs className="sw-mb-3">
          <HoverLink to={getProjectTutorialLocation(component.key)}>
            {translate('onboarding.tutorial.breadcrumbs.home')}
          </HoverLink>

          <HoverLink to={getProjectTutorialLocation(component.key, selectedTutorial)}>
            {translate('onboarding.tutorial.breadcrumbs', selectedTutorial)}
          </HoverLink>
        </Breadcrumbs>
      )}

      {selectedTutorial === TutorialModes.Local && (
        <OtherTutorial component={component} baseUrl={baseUrl} isLocal currentUser={currentUser} />
      )}

      {selectedTutorial === TutorialModes.OtherCI && (
        <OtherTutorial component={component} baseUrl={baseUrl} currentUser={currentUser} />
      )}

      {selectedTutorial === TutorialModes.BitbucketPipelines && (
        <BitbucketPipelinesTutorial
          almBinding={almBinding}
          baseUrl={baseUrl}
          component={component}
          currentUser={currentUser}
          mainBranchName={mainBranchName}
          willRefreshAutomatically={willRefreshAutomatically}
        />
      )}

      {selectedTutorial === TutorialModes.GitHubActions && (
        <GitHubActionTutorial
          almBinding={almBinding}
          baseUrl={baseUrl}
          component={component}
          currentUser={currentUser}
          mainBranchName={mainBranchName}
          willRefreshAutomatically={willRefreshAutomatically}
        />
      )}

      {selectedTutorial === TutorialModes.Jenkins && (
        <JenkinsTutorial
          almBinding={almBinding}
          baseUrl={baseUrl}
          component={component}
          willRefreshAutomatically={willRefreshAutomatically}
        />
      )}

      {selectedTutorial === TutorialModes.GitLabCI && (
        <GitLabCITutorial
          baseUrl={baseUrl}
          component={component}
          currentUser={currentUser}
          willRefreshAutomatically={willRefreshAutomatically}
        />
      )}

      {selectedTutorial === TutorialModes.AzurePipelines && (
        <AzurePipelinesTutorial
          alm={projectBinding?.alm}
          baseUrl={baseUrl}
          component={component}
          currentUser={currentUser}
          willRefreshAutomatically={willRefreshAutomatically}
        />
      )}
    </div>
  );
}