retry.go

// Copyright 2023 The Authors (see AUTHORS file)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cli

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

	"google.golang.org/api/option"

	"github.com/abcxyz/github-metrics-aggregator/pkg/retry"
	"github.com/abcxyz/github-metrics-aggregator/pkg/version"
	"github.com/abcxyz/pkg/cli"
	"github.com/abcxyz/pkg/logging"
	"github.com/abcxyz/pkg/serving"
)

var _ cli.Command = (*RetryServerCommand)(nil)

type RetryServerCommand struct {
	cli.BaseCommand

	cfg *retry.Config

	// testFlagSetOpts is only used for testing.
	testFlagSetOpts []cli.Option

	// testDatastore is only used for testing
	testDatastore retry.Datastore

	// testGCSLockClientOptions is only used for testing
	testGCSLockClientOptions []option.ClientOption

	// testGitHub is only used for testing
	testGitHub retry.GitHubSource
}

func (c *RetryServerCommand) Desc() string {
	return `Start a retry server for GitHub Metrics Aggregator`
}

func (c *RetryServerCommand) Help() string {
	return `
Usage: {{ COMMAND }} [options]
  Start a retry server for GitHub Metrics Aggregator.
`
}

func (c *RetryServerCommand) Flags() *cli.FlagSet {
	c.cfg = &retry.Config{}
	set := cli.NewFlagSet(c.testFlagSetOpts...)
	return c.cfg.ToFlags(set)
}

func (c *RetryServerCommand) Run(ctx context.Context, args []string) error {
	server, mux, err := c.RunUnstarted(ctx, args)
	if err != nil {
		return err
	}

	return server.StartHTTPHandler(ctx, mux)
}

func (c *RetryServerCommand) RunUnstarted(ctx context.Context, args []string) (*serving.Server, http.Handler, error) {
	f := c.Flags()
	if err := f.Parse(args); err != nil {
		return nil, nil, fmt.Errorf("failed to parse flags: %w", err)
	}
	args = f.Args()
	if len(args) > 0 {
		return nil, nil, fmt.Errorf("unexpected arguments: %q", args)
	}

	logger := logging.FromContext(ctx)
	logger.DebugContext(ctx, "server starting",
		"name", version.Name,
		"commit", version.Commit,
		"version", version.Version)

	if err := c.cfg.Validate(); err != nil {
		return nil, nil, fmt.Errorf("invalid configuration: %w", err)
	}
	logger.DebugContext(ctx, "loaded configuration", "config", c.cfg)

	retryClientOptions := &retry.RetryClientOptions{}

	if c.testDatastore != nil {
		retryClientOptions.DatastoreClientOverride = c.testDatastore
	}

	if c.testGCSLockClientOptions != nil {
		retryClientOptions.GCSLockClientOpts = c.testGCSLockClientOptions
	}

	if c.testGitHub != nil {
		retryClientOptions.GitHubOverride = c.testGitHub
	}

	retryServer, err := retry.NewServer(ctx, c.cfg, retryClientOptions)
	if err != nil {
		return nil, nil, fmt.Errorf("failed to create server: %w", err)
	}

	mux := retryServer.Routes(ctx)

	server, err := serving.New(c.cfg.Port)
	if err != nil {
		return nil, nil, fmt.Errorf("failed to create serving infrastructure: %w", err)
	}

	return server, mux, nil
}