Missing "resuming" eventing function state

[fkollmann]

Hey,

the EventingFunctionStatus enumeration is missing the resuming state.

Best Regards,
Felix

[chvck]

Hi @fkollmann where do you see that EventingFunctionStatus should have a resuming state? Our docs at https://docs.couchbase.com/server/current/eventing-rest-api/index.html#status_all state:

Returns a list (array) of all eventing functions, showing their corresponding composite_status. A function's status can have one of the following values: undeployed, deploying, deployed, undeploying, paused, and pausing. There's no value of resuming; when resuming a paused eventing function, the composite_status returns deploying until it reaches the deployed state

[fkollmann]

Here is a real world example :) @chvck

We had to manually add it to our deployment helper functions:

func (s *Service) deployEventingFunction(ctx context.Context, log logging.Logger, functionName string) error {
	if functionName == "" {
		return fmt.Errorf("functionName is empty")
	}

	eventing := s.cluster.EventingFunctions()

	for {
		if ctx != nil && ctx.Err() != nil {
			return fmt.Errorf("failed to deploy function '%v': %w", functionName, ctx.Err())
		}

		_, existingFunctionStatus, err := s.existingEventingFunction(ctx, functionName)
		if err != nil {
			return fmt.Errorf("failed to get eventing function '%v': %w", functionName, err)
		}

		switch existingFunctionStatus {
		case gocb.EventingFunctionStatePaused:
			err = eventing.ResumeFunction(
				functionName,
				&gocb.ResumeEventingFunctionOptions{
					Context: ctx,
				},
			)
			if err != nil && !isHTTPError(err, 406) { // ignore undeployed functions
				return fmt.Errorf("failed to resume eventing function '%v': %w", functionName, err)
			}

		case gocb.EventingFunctionStateUndeployed:
			err = eventing.DeployFunction(
				functionName,
				&gocb.DeployEventingFunctionOptions{
					Context: ctx,
				},
			)
			if err != nil {
				return fmt.Errorf("failed to deploy eventing function '%v': %w", functionName, err)
			}

		case gocb.EventingFunctionStateDeployed:
			return nil // function already undeployed

		case gocb.EventingFunctionStateDeploying, gocb.EventingFunctionStateUndeploying, gocb.EventingFunctionStatePausing, "resuming" /*gocb.EventingFunctionStateResuming*/ :
			break // nothing to do

		default:
			return fmt.Errorf("failed to deploy function '%v': unexpected status '%v'", functionName, existingFunctionStatus)
		}

		// retry in 1 second
		time.Sleep(1 * time.Second)
	}
}

[chvck]

Thanks @fkollmann that's helpful. I've raised https://jira.issues.couchbase.com/browse/GOCBC-1791 for internal tracking and will follow up with the Eventing team.