Merge pull request #256 from atc0005/i245-paging-support-explicit-response-closure

Explicitly close response bodys of paged requests

Author: atc0005

internal/rsat/organizations.go

@@ -112,12 +112,7 @@ func GetOrganizations(ctx context.Context, client *APIClient) ([]Organization, e
 			apiURL,
 			client.AuthInfo.ReadLimit,
 		)
-		// Make sure that we close the response body once we're done with it
-		defer func() {
-			if closeErr := response.Body.Close(); closeErr != nil {
-				logger.Error().Err(closeErr).Msg("error closing response body")
-			}
-		}()
+
 		var orgsQueryResp OrganizationsResponse
 		decodeErr := decode(&orgsQueryResp, response.Body, logger, apiURL, client.AuthInfo.ReadLimit)
 		if decodeErr != nil {
@@ -128,6 +123,14 @@ func GetOrganizations(ctx context.Context, client *APIClient) ([]Organization, e
 			Str("api_endpoint", apiURL).
 			Msg("Successfully decoded JSON data")
 
+		// Close the response body once we're done with it. We explicitly
+		// close here vs deferring via closure to prevent accumulating client
+		// connections to the API if we need to perform multiple paged
+		// requests.
+		if closeErr := response.Body.Close(); closeErr != nil {
+			logger.Error().Err(closeErr).Msg("error closing response body")
+		}
+
 		numNewOrgs := len(orgsQueryResp.Organizations)
 		numCollectedOrgs := len(allOrgs)
 		numOrgsRemaining := orgsQueryResp.Subtotal - numCollectedOrgs

internal/rsat/syncplans.go

@@ -436,13 +436,6 @@ func getOrgSyncPlans(ctx context.Context, client *APIClient, org Organization) (
 			return nil, respErr
 		}
 
-		// Make sure that we close the response body once we're done with it
-		defer func() {
-			if closeErr := response.Body.Close(); closeErr != nil {
-				subLogger.Error().Err(closeErr).Msg("error closing response body")
-			}
-		}()
-
 		subLogger.Debug().Msgf(
 			"Decoding JSON data from %q using a limit of %d bytes",
 			apiURL,
@@ -455,17 +448,25 @@ func getOrgSyncPlans(ctx context.Context, client *APIClient, org Organization) (
 			return nil, decodeErr
 		}
 
+		subLogger.Debug().
+			Str("api_endpoint", apiURL).
+			Msg("Successfully decoded JSON data")
+
+		// Close the response body once we're done with it. We explicitly
+		// close here vs deferring via closure to prevent accumulating client
+		// connections to the API if we need to perform multiple paged
+		// requests.
+		if closeErr := response.Body.Close(); closeErr != nil {
+			subLogger.Error().Err(closeErr).Msg("error closing response body")
+		}
+
 		// Annotate Sync Plans with specific Org values for convenience.
 		for i := range syncPlansQueryResp.SyncPlans {
 			syncPlansQueryResp.SyncPlans[i].OrganizationName = org.Name
 			syncPlansQueryResp.SyncPlans[i].OrganizationLabel = org.Label
 			syncPlansQueryResp.SyncPlans[i].OrganizationTitle = org.Title
 		}
 
-		subLogger.Debug().
-			Str("api_endpoint", apiURL).
-			Msg("Successfully decoded JSON data")
-
 		numNewSyncPlans := len(syncPlansQueryResp.SyncPlans)
 		numCollectedSyncPlans := len(allSyncPlans)
 		numSyncPlansRemaining := syncPlansQueryResp.Subtotal - numCollectedSyncPlans