tx-command-api.go

package tx

//
// thoughts on container-managed transactions in google go
//

//
// approach 1: via tx-command pattern.  Downside to this (??) is that there is
// no analog for thread-locals in go, so ctx must be passed around all the time
// once you cross the first tx barrier
//

// Error satisfies the error interface
type Error string
func (e Error) Error() string {
  return string(e)
}

type Mode int
const (
    Supports Mode = iota
    Required
    RequiresNew
    Mandatory
    Never
)

type Context interface {
  func SetRollback()
  func IsRolledBack() bool
}

type ContextSpi interface {
  func exit()
  Context
}

// factory method for creating context service provider implementations.
// implementation should function along the lines of get-or-create-context
type ContextSpiFactory func(m Mode, parent *Context) (*ContextSpi)

// current, global context spi
var spiFactory ContextSpiFactory

// client method to allow setting global context spi
func() SetSpiFactory (f ContextSpiFactory) {
  spiFactory = f
}

type Command interface {

  // implementation of the command that does work in some tranactional context
  func Run(ctx *Context, args ...interface{}) (results ...interface{})

  // transactional mode that this command should run in
  func Mode() Mode
}

// clients call this method to execute an instance of a Command.
// if a client has not yet started a tx then ctx = nil is fine, otherwise the
// client should pass in the current tx context.
func (cmd Command*) Execute(parent *Context, args... interface{}) (err error, r ...interface{}) {

  defer func() {
    if e = recover(); e != nil {
      // XXX any cleanup should happen here...
      err = e.(Error) // re-panic if not a tx error
    }
  }

  // establish new, or lookup current, tx context
  ctx := spiFactory(cmd.Mode(), parent)

  defer func() {
    ctx.exit()
  }

  results = cmd.Run(ctx, args...)
  return
}

// basic, mock implementation of a context service provider
type MockCtx struct {
  ContextSpi
  rolledBack bool
  mode Mode
  parent *MockCtx
}

func (ctx *MockCtx) IsRolledBack() (bool) {
  return ctx.rolledBack
}

func (ctx *MockCtx) SetRollback() {
  ctx.rolledBack = true
}

// factory method for mock context.  obviously not implemented fully
func NewMockCtx(m Mode, p *Context) (*ContextSpi) {
  switch m {
    case Supports:
    case Required:
    case RequiresNew:
    case Mandatory:
    case Never:
    default:
      panic(Error(fmt.Sprintf("tx: unsupported tx-mode ", m)))
  }
  return &MockCtx{mode: m, parent: p}
}

// assume that commands are not allowed to throw their own errors across tx
// boundaries
func (ctx *MockCtx) exit() {
  if err = recover(); err != nil || ctx.rolledBack {
    // XXX rollback
  }
  else {
    // XXX (2-phase) commit? (if necessary)
  }
}