unfreezerepowf

Documentation

Overview

Package `unfreezerepowf` implements the unfreeze-repo ephemeral workflow.

Workflow Events

Some events have a suffix `2` to distinguish them from events that were used in an earlier, experimental implementation (see NOE-23).

The workflow is initiated by gRPC `BeginUnfreezeRepo()`. It starts the workflow with `WorkflowEvent_EV_FSO_UNFREEZE_REPO_STARTED_2` on the workflow and a corresponding `WorkflowEvent_EV_FSO_UNFREEZE_REPO_STARTED_2` on the ephemeral registry workflow index.

Nogfsoregd observes the workflow. It changes the repo state to freezing in the registry with `RegistryEvent_EV_FSO_UNFREEZE_REPO_STARTED_2` and on the repo with `RepoEvent_EV_FSO_UNFREEZE_REPO_STARTED_2`. It then posts `WorkflowEvent_EV_FSO_UNFREEZE_REPO_FILES_STARTED` on the workflow to notify Nogfsostad.

Nogfsostad observes the workflow. It unsets the immutable file attributes, commits the shadow repo, and posts `WorkflowEvent_EV_FSO_UNFREEZE_REPO_FILES_COMPLETED` on the workflow.

Nogfsoregd then completes the workflow: `RepoEvent_EV_FSO_UNFREEZE_REPO_COMPLETED_2` on the repo, `RegistryEvent_EV_FSO_UNFREEZE_REPO_COMPLETED_2` on the registry, `WorkflowEvent_EV_FSO_UNFREEZE_REPO_COMPLETED_2` on the workflow, `WorkflowEvent_EV_FSO_UNFREEZE_REPO_COMPLETED_2` on the ephemeral registry workflow index, and a final `WorkflowEvent_EV_FSO_UNFREEZE_REPO_COMMITTED` on the workflow.

The final workflow event has no observable side effect. Its only purpose is to explicitly confirm termination of the workflow history. The final event may be missing if a multi-step command to complete the workflow was interrupted.

The workflow is eventually deleted from the index with `WorkflowEvent_EV_FSO_UNFREEZE_REPO_DELETED` on the ephemeral registry workflow index. A workflow may be deleted with or without the final workflow event.

Index

• Variables
• func IsPackageError(err error) bool
• type Advancer
  • func (a *Advancer) Advance(s events.State, ev events.Event) events.State
• type AlreadyTerminatedError
  • func (err *AlreadyTerminatedError) Error() string
• type Behavior
  • func (Behavior) NewAdvancer() events.Advancer
  • func (Behavior) NewEvent() events.Event
  • func (Behavior) NewState(id uuid.I) events.State
  • func (Behavior) Tell(s events.State, c events.Command) ([]events.Event, error)
• type CmdAbort
  • func (*CmdAbort) AggregateCommand()
• type CmdAbortFiles
  • func (*CmdAbortFiles) AggregateCommand()
• type CmdBeginFiles
  • func (*CmdBeginFiles) AggregateCommand()
• type CmdCommit
  • func (*CmdCommit) AggregateCommand()
• type CmdCommitFiles
  • func (*CmdCommitFiles) AggregateCommand()
• type CmdEnd
  • func (*CmdEnd) AggregateCommand()
• type CmdInit
  • func (*CmdInit) AggregateCommand()
• type Event
  • func (ev *Event) UnmarshalProto(data []byte) error
• type EventTypeError
  • func (err *EventTypeError) Error() string
• type InvalidCommandError
  • func (err *InvalidCommandError) Error() string
• type JournalError
  • func (err *JournalError) Error() string
  • func (err *JournalError) Unwrap() error
• type NewEventsError
  • func (err *NewEventsError) Error() string
  • func (err *NewEventsError) Unwrap() error
• type NotIdempotentError
  • func (err *NotIdempotentError) Error() string
• type State
  • func (*State) AggregateState()
  • func (s *State) Id() uuid.I
  • func (st *State) RegistryId() uuid.I
  • func (st *State) RegistryName() string
  • func (st *State) RepoGlobalPath() string
  • func (st *State) RepoId() uuid.I
  • func (s *State) SetVid(vid ulid.I)
  • func (st *State) StateCode() StateCode
  • func (st *State) StatusCode() int32
  • func (st *State) StatusMessage() string
  • func (s *State) Vid() ulid.I
• type StateCode
• type StateConflictError
  • func (err *StateConflictError) Error() string
• type UninitializedError
  • func (err *UninitializedError) Error() string
• type Workflows
  • func New(journal *events.Journal) *Workflows
  • func (r *Workflows) Abort(id uuid.I, vid ulid.I, code int32, message string) (ulid.I, error)
  • func (r *Workflows) AbortFiles(id uuid.I, vid ulid.I, code int32, message string) (ulid.I, error)
  • func (r *Workflows) BeginFiles(id uuid.I, vid ulid.I) (ulid.I, error)
  • func (r *Workflows) Commit(id uuid.I, vid ulid.I) (ulid.I, error)
  • func (r *Workflows) CommitFiles(id uuid.I, vid ulid.I) (ulid.I, error)
  • func (r *Workflows) End(id uuid.I, vid ulid.I) (ulid.I, error)
  • func (r *Workflows) FindId(id uuid.I) (*State, error)
  • func (r *Workflows) Init(id uuid.I, cmd *CmdInit) (ulid.I, error)

Variables

var NoVC = events.NoVC

var RetryNoVC = events.RetryNoVC

Functions

func IsPackageError

func IsPackageError(err error) bool

Types

type Advancer

type Advancer struct {
	// contains filtered or unexported fields
}

The bools indicate which part of the state has been duplicated.

func (*Advancer) Advance

func (a *Advancer) Advance(s events.State, ev events.Event) events.State

type AlreadyTerminatedError

type AlreadyTerminatedError struct{}

func (*AlreadyTerminatedError) Error

func (err *AlreadyTerminatedError) Error() string

type Behavior

type Behavior struct{}

func (Behavior) NewAdvancer

func (Behavior) NewAdvancer() events.Advancer

func (Behavior) NewEvent

func (Behavior) NewEvent() events.Event

func (Behavior) NewState

func (Behavior) NewState(id uuid.I) events.State

func (Behavior) Tell

func (Behavior) Tell(
	s events.State, c events.Command,
) ([]events.Event, error)

type CmdAbort

type CmdAbort struct {
	Code    int32
	Message string
}

func (*CmdAbort) AggregateCommand

func (*CmdAbort) AggregateCommand()

type CmdAbortFiles

type CmdAbortFiles struct {
	Code    int32
	Message string
}

func (*CmdAbortFiles) AggregateCommand

func (*CmdAbortFiles) AggregateCommand()

type CmdBeginFiles

type CmdBeginFiles struct{}

func (*CmdBeginFiles) AggregateCommand

func (*CmdBeginFiles) AggregateCommand()

type CmdCommit

type CmdCommit struct{}

func (*CmdCommit) AggregateCommand

func (*CmdCommit) AggregateCommand()

type CmdCommitFiles

type CmdCommitFiles struct{}

func (*CmdCommitFiles) AggregateCommand

func (*CmdCommitFiles) AggregateCommand()

type CmdEnd

type CmdEnd struct{}

func (*CmdEnd) AggregateCommand

func (*CmdEnd) AggregateCommand()

type CmdInit

type CmdInit struct {
	RegistryId       uuid.I
	RegistryName     string
	StartRegistryVid ulid.I
	RepoId           uuid.I
	RepoGlobalPath   string
	StartRepoVid     ulid.I
	AuthorName       string
	AuthorEmail      string
}

func (*CmdInit) AggregateCommand

func (*CmdInit) AggregateCommand()

type Event

type Event struct{ wfev.Event }

func (*Event) UnmarshalProto

func (ev *Event) UnmarshalProto(data []byte) error

type EventTypeError

type EventTypeError struct{}

func (*EventTypeError) Error

func (err *EventTypeError) Error() string

type InvalidCommandError

type InvalidCommandError struct{}

func (*InvalidCommandError) Error

func (err *InvalidCommandError) Error() string

type JournalError

type JournalError struct {
	Err error
}

func (*JournalError) Error

func (err *JournalError) Error() string

func (*JournalError) Unwrap

func (err *JournalError) Unwrap() error

type NewEventsError

type NewEventsError struct {
	Err error
}

func (*NewEventsError) Error

func (err *NewEventsError) Error() string

func (*NewEventsError) Unwrap

func (err *NewEventsError) Unwrap() error

type NotIdempotentError

type NotIdempotentError struct {
}

func (*NotIdempotentError) Error

func (err *NotIdempotentError) Error() string

type State

type State struct {
	// contains filtered or unexported fields
}

func (*State) AggregateState

func (*State) AggregateState()

func (*State) Id

func (s *State) Id() uuid.I

func (*State) RegistryId

func (st *State) RegistryId() uuid.I

func (*State) RegistryName

func (st *State) RegistryName() string

func (*State) RepoGlobalPath

func (st *State) RepoGlobalPath() string

func (*State) RepoId

func (st *State) RepoId() uuid.I

func (*State) SetVid

func (s *State) SetVid(vid ulid.I)

func (*State) StateCode

func (st *State) StateCode() StateCode

func (*State) StatusCode

func (st *State) StatusCode() int32

func (*State) StatusMessage

func (st *State) StatusMessage() string

func (*State) Vid

func (s *State) Vid() ulid.I

type StateCode

type StateCode int

const (
	StateUninitialized StateCode = iota
	StateInitialized

	StateFiles
	StateFilesCompleted
	StateFilesFailed

	StateCompleted
	StateFailed

	StateTerminated
)

type StateConflictError

type StateConflictError struct{}

func (*StateConflictError) Error

func (err *StateConflictError) Error() string

type UninitializedError

type UninitializedError struct{}

func (*UninitializedError) Error

func (err *UninitializedError) Error() string

type Workflows

type Workflows struct {
	// contains filtered or unexported fields
}

func New

func New(journal *events.Journal) *Workflows

func (*Workflows) Abort

func (r *Workflows) Abort(
	id uuid.I, vid ulid.I, code int32, message string,
) (ulid.I, error)

func (*Workflows) AbortFiles

func (r *Workflows) AbortFiles(
	id uuid.I, vid ulid.I, code int32, message string,
) (ulid.I, error)

func (*Workflows) BeginFiles

func (r *Workflows) BeginFiles(
	id uuid.I, vid ulid.I,
) (ulid.I, error)

func (*Workflows) Commit

func (r *Workflows) Commit(
	id uuid.I, vid ulid.I,
) (ulid.I, error)

func (*Workflows) CommitFiles

func (r *Workflows) CommitFiles(
	id uuid.I, vid ulid.I,
) (ulid.I, error)

func (*Workflows) End

func (r *Workflows) End(id uuid.I, vid ulid.I) (ulid.I, error)

func (*Workflows) FindId

func (r *Workflows) FindId(id uuid.I) (*State, error)

func (*Workflows) Init

func (r *Workflows) Init(id uuid.I, cmd *CmdInit) (ulid.I, error)