rest.go

/*
 * Flow Emulator
 *
 * Copyright 2019 Dapper Labs, Inc.
 *
 * 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 access

import (
	"context"
	"flag"
	"fmt"
	"github.com/onflow/flow-go/engine/access/state_stream"
	"github.com/onflow/flow-go/engine/access/state_stream/backend"
	"net"
	"net/http"
	"os"

	"github.com/prometheus/client_golang/prometheus"
	"github.com/rs/zerolog"

	"github.com/onflow/flow-go/engine/access/rest"
	"github.com/onflow/flow-go/engine/access/rest/routes"
	"github.com/onflow/flow-go/model/flow"
	"github.com/onflow/flow-go/module"
	"github.com/onflow/flow-go/module/metrics"

	"github.com/onflow/flow-emulator/adapters"
)

type RestServer struct {
	logger   *zerolog.Logger
	host     string
	port     int
	server   *http.Server
	listener net.Listener
}

func (r *RestServer) Listen() error {
	l, err := net.Listen("tcp", fmt.Sprintf("%s:%d", r.host, r.port))
	if err != nil {
		return err
	}
	r.listener = l
	return nil
}

func (r *RestServer) Start() error {
	if r.listener == nil {
		if err := r.Listen(); err != nil {
			return err
		}
	}

	r.logger.Info().
		Int("port", r.port).
		Msgf("✅  Started REST API server on port %d", r.port)

	err := r.server.Serve(r.listener)
	if err != nil {
		return err
	}
	return nil
}

func (r *RestServer) Stop() {
	_ = r.server.Shutdown(context.Background())
}

func NewRestServer(logger *zerolog.Logger, adapter *adapters.AccessAdapter, chain flow.Chain, host string, port int, debug bool) (*RestServer, error) {

	debugLogger := zerolog.Logger{}
	if debug {
		debugLogger = zerolog.New(os.Stdout)
	}
	var restCollector module.RestMetrics = metrics.NewNoopCollector()

	// only collect metrics if not test
	if flag.Lookup("test.v") == nil {
		var err error
		restCollector, err = metrics.NewRestCollector(routes.URLToRoute, prometheus.DefaultRegisterer)
		if err != nil {
			return nil, err
		}
	}

	srv, err := rest.NewServer(
		adapter,
		rest.Config{
			ListenAddress: fmt.Sprintf("%s:3333", host),
			WriteTimeout:  rest.DefaultWriteTimeout,
			ReadTimeout:   rest.DefaultReadTimeout,
			IdleTimeout:   rest.DefaultIdleTimeout,
		},
		debugLogger,
		chain,
		restCollector,
		nil,
		backend.Config{
			EventFilterConfig:    state_stream.DefaultEventFilterConfig,
			ClientSendTimeout:    state_stream.DefaultSendTimeout,
			ClientSendBufferSize: state_stream.DefaultSendBufferSize,
			MaxGlobalStreams:     state_stream.DefaultMaxGlobalStreams,
			HeartbeatInterval:    state_stream.DefaultHeartbeatInterval,
		},
	)

	if err != nil {
		return nil, err
	}

	return &RestServer{
		logger: logger,
		host:   host,
		port:   port,
		server: srv,
	}, nil
}