Add specialized erroring to files and blobfs creators

Author: adreed-msft

common/folderCreationTracker_interface.go

@@ -14,11 +14,11 @@ type Prompter interface {
 	ShouldOverwrite(objectPath string, objectType EntityType) bool
 }
 
-// FolderCreationErrorFolderAlreadyExists is a signalling error that should be
+// FolderCreationErrorAlreadyExists is a signalling error that should be
 // returned by doCreation on FolderCreationTracker.CreateFolder for supported folder-creators.
 // This will inform the folder creation tracker to _not_ try to create the folder.
-type FolderCreationErrorFolderAlreadyExists struct{}
+type FolderCreationErrorAlreadyExists struct{}
 
-func (f FolderCreationErrorFolderAlreadyExists) Error() string {
+func (f FolderCreationErrorAlreadyExists) Error() string {
 	return "not a real error"
 }

jobsAdmin/init.go

@@ -414,6 +414,7 @@ func resurrectJobSummary(jm ste.IJobMgr) common.ListJobSummaryResponse {
 			switch jppt.TransferStatus() {
 			case common.ETransferStatus.NotStarted(),
 				common.ETransferStatus.FolderCreated(),
+				common.ETransferStatus.FolderExisted(),
 				common.ETransferStatus.Started(),
 				common.ETransferStatus.Restarted(),
 				common.ETransferStatus.Cancelled():

ste/folderCreationTracker.go

@@ -145,7 +145,7 @@ func (f *jpptFolderTracker) CreateFolder(folder string, doCreation func() error)
 	}
 
 	err := doCreation()
-	if err != nil && !errors.Is(err, common.FolderCreationErrorFolderAlreadyExists{}) {
+	if err != nil && !errors.Is(err, common.FolderCreationErrorAlreadyExists{}) {
 		return err
 	}
 
@@ -155,7 +155,7 @@ func (f *jpptFolderTracker) CreateFolder(folder string, doCreation func() error)
 
 	if err == nil { // first, update our internal status, then,
 		state.Status = EJpptFolderTrackerStatus.FolderCreated()
-	} else if errors.Is(err, common.FolderCreationErrorFolderAlreadyExists{}) {
+	} else if errors.Is(err, common.FolderCreationErrorAlreadyExists{}) {
 		state.Status = EJpptFolderTrackerStatus.FolderExisted()
 	}
 

ste/folderCreationTracker_test.go

@@ -133,11 +133,14 @@ func TestFolderCreationTracker_directoryExists(t *testing.T) {
 	existsIdx := JpptFolderIndex{0, 1}
 	folderCreated := "folderCreated"
 	createdIdx := JpptFolderIndex{1, 1} // cheap validation of job part overlap
+	folderShouldCreate := "folderShouldCreate"
+	shouldCreateIdx := JpptFolderIndex{0, 2}
 
 	plan := &mockedJobPlan{
 		transfers: map[JpptFolderIndex]*JobPartPlanTransfer{
-			existsIdx:  {atomicTransferStatus: common.ETransferStatus.NotStarted()},
-			createdIdx: {atomicTransferStatus: common.ETransferStatus.NotStarted()},
+			existsIdx:       {atomicTransferStatus: common.ETransferStatus.NotStarted()},
+			createdIdx:      {atomicTransferStatus: common.ETransferStatus.NotStarted()},
+			shouldCreateIdx: {atomicTransferStatus: common.ETransferStatus.NotStarted()},
 		},
 	}
 
@@ -149,20 +152,28 @@ func TestFolderCreationTracker_directoryExists(t *testing.T) {
 
 	fct.RegisterPropertiesTransfer(folderExists, existsIdx.PartNum, existsIdx.TransferIndex)
 	fct.RegisterPropertiesTransfer(folderCreated, createdIdx.PartNum, createdIdx.TransferIndex)
+	fct.RegisterPropertiesTransfer(folderShouldCreate, shouldCreateIdx.PartNum, shouldCreateIdx.TransferIndex)
 
 	_ = fct.CreateFolder(folderCreated, func() error {
 		return nil
 	}) // "create" our folder
 	err := fct.CreateFolder(folderExists, func() error {
-		return common.FolderCreationErrorFolderAlreadyExists{}
-	})
-	a.NoError(err, "already exists should be caught")
+		return common.FolderCreationErrorAlreadyExists{}
+	}) // fail creation on not existing
+	a.NoError(err, "already exists should be caught") // ensure we caught that error
+	expectedFailureErr := errors.New("this creation should fail")
+	err = fct.CreateFolder(folderShouldCreate, func() error {
+		return expectedFailureErr
+	}) // ensure that a natural failure should return properly
+	a.Equal(err, expectedFailureErr)
 
 	// validate folder states
-	a.Equal(fct.contents[folderCreated].Status, EJpptFolderTrackerStatus.FolderCreated())
+	a.Equal(fct.contents[folderCreated].Status, EJpptFolderTrackerStatus.FolderCreated()) // Our created folder should be marked as such.
 	a.Equal(plan.transfers[createdIdx].TransferStatus(), common.ETransferStatus.FolderCreated())
-	a.Equal(fct.contents[folderExists].Status, EJpptFolderTrackerStatus.FolderExisted())
+	a.Equal(fct.contents[folderExists].Status, EJpptFolderTrackerStatus.FolderExisted()) // Our existing folder should be marked as such.
 	a.Equal(plan.transfers[existsIdx].TransferStatus(), common.ETransferStatus.FolderExisted())
+	a.Equal(fct.contents[folderShouldCreate].Status, EJpptFolderTrackerStatus.Unseen()) // no status updates should've occurred on a "naturally" failed create.
+	a.Equal(plan.transfers[shouldCreateIdx].TransferStatus(), common.ETransferStatus.NotStarted())
 
 	// validate that re-create doesn't trigger on either
 	err = fct.CreateFolder(folderCreated, func() error {
@@ -175,4 +186,9 @@ func TestFolderCreationTracker_directoryExists(t *testing.T) {
 		return errors.New("should return nil")
 	})
 	a.NoError(err)
+
+	// validate we can still create normally for our naturally failed folder
+	err = fct.CreateFolder(folderShouldCreate, func() error {
+		return nil
+	})
 }

ste/sender-azureFile.go

@@ -460,6 +460,11 @@ func (d AzureFileParentDirCreator) CreateDirToRoot(ctx context.Context, shareCli
 		recorderURL.RawQuery = ""
 		err = t.CreateFolder(recorderURL.String(), func() error {
 			_, err := currentDirectoryClient.Create(ctx, nil)
+
+			if fileerror.HasCode(err, fileerror.ResourceAlreadyExists) {
+				return common.FolderCreationErrorAlreadyExists{}
+			}
+
 			return err
 		})
 		if verifiedErr := d.verifyAndHandleCreateErrors(err); verifiedErr != nil {

ste/sender-blobFS.go

@@ -23,10 +23,11 @@ package ste
 import (
 	"context"
 	"fmt"
-	datalakesas "github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/sas"
 	"strings"
 	"time"
 
+	datalakesas "github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/sas"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/streaming"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
@@ -221,11 +222,13 @@ func (u *blobFSSenderBase) doEnsureDirExists(directoryClient *directory.Client)
 	// know which will happen first
 	err = u.jptm.GetFolderCreationTracker().CreateFolder(directoryClient.DFSURL(), func() error {
 		_, err := directoryClient.Create(u.jptm.Context(), &directory.CreateOptions{AccessConditions: &directory.AccessConditions{ModifiedAccessConditions: &directory.ModifiedAccessConditions{IfNoneMatch: to.Ptr(azcore.ETagAny)}}})
+
+		if datalakeerror.HasCode(err, datalakeerror.PathAlreadyExists) {
+			return common.FolderCreationErrorAlreadyExists{}
+		}
+
 		return err
 	})
-	if datalakeerror.HasCode(err, datalakeerror.PathAlreadyExists) {
-		return nil // not a error as far as we are concerned. It just already exists
-	}
 	return err
 }
 
@@ -297,7 +300,7 @@ func (u *blobFSSenderBase) SendSymlink(linkData string) error {
 	}
 
 	meta[common.POSIXSymlinkMeta] = to.Ptr("true") // just in case there isn't any metadata
-	blobHeaders := blob.HTTPHeaders{ // translate headers, since those still apply
+	blobHeaders := blob.HTTPHeaders{               // translate headers, since those still apply
 		BlobContentType:        u.creationTimeHeaders.ContentType,
 		BlobContentEncoding:    u.creationTimeHeaders.ContentEncoding,
 		BlobContentLanguage:    u.creationTimeHeaders.ContentLanguage,