package hook

type TestService struct {
	ServiceControl
	// Hooks to run when specified control points are reached in the service business logic.
	ControlHooks map[string]ControlProcessor
}

// ControlProcessor defines a function that is run when a specified control point is reached in the service
// business logic. The function receives the service instance so internal state can be inspected, plus for any
// arguments passed to the currently executing service function.
type ControlProcessor func(sc ServiceControl, args ...interface{}) error

// ControlHookCleanup defines a function used to remove a control hook.
type ControlHookCleanup func()

// ServiceControl instances allow hooks to be registered for execution at the specified point of execution.
// The control point name can be a function name or a logical execution point meaningful to the service.
// If name is "", the hook for the currently executing function is executed.
// Returns a function which can be used to remove the hook.
type ServiceControl interface {
	RegisterControlPoint(name string, controller ControlProcessor) ControlHookCleanup
}

// ProcessControlHook retrieves the ControlProcessor for the specified hook name and runs it, returning any error.
// Use it like this to invoke a hook registered for some arbitrary control point:
// if err := n.ProcessControlHook("foobar", <serviceinstance>, <somearg1>, <somearg2>); err != nil {
//     return err
// }
func (s *TestService) ProcessControlHook(hookName string, sc ServiceControl, args ...interface{}) error {
	if s.ControlHooks == nil {
		return nil
	}
	if hook, ok := s.ControlHooks[hookName]; ok {
		return hook(sc, args...)
	}
	return nil
}

// ProcessFunctionHook runs the ControlProcessor for the current function, returning any error.
// Use it like this:
// if err := n.ProcessFunctionHook(<serviceinstance>, <somearg1>, <somearg2>); err != nil {
//     return err
// }
func (s *TestService) ProcessFunctionHook(sc ServiceControl, args ...interface{}) error {
	hookName := s.currentServiceMethodName()
	return s.ProcessControlHook(hookName, sc, args...)
}

// RegisterControlPoint assigns the specified controller to the named hook. If nil, any existing controller for the
// hook is removed.
// hookName is the name of a function on the service or some arbitrarily named control point.
func (s *TestService) RegisterControlPoint(hookName string, controller ControlProcessor) ControlHookCleanup {
	if s.ControlHooks == nil {
		s.ControlHooks = make(map[string]ControlProcessor)
	}
	if controller == nil {
		delete(s.ControlHooks, hookName)
	} else {
		s.ControlHooks[hookName] = controller
	}
	return func() {
		s.RegisterControlPoint(hookName, nil)
	}
}
