feat: Add expiry to VC status store

cmd/orb-server/startcmd/start.go

@@ -460,18 +460,15 @@ func startOrbServices(parameters *orbParameters) error {
 
 	anchorGraph := graph.New(graphProviders)
 
+	expiryService := expiry.NewService(parameters.dataExpiryCheckInterval, configStore, uuid.New().String())
+
 	var updateDocumentStore *unpublishedopstore.Store
-	var expiryService *expiry.Service
 	if parameters.updateDocumentStoreEnabled {
-		expiryService = expiry.NewService(parameters.dataExpiryCheckInterval, configStore, uuid.New().String())
-
 		updateDocumentStore, err = unpublishedopstore.New(storeProviders.provider,
 			parameters.unpublishedOperationLifespan, expiryService)
 		if err != nil {
 			return fmt.Errorf("failed to create unpublished document store: %w", err)
 		}
-
-		expiryService.Start()
 	}
 
 	// get protocol client provider
@@ -528,7 +525,7 @@ func startOrbServices(parameters *orbParameters) error {
 		return fmt.Errorf("failed to create proof store: %s", err.Error())
 	}
 
-	vcStatusStore, err := vcstatus.New(storeProviders.provider)
+	vcStatusStore, err := vcstatus.New(storeProviders.provider, expiryService, parameters.maxWitnessDelay)
 	if err != nil {
 		return fmt.Errorf("failed to create vc status store: %s", err.Error())
 	}
@@ -720,6 +717,9 @@ func startOrbServices(parameters *orbParameters) error {
 	batchWriter.Start()
 	logger.Infof("started batch writer")
 
+	// start expiry service
+	expiryService.Start()
+
 	var didDocHandlerOpts []dochandler.Option
 	didDocHandlerOpts = append(didDocHandlerOpts, dochandler.WithDomain("https:"+u.Host))
 	didDocHandlerOpts = append(didDocHandlerOpts, dochandler.WithLabel(unpublishedDIDLabel))

pkg/anchor/handler/proof/handler_test.go

@@ -75,7 +75,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -124,7 +124,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -168,7 +168,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusCompleted)
@@ -201,7 +201,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -409,7 +409,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -444,7 +444,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -475,7 +475,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		vcStore, err := anchoreventstore.New(provider, testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(vcID, proofapi.VCStatusInProcess)
@@ -507,7 +507,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -540,7 +540,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		err = vcStore.Put(ae)
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)
@@ -567,7 +567,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		vcStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(vcID, proofapi.VCStatusInProcess)
@@ -602,7 +602,7 @@ func TestWitnessProofHandler(t *testing.T) {
 		monitoringSvc := &mocks.MonitoringService{}
 		monitoringSvc.WatchReturns(fmt.Errorf("monitoring error"))
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		err = vcStatusStore.AddStatus(ae.Anchors().String(), proofapi.VCStatusInProcess)

pkg/anchor/writer/writer_test.go

@@ -143,7 +143,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -193,7 +193,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -245,7 +245,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -298,7 +298,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 
 		wit := &mockWitness{proofBytes: []byte(`{"proof": {"domain":"domain","created": "2021-02-23T19:36:07Z"}}`)}
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -484,7 +484,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -745,7 +745,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -798,7 +798,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{
@@ -841,7 +841,7 @@ func TestWriter_WriteAnchor(t *testing.T) {
 		anchorEventStore, err := anchoreventstore.New(mem.NewProvider(), testutil.GetLoader(t))
 		require.NoError(t, err)
 
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		activityStore := memstore.New("")
@@ -1202,7 +1202,7 @@ func TestWriter_postOfferActivity(t *testing.T) {
 	require.NoError(t, json.Unmarshal([]byte(jsonAnchorEvent), anchorEvent))
 
 	t.Run("success", func(t *testing.T) {
-		vcStatusStore, err := vcstatus.New(mem.NewProvider())
+		vcStatusStore, err := vcstatus.New(mem.NewProvider(), testutil.GetExpiryService(t), time.Minute)
 		require.NoError(t, err)
 
 		providers := &Providers{

pkg/internal/testutil/testutil.go

@@ -11,6 +11,7 @@ import (
 	"fmt"
 	"net/url"
 	"testing"
+	"time"
 
 	"github.com/hyperledger/aries-framework-go/component/storageutil/mem"
 	"github.com/hyperledger/aries-framework-go/pkg/doc/ld"
@@ -19,6 +20,7 @@ import (
 	"github.com/trustbloc/sidetree-core-go/pkg/canonicalizer"
 
 	"github.com/trustbloc/orb/internal/pkg/ldcontext"
+	"github.com/trustbloc/orb/pkg/store/expiry"
 )
 
 // MustParseURL parses the given string and returns the URL.
@@ -96,3 +98,14 @@ func GetLoader(t *testing.T) *ld.DocumentLoader {
 
 	return documentLoader
 }
+
+// GetExpiryService returns test expiry service object. For most tests, the expiry service used doesn't really matter
+// this object is just needed to ensure that no nil pointer errors happen when initializing the store.
+func GetExpiryService(t *testing.T) *expiry.Service {
+	t.Helper()
+
+	coordinationStore, err := mem.NewProvider().OpenStore("coordination")
+	require.NoError(t, err)
+
+	return expiry.NewService(time.Second, coordinationStore, "TestInstanceID")
+}

pkg/store/operation/unpublished/store_test.go

@@ -17,20 +17,21 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/trustbloc/sidetree-core-go/pkg/api/operation"
 
+	"github.com/trustbloc/orb/pkg/internal/testutil"
 	"github.com/trustbloc/orb/pkg/store/expiry"
 )
 
 func TestNew(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 		require.NotNil(t, s)
 	})
 
 	t.Run("error - from open store", func(t *testing.T) {
 		s, err := New(&mockstore.Provider{
 			ErrOpenStore: fmt.Errorf("failed to open store"),
-		}, time.Minute, getTestExpiryService(t))
+		}, time.Minute, testutil.GetExpiryService(t))
 		require.Error(t, err)
 		require.Contains(t, err.Error(), "failed to open store")
 		require.Nil(t, s)
@@ -39,7 +40,7 @@ func TestNew(t *testing.T) {
 
 func TestStore_Put(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -69,7 +70,7 @@ func TestStore_Put(t *testing.T) {
 			ErrGet: fmt.Errorf("random get error"),
 		}}
 
-		s, err := New(storeProvider, time.Minute, getTestExpiryService(t))
+		s, err := New(storeProvider, time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -79,7 +80,7 @@ func TestStore_Put(t *testing.T) {
 	})
 
 	t.Run("error - consecutive put", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -94,7 +95,7 @@ func TestStore_Put(t *testing.T) {
 
 func TestStore_Get(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -106,7 +107,7 @@ func TestStore_Get(t *testing.T) {
 	})
 
 	t.Run("error - operation without suffix", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{})
@@ -119,7 +120,7 @@ func TestStore_Get(t *testing.T) {
 			ErrGet: fmt.Errorf("error get"),
 		}}
 
-		s, err := New(storeProvider, time.Minute, getTestExpiryService(t))
+		s, err := New(storeProvider, time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		op, err := s.Get("suffix")
@@ -137,7 +138,7 @@ func TestStore_Get(t *testing.T) {
 		err = store.Put("suffix", []byte("not-json"))
 		require.NoError(t, err)
 
-		s, err := New(provider, time.Minute, getTestExpiryService(t))
+		s, err := New(provider, time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		op, err := s.Get("suffix")
@@ -149,7 +150,7 @@ func TestStore_Get(t *testing.T) {
 
 func TestStore_Delete(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -164,7 +165,7 @@ func TestStore_Delete(t *testing.T) {
 			ErrDelete: fmt.Errorf("delete error"),
 		}}
 
-		s, err := New(storeProvider, time.Minute, getTestExpiryService(t))
+		s, err := New(storeProvider, time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Delete("suffix")
@@ -175,7 +176,7 @@ func TestStore_Delete(t *testing.T) {
 
 func TestStore_DeleteAll(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.Put(&operation.AnchoredOperation{UniqueSuffix: "suffix"})
@@ -186,7 +187,7 @@ func TestStore_DeleteAll(t *testing.T) {
 	})
 
 	t.Run("success - no suffixes provided", func(t *testing.T) {
-		s, err := New(mem.NewProvider(), time.Minute, getTestExpiryService(t))
+		s, err := New(mem.NewProvider(), time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.DeleteAll(nil)
@@ -198,22 +199,11 @@ func TestStore_DeleteAll(t *testing.T) {
 			ErrBatch: fmt.Errorf("batch error"),
 		}}
 
-		s, err := New(storeProvider, time.Minute, getTestExpiryService(t))
+		s, err := New(storeProvider, time.Minute, testutil.GetExpiryService(t))
 		require.NoError(t, err)
 
 		err = s.DeleteAll([]string{"suffix"})
 		require.Error(t, err)
 		require.Contains(t, err.Error(), "batch error")
 	})
 }
-
-// Returns an example expiry service object. For these tests, the expiry service used doesn't really matter - this
-// object is just needed to ensure that no nil pointer errors happen when initializing the unpublished operation store.
-func getTestExpiryService(t *testing.T) *expiry.Service {
-	t.Helper()
-
-	coordinationStore, err := mem.NewProvider().OpenStore("coordination")
-	require.NoError(t, err)
-
-	return expiry.NewService(time.Second, coordinationStore, "TestInstanceID")
-}