featureflag

Documentation

Index

• Variables
• func ContextWithExplicitFeatureFlags(ctx context.Context) context.Context
• func ContextWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context
• func FromContext(ctx context.Context) map[FeatureFlag]bool
• func IncomingCtxWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context
• func OutgoingCtxWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context
• type FeatureFlag
  • func DefinedFlags() []FeatureFlag
  • func FromMetadataKey(metadataKey string) (FeatureFlag, error)
  • func NewFeatureFlag(name, version, rolloutIssueURL string, onByDefault bool) FeatureFlag
  • func (ff FeatureFlag) FormatWithValue(enabled bool) string
  • func (ff FeatureFlag) IsDisabled(ctx context.Context) bool
  • func (ff FeatureFlag) IsEnabled(ctx context.Context) bool
  • func (ff FeatureFlag) MetadataKey() string

Variables

var CommandCloseStdout = NewFeatureFlag(
	"command_close_stdout",
	"v16.4.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5558",
	false,
)

CommandCloseStdout causes the `command` package to close stdout of commands when calling `Wait()` on them instead of discarding their output. This has two consequences:

• We notice when a command's output has not been fully read when calling `Wait()`. Previously, such a call would have succeeded.

• We notice when a command has been killed when trying to consume its output. Previously, fully consuming the output would succeed, which can lead to partially-read output without indication of an error.

So overall, the new behaviour is more thorough and will cause us to detect errors in stdout handling more readily.

var (
	// EnableAllFeatureFlagsEnvVar will cause Gitaly to treat all feature flags as
	// enabled in case its value is set to `true`. Only used for testing purposes.
	EnableAllFeatureFlagsEnvVar = "GITALY_TESTING_ENABLE_ALL_FEATURE_FLAGS"
)

var GPGSigning = NewFeatureFlag(
	"gpg_signing",
	"v16.2.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5361",
	false,
)

GPGSigning enables the use of Git v2.41.

var GitV242 = NewFeatureFlag(
	"git_v242",
	"v16.4.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5539",
	true,
)

GitV242 enables the use of Git v2.42.

var InterceptReplicateRepository = NewFeatureFlag(
	"intercept_replicate_repository",
	"v16.3.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5477",
	false,
)

InterceptReplicateRepository will enable the interception of the ReplicateRepository RPC in Praefect. Interception of this RPC enables Praefect to support object pool replication.

var MailmapOptions = NewFeatureFlag(
	"mailmap_options",
	"v16.2.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5394",
	true,
)

MailmapOptions enables the use of mailmap feature in GitLab

var ReplicateRepositoryObjectPool = NewFeatureFlag(
	"replicate_repository_object_pool",
	"v16.2.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5088",
	false,
)

ReplicateRepositoryObjectPool will enable replication of a repository's object pool through the `ReplicateRepository` RPC. This will help to preserve object deduplication between repositories that share an object pool.

var TransactionalAlternatesDisconnect = NewFeatureFlag(
	"transactional_alternates_disconnect",
	"v16.4.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5540",
	false,
)

TransactionalAlternatesDisconnect enables transactions to be used when disconnecting an alternate object database from a Git repository. If the transaction fails, the alternate disconnect is rolled back.

var TransactionalLinkRepository = NewFeatureFlag(
	"transactional_link_repository",
	"v16.4.0",
	"https://gitlab.com/gitlab-org/gitaly/-/issues/5587",
	false,
)

TransactionalLinkRepository enables transactions to be used when linking a repository to an object pool via the `LinkRepositoryToObjectPool` RPC.

Functions

func ContextWithExplicitFeatureFlags

func ContextWithExplicitFeatureFlags(ctx context.Context) context.Context

ContextWithExplicitFeatureFlags marks the context such that all feature flags which are checked must have been explicitly set in that context. If a feature flag wasn't set to an explicit value, then checking this feature flag will panic. This is not for use in production systems, but is intended for tests to verify that we test each feature flag properly.

func ContextWithFeatureFlag

func ContextWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context

ContextWithFeatureFlag sets the feature flag in both the incoming and outgoing context.

func FromContext

func FromContext(ctx context.Context) map[FeatureFlag]bool

FromContext returns the set of all feature flags defined in the context. This returns both feature flags that are currently defined by Gitaly, but may also return some that aren't defined by us in case they match the feature flag prefix but don't have a definition. This function also returns the state of the feature flag *as defined in the context*. This value may be overridden.

func IncomingCtxWithFeatureFlag

func IncomingCtxWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context

IncomingCtxWithFeatureFlag sets the feature flag for an incoming context. This is NOT meant for use in clients that transfer the context across process boundaries.

func OutgoingCtxWithFeatureFlag

func OutgoingCtxWithFeatureFlag(ctx context.Context, flag FeatureFlag, enabled bool) context.Context

OutgoingCtxWithFeatureFlag sets the feature flag for an outgoing context.

Types

type FeatureFlag

type FeatureFlag struct {
	// Name is the name of the feature flag.
	Name string `json:"name"`
	// OnByDefault is the default value if the feature flag is not explicitly set in
	// the incoming context.
	OnByDefault bool `json:"on_by_default"`
}

FeatureFlag gates the implementation of new or changed functionality.

func DefinedFlags

func DefinedFlags() []FeatureFlag

DefinedFlags returns the set of feature flags that have been explicitly defined.

func FromMetadataKey

func FromMetadataKey(metadataKey string) (FeatureFlag, error)

FromMetadataKey parses the given gRPC metadata key into a Gitaly feature flag and performs the necessary conversions. Returns an error in case the metadata does not refer to a feature flag.

This function tries to look up the default value via our set of flag definitions. In case the flag definition is unknown to Gitaly it assumes a default value of `false`.

func NewFeatureFlag

func NewFeatureFlag(name, version, rolloutIssueURL string, onByDefault bool) FeatureFlag

NewFeatureFlag creates a new feature flag and adds it to the array of all existing feature flags. The name must be of the format `some_feature_flag`. Accepts a version and rollout issue URL as input that are not used for anything but only for the sake of linking to the feature flag rollout issue in the Gitaly project.

func (FeatureFlag) FormatWithValue

func (ff FeatureFlag) FormatWithValue(enabled bool) string

FormatWithValue converts the feature flag into a string with the given state. Note that this function uses the feature flag name and not the raw metadata key as used in gRPC metadata.

func (FeatureFlag) IsDisabled

func (ff FeatureFlag) IsDisabled(ctx context.Context) bool

IsDisabled determines whether the feature flag is disabled in the incoming context.

func (FeatureFlag) IsEnabled

func (ff FeatureFlag) IsEnabled(ctx context.Context) bool

IsEnabled checks if the feature flag is enabled for the passed context. Only returns true if the metadata for the feature flag is set to "true"

func (FeatureFlag) MetadataKey

func (ff FeatureFlag) MetadataKey() string

MetadataKey returns the key of the feature flag as it is present in the metadata map.