org.sonar.server.webhook.ws.WebhookDeliveriesAction Maven / Gradle / Ivy

Go to download
/*
 * SonarQube
 * Copyright (C) 2009-2018 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.webhook.ws;

import com.google.common.io.Resources;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.web.UserRole;
import org.sonar.core.util.Uuids;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.webhook.WebhookDeliveryLiteDto;
import org.sonar.server.component.ComponentFinder;
import org.sonar.server.user.UserSession;
import org.sonarqube.ws.Common;
import org.sonarqube.ws.Webhooks;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;
import static org.apache.commons.lang.StringUtils.isNotBlank;
import static org.sonar.api.server.ws.WebService.Param.PAGE;
import static org.sonar.api.server.ws.WebService.Param.PAGE_SIZE;
import static org.sonar.api.utils.Paging.offset;
import static org.sonar.core.util.Uuids.UUID_EXAMPLE_02;
import static org.sonar.server.es.SearchOptions.MAX_LIMIT;
import static org.sonar.server.webhook.ws.WebhookWsSupport.copyDtoToProtobuf;
import static org.sonar.server.ws.WsUtils.writeProtobuf;

public class WebhookDeliveriesAction implements WebhooksWsAction {

  private static final String PARAM_COMPONENT = "componentKey";
  private static final String PARAM_TASK = "ceTaskId";
  private static final String PARAM_WEBHOOK = "webhook";

  private final DbClient dbClient;
  private final UserSession userSession;
  private final ComponentFinder componentFinder;

  public WebhookDeliveriesAction(DbClient dbClient, UserSession userSession, ComponentFinder componentFinder) {
    this.dbClient = dbClient;
    this.userSession = userSession;
    this.componentFinder = componentFinder;
  }

  @Override
  public void define(WebService.NewController controller) {
    WebService.NewAction action = controller.createAction("deliveries")
      .setSince("6.2")
      .setDescription("Get the recent deliveries for a specified project or Compute Engine task.
" +
        "Require 'Administer' permission on the related project.
" +
        "Note that additional information are returned by api/webhooks/delivery.")
      .setResponseExample(Resources.getResource(this.getClass(), "example-deliveries.json"))
      .setHandler(this);

    action.createParam(PARAM_COMPONENT)
      .setDescription("Key of the project")
      .setExampleValue("my-project");

    action.createParam(PARAM_TASK)
      .setDescription("Id of the Compute Engine task")
      .setExampleValue(Uuids.UUID_EXAMPLE_01);

    action.createParam(PARAM_WEBHOOK)
      .setSince("7.1")
      .setDescription("Key of the webhook that triggered those deliveries," +
        "auto-generated value that can be obtained through api/webhooks/create or api/webhooks/list")
      .setExampleValue(UUID_EXAMPLE_02);

    action.addPagingParamsSince(10, MAX_LIMIT, "7.1");
  }

  @Override
  public void handle(Request request, Response response) throws Exception {
    // fail-fast if not logged in
    userSession.checkLoggedIn();

    String ceTaskId = request.param(PARAM_TASK);
    String componentKey = request.param(PARAM_COMPONENT);
    String webhookUuid = request.param(PARAM_WEBHOOK);
    int page = request.mandatoryParamAsInt(PAGE);
    int pageSize = request.mandatoryParamAsInt(PAGE_SIZE);

    checkArgument(webhookUuid != null ^ (ceTaskId != null ^ componentKey != null),
      "Either '%s' or '%s' or '%s' must be provided", PARAM_TASK, PARAM_COMPONENT, PARAM_WEBHOOK);

    Data data = loadFromDatabase(webhookUuid, ceTaskId, componentKey, page, pageSize);
    data.ensureAdminPermission(userSession);
    data.writeTo(request, response);
  }

  private Data loadFromDatabase(@Nullable String webhookUuid, @Nullable String ceTaskId, @Nullable String componentKey, int page, int pageSize) {
    ComponentDto component;
    List deliveries;
    int totalElements;
    try (DbSession dbSession = dbClient.openSession(false)) {
      if (isNotBlank(webhookUuid)) {
        totalElements = dbClient.webhookDeliveryDao().countDeliveriesByWebhookUuid(dbSession, webhookUuid);
        deliveries = dbClient.webhookDeliveryDao().selectByWebhookUuid(dbSession, webhookUuid, offset(page, pageSize), pageSize);
        component = getComponentDto(dbSession, deliveries);
      } else if (componentKey != null) {
        component = componentFinder.getByKey(dbSession, componentKey);
        totalElements = dbClient.webhookDeliveryDao().countDeliveriesByComponentUuid(dbSession, component.uuid());
        deliveries = dbClient.webhookDeliveryDao().selectOrderedByComponentUuid(dbSession, component.uuid(), offset(page, pageSize), pageSize);
      } else {
        totalElements = dbClient.webhookDeliveryDao().countDeliveriesByCeTaskUuid(dbSession, ceTaskId);
        deliveries = dbClient.webhookDeliveryDao().selectOrderedByCeTaskUuid(dbSession, ceTaskId, offset(page, pageSize), pageSize);
        component = getComponentDto(dbSession, deliveries);
      }
    }
    return new Data(component, deliveries).withPagingInfo(page, pageSize, totalElements);
  }

  private ComponentDto getComponentDto(DbSession dbSession, List deliveries) {
    Optional deliveredComponentUuid = deliveries
      .stream()
      .map(WebhookDeliveryLiteDto::getComponentUuid)
      .findFirst();

    if (deliveredComponentUuid.isPresent()) {
      return componentFinder.getByUuid(dbSession, deliveredComponentUuid.get());
    } else {
      return null;
    }
  }

  private static class Data {
    private final ComponentDto component;
    private final List deliveryDtos;

    private int pageIndex;
    private int pageSize;
    private int totalElements;

    Data(@Nullable ComponentDto component, List deliveries) {
      this.deliveryDtos = deliveries;
      if (deliveries.isEmpty()) {
        this.component = null;
      } else {
        this.component = requireNonNull(component);
      }
    }

    void ensureAdminPermission(UserSession userSession) {
      if (component != null) {
        userSession.checkComponentPermission(UserRole.ADMIN, component);
      }
    }

    void writeTo(Request request, Response response) {
      Webhooks.DeliveriesWsResponse.Builder responseBuilder = Webhooks.DeliveriesWsResponse.newBuilder();
      Webhooks.Delivery.Builder deliveryBuilder = Webhooks.Delivery.newBuilder();
      for (WebhookDeliveryLiteDto dto : deliveryDtos) {
        copyDtoToProtobuf(component, dto, deliveryBuilder);
        responseBuilder.addDeliveries(deliveryBuilder);
      }

      responseBuilder.setPaging(buildPaging(pageIndex, pageSize, totalElements));
      writeProtobuf(responseBuilder.build(), request, response);
    }

    static Common.Paging buildPaging(int pageIndex, int pageSize, int totalElements) {
      return Common.Paging.newBuilder()
        .setPageIndex(pageIndex)
        .setPageSize(pageSize)
        .setTotal(totalElements)
        .build();
    }

    public Data withPagingInfo(int pageIndex, int pageSize, int totalElements) {
      this.pageIndex = pageIndex;
      this.pageSize = pageSize;
      this.totalElements = totalElements;
      return this;
    }
  }
}