evcc-io/tariff/octopus.go

package tariff

import (
	"errors"
	"fmt"
	"slices"
	"strings"
	"sync"
	"time"

	"github.com/cenkalti/backoff/v4"
	"github.com/evcc-io/evcc/api"
	octoGql "github.com/evcc-io/evcc/tariff/octopus/graphql"
	octoRest "github.com/evcc-io/evcc/tariff/octopus/rest"
	"github.com/evcc-io/evcc/util"
	"github.com/evcc-io/evcc/util/request"
)

type Octopus struct {
	log             *util.Logger
	region          string
	productCode     string
	apikey          string
	accountnumber   string
	paymentMethod   string
	tariffDirection octoGql.TariffDirection
	data            *util.Monitor[api.Rates]
}

var _ api.Tariff = (*Octopus)(nil)

func init() {
	registry.Add("octopusenergy", NewOctopusFromConfig)
}

// NewOctopusFromConfig creates the tariff provider from the given config map, and runs it.
func NewOctopusFromConfig(other map[string]any) (api.Tariff, error) {
	t, err := buildOctopusFromConfig(other)
	if err != nil {
		return nil, err
	}

	return runOrError(t)
}

// buildOctopusFromConfig creates the Tariff provider from the given config map.
// Split out to allow for testing.
func buildOctopusFromConfig(other map[string]any) (*Octopus, error) {
	var cc struct {
		Region          string
		Tariff          string // DEPRECATED: use ProductCode
		ProductCode     string
		DirectDebit     bool
		ApiKey          string
		AccountNumber   string
		TariffDirection octoGql.TariffDirection
	}

	logger := util.NewLogger("octopus")

	if err := util.DecodeOther(other, &cc); err != nil {
		return nil, err
	}

	switch cc.TariffDirection {
	case "", octoGql.TariffDirectionImport:
		// default to Import if unset
		if cc.TariffDirection == "" {
			cc.TariffDirection = octoGql.TariffDirectionImport
		}
	case octoGql.TariffDirectionExport:
		// OK
	default:
		// Do not permit invalid TariffDirections.
		return nil, fmt.Errorf("invalid tariff direction %q", cc.TariffDirection)
	}

	// Allow ApiKey to be missing only if Region and Tariff are not.
	if cc.ApiKey == "" {
		if cc.Region == "" {
			return nil, errors.New("missing region")
		}
		if cc.Tariff != "" {
			// deprecated - copy to correct slot and WARN
			logger.WARN.Print("'tariff' is deprecated and will break in a future version - use 'productCode' instead")
			cc.ProductCode = cc.Tariff
		}
		if cc.ProductCode == "" {
			return nil, errors.New("missing product code")
		}
		if cc.TariffDirection != octoGql.TariffDirectionImport {
			// Throw a WARN if it appears the user has set the key when it's not necessary to do so
			logger.WARN.Println("tariffDirection ignored when using product code")
		}
	} else {
		// ApiKey validators
		if cc.Region != "" || cc.Tariff != "" {
			return nil, errors.New("cannot use apikey at same time as product code")
		}
		// We permit the specific special apiKey "test" as sk_live_ keys are considered Stripe secrets by Github
		if cc.ApiKey != "test" && (len(cc.ApiKey) != 32 || !strings.HasPrefix(cc.ApiKey, "sk_live_")) {
			return nil, errors.New("invalid apikey format")
		}
	}
	paymentMethod := octoRest.RatePaymentMethodDirectDebit
	if !cc.DirectDebit {
		// Not using Direct Debit, filter by non-Direct Debit tariff entries
		paymentMethod = octoRest.RatePaymentMethodNotDirectDebit
	}

	t := &Octopus{
		log:             logger,
		region:          cc.Region,
		productCode:     cc.ProductCode,
		apikey:          cc.ApiKey,
		accountnumber:   cc.AccountNumber,
		paymentMethod:   paymentMethod,
		tariffDirection: cc.TariffDirection,
		data:            util.NewMonitor[api.Rates](2 * time.Hour),
	}

	return t, nil
}

func (t *Octopus) run(done chan error) {
	var once sync.Once
	client := request.NewHelper(t.log)

	var restQueryUri string

	// If ApiKey is available, use GraphQL to get appropriate tariff code before entering execution loop.
	if t.apikey != "" {
		gqlCli, err := octoGql.NewClient(t.log, t.apikey, t.accountnumber)
		if err != nil {
			once.Do(func() { done <- err })
			t.log.ERROR.Println(err)
			return
		}
		tariffCode, err := gqlCli.TariffCode(t.tariffDirection)
		if err != nil {
			once.Do(func() { done <- err })
			t.log.ERROR.Println(err)
			return
		}
		restQueryUri = octoRest.ConstructRatesAPIFromTariffCode(tariffCode)
	} else {
		// Construct Rest Query URI using tariff and region codes.
		restQueryUri = octoRest.ConstructRatesAPIFromProductAndRegionCode(t.productCode, t.region)
	}

	// TODO tick every 15 minutes if GraphQL is available to poll for Intelligent slots.
	for tick := time.Tick(time.Hour); ; <-tick {
		var res octoRest.UnitRates

		if err := backoff.Retry(func() error {
			return backoffPermanentError(client.GetJSON(restQueryUri, &res))
		}, bo()); err != nil {
			once.Do(func() { done <- err })

			t.log.ERROR.Println(err)
			continue
		}

		data := make(api.Rates, 0, len(res.Results))
		for _, r := range res.Results {
			// This checks whether:
			// - a Payment Method is set on the Result
			// - a Payment Method filter is set
			// - the Payment Method in the Result matches the Payment Method filter
			if r.PaymentMethod != "" && t.paymentMethod != "" && r.PaymentMethod != t.paymentMethod {
				// A Payment Method filter is set, and this Tariff entry does not match our filter.
				continue
			}
			// ValidityEnd can be zero (wonderful) which just means that the tariff has no present expected end.
			// We need to catch that and set the date to something way in the future.
			rateEnd := r.ValidityEnd
			if rateEnd.IsZero() {
				t.log.TRACE.Printf("handling rate with indefinite length: %v", r.ValidityStart)
				// Currently adds a year from the start date
				rateEnd = r.ValidityStart.AddDate(1, 0, 0)
			}
			ar := api.Rate{
				Start: r.ValidityStart,
				End:   rateEnd,
				// UnitRates are supplied inclusive of tax, though this could be flipped easily with a config flag.
				Value: r.PriceInclusiveTax / 1e2,
			}
			data = append(data, ar)
		}

		mergeRates(t.data, data)
		once.Do(func() { close(done) })
	}
}

// Rates implements the api.Tariff interface
func (t *Octopus) Rates() (api.Rates, error) {
	var res api.Rates
	err := t.data.GetFunc(func(val api.Rates) {
		res = slices.Clone(val)
	})
	return res, err
}

// Type implements the api.Tariff interface
func (t *Octopus) Type() api.TariffType {
	return api.TariffTypePriceForecast
}