Add throttling and timeout configuration to the Go SDK (#41)

* Add throttling and timeout configuration to the Go SDK

* Update go.mod

* Update go.mod/vendor

* go.mod updates

* Vendor

funcs.go

@@ -9,6 +9,10 @@ import (
 	"github.com/inngest/inngest/pkg/inngest"
 )
 
+func StrPtr(i string) *string { return &i }
+
+func IntPtr(i int) *int { return &i }
+
 type FunctionOpts struct {
 	// ID is an optional function ID.  If not specified, the ID
 	// will be auto-generated by lowercasing and slugging the name.
@@ -22,20 +26,20 @@ type FunctionOpts struct {
 	Retries     *int
 	Cancel      []inngest.Cancel
 	Debounce    *Debounce
-
-	// RateLimit allows the function to be rate limited.
-	RateLimit   *RateLimit
+	// Timeouts represents timeouts for a function.
+	Timeouts *Timeouts
+	// Throttle represents a soft rate limit for gating function starts.  Any function runs
+	// over the throttle period will be enqueued in the backlog to run at the next available
+	// time.
+	Throttle *Throttle
+	// RateLimit allows specifying custom rate limiting for the function.  A RateLimit is
+	// hard rate limiting:  any function invocations over the rate limit will be ignored and
+	// will never run.
+	RateLimit *RateLimit
+	// BatchEvents represents batching
 	BatchEvents *inngest.EventBatchConfig
 }
 
-func StrPtr(i string) *string {
-	return &i
-}
-
-func IntPtr(i int) *int {
-	return &i
-}
-
 // GetRateLimit returns the inngest.RateLimit for function configuration.  The
 // SDK's RateLimit type is incompatible with the inngest.RateLimit type signature
 // for ease of definition.
@@ -61,18 +65,39 @@ type Debounce struct {
 	Timeout *time.Duration `json:"timeout,omitempty"`
 }
 
-type RateLimit struct {
-	// Limit is how often the function can be called within the specified period
+// Throttle represents concurrency over time.
+type Throttle struct {
+	// Limit is how often the function can be called within the specified period.  The
+	// minimum limit is 1.
 	Limit uint `json:"limit"`
-	// Period represents the time period for throttling the function
+	// Period represents the time period for throttling the function.  The minimum
+	// granularity is 1 second.  Run starts are spaced evenly through the given period.
 	Period time.Duration `json:"period"`
+	// Burst is number of runs allowed to start in the given window, in a single burst,
+	// before throttling applies.
+	//
+	// A burst > 1 bypasses smoothing for the burst and allows many runs to start
+	// at once, if desired.  Defaults to 1, which disables bursting.
+	Burst uint `json:"burst"`
 	// Key is an optional string to constrain throttling using event data.  For
 	// example, if you want to throttle incoming notifications based off of a user's
-	// ID in an event you can use the following key: "{{ event.user.id }}".  This ensures
+	// ID in an event you can use the following key: "event.user.id".  This ensures
 	// that we throttle functions for each user independently.
 	Key *string `json:"key,omitempty"`
 }
 
+type RateLimit struct {
+	// Limit is how often the function can be called within the specified period
+	Limit uint `json:"limit"`
+	// Period represents the time period for throttling the function
+	Period time.Duration `json:"period"`
+	// Key is an optional string to constrain rate limiting using event data.  For
+	// example, if you want to rate limit incoming notifications based off of a user's
+	// ID in an event you can use the following key: "event.user.id".  This ensures
+	// that we rate limit functions for each user independently.
+	Key *string `json:"key,omitempty"`
+}
+
 // Convert converts a RateLimit to an inngest.RateLimit
 func (r RateLimit) Convert() *inngest.RateLimit {
 	return &inngest.RateLimit{
@@ -82,6 +107,26 @@ func (r RateLimit) Convert() *inngest.RateLimit {
 	}
 }
 
+// Timeouts represents timeouts for the function. If any of the timeouts are hit, the function
+// will be marked as cancelled with a cancellation reason.
+type Timeouts struct {
+	// Start represents the timeout for starting a function.  If the time between scheduling
+	// and starting a function exceeds this value, the function will be cancelled.  Note that
+	// this is inclusive of time between retries.
+	//
+	// A function may exceed this duration because of concurrency limits, throttling, etc.
+	Start time.Duration `json:"start,omitempty"`
+
+	// Finish represents the time between a function starting and the function finishing.
+	// If a function takes longer than this time to finish, the function is marked as cancelled.
+	// The start time is taken from the time that the first successful function request begins,
+	// and does not include the time spent in the queue before the function starts.
+	//
+	// Note that if the final request to a function begins before this timeout, and completes
+	// after this timeout, the function will succeed.
+	Finish time.Duration `json:"finish,omitempty"`
+}
+
 // CreateFunction creates a new function which can be registered within a handler.
 //
 // This function uses generics, allowing you to supply the event that triggers the function.
@@ -106,7 +151,7 @@ func (r RateLimit) Convert() *inngest.RateLimit {
 //	)
 func CreateFunction[T any](
 	fc FunctionOpts,
-	trigger inngest.Triggerable,
+	trigger inngest.Trigger,
 	f SDKFunction[T],
 ) ServableFunction {
 	// Validate that the input type is a concrete type, and not an interface.
@@ -170,7 +215,7 @@ type ServableFunction interface {
 	Config() FunctionOpts
 
 	// Trigger returns the event name or schedule that triggers the function.
-	Trigger() inngest.Triggerable
+	Trigger() inngest.Trigger
 
 	// ZeroEvent returns the zero event type to marshal the event into, given an
 	// event name.
@@ -200,7 +245,7 @@ type InputCtx struct {
 
 type servableFunc struct {
 	fc      FunctionOpts
-	trigger inngest.Triggerable
+	trigger inngest.Trigger
 	f       any
 }
 
@@ -219,7 +264,7 @@ func (s servableFunc) Name() string {
 	return s.fc.Name
 }
 
-func (s servableFunc) Trigger() inngest.Triggerable {
+func (s servableFunc) Trigger() inngest.Trigger {
 	return s.trigger
 }
 

go.mod

@@ -7,8 +7,8 @@ replace github.com/tencentcloud/tencentcloud-sdk-go v3.0.82+incompatible => gith
 require (
 	github.com/gosimple/slug v1.12.0
 	github.com/gowebpki/jcs v1.0.0
-	github.com/inngest/inngest v0.26.3-0.20240229121853-bf40aa29d3af
-	github.com/stretchr/testify v1.8.4
+	github.com/inngest/inngest v0.26.8-0.20240416154023-e5e81de0ebeb
+	github.com/stretchr/testify v1.9.0
 	github.com/xhit/go-str2duration/v2 v2.1.0
 	golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df
 )
@@ -20,6 +20,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dustinkirkland/golang-petname v0.0.0-20191129215211-8e5a1ed0cff0 // indirect
+	github.com/fatih/structs v1.1.0 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/google/cel-go v0.18.2 // indirect
 	github.com/google/uuid v1.6.0 // indirect
@@ -33,6 +34,7 @@ require (
 	github.com/karlseguin/ccache/v2 v2.0.8 // indirect
 	github.com/magiconair/properties v1.8.5 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/ohler55/ojg v1.21.0 // indirect
@@ -50,8 +52,10 @@ require (
 	github.com/stoewer/go-strcase v1.2.0 // indirect
 	github.com/subosito/gotenv v1.2.0 // indirect
 	github.com/zclconf/go-cty v1.8.3 // indirect
-	golang.org/x/sync v0.6.0 // indirect
-	golang.org/x/sys v0.15.0 // indirect
+	go.opentelemetry.io/otel v1.21.0 // indirect
+	go.opentelemetry.io/otel/trace v1.21.0 // indirect
+	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sys v0.19.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20231127180814-3a041ad873d4 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231127180814-3a041ad873d4 // indirect

go.sum

@@ -139,6 +139,8 @@ github.com/evanphx/json-patch v4.2.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLi
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
 github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
+github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
+github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY=
@@ -208,8 +210,8 @@ github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/gofuzz v0.0.0-20161122191042-44d81051d367/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI=
 github.com/google/gofuzz v0.0.0-20170612174753-24818f796faf/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI=
@@ -303,8 +305,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
 github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
 github.com/inngest/expr v0.0.0-20240201152704-a643bc6ace48 h1:32YlbLIeO8HOMzYF3DfRLNX8hKeDb8omccWf03PHyh4=
 github.com/inngest/expr v0.0.0-20240201152704-a643bc6ace48/go.mod h1:Evn0nMuDe2NghjynoNzNwwc8ONXuFVzVr1H93tCwPyE=
-github.com/inngest/inngest v0.26.3-0.20240229121853-bf40aa29d3af h1:x06KIKaXVJeKR5Q5sDLICo0FRMRpHcM3gpfMKL5uyso=
-github.com/inngest/inngest v0.26.3-0.20240229121853-bf40aa29d3af/go.mod h1:AACs06uRhKFHxcC2jHIbi5SeixRKE0BBLdTv2UjB86Q=
+github.com/inngest/inngest v0.26.8-0.20240416154023-e5e81de0ebeb h1:4moS21Kci1loZigWLFBFMm6Zob1pzIefeaiG0DpsLyw=
+github.com/inngest/inngest v0.26.8-0.20240416154023-e5e81de0ebeb/go.mod h1:2nNqpkxhIsO5EmgiQ+UPNPaKQiQ6x9be0QEQGUdGjaA=
 github.com/jhump/protoreflect v1.6.0/go.mod h1:eaTn3RZAmMBcV0fifFvlm6VHNz3wSkYyXYWUh7ymB74=
 github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k=
 github.com/jmespath/go-jmespath v0.3.0/go.mod h1:9QtRXoHjLGCJ5IBSaohpXITPlowMeeYCZ7fLUTSywik=
@@ -361,8 +363,8 @@ github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hd
 github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcMEpPG5Rm84=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
-github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mattn/go-shellwords v1.0.4/go.mod h1:3xCvwCdWdlDJUrvuMn7Wuy9eWs4pE8vqg+NOMyg4B2o=
 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
@@ -472,8 +474,8 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s=
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/tencentcloud/tencentcloud-sdk-go v1.0.191/go.mod h1:asUz5BPXxgoPGaRgZaVm1iGcUAuHyYUo1nXqKa83cvI=
@@ -510,6 +512,10 @@ go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
 go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
+go.opentelemetry.io/otel v1.21.0 h1:hzLeKBZEL7Okw2mGzZ0cc4k/A7Fta0uoPgaJCr8fsFc=
+go.opentelemetry.io/otel v1.21.0/go.mod h1:QZzNPQPm1zLX4gZK4cMi+71eaorMSGT3A4znnUvNNEo=
+go.opentelemetry.io/otel/trace v1.21.0 h1:WD9i5gzvoUPuXIXH24ZNBudiarZDKuekPqi/E8fpfLc=
+go.opentelemetry.io/otel/trace v1.21.0/go.mod h1:LGbsEB0f9LGjN+OZaQQ26sohbOmiMR+BaslueVtS/qQ=
 go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 go.uber.org/zap v1.9.1/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
@@ -620,8 +626,8 @@ golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
-golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
+golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20170830134202-bb24a47a89ea/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -668,8 +674,9 @@ golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
-golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
+golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=

handler.go

@@ -290,6 +290,8 @@ func (h *handler) register(w http.ResponseWriter, r *http.Request) error {
 			Triggers:    inngest.MultipleTriggers{},
 			RateLimit:   fn.Config().GetRateLimit(),
 			Cancel:      fn.Config().Cancel,
+			Timeouts:    (*inngest.Timeouts)(fn.Config().Timeouts),
+			Throttle:    (*inngest.Throttle)(fn.Config().Throttle),
 			Steps: map[string]sdk.SDKStep{
 				"step": {
 					ID:      "step",