Interfaces: Update all component interfaces to implement io.Closer (#…

…3542) Signed-off-by: joshvanl <[email protected]>
dapr · Sep 19, 2024 · be7c19b · be7c19b
1 parent 6d12e84
commit be7c19b
Show file tree

Hide file tree

Showing 68 changed files with 580 additions and 273 deletions.
diff --git a/.build-tools/go.mod b/.build-tools/go.mod
@@ -12,7 +12,7 @@ require (
 )
 
 require (
-	github.com/dapr/kit v0.13.1-0.20240402103809-0c7cfce53d9e // indirect
+	github.com/dapr/kit v0.13.1-0.20240909215017-3823663aa4bb // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect

diff --git a/.build-tools/go.sum b/.build-tools/go.sum
@@ -1,6 +1,6 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
-github.com/dapr/kit v0.13.1-0.20240402103809-0c7cfce53d9e h1:mLvqfGuppb6uhsijmwTlF5sZVtGvig+Ua5ESKF17SxA=
-github.com/dapr/kit v0.13.1-0.20240402103809-0c7cfce53d9e/go.mod h1:dons8V2bF6MPR2yFdxtTa86PfaE7EJtKAOkZ9hOavBQ=
+github.com/dapr/kit v0.13.1-0.20240909215017-3823663aa4bb h1:ahLO7pMmX6HAuT6/RxYWBY4AN2fXQJcYlU1msY6Kt7U=
+github.com/dapr/kit v0.13.1-0.20240909215017-3823663aa4bb/go.mod h1:Hz1W2LmWfA4UX/12MdA+brsf+np6f/1dJt6C6F63cjI=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

diff --git a/.github/workflows/certification.yml b/.github/workflows/certification.yml
@@ -259,7 +259,7 @@ jobs:
         set +e
         gotestsum --jsonfile ${{ env.TEST_OUTPUT_FILE_PREFIX }}_certification.json \
           --junitfile ${{ env.TEST_OUTPUT_FILE_PREFIX }}_certification.xml --format standard-quiet -- \
-          -coverprofile=cover.out -covermode=set -tags=certtests -timeout=30m -coverpkg=${{ matrix.source-pkg }}
+          -coverprofile=cover.out -covermode=set  -tags=certtests,unit -timeout=30m -coverpkg=${{ matrix.source-pkg }}
         status=$?
         echo "Completed certification tests for ${{ matrix.component }} ... "
         if test $status -ne 0; then

diff --git a/bindings/alicloud/oss/oss.go b/bindings/alicloud/oss/oss.go
@@ -114,3 +114,7 @@ func (s *AliCloudOSS) GetComponentMetadata() (metadataInfo metadata.MetadataMap)
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (s *AliCloudOSS) Close() error {
+	return nil
+}
diff --git a/bindings/alicloud/sls/sls.go b/bindings/alicloud/sls/sls.go
@@ -134,3 +134,11 @@ func (s *AliCloudSlsLogstorage) GetComponentMetadata() (metadataInfo metadata.Me
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (s *AliCloudSlsLogstorage) Close() error {
+	if s.producer != nil {
+		return s.producer.Close(time.Second.Milliseconds() * 5)
+	}
+
+	return nil
+}
diff --git a/bindings/alicloud/tablestore/tablestore.go b/bindings/alicloud/tablestore/tablestore.go
@@ -353,3 +353,7 @@ func (s *AliCloudTableStore) GetComponentMetadata() (metadataInfo contribMetadat
 	contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.BindingType)
 	return
 }
+
+func (s *AliCloudTableStore) Close() error {
+	return nil
+}
diff --git a/bindings/apns/apns.go b/bindings/apns/apns.go
@@ -267,3 +267,7 @@ func (a *APNS) GetComponentMetadata() (metadataInfo contribMetadata.MetadataMap)
 	contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.BindingType)
 	return
 }
+
+func (a *APNS) Close() error {
+	return nil
+}
diff --git a/bindings/aws/dynamodb/dynamodb.go b/bindings/aws/dynamodb/dynamodb.go
@@ -121,3 +121,7 @@ func (d *DynamoDB) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (d *DynamoDB) Close() error {
+	return nil
+}
diff --git a/bindings/aws/ses/ses.go b/bindings/aws/ses/ses.go
@@ -175,3 +175,7 @@ func (a *AWSSES) GetComponentMetadata() (metadataInfo contribMetadata.MetadataMa
 	contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.BindingType)
 	return
 }
+
+func (a *AWSSES) Close() error {
+	return nil
+}
diff --git a/bindings/aws/sns/sns.go b/bindings/aws/sns/sns.go
@@ -125,3 +125,7 @@ func (a *AWSSNS) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (a *AWSSNS) Close() error {
+	return nil
+}
diff --git a/bindings/azure/blobstorage/blobstorage.go b/bindings/azure/blobstorage/blobstorage.go
@@ -377,3 +377,7 @@ func (a *AzureBlobStorage) GetComponentMetadata() (metadataInfo contribMetadata.
 	contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.BindingType)
 	return
 }
+
+func (a *AzureBlobStorage) Close() error {
+	return nil
+}
diff --git a/bindings/azure/cosmosdb/cosmosdb.go b/bindings/azure/cosmosdb/cosmosdb.go
@@ -198,3 +198,7 @@ func (c *CosmosDB) GetComponentMetadata() (metadataInfo contribMetadata.Metadata
 	contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.BindingType)
 	return
 }
+
+func (c *CosmosDB) Close() error {
+	return nil
+}
diff --git a/bindings/azure/cosmosdbgremlinapi/cosmosdbgremlinapi.go b/bindings/azure/cosmosdbgremlinapi/cosmosdbgremlinapi.go
@@ -46,7 +46,7 @@ const (
 // CosmosDBGremlinAPI allows performing state operations on collections.
 type CosmosDBGremlinAPI struct {
 	metadata *cosmosDBGremlinAPICredentials
-	client   *gremcos.Cosmos
+	client   gremcos.Cosmos
 	logger   logger.Logger
 }
 
@@ -77,7 +77,7 @@ func (c *CosmosDBGremlinAPI) Init(_ context.Context, metadata bindings.Metadata)
 		return errors.New("CosmosDBGremlinAPI Error: failed to create the Cosmos Graph DB connector")
 	}
 
-	c.client = &client
+	c.client = client
 
 	return nil
 }
@@ -116,7 +116,7 @@ func (c *CosmosDBGremlinAPI) Invoke(_ context.Context, req *bindings.InvokeReque
 			respStartTimeKey: startTime.Format(time.RFC3339Nano),
 		},
 	}
-	d, err := (*c.client).Execute(gq)
+	d, err := c.client.Execute(gq)
 	if err != nil {
 		return nil, errors.New("CosmosDBGremlinAPI Error:error excuting gremlin")
 	}
@@ -136,3 +136,10 @@ func (c *CosmosDBGremlinAPI) GetComponentMetadata() (metadataInfo metadata.Metad
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (c *CosmosDBGremlinAPI) Close() error {
+	if c.client != nil {
+		return c.client.Stop()
+	}
+	return nil
+}
diff --git a/bindings/azure/signalr/signalr.go b/bindings/azure/signalr/signalr.go
@@ -419,3 +419,7 @@ func (s *SignalR) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (s *SignalR) Close() error {
+	return nil
+}
diff --git a/bindings/dubbo/dubbo_output.go b/bindings/dubbo/dubbo_output.go
@@ -97,3 +97,7 @@ func (out *DubboOutputBinding) Operations() []bindings.OperationKind {
 func (out *DubboOutputBinding) GetComponentMetadata() metadata.MetadataMap {
 	return metadata.MetadataMap{}
 }
+
+func (out *DubboOutputBinding) Close() error {
+	return nil
+}
diff --git a/bindings/graphql/graphql.go b/bindings/graphql/graphql.go
@@ -192,3 +192,7 @@ func (gql *GraphQL) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (gql *GraphQL) Close() error {
+	return nil
+}
diff --git a/bindings/http/http.go b/bindings/http/http.go
@@ -370,3 +370,7 @@ func (h *HTTPSource) GetComponentMetadata() (metadataInfo metadata.MetadataMap)
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (h *HTTPSource) Close() error {
+	return nil
+}
diff --git a/bindings/huawei/obs/obs.go b/bindings/huawei/obs/obs.go
@@ -338,3 +338,10 @@ func (o *HuaweiOBS) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (o *HuaweiOBS) Close() error {
+	if o.service != nil {
+		o.service.Close()
+	}
+	return nil
+}
diff --git a/bindings/huawei/obs/obs_service.go b/bindings/huawei/obs/obs_service.go
@@ -27,6 +27,7 @@ type HuaweiOBSAPI interface {
 	GetObject(ctx context.Context, input *obs.GetObjectInput) (output *obs.GetObjectOutput, err error)
 	DeleteObject(ctx context.Context, input *obs.DeleteObjectInput) (output *obs.DeleteObjectOutput, err error)
 	ListObjects(ctx context.Context, input *obs.ListObjectsInput) (output *obs.ListObjectsOutput, err error)
+	Close()
 }
 
 // HuaweiOBSService is a service layer which wraps the actual OBS SDK client to provide the API functions
@@ -54,3 +55,7 @@ func (s *HuaweiOBSService) DeleteObject(ctx context.Context, input *obs.DeleteOb
 func (s *HuaweiOBSService) ListObjects(ctx context.Context, input *obs.ListObjectsInput) (output *obs.ListObjectsOutput, err error) {
 	return s.client.ListObjects(input, obs.WithRequestContext(ctx))
 }
+
+func (s *HuaweiOBSService) Close() {
+	s.client.Close()
+}
diff --git a/bindings/huawei/obs/obs_test.go b/bindings/huawei/obs/obs_test.go
@@ -61,6 +61,8 @@ func (m *MockHuaweiOBSService) ListObjects(ctx context.Context, input *obs.ListO
 	return m.ListObjectsFn(ctx, input)
 }
 
+func (m *MockHuaweiOBSService) Close() {}
+
 func TestParseMetadata(t *testing.T) {
 	obs := NewHuaweiOBS(logger.NewLogger("test")).(*HuaweiOBS)
 

diff --git a/bindings/kitex/kitex_output.go b/bindings/kitex/kitex_output.go
@@ -83,3 +83,7 @@ func (out *kitexOutputBinding) Operations() []bindings.OperationKind {
 func (out *kitexOutputBinding) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	return
 }
+
+func (out *kitexOutputBinding) Close() error {
+	return nil
+}
diff --git a/bindings/localstorage/localstorage.go b/bindings/localstorage/localstorage.go
@@ -342,3 +342,7 @@ func (ls *LocalStorage) GetComponentMetadata() (metadataInfo metadata.MetadataMa
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (ls *LocalStorage) Close() error {
+	return nil
+}
diff --git a/bindings/output_binding.go b/bindings/output_binding.go
@@ -16,6 +16,7 @@ package bindings
 import (
 	"context"
 	"fmt"
+	"io"
 
 	"github.com/dapr/components-contrib/health"
 	"github.com/dapr/components-contrib/metadata"
@@ -28,6 +29,7 @@ type OutputBinding interface {
 	Init(ctx context.Context, metadata Metadata) error
 	Invoke(ctx context.Context, req *InvokeRequest) (*InvokeResponse, error)
 	Operations() []OperationKind
+	io.Closer
 }
 
 func PingOutBinding(ctx context.Context, outputBinding OutputBinding) error {

diff --git a/bindings/postmark/postmark.go b/bindings/postmark/postmark.go
@@ -167,3 +167,7 @@ func (p *Postmark) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (p *Postmark) Close() error {
+	return nil
+}
diff --git a/bindings/smtp/smtp.go b/bindings/smtp/smtp.go
@@ -237,3 +237,7 @@ func (s *Mailer) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (s *Mailer) Close() error {
+	return nil
+}
diff --git a/bindings/twilio/sendgrid/sendgrid.go b/bindings/twilio/sendgrid/sendgrid.go
@@ -271,6 +271,10 @@ func (sg *SendGrid) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	return
 }
 
+func (sg *SendGrid) Close() error {
+	return nil
+}
+
 // Function that unmarshals the Dynamic Template Data JSON String into a map[string]any.
 func UnmarshalDynamicTemplateData(jsonString string, result *map[string]any) error {
 	err := json.Unmarshal([]byte(jsonString), &result)
@@ -279,3 +283,7 @@ func UnmarshalDynamicTemplateData(jsonString string, result *map[string]any) err
 	}
 	return nil
 }
+
+func Close() error {
+	return nil
+}
diff --git a/bindings/twilio/sms/sms.go b/bindings/twilio/sms/sms.go
@@ -141,3 +141,7 @@ func (t *SMS) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (t *SMS) Close() error {
+	return nil
+}
diff --git a/bindings/zeebe/command/command.go b/bindings/zeebe/command/command.go
@@ -138,3 +138,10 @@ func (z *ZeebeCommand) GetComponentMetadata() (metadataInfo metadata.MetadataMap
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType)
 	return
 }
+
+func (z *ZeebeCommand) Close() error {
+	if z.client != nil {
+		return z.client.Close()
+	}
+	return nil
+}
diff --git a/common/component/redis/redis.go b/common/component/redis/redis.go
@@ -100,7 +100,6 @@ type ConfigurationSubscribeArgs struct {
 	RedisChannel           string
 	IsAllKeysChannel       bool
 	ID                     string
-	Stop                   chan struct{}
 }
 
 func ParseClientFromProperties(properties map[string]string, componentType metadata.ComponentType, ctx context.Context, logger *kitlogger.Logger) (RedisClient, *Settings, error) {

diff --git a/common/component/redis/v8client.go b/common/component/redis/v8client.go
@@ -86,8 +86,6 @@ func (c v8Client) ConfigurationSubscribe(ctx context.Context, args *Configuratio
 	defer p.Close()
 	for {
 		select {
-		case <-args.Stop:
-			return
 		case <-ctx.Done():
 			return
 		case msg := <-p.Channel():

diff --git a/common/component/redis/v9client.go b/common/component/redis/v9client.go
@@ -94,8 +94,6 @@ func (c v9Client) ConfigurationSubscribe(ctx context.Context, args *Configuratio
 	defer p.Close()
 	for {
 		select {
-		case <-args.Stop:
-			return
 		case <-ctx.Done():
 			return
 		case msg := <-p.Channel():