github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/event/transform.go (about)

     1  package event
     2  
     3  const (
     4  	// ETTransformStart signals the start a transform execution
     5  	// Payload will be a TransformLifecycle
     6  	ETTransformStart = Type("tf:Start")
     7  	// ETTransformStop signals the completion of a transform execution
     8  	// Payload will be a TransformLifecycle
     9  	ETTransformStop = Type("tf:Stop")
    10  
    11  	// ETTransformStepStart signals a step is starting.
    12  	// Payload will be a TransformStepLifecycle
    13  	ETTransformStepStart = Type("tf:StepStart")
    14  	// ETTransformStepStop signals a step has stopped.
    15  	// Payload will be a TransformStepLifecycle
    16  	ETTransformStepStop = Type("tf:StepStop")
    17  	// ETTransformStepSkip signals a step was skipped.
    18  	// Payload will be a TransformStepLifecycle
    19  	ETTransformStepSkip = Type("tf:StepSkip")
    20  
    21  	// ETTransformPrint is sent by print commands.
    22  	// Payload will be a Message
    23  	ETTransformPrint = Type("tf:Print")
    24  	// ETTransformError is for when a tranform program execution error occurs.
    25  	// Payload will be a Message
    26  	ETTransformError = Type("tf:Error")
    27  	// ETTransformDatasetPreview is an abbreviated dataset document in a transform
    28  	// Payload will be a *dataset.Dataset Preview
    29  	ETTransformDatasetPreview = Type("tf:DatasetPreview")
    30  
    31  	// ETTransformCanceled is for when a transform is canceled before
    32  	// it can complete its run
    33  	// Payload will be a TransformLifecycle
    34  	ETTransformCanceled = Type("tf:Canceled")
    35  )
    36  
    37  // TransformLifecycle captures state about the execution of an entire transform
    38  // script
    39  // it's the payload of ETTransformStart/Stop
    40  type TransformLifecycle struct {
    41  	RunID     string `json:"runID,omitempty"`
    42  	StepCount int    `json:"stepCount"`
    43  	Status    string `json:"status,omitempty"`
    44  	Mode      string `json:"mode,omitempty"`
    45  	InitID    string `json:"initID,omitempty"`
    46  }
    47  
    48  // TransformStepLifecycle describes the state of transform step execution at a
    49  // moment in time
    50  // payload for ETTransformStepStart/Stop
    51  type TransformStepLifecycle struct {
    52  	Name     string `json:"name"`
    53  	Category string `json:"category"`
    54  	Status   string `json:"status,omitempty"`
    55  	Mode     string `json:"mode,omitempty"`
    56  }
    57  
    58  // TransformMsgLvl is an enumeration of all possible degrees of message
    59  // logging in an implicit hierarchy (levels)
    60  type TransformMsgLvl string
    61  
    62  const (
    63  	// TransformMsgLvlNone defines an unknown logging level
    64  	TransformMsgLvlNone = TransformMsgLvl("")
    65  	// TransformMsgLvlDebug defines logging level debug
    66  	TransformMsgLvlDebug = TransformMsgLvl("debug")
    67  	// TransformMsgLvlInfo defines logging level info
    68  	TransformMsgLvlInfo = TransformMsgLvl("info")
    69  	// TransformMsgLvlWarn defines logging level warn
    70  	TransformMsgLvlWarn = TransformMsgLvl("warn")
    71  	// TransformMsgLvlError defines logging level error
    72  	TransformMsgLvlError = TransformMsgLvl("error")
    73  )
    74  
    75  // TransformMessage is the payload for print and error events
    76  type TransformMessage struct {
    77  	Lvl  TransformMsgLvl `json:"lvl"`
    78  	Msg  string          `json:"msg"`
    79  	Mode string          `json:"mode,omitempty"`
    80  }