timeouts.go

//
// DISCLAIMER
//
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// 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.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//

package v1

import (
	"time"

	meta "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
	DefaultMaintenanceGracePeriod = 30 * time.Minute
)

type Timeouts struct {

	// MaintenanceGracePeriod action timeout
	MaintenanceGracePeriod *Timeout `json:"maintenanceGracePeriod,omitempty"`

	// Actions keep map of the actions timeouts.
	// +doc/type: map[string]meta.Duration
	// +doc/link: List of supported action names|../generated/actions.md
	// +doc/link: Definition of meta.Duration|https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go
	// +doc/example: actions:
	// +doc/example:   AddMember: 30m
	Actions ActionTimeouts `json:"actions,omitempty"`

	// Deprecated
	AddMember *Timeout `json:"-"`

	// Deprecated
	RuntimeContainerImageUpdate *Timeout `json:"-"`
}

func (t *Timeouts) GetMaintenanceGracePeriod() time.Duration {
	if t == nil {
		return DefaultMaintenanceGracePeriod
	}

	return t.MaintenanceGracePeriod.Get(DefaultMaintenanceGracePeriod)
}

func (t *Timeouts) Get() Timeouts {
	if t == nil {
		return Timeouts{}
	}

	return *t
}

type ActionTimeouts map[ActionType]Timeout

const InfiniteTimeout time.Duration = 0

func NewInfiniteTimeout() Timeout {
	return NewTimeout(InfiniteTimeout)
}

func NewTimeout(timeout time.Duration) Timeout {
	return Timeout(meta.Duration{Duration: timeout})
}

type Timeout meta.Duration

func (t *Timeout) UnmarshalJSON(b []byte) error {
	var d meta.Duration

	if err := d.UnmarshalJSON(b); err != nil {
		return err
	}

	*t = Timeout(d)

	return nil
}

func (t Timeout) MarshalJSON() ([]byte, error) {
	return meta.Duration(t).MarshalJSON()
}

func (t *Timeout) Infinite() bool {
	if t == nil {
		return false
	}

	return t.Duration == 0
}

func (t *Timeout) Get(d time.Duration) time.Duration {
	if t == nil {
		return d
	}

	return t.Duration
}