All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.server.ce.ws.TaskFormatter Maven / Gradle / Ivy

There is a newer version: 7.2.1
Show newest version
/*
 * SonarQube
 * Copyright (C) 2009-2017 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.
 */
package org.sonar.server.ce.ws;

import com.google.common.collect.Multimap;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.utils.DateUtils;
import org.sonar.api.utils.System2;
import org.sonar.core.util.stream.MoreCollectors;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.ce.CeActivityDto;
import org.sonar.db.ce.CeQueueDto;
import org.sonar.db.ce.CeTaskCharacteristicDto;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.organization.OrganizationDto;
import org.sonarqube.ws.Common;
import org.sonarqube.ws.WsCe;

import static com.google.common.base.Preconditions.checkState;
import static java.lang.String.format;
import static java.util.Collections.singletonList;
import static org.sonar.api.utils.DateUtils.formatDateTime;
import static org.sonar.core.util.Protobuf.setNullable;

/**
 * Converts {@link CeActivityDto} and {@link CeQueueDto} to the protobuf objects
 * used to write WS responses (see ws-ce.proto in module sonar-ws)
 */
public class TaskFormatter {

  private final DbClient dbClient;
  private final System2 system2;

  public TaskFormatter(DbClient dbClient, System2 system2) {
    this.dbClient = dbClient;
    this.system2 = system2;
  }

  public List formatQueue(DbSession dbSession, List dtos) {
    DtoCache cache = DtoCache.forQueueDtos(dbClient, dbSession, dtos);
    return dtos.stream().map(input -> formatQueue(input, cache)).collect(MoreCollectors.toList(dtos.size()));
  }

  public WsCe.Task formatQueue(DbSession dbSession, CeQueueDto queue) {
    return formatQueue(queue, DtoCache.forQueueDtos(dbClient, dbSession, singletonList(queue)));
  }

  private WsCe.Task formatQueue(CeQueueDto dto, DtoCache componentDtoCache) {
    WsCe.Task.Builder builder = WsCe.Task.newBuilder();
    String organizationKey = componentDtoCache.getOrganizationKey(dto.getComponentUuid());
    // FIXME organization field should be set from the CeQueueDto rather than from the ComponentDto
    setNullable(organizationKey, builder::setOrganization);
    if (dto.getComponentUuid() != null) {
      builder.setComponentId(dto.getComponentUuid());
      setComponent(builder, dto.getComponentUuid(), componentDtoCache);
    }
    builder.setId(dto.getUuid());
    builder.setStatus(WsCe.TaskStatus.valueOf(dto.getStatus().name()));
    builder.setType(dto.getTaskType());
    builder.setLogs(false);
    setNullable(dto.getSubmitterLogin(), builder::setSubmitterLogin);
    builder.setSubmittedAt(formatDateTime(new Date(dto.getCreatedAt())));
    setNullable(dto.getStartedAt(), builder::setStartedAt, DateUtils::formatDateTime);
    setNullable(computeExecutionTimeMs(dto), builder::setExecutionTimeMs);
    setBranch(builder, dto.getUuid(), componentDtoCache);
    return builder.build();
  }

  public WsCe.Task formatActivity(DbSession dbSession, CeActivityDto dto, @Nullable String scannerContext) {
    return formatActivity(dto, DtoCache.forActivityDtos(dbClient, dbSession, singletonList(dto)), scannerContext);
  }

  public List formatActivity(DbSession dbSession, List dtos) {
    DtoCache cache = DtoCache.forActivityDtos(dbClient, dbSession, dtos);
    return dtos.stream()
      .map(input -> formatActivity(input, cache, null))
      .collect(MoreCollectors.toList(dtos.size()));
  }

  private static WsCe.Task formatActivity(CeActivityDto dto, DtoCache componentDtoCache, @Nullable String scannerContext) {
    WsCe.Task.Builder builder = WsCe.Task.newBuilder();
    String organizationKey = componentDtoCache.getOrganizationKey(dto.getComponentUuid());
    // FIXME organization field should be set from the CeActivityDto rather than from the ComponentDto
    setNullable(organizationKey, builder::setOrganization);
    builder.setId(dto.getUuid());
    builder.setStatus(WsCe.TaskStatus.valueOf(dto.getStatus().name()));
    builder.setType(dto.getTaskType());
    builder.setLogs(false);
    setNullable(dto.getComponentUuid(), uuid -> setComponent(builder, uuid, componentDtoCache).setComponentId(uuid));
    String analysisUuid = dto.getAnalysisUuid();
    if (analysisUuid != null) {
      builder.setAnalysisId(analysisUuid);
    }
    setBranch(builder, dto.getUuid(), componentDtoCache);
    setNullable(analysisUuid, builder::setAnalysisId);
    setNullable(dto.getSubmitterLogin(), builder::setSubmitterLogin);
    builder.setSubmittedAt(formatDateTime(new Date(dto.getSubmittedAt())));
    setNullable(dto.getStartedAt(), builder::setStartedAt, DateUtils::formatDateTime);
    setNullable(dto.getExecutedAt(), builder::setExecutedAt, DateUtils::formatDateTime);
    setNullable(dto.getExecutionTimeMs(), builder::setExecutionTimeMs);
    setNullable(dto.getErrorMessage(), builder::setErrorMessage);
    setNullable(dto.getErrorStacktrace(), builder::setErrorStacktrace);
    setNullable(dto.getErrorType(), builder::setErrorType);
    setNullable(scannerContext, builder::setScannerContext);
    builder.setHasScannerContext(dto.isHasScannerContext());
    return builder.build();
  }

  private static WsCe.Task.Builder setComponent(WsCe.Task.Builder builder, @Nullable String componentUuid, DtoCache componentDtoCache) {
    ComponentDto componentDto = componentDtoCache.getComponent(componentUuid);
    if (componentDto == null) {
      return builder;
    }
    builder.setComponentKey(componentDto.getKey());
    builder.setComponentName(componentDto.name());
    builder.setComponentQualifier(componentDto.qualifier());
    return builder;
  }

  private static WsCe.Task.Builder setBranch(WsCe.Task.Builder builder, String taskUuid, DtoCache componentDtoCache) {
    componentDtoCache.getBranchName(taskUuid).ifPresent(
      b -> {
        builder.setBranch(b);
        builder.setBranchType(componentDtoCache.getBranchType(taskUuid)
          .orElseThrow(() -> new IllegalStateException(format("Could not find branch type of task '%s'", taskUuid))));
      });
    return builder;
  }

  private static class DtoCache {
    private final Map componentsByUuid;
    private final Map organizationsByUuid;
    private final Multimap characteristicsByTaskUuid;

    private DtoCache(Map componentsByUuid, Map organizationsByUuid,
      Multimap characteristicsByTaskUuid) {
      this.componentsByUuid = componentsByUuid;
      this.organizationsByUuid = organizationsByUuid;
      this.characteristicsByTaskUuid = characteristicsByTaskUuid;
    }

    static DtoCache forQueueDtos(DbClient dbClient, DbSession dbSession, Collection ceQueueDtos) {
      Map componentsByUuid = dbClient.componentDao().selectByUuids(dbSession, uuidOfCeQueueDtos(ceQueueDtos))
        .stream()
        .collect(MoreCollectors.uniqueIndex(ComponentDto::uuid));
      Multimap characteristicsByTaskUuid = dbClient.ceTaskCharacteristicsDao()
        .selectByTaskUuids(dbSession, ceQueueDtos.stream().map(CeQueueDto::getUuid).collect(Collectors.toList()))
        .stream().collect(MoreCollectors.index(CeTaskCharacteristicDto::getTaskUuid));
      return new DtoCache(componentsByUuid, buildOrganizationsByUuid(dbClient, dbSession, componentsByUuid), characteristicsByTaskUuid);
    }

    private static Set uuidOfCeQueueDtos(Collection ceQueueDtos) {
      return ceQueueDtos.stream()
        .filter(Objects::nonNull)
        .map(CeQueueDto::getComponentUuid)
        .filter(Objects::nonNull)
        .collect(MoreCollectors.toSet(ceQueueDtos.size()));
    }

    static DtoCache forActivityDtos(DbClient dbClient, DbSession dbSession, Collection ceActivityDtos) {
      Map componentsByUuid = dbClient.componentDao().selectByUuids(
        dbSession,
        uuidOfCeActivityDtos(ceActivityDtos))
        .stream()
        .collect(MoreCollectors.uniqueIndex(ComponentDto::uuid));
      Multimap characteristicsByTaskUuid = dbClient.ceTaskCharacteristicsDao()
        .selectByTaskUuids(dbSession, ceActivityDtos.stream().map(CeActivityDto::getUuid).collect(Collectors.toList()))
        .stream().collect(MoreCollectors.index(CeTaskCharacteristicDto::getTaskUuid));
      return new DtoCache(componentsByUuid, buildOrganizationsByUuid(dbClient, dbSession, componentsByUuid), characteristicsByTaskUuid);
    }

    private static Set uuidOfCeActivityDtos(Collection ceActivityDtos) {
      return ceActivityDtos.stream()
        .filter(Objects::nonNull)
        .map(CeActivityDto::getComponentUuid)
        .filter(Objects::nonNull)
        .collect(MoreCollectors.toSet(ceActivityDtos.size()));
    }

    private static Map buildOrganizationsByUuid(DbClient dbClient, DbSession dbSession, Map componentsByUuid) {
      return dbClient.organizationDao().selectByUuids(
        dbSession,
        componentsByUuid.values().stream()
          .map(ComponentDto::getOrganizationUuid)
          .collect(MoreCollectors.toSet(componentsByUuid.size())))
        .stream()
        .collect(MoreCollectors.uniqueIndex(OrganizationDto::getUuid));
    }

    @CheckForNull
    ComponentDto getComponent(@Nullable String uuid) {
      if (uuid == null) {
        return null;
      }
      return componentsByUuid.get(uuid);
    }

    @CheckForNull
    String getOrganizationKey(@Nullable String componentUuid) {
      if (componentUuid == null) {
        return null;
      }
      ComponentDto componentDto = componentsByUuid.get(componentUuid);
      if (componentDto == null) {
        return null;
      }
      String organizationUuid = componentDto.getOrganizationUuid();
      OrganizationDto organizationDto = organizationsByUuid.get(organizationUuid);
      checkState(organizationDto != null, "Organization with uuid '%s' not found", organizationUuid);
      return organizationDto.getKey();
    }

    Optional getBranchName(String taskUuid) {
      return characteristicsByTaskUuid.get(taskUuid).stream()
        .filter(c -> c.getKey().equals(CeTaskCharacteristicDto.BRANCH_KEY))
        .map(CeTaskCharacteristicDto::getValue)
        .findAny();
    }

    Optional getBranchType(String taskUuid) {
      return characteristicsByTaskUuid.get(taskUuid).stream()
        .filter(c -> c.getKey().equals(CeTaskCharacteristicDto.BRANCH_TYPE_KEY))
        .map(c -> Common.BranchType.valueOf(c.getValue()))
        .findAny();
    }
  }

  /**
   * now - startedAt
   */
  @CheckForNull
  private Long computeExecutionTimeMs(CeQueueDto dto) {
    Long startedAt = dto.getStartedAt();
    if (startedAt == null) {
      return null;
    }
    return system2.now() - startedAt;
  }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy