mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-23 03:34:30 -05:00
67a5cd0911
This extends statemgr.Persistent, statemgr.Locker and remote.Client to all expect context.Context parameters, and then updates all of the existing implementations of those interfaces to support them. All of the calls to statemgr.Persistent and statemgr.Locker methods outside of tests are consistently context.TODO() for now, because the caller landscape of these interfaces has some complications: 1. statemgr.Locker is also used by the clistate package for its state implementation that was derived from statemgr.Filesystem's predecessor, even though what clistate manages is not actually "state" in the sense of package statemgr. The callers of that are not yet ready to provide real contexts. In a future commit we'll either need to plumb context through to all of the clistate callers, or continue the effort to separate statemgr from clistate by introducing a clistate-specific "locker" API for it to use instead. 2. We call statemgr.Persistent and statemgr.Locker methods in situations where the active context might have already been cancelled, and so we'll need to make sure to ignore cancellation when calling those. This is mainly limited to PersistState and Unlock, since both need to be able to complete after a cancellation, but there are various codepaths that perform a Lock, Refresh, Persist, Unlock sequence and so it isn't yet clear where is the best place to enforce the invariant that Persist and Unlock must not be called with a cancelable context. We'll deal with that more in subsequent commits. Within the various state manager and remote client implementations the contexts _are_ wired together as best as possible with how these subsystems are already laid out, and so once we deal with the problems above and make callers provide suitable contexts they should be able to reach all of the leaf API clients that might want to generate OpenTelemetry traces. Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
54 lines
1.4 KiB
Go
54 lines
1.4 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package remote
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/opentofu/opentofu/internal/states/statemgr"
|
|
)
|
|
|
|
// Client is the interface that must be implemented for a remote state
|
|
// driver. It supports dumb put/get/delete, and the higher level structs
|
|
// handle persisting the state properly here.
|
|
type Client interface {
|
|
Get(context.Context) (*Payload, error)
|
|
Put(context.Context, []byte) error
|
|
Delete(context.Context) error
|
|
}
|
|
|
|
// ClientForcePusher is an optional interface that allows a remote
|
|
// state to force push by managing a flag on the client that is
|
|
// toggled on by a call to EnableForcePush.
|
|
type ClientForcePusher interface {
|
|
Client
|
|
EnableForcePush()
|
|
}
|
|
|
|
// ClientLocker is an optional interface that allows a remote state
|
|
// backend to enable state lock/unlock.
|
|
type ClientLocker interface {
|
|
Client
|
|
statemgr.Locker
|
|
}
|
|
|
|
// OptionalClientLocker is an optional interface that allows callers to
|
|
// to determine whether or not locking is actually enabled.
|
|
// See OptionalLocker for more details.
|
|
type OptionalClientLocker interface {
|
|
ClientLocker
|
|
IsLockingEnabled() bool
|
|
}
|
|
|
|
// Payload is the return value from the remote state storage.
|
|
type Payload struct {
|
|
MD5 []byte
|
|
Data []byte
|
|
}
|
|
|
|
// Factory is the factory function to create a remote client.
|
|
type Factory func(map[string]string) (Client, error)
|