github.com/massongit/reviewdog@v0.0.0-20240331071725-4a16675475a8/service/bitbucket/cloud_api_client.go

package bitbucket

import (
	"context"
	"fmt"
	"io"
	"net/http"
	"net/url"

	bbapi "github.com/reviewdog/go-bitbucket"
)

const (
	// PipelineProxyURL available while using Bitbucket Pipelines and
	// allows you to use the Reports-API without extra authentication.
	// For that you need to send your request through a proxy server that runs alongside with
	// every pipeline on ‘localhost:29418’, and a valid Auth-Header will automatically be added to your request.
	// https://support.atlassian.com/bitbucket-cloud/docs/code-insights/#Authentication
	// However, if using proxy HTTP API endpoint need to be used
	pipelineProxyURL = "http://localhost:29418"

	// PipeProxyURL is to be used when reviewdog is running within a Bitbucket Pipe
	// Pipes run in docker containers and as a result will need to connect to the proxy via this Docker DNS.
	pipeProxyURL = "http://host.docker.internal:29418"
)

// CloudAPIClient is wrapper for Bitbucket Cloud Code Insights API client
type CloudAPIClient struct {
	cli    *bbapi.APIClient
	helper *CloudAPIHelper
}

// NewCloudAPIClient creates client for Bitbucket Cloud Insights API
func NewCloudAPIClient(isInPipeline bool, isInPipe bool) APIClient {
	httpClient := &http.Client{
		Timeout: httpTimeout,
	}

	server := bbapi.ServerConfiguration{
		URL:         "https://api.bitbucket.org/2.0",
		Description: `HTTPS API endpoint`,
	}

	if isInPipeline {
		var proxyURL *url.URL
		if isInPipe {
			// if we are executing a pipe within a pipeline, use docker endpoint
			// and proxy
			proxyURL, _ = url.Parse(pipeProxyURL)
		} else {
			// if we are on the Bitbucket Pipeline, use HTTP endpoint
			// and proxy
			proxyURL, _ = url.Parse(pipelineProxyURL)
		}

		httpClient.Transport = &http.Transport{
			Proxy: http.ProxyURL(proxyURL),
		}

		server = bbapi.ServerConfiguration{
			URL:         "http://api.bitbucket.org/2.0",
			Description: `If called from Bitbucket Pipelines, using HTTP API endpoint and AuthProxy`,
		}
	}

	return NewCloudAPIClientWithConfigurations(httpClient, server)
}

// NewCloudAPIClientWithConfigurations creates client for Bitbucket Cloud Insights API with specified configuration
func NewCloudAPIClientWithConfigurations(client *http.Client, server bbapi.ServerConfiguration) APIClient {
	config := bbapi.NewConfiguration()
	if client != nil {
		config.HTTPClient = client
	} else {
		config.HTTPClient = &http.Client{
			Timeout: httpTimeout,
		}
	}
	config.Servers = bbapi.ServerConfigurations{server}

	return &CloudAPIClient{
		cli:    bbapi.NewAPIClient(config),
		helper: &CloudAPIHelper{},
	}
}

// CreateOrUpdateReport creates or updates specified report
func (c *CloudAPIClient) CreateOrUpdateReport(ctx context.Context, req *ReportRequest) error {
	_, resp, err := c.cli.
		ReportsApi.CreateOrUpdateReport(ctx, req.Owner, req.Repository, req.Commit, req.ReportID).
		Body(c.helper.BuildReport(req)).
		Execute()

	if err := c.checkAPIError(err, resp, http.StatusOK); err != nil {
		return fmt.Errorf("failed to create code insights report: %w", err)
	}

	return nil
}

// CreateOrUpdateAnnotations creates or updates annotations
func (c *CloudAPIClient) CreateOrUpdateAnnotations(ctx context.Context, req *AnnotationsRequest) error {
	_, resp, err := c.cli.ReportsApi.
		BulkCreateOrUpdateAnnotations(ctx, req.Owner, req.Repository, req.Commit, req.ReportID).
		Body(c.helper.BuildAnnotations(req.Comments)).
		Execute()

	if err := c.checkAPIError(err, resp, http.StatusOK); err != nil {
		return fmt.Errorf("failed to create code insights annotations: %w", err)
	}

	return nil
}

func (c *CloudAPIClient) checkAPIError(err error, resp *http.Response, expectedCode int) error {
	if err != nil {
		return fmt.Errorf("bitbucket Cloud API error: %w", err)
	}

	if resp != nil && resp.StatusCode != expectedCode {
		body, _ := io.ReadAll(resp.Body)

		return UnexpectedResponseError{
			Code: resp.StatusCode,
			Body: body,
		}
	}

	return nil
}