Skip to content

Latest commit

 

History

History
237 lines (181 loc) · 6.19 KB

README.md

File metadata and controls

237 lines (181 loc) · 6.19 KB
Raw

faktory_worker_go

travis

This repository provides a Faktory worker process for Go apps. This worker process fetches background jobs from the Faktory server and processes them.

How is this different from all the other Go background worker libraries? They all use Redis or another "dumb" datastore. This library is far simpler because the Faktory server implements most of the data storage, retry logic, Web UI, etc.

Installation

You must install Faktory first. Then:

go get -u github.com/contribsys/faktory_worker_go

Usage

To process background jobs, follow these steps:

  1. Register your job types and their associated funcs
  2. Set a few optional parameters
  3. Start the processing

There are a couple ways to stop the process. In this example, send the TERM or INT signal.

package main

import (
  "context"
  "log"

  worker "github.com/contribsys/faktory_worker_go"
)

func someFunc(ctx context.Context, args ...interface{}) error {
  help := worker.HelperFor(ctx)
  log.Printf("Working on job %s\n", help.Jid())
  return nil
}

func main() {
  mgr := worker.NewManager()

  // register job types and the function to execute them
  mgr.Register("SomeJob", someFunc)
  //mgr.Register("AnotherJob", anotherFunc)

  // use up to N goroutines to execute jobs
  mgr.Concurrency = 20
  // wait up to 25 seconds to let jobs in progress finish
  mgr.ShutdownTimeout = 25 * time.Second

  // pull jobs from these queues, in this order of precedence
  mgr.ProcessStrictPriorityQueues("critical", "default", "bulk")

  // alternatively you can use weights to avoid starvation
  //mgr.ProcessWeightedPriorityQueues(map[string]int{"critical":3, "default":2, "bulk":1})

  // Start processing jobs, this method does not return.
  mgr.Run()
}

Alternatively you can control the stopping of the Manager using RunWithContext. You must process any signals yourself.

package main

import (
  "context"
  "log"
  "os"
  "os/signal"
  "syscall"

  worker "github.com/contribsys/faktory_worker_go"
)

func someFunc(ctx context.Context, args ...interface{}) error {
  help := worker.HelperFor(ctx)
  log.Printf("Working on job %s\n", help.Jid())
  return nil
}

func main() {
  ctx, cancel := context.WithCancel(context.Background())
  mgr := worker.NewManager()

  // register job types and the function to execute them
  mgr.Register("SomeJob", someFunc)
  //mgr.Register("AnotherJob", anotherFunc)

  // use up to N goroutines to execute jobs
  mgr.Concurrency = 20
  // wait up to 25 seconds to let jobs in progress finish
  mgr.ShutdownTimeout = 25 * time.Second

  // pull jobs from these queues, in this order of precedence
  mgr.ProcessStrictPriorityQueues("critical", "default", "bulk")

  // alternatively you can use weights to avoid starvation
  //mgr.ProcessWeightedPriorityQueues(map[string]int{"critical":3, "default":2, "bulk":1})

  go func(){
    // Start processing jobs in background routine, this method does not return
    // unless an error is returned or cancel() is called
    mgr.RunWithContext(ctx)
  }()

  go func() {
    stopSignals := []os.Signal{
      syscall.SIGTERM,
      syscall.SIGINT,
      // TODO Implement the TSTP signal to call mgr.Quiet()
    }
    stop := make(chan os.Signal, len(stopSignals))
    for _, s := range stopSignals {
       signal.Notify(stop, s)
    }

    for {
      select {
      case <-ctx.Done():
        return
      case <-stop:
        break
      }
    }

    _ = time.AfterFunc(mgr.ShutdownTimeout, cancel)
    _ = mgr.Terminate(true) // never returns
  }()

  <-ctx.Done()
}

Testing

faktory_worker_go provides helpers that allow you to configure tests to execute jobs inline if you prefer. In this example, the application has defined its own wrapper function for client.Push.

import (
	faktory "github.com/contribsys/faktory/client"
	worker "github.com/contribsys/faktory_worker_go"
)

func Push(mgr worker.Manager, job *faktory.Job) error {
	if viper.GetBool("faktory_inline") {
		return syntheticPush(mgr worker.Manager, job)
	}
	return realPush(job)
}

func syntheticPush(mgr worker.Manager, job *faktory.Job) error {
	err := mgr.InlineDispatch(job)
	if err != nil {
		return errors.Wrap(err, "syntheticPush failed")
	}

  return nil
}

func realPush(job *faktory.Job) error {
	client, err := faktory.Open()
	if err != nil {
		return errors.Wrap(err, "failed to open Faktory client connection")
	}

	err = client.Push(job)
	if err != nil {
		return errors.Wrap(err, "failed to enqueue Faktory job")
	}

	return nil
}

FAQ

  • How do I specify the Faktory server location?

By default, it will use localhost:7419 which is sufficient for local development. Use FAKTORY_URL to specify the URL, e.g. tcp://faktory.example.com:12345 or use FAKTORY_PROVIDER to specify the environment variable which does contain the URL: FAKTORY_PROVIDER=FAKTORYTOGO_URL. This level of indirection is useful for SaaSes, Heroku Addons, etc.

  • How do I push new jobs to Faktory?
  1. Inside a job, you can check out a connection from the Pool of Faktory connections using the job helper's With method:
func someFunc(ctx context.Context, args ...interface{}) error {
  help := worker.HelperFor(ctx)
  return help.With(func(cl *faktory.Client) error {
    job := faktory.NewJob("SomeJob", 1, 2, 3)
    return cl.Push(job)
  })
}
  1. You can always open a client connection to Faktory directly but this won't perform as well:
import (
  faktory "github.com/contribsys/faktory/client"
)

client, err := faktory.Open()
job := faktory.NewJob("SomeJob", 1, 2, 3)
err = client.Push(job)

NB: Client instances are not safe to share, you can use a Pool of Clients which is thread-safe.

See the Faktory Client API for Go or Ruby. You can implement a Faktory client in any programming language. See the wiki for details.

Author

Mike Perham, https://ruby.social/@getajobmike

License

This codebase is licensed via the Mozilla Public License, v2.0. https://choosealicense.com/licenses/mpl-2.0/