feat: configurable receipt timestamps

Author: alanshaw

execution/dispatcher/dispatcher.go

@@ -17,9 +17,10 @@ type handler struct {
 // Dispatcher executes UCAN invocations by dispatching them to registered
 // handlers.
 type Dispatcher struct {
-	authority      principal.Signer
-	handlers       map[ucan.Command]handler
-	validationOpts []validator.Option
+	authority         principal.Signer
+	handlers          map[ucan.Command]handler
+	validationOpts    []validator.Option
+	receiptTimestamps bool
 }
 
 // New creates an invocation executor that executes UCAN invocations by
@@ -33,9 +34,10 @@ func New(authority principal.Signer, options ...Option) *Dispatcher {
 		opt(&cfg)
 	}
 	return &Dispatcher{
-		authority:      authority,
-		handlers:       map[ucan.Command]handler{},
-		validationOpts: cfg.validationOpts,
+		authority:         authority,
+		handlers:          map[ucan.Command]handler{},
+		validationOpts:    cfg.validationOpts,
+		receiptTimestamps: cfg.receiptTimestamps,
 	}
 }
 
@@ -52,6 +54,7 @@ func (d *Dispatcher) Execute(req execution.Request) (execution.Response, error)
 		return execution.NewResponse(
 			req.Invocation().Task().Link(),
 			execution.WithSigner(d.authority),
+			execution.WithReceiptTimestamp(d.receiptTimestamps),
 			execution.WithFailure(execution.NewInvalidAudienceError(d.authority, aud)),
 		)
 	}
@@ -62,6 +65,7 @@ func (d *Dispatcher) Execute(req execution.Request) (execution.Response, error)
 		return execution.NewResponse(
 			req.Invocation().Task().Link(),
 			execution.WithSigner(d.authority),
+			execution.WithReceiptTimestamp(d.receiptTimestamps),
 			execution.WithFailure(NewHandlerNotFoundError(cmd)),
 		)
 	}
@@ -82,11 +86,16 @@ func (d *Dispatcher) Execute(req execution.Request) (execution.Response, error)
 		return execution.NewResponse(
 			req.Invocation().Task().Link(),
 			execution.WithSigner(d.authority),
+			execution.WithReceiptTimestamp(d.receiptTimestamps),
 			execution.WithFailure(err),
 		)
 	}
 
-	res, err := execution.NewResponse(req.Invocation().Task().Link(), execution.WithSigner(d.authority))
+	res, err := execution.NewResponse(
+		req.Invocation().Task().Link(),
+		execution.WithSigner(d.authority),
+		execution.WithReceiptTimestamp(d.receiptTimestamps),
+	)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create response: %w", err)
 	}
@@ -96,6 +105,7 @@ func (d *Dispatcher) Execute(req execution.Request) (execution.Response, error)
 		return execution.NewResponse(
 			req.Invocation().Task().Link(),
 			execution.WithSigner(d.authority),
+			execution.WithReceiptTimestamp(d.receiptTimestamps),
 			execution.WithFailure(execution.NewHandlerExecutionError(cmd, err)),
 		)
 	}

execution/dispatcher/options.go

@@ -8,11 +8,20 @@ import (
 type Option func(cfg *execConfig)
 
 type execConfig struct {
-	validationOpts []validator.Option
+	validationOpts    []validator.Option
+	receiptTimestamps bool
 }
 
 func WithValidationOptions(options ...validator.Option) Option {
 	return func(cfg *execConfig) {
 		cfg.validationOpts = append(cfg.validationOpts, options...)
 	}
 }
+
+// WithReceiptTimestamps configures the dispatcher to issue receipts with
+// issuance timestamps or not.
+func WithReceiptTimestamps(enabled bool) Option {
+	return func(cfg *execConfig) {
+		cfg.receiptTimestamps = enabled
+	}
+}

execution/response.go

@@ -14,10 +14,11 @@ import (
 )
 
 type ExecResponse struct {
-	signer   ucan.Signer
-	task     cid.Cid
-	receipt  ucan.Receipt
-	metadata ucan.Container
+	signer           ucan.Signer
+	task             cid.Cid
+	receipt          ucan.Receipt
+	metadata         ucan.Container
+	receiptTimestamp bool
 }
 
 type ResponseOption func(r *ExecResponse) error
@@ -36,6 +37,16 @@ func WithReceipt(receipt ucan.Receipt) ResponseOption {
 	}
 }
 
+// WithReceiptTimestamp configures the response to issue receipts with
+// issuance timestamps. Note: this option should be ordered before [WithSuccess]
+// or [WithFailure], since these options issue a receipt.
+func WithReceiptTimestamp(enabled bool) ResponseOption {
+	return func(resp *ExecResponse) error {
+		resp.receiptTimestamp = enabled
+		return nil
+	}
+}
+
 // WithSuccess issues and sets a receipt for a successful execution of a task.
 func WithSuccess(o ipld.Any) ResponseOption {
 	return func(resp *ExecResponse) error {

server/http.go

@@ -31,11 +31,16 @@ func NewHTTP(id principal.Signer, options ...HTTPOption) *HTTPServer {
 	for _, opt := range options {
 		opt(&cfg)
 	}
-	executor := dispatcher.New(id, dispatcher.WithValidationOptions(cfg.validationOpts...))
+	executor := dispatcher.New(
+		id,
+		dispatcher.WithValidationOptions(cfg.validationOpts...),
+		dispatcher.WithReceiptTimestamps(cfg.receiptTimestamps),
+	)
 	return &HTTPServer{
-		id:       id,
-		codec:    cfg.codec,
-		executor: executor,
+		id:        id,
+		codec:     cfg.codec,
+		executor:  executor,
+		listeners: cfg.listeners,
 	}
 }
 

server/http_test.go

@@ -4,6 +4,7 @@ import (
 	"io"
 	"net/http"
 	"testing"
+	"time"
 
 	"github.com/alanshaw/ucantone/execution"
 	"github.com/alanshaw/ucantone/ipld"
@@ -22,7 +23,7 @@ func TestHTTPServer(t *testing.T) {
 	alice := testutil.RandomSigner(t)
 
 	t.Run("invocation execution round trip", func(t *testing.T) {
-		server := server.NewHTTP(service)
+		server := server.NewHTTP(service, server.WithReceiptTimestamps(true))
 
 		var messages []ipld.Any
 		server.Handle(testutil.ConsoleLogCapability, func(req execution.Request, res execution.Response) error {
@@ -97,8 +98,13 @@ func TestHTTPServer(t *testing.T) {
 		require.NoError(t, err)
 
 		require.Len(t, ctResp.Receipts(), 1)
+		rcpt := ctResp.Receipts()[0]
 
-		o, x := result.Unwrap(ctResp.Receipts()[0].Out())
+		require.NotNil(t, rcpt.IssuedAt())
+		// we can't assert an exact timestamp, but check that it is recent
+		require.GreaterOrEqual(t, int64(*rcpt.IssuedAt()), time.Now().Add(-time.Second).Unix())
+
+		o, x := result.Unwrap(rcpt.Out())
 		require.NotNil(t, o)
 		require.Nil(t, x)
 		t.Log(o)

server/options.go

@@ -11,9 +11,10 @@ import (
 type HTTPOption func(cfg *httpServerConfig)
 
 type httpServerConfig struct {
-	codec          transport.InboundCodec[*http.Request, *http.Response]
-	validationOpts []validator.Option
-	listeners      []EventListener
+	codec             transport.InboundCodec[*http.Request, *http.Response]
+	validationOpts    []validator.Option
+	receiptTimestamps bool
+	listeners         []EventListener
 }
 
 func WithHTTPCodec(codec transport.InboundCodec[*http.Request, *http.Response]) HTTPOption {
@@ -28,6 +29,14 @@ func WithValidationOptions(options ...validator.Option) HTTPOption {
 	}
 }
 
+// WithReceiptTimestamps configures the server to issue receipts with
+// issuance timestamps or not.
+func WithReceiptTimestamps(enabled bool) HTTPOption {
+	return func(cfg *httpServerConfig) {
+		cfg.receiptTimestamps = enabled
+	}
+}
+
 // WithEventListener adds an event listener to the HTTP server for monitoring
 // requests and responses.
 func WithEventListener(listener EventListener) HTTPOption {