deduplicate cache folders (#1814)

## Description

These two structures are effectively identical.
This refactor deferrs to the graph version since
services may still wrap that for more specific
behavior as needed.

## Does this PR need a docs update or release note?

- [x] ⛔ No 

## Type of change

- [x] 🐹 Trivial/Minor

## Issue(s)

* #1727

## Test Plan

- [x] ⚡ Unit test
- [x] 💚 E2E

src/internal/connector/data_collections_test.go

@@ -551,9 +551,11 @@ func (suite *ConnectorCreateExchangeCollectionIntegrationSuite) TestEventsSerial
 
 				for stream := range streamChannel {
 					buf := &bytes.Buffer{}
+
 					read, err := buf.ReadFrom(stream.ToReader())
 					assert.NoError(t, err)
 					assert.NotZero(t, read)
+
 					event, err := support.CreateEventFromBytes(buf.Bytes())
 					assert.NotNil(t, event)
 					assert.NoError(t, err, "creating event from bytes: "+buf.String())

src/internal/connector/exchange/cache_container.go

@@ -5,7 +5,6 @@ import (
 	"github.com/pkg/errors"
 
 	"github.com/alcionai/corso/src/internal/connector/graph"
-	"github.com/alcionai/corso/src/pkg/path"
 )
 
 // checkIDAndName is a helper function to ensure that
@@ -39,29 +38,6 @@ func checkRequiredValues(c graph.Container) error {
 	return nil
 }
 
-// =========================================
-// cachedContainer Implementations
-// =========================================
-
-var _ graph.CachedContainer = &cacheFolder{}
-
-type cacheFolder struct {
-	graph.Container
-	p *path.Builder
-}
-
-// =========================================
-// Required Functions to satisfy interfaces
-// =========================================
-
-func (cf cacheFolder) Path() *path.Builder {
-	return cf.p
-}
-
-func (cf *cacheFolder) SetPath(newPath *path.Builder) {
-	cf.p = newPath
-}
-
 // CalendarDisplayable is a transformative struct that aligns
 // models.Calendarable interface with the container interface.
 // Calendars do not have a parentFolderID. Therefore,

src/internal/connector/exchange/contact_folder_cache.go

@@ -43,10 +43,7 @@ func (cfc *contactFolderCache) populateContactRoot(
 			"fetching root contact folder: "+support.ConnectorStackErrorTrace(err))
 	}
 
-	temp := cacheFolder{
+	temp := graph.NewCacheFolder(f, path.Builder{}.Append(baseContainerPath...))
-		Container: f,
-		p:         path.Builder{}.Append(baseContainerPath...),
-	}
 
 	if err := cfc.addFolder(temp); err != nil {
 		return errors.Wrap(err, "adding cache root")
@@ -100,9 +97,7 @@ func (cfc *contactFolderCache) Populate(
 				continue
 			}
 
-			temp := cacheFolder{
+			temp := graph.NewCacheFolder(fold, nil)
-				Container: fold,
-			}
 
 			err = cfc.addFolder(temp)
 			if err != nil {

src/internal/connector/exchange/container_resolver.go

@@ -85,10 +85,10 @@ func (cr *containerResolver) PathInCache(pathString string) (string, bool) {
 
 // addFolder adds a folder to the cache with the given ID. If the item is
 // already in the cache does nothing. The path for the item is not modified.
-func (cr *containerResolver) addFolder(cf cacheFolder) error {
+func (cr *containerResolver) addFolder(cf graph.CacheFolder) error {
 	// Only require a non-nil non-empty parent if the path isn't already
 	// populated.
-	if cf.p != nil {
+	if cf.Path() != nil {
 		if err := checkIDAndName(cf.Container); err != nil {
 			return errors.Wrap(err, "adding item to cache")
 		}
@@ -120,7 +120,7 @@ func (cr *containerResolver) Items() []graph.CachedContainer {
 // AddToCache adds container to map in field 'cache'
 // @returns error iff the required values are not accessible.
 func (cr *containerResolver) AddToCache(ctx context.Context, f graph.Container) error {
-	temp := cacheFolder{
+	temp := graph.CacheFolder{
 		Container: f,
 	}
 

src/internal/connector/exchange/container_resolver_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
+	"github.com/alcionai/corso/src/internal/connector/graph"
 	"github.com/alcionai/corso/src/internal/tester"
 	"github.com/alcionai/corso/src/pkg/path"
 )
@@ -144,67 +145,67 @@ func (suite *FolderCacheUnitSuite) TestCheckRequiredValues() {
 func (suite *FolderCacheUnitSuite) TestAddFolder() {
 	table := []struct {
 		name  string
-		cf    cacheFolder
+		cf    graph.CacheFolder
 		check assert.ErrorAssertionFunc
 	}{
 		{
 			name: "NoParentNoPath",
-			cf: cacheFolder{
+			cf: graph.NewCacheFolder(
-				Container: &mockContainer{
+				&mockContainer{
 					id:       &testID,
 					name:     &testName,
 					parentID: nil,
 				},
-				p: nil,
+				nil,
-			},
+			),
 			check: assert.Error,
 		},
 		{
 			name: "NoParentPath",
-			cf: cacheFolder{
+			cf: graph.NewCacheFolder(
-				Container: &mockContainer{
+				&mockContainer{
 					id:       &testID,
 					name:     &testName,
 					parentID: nil,
 				},
-				p: path.Builder{}.Append("foo"),
+				path.Builder{}.Append("foo"),
-			},
+			),
 			check: assert.NoError,
 		},
 		{
 			name: "NoName",
-			cf: cacheFolder{
+			cf: graph.NewCacheFolder(
-				Container: &mockContainer{
+				&mockContainer{
 					id:       &testID,
 					name:     nil,
 					parentID: &testParentID,
 				},
-				p: path.Builder{}.Append("foo"),
+				path.Builder{}.Append("foo"),
-			},
+			),
 			check: assert.Error,
 		},
 		{
 			name: "NoID",
-			cf: cacheFolder{
+			cf: graph.NewCacheFolder(
-				Container: &mockContainer{
+				&mockContainer{
 					id:       nil,
 					name:     &testName,
 					parentID: &testParentID,
 				},
-				p: path.Builder{}.Append("foo"),
+				path.Builder{}.Append("foo"),
-			},
+			),
 			check: assert.Error,
 		},
 		{
 			name: "NoPath",
-			cf: cacheFolder{
+			cf: graph.NewCacheFolder(
-				Container: &mockContainer{
+				&mockContainer{
 					id:       &testID,
 					name:     &testName,
 					parentID: &testParentID,
 				},
-				p: nil,
+				nil,
-			},
+			),
 			check: assert.NoError,
 		},
 	}

src/internal/connector/exchange/data_collections.go

@@ -16,7 +16,7 @@ import (
 func MetadataFileNames(cat path.CategoryType) []string {
 	switch cat {
 	case path.EmailCategory, path.ContactsCategory:
-		return []string{graph.DeltaTokenFileName, graph.PreviousPathFileName}
+		return []string{graph.DeltaURLsFileName, graph.PreviousPathFileName}
 	default:
 		return []string{graph.PreviousPathFileName}
 	}
@@ -82,7 +82,7 @@ func ParseMetadataCollections(
 
 					cdps.paths = m
 
-				case graph.DeltaTokenFileName:
+				case graph.DeltaURLsFileName:
 					if len(cdps.deltas) > 0 {
 						return nil, errors.Errorf("multiple versions of %s delta metadata", category)
 					}

src/internal/connector/exchange/data_collections_test.go

@@ -43,7 +43,7 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 		{
 			name: "delta urls",
 			data: []fileValues{
-				{graph.DeltaTokenFileName, "delta-link"},
+				{graph.DeltaURLsFileName, "delta-link"},
 			},
 			expectDeltas: map[string]string{
 				"key": "delta-link",
@@ -53,8 +53,8 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 		{
 			name: "multiple delta urls",
 			data: []fileValues{
-				{graph.DeltaTokenFileName, "delta-link"},
+				{graph.DeltaURLsFileName, "delta-link"},
-				{graph.DeltaTokenFileName, "delta-link-2"},
+				{graph.DeltaURLsFileName, "delta-link-2"},
 			},
 			expectError: assert.Error,
 		},
@@ -79,7 +79,7 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 		{
 			name: "delta urls and previous paths",
 			data: []fileValues{
-				{graph.DeltaTokenFileName, "delta-link"},
+				{graph.DeltaURLsFileName, "delta-link"},
 				{graph.PreviousPathFileName, "prev-path"},
 			},
 			expectDeltas: map[string]string{
@@ -93,7 +93,7 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 		{
 			name: "delta urls with special chars",
 			data: []fileValues{
-				{graph.DeltaTokenFileName, "`!@#$%^&*()_[]{}/\"\\"},
+				{graph.DeltaURLsFileName, "`!@#$%^&*()_[]{}/\"\\"},
 			},
 			expectDeltas: map[string]string{
 				"key": "`!@#$%^&*()_[]{}/\"\\",
@@ -103,7 +103,7 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 		{
 			name: "delta urls with escaped chars",
 			data: []fileValues{
-				{graph.DeltaTokenFileName, `\n\r\t\b\f\v\0\\`},
+				{graph.DeltaURLsFileName, `\n\r\t\b\f\v\0\\`},
 			},
 			expectDeltas: map[string]string{
 				"key": "\\n\\r\\t\\b\\f\\v\\0\\\\",
@@ -116,7 +116,7 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 				// rune(92) = \, rune(110) = n.  Ensuring it's not possible to
 				// error in serializing/deserializing and produce a single newline
 				// character from those two runes.
-				{graph.DeltaTokenFileName, string([]rune{rune(92), rune(110)})},
+				{graph.DeltaURLsFileName, string([]rune{rune(92), rune(110)})},
 			},
 			expectDeltas: map[string]string{
 				"key": "\\n",
@@ -154,12 +154,20 @@ func (suite *DataCollectionsUnitSuite) TestParseMetadataCollections() {
 			emails := cdps[path.EmailCategory]
 			deltas, paths := emails.deltas, emails.paths
 
+			if len(test.expectDeltas) > 0 {
+				assert.NotEmpty(t, deltas, "deltas")
+			}
+
+			if len(test.expectPaths) > 0 {
+				assert.NotEmpty(t, paths, "paths")
+			}
+
 			for k, v := range test.expectDeltas {
 				assert.Equal(t, v, deltas[k], "deltas elements")
 			}
 
 			for k, v := range test.expectPaths {
-				assert.Equal(t, v, paths[k], "deltas elements")
+				assert.Equal(t, v, paths[k], "paths elements")
 			}
 		})
 	}

src/internal/connector/exchange/event_calendar_cache.go

@@ -72,10 +72,7 @@ func (ecc *eventCalendarCache) Populate(
 	}
 
 	for _, container := range directories {
-		temp := cacheFolder{
+		temp := graph.NewCacheFolder(container, path.Builder{}.Append(*container.GetDisplayName()))
-			Container: container,
-			p:         path.Builder{}.Append(*container.GetDisplayName()),
-		}
 
 		if err := ecc.addFolder(temp); err != nil {
 			errs = support.WrapAndAppend(
@@ -95,10 +92,7 @@ func (ecc *eventCalendarCache) AddToCache(ctx context.Context, f graph.Container
 		return errors.Wrap(err, "adding cache folder")
 	}
 
-	temp := cacheFolder{
+	temp := graph.NewCacheFolder(f, path.Builder{}.Append(*f.GetDisplayName()))
-		Container: f,
-		p:         path.Builder{}.Append(*f.GetDisplayName()),
-	}
 
 	if err := ecc.addFolder(temp); err != nil {
 		return errors.Wrap(err, "adding cache folder")

src/internal/connector/exchange/mail_folder_cache.go

@@ -55,10 +55,7 @@ func (mc *mailFolderCache) populateMailRoot(
 			directory = DefaultMailFolder
 		}
 
-		temp := cacheFolder{
+		temp := graph.NewCacheFolder(f, path.Builder{}.Append(directory))
-			Container: f,
-			p:         path.Builder{}.Append(directory),
-		}
 
 		if err := mc.addFolder(temp); err != nil {
 			return errors.Wrap(err, "initializing mail resolver")
@@ -98,9 +95,7 @@ func (mc *mailFolderCache) Populate(
 		}
 
 		for _, f := range resp.GetValue() {
-			temp := cacheFolder{
+			temp := graph.NewCacheFolder(f, nil)
-				Container: f,
-			}
 
 			// Use addFolder instead of AddToCache to be conservative about path
 			// population. The fetch order of the folders could cause failures while

src/internal/connector/exchange/service_iterators.go

@@ -113,7 +113,7 @@ func FilterContainersAndFillCollections(
 	}
 
 	if len(deltaURLs) > 0 {
-		entries = append(entries, graph.NewMetadataEntry(graph.DeltaTokenFileName, deltaURLs))
+		entries = append(entries, graph.NewMetadataEntry(graph.DeltaURLsFileName, deltaURLs))
 	}
 
 	if col, err := graph.MakeMetadataCollection(

src/internal/connector/graph/service.go

@@ -10,9 +10,9 @@ import (
 )
 
 const (
-	// DeltaTokenFileName is the name of the file containing delta token(s) for a
+	// DeltaURLsFileName is the name of the file containing delta token(s) for a
 	// given endpoint. The endpoint granularity varies by service.
-	DeltaTokenFileName = "delta"
+	DeltaURLsFileName = "delta"
 	// PreviousPathFileName is the name of the file containing previous path(s) for a
 	// given endpoint.
 	PreviousPathFileName = "previouspath"
@@ -21,7 +21,7 @@ const (
 // AllMetadataFileNames produces the standard set of filenames used to store graph
 // metadata such as delta tokens and folderID->path references.
 func AllMetadataFileNames() []string {
-	return []string{DeltaTokenFileName, PreviousPathFileName}
+	return []string{DeltaURLsFileName, PreviousPathFileName}
 }
 
 type QueryParams struct {