Documentation
¶
Index ¶
- func NextCompositeStatus(ctx context.Context, existingStatus, status app.CompositeStatus) (app.CompositeStatus, error)
- type Activities
- func (a *Activities) PkgStatusGetInstallStackVersionStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
- func (a *Activities) PkgStatusGetInstallWorkflowStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
- func (a *Activities) PkgStatusGetInstallWorkflowStepStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
- func (a *Activities) PkgStatusUpdateFlowStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) PkgStatusUpdateFlowStepGroupStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) PkgStatusUpdateFlowStepStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) PkgStatusUpdateInstallStackVersionStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) PkgStatusUpdateInstallWorkflowStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) PkgStatusUpdateInstallWorkflowStepStatus(ctx context.Context, req UpdateStatusRequest) error
- func (a *Activities) TransitionRunnerStatus(ctx context.Context, req TransitionRunnerStatusRequest) (bool, error)
- func (a *Activities) UpdateActionWorkflowStatusV2(ctx context.Context, req UpdateActionWorkflowStatusV2Request) error
- func (a *Activities) UpdateAppConfigStatusV2(ctx context.Context, req UpdateAppConfigStatusV2Request) error
- func (a *Activities) UpdateAppStatusV2(ctx context.Context, req UpdateAppStatusV2Request) error
- func (a *Activities) UpdateBuildStatusV2(ctx context.Context, req UpdateBuildStatusV2) error
- func (a *Activities) UpdateComponentStatusV2(ctx context.Context, req UpdateComponentStatusV2Request) error
- func (a *Activities) UpdateDeployStatusV2(ctx context.Context, req UpdateDeployStatusV2Request) error
- func (a *Activities) UpdateFlowStatusMetadata(ctx context.Context, req UpdateFlowStatusMetadataRequest) error
- func (a *Activities) UpdateInstallActionWorkflowRunStepStatusV2(ctx context.Context, req UpdateInstallActionWorkflowRunStepStatusV2Request) error
- func (a *Activities) UpdateInstallLifecycleStatusV2(ctx context.Context, req UpdateInstallLifecycleStatusV2Request) error
- func (a *Activities) UpdateInstallWorkflowRunStatusV2(ctx context.Context, req UpdateInstallWorkflowRunStatusV2Request) error
- func (a *Activities) UpdateOrgInviteStatusV2(ctx context.Context, req UpdateOrgInviteStatusV2Request) error
- func (a *Activities) UpdateOrgStatusV2(ctx context.Context, req UpdateOrgStatusV2Request) error
- func (a *Activities) UpdateQueueSignalStatusV2(ctx context.Context, req UpdateQueueSignalStatusV2Request) error
- func (a *Activities) UpdateQueueStatusV2(ctx context.Context, req UpdateQueueStatusV2Request) error
- func (a *Activities) UpdateRunStatusV2(ctx context.Context, req UpdateRunStatusV2Request) error
- func (a *Activities) UpdateRunnerJobExecutionStatusV2(ctx context.Context, req UpdateRunnerJobExecutionStatusV2Request) error
- func (a *Activities) UpdateRunnerJobStatusV2(ctx context.Context, req UpdateRunnerJobStatusV2Request) error
- func (a *Activities) UpdateRunnerOperationStatusV2(ctx context.Context, req UpdateRunnerOperationStatusV2Request) error
- func (a *Activities) UpdateRunnerStatusV2(ctx context.Context, req UpdateRunnerStatusV2Request) error
- func (a *Activities) UpdateRunnerStatusV2Metadata(ctx context.Context, req UpdateRunnerStatusV2MetadataRequest) error
- type FlowStatusNotifier
- type GetStatusRequest
- type Params
- type ReleasedInstallNotifier
- type TransitionRunnerStatusRequest
- type UpdateActionWorkflowStatusV2Request
- type UpdateAppConfigStatusV2Request
- type UpdateAppStatusV2Request
- type UpdateBuildStatusV2
- type UpdateComponentStatusV2Request
- type UpdateDeployStatusV2Request
- type UpdateFlowStatusMetadataRequest
- type UpdateInstallActionWorkflowRunStepStatusV2Request
- type UpdateInstallLifecycleStatusV2Request
- type UpdateInstallWorkflowRunStatusV2Request
- type UpdateOrgInviteStatusV2Request
- type UpdateOrgStatusV2Request
- type UpdateQueueSignalStatusV2Request
- type UpdateQueueStatusV2Request
- type UpdateRunStatusV2Request
- type UpdateRunnerJobExecutionStatusV2Request
- type UpdateRunnerJobStatusV2Request
- type UpdateRunnerOperationStatusV2Request
- type UpdateRunnerStatusV2MetadataRequest
- type UpdateRunnerStatusV2Request
- type UpdateStatusRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NextCompositeStatus ¶ added in v0.19.1235
func NextCompositeStatus(ctx context.Context, existingStatus, status app.CompositeStatus) (app.CompositeStatus, error)
Types ¶
type Activities ¶
type Activities struct {
// contains filtered or unexported fields
}
func New ¶
func New(params Params) *Activities
func (*Activities) PkgStatusGetInstallStackVersionStatus ¶
func (a *Activities) PkgStatusGetInstallStackVersionStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgStatusGetInstallWorkflowStatus ¶
func (a *Activities) PkgStatusGetInstallWorkflowStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgStatusGetInstallWorkflowStepStatus ¶
func (a *Activities) PkgStatusGetInstallWorkflowStepStatus(ctx context.Context, req GetStatusRequest) (*app.CompositeStatus, error)
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgStatusUpdateFlowStatus ¶
func (a *Activities) PkgStatusUpdateFlowStatus(ctx context.Context, req UpdateStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgStatusUpdateFlowStepGroupStatus ¶ added in v0.19.894
func (a *Activities) PkgStatusUpdateFlowStepGroupStatus(ctx context.Context, req UpdateStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgStatusUpdateFlowStepStatus ¶
func (a *Activities) PkgStatusUpdateFlowStepStatus(ctx context.Context, req UpdateStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgStatusUpdateInstallStackVersionStatus ¶
func (a *Activities) PkgStatusUpdateInstallStackVersionStatus(ctx context.Context, req UpdateStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgStatusUpdateInstallWorkflowStatus ¶
func (a *Activities) PkgStatusUpdateInstallWorkflowStatus(ctx context.Context, req UpdateStatusRequest) error
TODO(sdboyer) remove after workflow refactor @temporal-gen-v2 activity
func (*Activities) PkgStatusUpdateInstallWorkflowStepStatus ¶
func (a *Activities) PkgStatusUpdateInstallWorkflowStepStatus(ctx context.Context, req UpdateStatusRequest) error
TODO(sdboyer) remove after workflow refactor @temporal-gen-v2 activity
func (*Activities) TransitionRunnerStatus ¶ added in v0.19.1197
func (a *Activities) TransitionRunnerStatus(ctx context.Context, req TransitionRunnerStatusRequest) (bool, error)
func (*Activities) UpdateActionWorkflowStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateActionWorkflowStatusV2(ctx context.Context, req UpdateActionWorkflowStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateAppConfigStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateAppConfigStatusV2(ctx context.Context, req UpdateAppConfigStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateAppStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateAppStatusV2(ctx context.Context, req UpdateAppStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateBuildStatusV2 ¶
func (a *Activities) UpdateBuildStatusV2(ctx context.Context, req UpdateBuildStatusV2) error
@temporal-gen-v2 activity
func (*Activities) UpdateComponentStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateComponentStatusV2(ctx context.Context, req UpdateComponentStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateDeployStatusV2 ¶
func (a *Activities) UpdateDeployStatusV2(ctx context.Context, req UpdateDeployStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateFlowStatusMetadata ¶ added in v0.19.1192
func (a *Activities) UpdateFlowStatusMetadata(ctx context.Context, req UpdateFlowStatusMetadataRequest) error
@temporal-gen-v2 activity
func (*Activities) UpdateInstallActionWorkflowRunStepStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateInstallActionWorkflowRunStepStatusV2(ctx context.Context, req UpdateInstallActionWorkflowRunStepStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateInstallLifecycleStatusV2 ¶ added in v0.19.998
func (a *Activities) UpdateInstallLifecycleStatusV2(ctx context.Context, req UpdateInstallLifecycleStatusV2Request) error
@temporal-gen-v2 activity @by-field InstallID
func (*Activities) UpdateInstallWorkflowRunStatusV2 ¶
func (a *Activities) UpdateInstallWorkflowRunStatusV2(ctx context.Context, req UpdateInstallWorkflowRunStatusV2Request) error
@temporal-gen-v2 activity @by-field RunID
func (*Activities) UpdateOrgInviteStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateOrgInviteStatusV2(ctx context.Context, req UpdateOrgInviteStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateOrgStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateOrgStatusV2(ctx context.Context, req UpdateOrgStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateQueueSignalStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateQueueSignalStatusV2(ctx context.Context, req UpdateQueueSignalStatusV2Request) error
@temporal-gen-v2 activity @local
func (*Activities) UpdateQueueStatusV2 ¶ added in v0.19.901
func (a *Activities) UpdateQueueStatusV2(ctx context.Context, req UpdateQueueStatusV2Request) error
@temporal-gen-v2 activity @by-field QueueID
func (*Activities) UpdateRunStatusV2 ¶
func (a *Activities) UpdateRunStatusV2(ctx context.Context, req UpdateRunStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateRunnerJobExecutionStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateRunnerJobExecutionStatusV2(ctx context.Context, req UpdateRunnerJobExecutionStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateRunnerJobStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateRunnerJobStatusV2(ctx context.Context, req UpdateRunnerJobStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateRunnerOperationStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateRunnerOperationStatusV2(ctx context.Context, req UpdateRunnerOperationStatusV2Request) error
@temporal-gen-v2 activity
func (*Activities) UpdateRunnerStatusV2 ¶ added in v0.19.894
func (a *Activities) UpdateRunnerStatusV2(ctx context.Context, req UpdateRunnerStatusV2Request) error
@temporal-gen-v2 activity @local
func (*Activities) UpdateRunnerStatusV2Metadata ¶ added in v0.19.1091
func (a *Activities) UpdateRunnerStatusV2Metadata(ctx context.Context, req UpdateRunnerStatusV2MetadataRequest) error
@temporal-gen-v2 activity @local
type FlowStatusNotifier ¶ added in v0.19.1071
type FlowStatusNotifier interface {
FlowStatusUpdated(ctx context.Context, req UpdateStatusRequest)
}
FlowStatusNotifier is an optional hook invoked after a flow status update is persisted. Implemented outside this package (see pkg/flow/signals/workflowstepawaitingretry) because the queue client can't be imported here without an import cycle (queue/handler imports this package). Implementations must be best-effort: they may not fail the status update, so the method returns nothing.
type GetStatusRequest ¶
type GetStatusRequest struct {
ID string `json:"id" validate:"required"`
}
NOTE(jm): this could probably be implemented with some type of parsing the ID to figure out what model is represented by it, but if we do that and something _does not_ work, then it's going to be damn near impossible to debug, so we keep the verbose approach here, until something more elegant comes along.
type Params ¶
type Params struct {
fx.In
DB *gorm.DB `name:"psql"`
MW metrics.Writer
Notifier FlowStatusNotifier `optional:"true"`
Released ReleasedInstallNotifier `optional:"true"`
L *zap.Logger `optional:"true"`
}
type ReleasedInstallNotifier ¶ added in v0.19.1231
type ReleasedInstallNotifier interface {
ReleasedInstallSucceeded(ctx context.Context, workflowID, appBranchRunID, installID string)
}
ReleasedInstallNotifier starts work that belongs to an install the group already released. It must not fail the status write that triggered it.
type TransitionRunnerStatusRequest ¶ added in v0.19.1197
type TransitionRunnerStatusRequest struct {
RunnerID string
Status app.RunnerStatus
StatusDescription string
SkipIfDisabled bool
Metadata map[string]any
OnlyIfStatus *app.RunnerStatus
}
type UpdateActionWorkflowStatusV2Request ¶ added in v0.19.894
type UpdateActionWorkflowStatusV2Request struct {
ActionWorkflowID string `validate:"required"`
Status app.ActionWorkflowStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateAppConfigStatusV2Request ¶ added in v0.19.894
type UpdateAppConfigStatusV2Request struct {
AppConfigID string `validate:"required"`
Status app.AppConfigStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateAppStatusV2Request ¶ added in v0.19.894
type UpdateBuildStatusV2 ¶
type UpdateBuildStatusV2 struct {
BuildID string `validate:"required"`
Status app.ComponentBuildStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateComponentStatusV2Request ¶ added in v0.19.894
type UpdateComponentStatusV2Request struct {
ComponentID string `validate:"required"`
Status app.ComponentStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateFlowStatusMetadataRequest ¶ added in v0.19.1192
type UpdateInstallActionWorkflowRunStepStatusV2Request ¶ added in v0.19.894
type UpdateInstallActionWorkflowRunStepStatusV2Request struct {
StepID string `validate:"required"`
Status app.InstallActionWorkflowRunStepStatus `validate:"required"`
}
type UpdateInstallLifecycleStatusV2Request ¶ added in v0.19.998
type UpdateInstallLifecycleStatusV2Request struct {
InstallID string `validate:"required"`
Status app.InstallLifecycleStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateInstallWorkflowRunStatusV2Request ¶
type UpdateInstallWorkflowRunStatusV2Request struct {
RunID string `validate:"required"`
Status app.InstallActionWorkflowRunStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateOrgInviteStatusV2Request ¶ added in v0.19.894
type UpdateOrgInviteStatusV2Request struct {
OrgInviteID string `validate:"required"`
Status app.OrgInviteStatus `validate:"required"`
}
type UpdateOrgStatusV2Request ¶ added in v0.19.894
type UpdateQueueSignalStatusV2Request ¶ added in v0.19.894
type UpdateQueueStatusV2Request ¶ added in v0.19.901
type UpdateRunStatusV2Request ¶
type UpdateRunStatusV2Request struct {
RunID string `validate:"required"`
Status app.SandboxRunStatus `validate:"required"`
StatusDescription string `validate:"required"`
SkipStatusSync bool
}
type UpdateRunnerJobExecutionStatusV2Request ¶ added in v0.19.894
type UpdateRunnerJobExecutionStatusV2Request struct {
RunnerJobExecutionID string `validate:"required"`
Status app.RunnerJobExecutionStatus `validate:"required"`
StatusDescription string
}
type UpdateRunnerJobStatusV2Request ¶ added in v0.19.894
type UpdateRunnerJobStatusV2Request struct {
RunnerJobID string `validate:"required"`
Status app.RunnerJobStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateRunnerOperationStatusV2Request ¶ added in v0.19.894
type UpdateRunnerOperationStatusV2Request struct {
RunnerOperationID string `validate:"required"`
Status app.RunnerOperationStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateRunnerStatusV2MetadataRequest ¶ added in v0.19.1091
type UpdateRunnerStatusV2Request ¶ added in v0.19.894
type UpdateRunnerStatusV2Request struct {
RunnerID string `validate:"required"`
Status app.RunnerStatus `validate:"required"`
StatusDescription string `validate:"required"`
}
type UpdateStatusRequest ¶
type UpdateStatusRequest struct {
ID string `validate:"required"`
Status app.CompositeStatus `json:"status" validate:"required"`
}
NOTE
This package is the beginning of consolidating all status logic into a single package.
Right now, it's a bit verbose with getters for statuses when updating, however long term we can either generate this or make the status selectable in isolation by selecting the field using reflection or something else.
However, for now, this interface provides a few things: 1. ability to manage history of a status 2. ability to start doing things such as sending a signal to a channel if needed. This enables the ability to start blocking for a "status" change or a specific status.