bundles: add region tracing

Add 'TraceLogger.Region()' invocations to all public methods of the
'BundleProvider' struct, except for 'CreateInitialBundle()' and
'CreateSingletonBundle()' (due to the relative brevity of those functions).

Note that static check suppressions are added to two of the 'Region()' calls
to allow overriding the 'ctx' despite it not being used later in the
function. This helps future-proof against the easy-to-miss bug where a call
is added to the function that uses 'ctx', but because 'ctx' is not
overridden with the value from 'Region()', the ctx doesn't include the
appropriate region information.

Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

internal/bundles/bundles.go

@@ -118,6 +118,10 @@ func (b *bundleProvider) CreateSingletonList(ctx context.Context, bundle Bundle)
 
 // Given a BundleList
 func (b *bundleProvider) WriteBundleList(ctx context.Context, list *BundleList, repo *core.Repository) error {
+	//lint:ignore SA4006 always override the ctx with the result from 'Region()'
+	ctx, exitRegion := b.logger.Region(ctx, "bundles", "write_bundle_list")
+	defer exitRegion()
+
 	listFile := repo.WebDir + "/bundle-list"
 	jsonFile := repo.RepoDir + "/bundle-list.json"
 
@@ -179,6 +183,10 @@ func (b *bundleProvider) WriteBundleList(ctx context.Context, list *BundleList,
 }
 
 func (b *bundleProvider) GetBundleList(ctx context.Context, repo *core.Repository) (*BundleList, error) {
+	//lint:ignore SA4006 always override the ctx with the result from 'Region()'
+	ctx, exitRegion := b.logger.Region(ctx, "bundles", "get_bundle_list")
+	defer exitRegion()
+
 	jsonFile := repo.RepoDir + "/bundle-list.json"
 
 	reader, err := os.Open(jsonFile)
@@ -283,6 +291,9 @@ func (b *bundleProvider) getAllPrereqsForIncrementalBundle(list *BundleList) ([]
 }
 
 func (b *bundleProvider) CreateIncrementalBundle(ctx context.Context, repo *core.Repository, list *BundleList) (*Bundle, error) {
+	ctx, exitRegion := b.logger.Region(ctx, "bundles", "create_incremental_bundle")
+	defer exitRegion()
+
 	bundle := b.createDistinctBundle(repo, list)
 
 	lines, err := b.getAllPrereqsForIncrementalBundle(list)
@@ -303,6 +314,9 @@ func (b *bundleProvider) CreateIncrementalBundle(ctx context.Context, repo *core
 }
 
 func (b *bundleProvider) CollapseList(ctx context.Context, repo *core.Repository, list *BundleList) error {
+	ctx, exitRegion := b.logger.Region(ctx, "bundles", "collapse_list")
+	defer exitRegion()
+
 	maxBundles := 5
 
 	if len(list.Bundles) <= maxBundles {