address comments

Author: shijiesheng

internal/batch/batch_future.go

@@ -9,12 +9,8 @@ import (
 	"go.uber.org/cadence/internal"
 )
 
-type BatchFuture interface {
-	internal.Future
-	GetFutures() []internal.Future
-}
-
-type batchFutureImpl struct {
+// BatchFutureImpl is an implementation of BatchFuture
+type BatchFutureImpl struct {
 	futures   []internal.Future
 	settables []internal.Settable
 	factories []func(ctx internal.Context) internal.Future
@@ -24,7 +20,7 @@ type batchFutureImpl struct {
 	wg internal.WaitGroup
 }
 
-func NewBatchFuture(ctx internal.Context, batchSize int, factories []func(ctx internal.Context) internal.Future) (BatchFuture, error) {
+func NewBatchFuture(ctx internal.Context, batchSize int, factories []func(ctx internal.Context) internal.Future) (*BatchFutureImpl, error) {
 	var futures []internal.Future
 	var settables []internal.Settable
 	for range factories {
@@ -33,7 +29,7 @@ func NewBatchFuture(ctx internal.Context, batchSize int, factories []func(ctx in
 		settables = append(settables, settable)
 	}
 
-	batchFuture := &batchFutureImpl{
+	batchFuture := &BatchFutureImpl{
 		futures:   futures,
 		settables: settables,
 		factories: factories,
@@ -45,11 +41,11 @@ func NewBatchFuture(ctx internal.Context, batchSize int, factories []func(ctx in
 	return batchFuture, nil
 }
 
-func (b *batchFutureImpl) GetFutures() []internal.Future {
+func (b *BatchFutureImpl) GetFutures() []internal.Future {
 	return b.futures
 }
 
-func (b *batchFutureImpl) start(ctx internal.Context) {
+func (b *BatchFutureImpl) start(ctx internal.Context) {
 
 	buffered := internal.NewBufferedChannel(ctx, b.batchSize) // buffered channel to limit the number of concurrent futures
 	channel := internal.NewNamedChannel(ctx, "batch-future-channel")
@@ -91,7 +87,7 @@ func (b *batchFutureImpl) start(ctx internal.Context) {
 	})
 }
 
-func (b *batchFutureImpl) IsReady() bool {
+func (b *BatchFutureImpl) IsReady() bool {
 	for _, future := range b.futures {
 		if !future.IsReady() {
 			return false
@@ -105,7 +101,7 @@ func (b *batchFutureImpl) IsReady() bool {
 // If valuePtr is a pointer to a slice, the slice will be resized to the length of the futures. Each element of the slice will be assigned with the underlying Future.Get() and thus behaves the same way.
 // If valuePtr is nil, no assignment will be made.
 // If error occurs, values will be set on successful futures and the errors of failed futures will be returned.
-func (b *batchFutureImpl) Get(ctx internal.Context, valuePtr interface{}) error {
+func (b *BatchFutureImpl) Get(ctx internal.Context, valuePtr interface{}) error {
 	// No assignment if valuePtr is nil
 	if valuePtr == nil {
 		b.wg.Wait(ctx)

internal/batch/batch_future_test.go

@@ -174,42 +174,6 @@ func Test_BatchWorkflowUsingFutures(t *testing.T) {
 	assert.Equal(t, expected, result)
 }
 
-func futureTest(ctx internal.Context) error {
-	f, s := internal.NewFuture(ctx)
-	f2, s2 := internal.NewFuture(ctx)
-	s2.Chain(f)
-
-	wg := internal.NewWaitGroup(ctx)
-	wg.Add(1)
-	internal.GoNamed(ctx, "future-test", func(ctx internal.Context) {
-		defer wg.Done()
-		internal.Sleep(ctx, time.Second*10)
-		s.Set(1, nil)
-	})
-
-	err := f2.Get(ctx, nil)
-	if err != nil {
-		return err
-	}
-
-	err = f.Get(ctx, nil)
-	if err != nil {
-		return err
-	}
-
-	wg.Wait(ctx)
-	return err
-}
-
-func Test_Futures(t *testing.T) {
-	testSuite := &testsuite.WorkflowTestSuite{}
-	env := testSuite.NewTestWorkflowEnvironment()
-
-	env.RegisterWorkflow(futureTest)
-
-	env.ExecuteWorkflow(futureTest)
-}
-
 func batchWorkflowAssignWithSlice(ctx internal.Context) ([]int, error) {
 	totalSize := 5
 	concurrency := 2
@@ -287,11 +251,10 @@ func batchWorkflowAssignWithNil(ctx internal.Context) ([]int, error) {
 		return nil, err
 	}
 
-	var valuePtr []int
 	if err := batchFuture.Get(ctx, nil); err != nil {
 		return nil, err
 	}
-	return valuePtr, nil
+	return nil, nil
 }
 
 func Test_BatchFuture_Get(t *testing.T) {

internal/workflow_testsuite.go

@@ -601,12 +601,7 @@ func (t *TestWorkflowEnvironment) GetWorkflowResult(valuePtr interface{}) error
 	if !t.impl.isTestCompleted {
 		panic("workflow is not completed")
 	}
-	// fast lane for no result assignment
-	if t.impl.testResult == nil || t.impl.testResult.HasValue() == false || valuePtr == nil {
-		return t.impl.testError
-	}
-	if t.impl.testError != nil {
-		t.impl.testResult.Get(valuePtr)
+	if t.impl.testError != nil || t.impl.testResult == nil || t.impl.testResult.HasValue() == false || valuePtr == nil {
 		return t.impl.testError
 	}
 	return t.impl.testResult.Get(valuePtr)

x/doc.go

@@ -1,5 +1,2 @@
+// Package x is an experimental package for early-stage features. The API here is not stable and may change.
 package x
-
-/*
-Package x is an experimental package for early-stage features. The API here is not stable and may change.
-*/