Merge pull request #217 from promhippie/nil-pointers

fix: resolve nil pointer errors

changelog/unreleased/fix-nil-pointer.md

@@ -0,0 +1,7 @@
+Bugfix: Resolve nil pointer issues with responses
+
+We have introduced previously a feature where we made sure to close all response
+bodies, but we forgot to properly check if these responses are really valid
+which lead to nil pointer dereference issues.
+
+https://github.com/promhippie/github_exporter/issues/216

pkg/exporter/admin.go

@@ -380,7 +380,7 @@ func (c *AdminCollector) Collect(ch chan<- prometheus.Metric) {
 	now := time.Now()
 	record, resp, err := c.client.Admin.GetAdminStats(ctx)
 	c.duration.WithLabelValues("admin").Observe(time.Since(now).Seconds())
-	defer resp.Body.Close()
+	defer closeBody(resp)
 
 	if err != nil {
 		level.Error(c.logger).Log(

pkg/exporter/billing.go

@@ -379,7 +379,7 @@ func (c *BillingCollector) getActionBilling() []*actionBilling {
 			continue
 		}
 
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		result = append(result, &actionBilling{
 			Type:          "enterprise",
@@ -390,7 +390,7 @@ func (c *BillingCollector) getActionBilling() []*actionBilling {
 
 	for _, name := range c.config.Orgs.Value() {
 		record, resp, err := c.client.Billing.GetActionsBillingOrg(ctx, name)
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		if err != nil {
 			level.Error(c.logger).Log(
@@ -460,7 +460,7 @@ func (c *BillingCollector) getPackageBilling() []*packageBilling {
 			continue
 		}
 
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		result = append(result, &packageBilling{
 			Type:           "enterprise",
@@ -474,7 +474,7 @@ func (c *BillingCollector) getPackageBilling() []*packageBilling {
 		defer cancel()
 
 		record, resp, err := c.client.Billing.GetPackagesBillingOrg(ctx, name)
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		if err != nil {
 			level.Error(c.logger).Log(
@@ -544,7 +544,7 @@ func (c *BillingCollector) getStorageBilling() []*storageBilling {
 			continue
 		}
 
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		result = append(result, &storageBilling{
 			Type:           "enterprise",
@@ -558,7 +558,7 @@ func (c *BillingCollector) getStorageBilling() []*storageBilling {
 		defer cancel()
 
 		record, resp, err := c.client.Billing.GetStorageBillingOrg(ctx, name)
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		if err != nil {
 			level.Error(c.logger).Log(

pkg/exporter/helper.go

@@ -8,6 +8,12 @@ import (
 	"github.com/google/go-github/v53/github"
 )
 
+func closeBody(resp *github.Response) {
+	if resp != nil {
+		resp.Body.Close()
+	}
+}
+
 func alreadyCollected(collected []string, needle string) bool {
 	for _, val := range collected {
 		if needle == val {
@@ -46,7 +52,7 @@ func reposByOwnerAndName(ctx context.Context, client *github.Client, owner, repo
 			)
 
 			if err != nil {
-				resp.Body.Close()
+				closeBody(resp)
 				return nil, err
 			}
 
@@ -56,11 +62,11 @@ func reposByOwnerAndName(ctx context.Context, client *github.Client, owner, repo
 			)
 
 			if resp.NextPage == 0 {
-				resp.Body.Close()
+				closeBody(resp)
 				break
 			}
 
-			resp.Body.Close()
+			closeBody(resp)
 			opts.Page = resp.NextPage
 		}
 

pkg/exporter/org.go

@@ -169,7 +169,7 @@ func (c *OrgCollector) Collect(ch chan<- prometheus.Metric) {
 		now := time.Now()
 		record, resp, err := c.client.Organizations.Get(ctx, name)
 		c.duration.WithLabelValues("org").Observe(time.Since(now).Seconds())
-		defer resp.Body.Close()
+		defer closeBody(resp)
 
 		if err != nil {
 			level.Error(c.logger).Log(

pkg/exporter/runner.go

@@ -393,7 +393,7 @@ func (c *RunnerCollector) pagedRepoRunners(ctx context.Context, owner, name stri
 		)
 
 		if err != nil {
-			resp.Body.Close()
+			closeBody(resp)
 			return nil, err
 		}
 
@@ -403,11 +403,11 @@ func (c *RunnerCollector) pagedRepoRunners(ctx context.Context, owner, name stri
 		)
 
 		if resp.NextPage == 0 {
-			resp.Body.Close()
+			closeBody(resp)
 			break
 		}
 
-		resp.Body.Close()
+		closeBody(resp)
 		opts.Page = resp.NextPage
 	}
 
@@ -462,7 +462,7 @@ func (c *RunnerCollector) pagedEnterpriseRunners(ctx context.Context, name strin
 		)
 
 		if err != nil {
-			resp.Body.Close()
+			closeBody(resp)
 			return nil, err
 		}
 
@@ -472,11 +472,11 @@ func (c *RunnerCollector) pagedEnterpriseRunners(ctx context.Context, name strin
 		)
 
 		if resp.NextPage == 0 {
-			resp.Body.Close()
+			closeBody(resp)
 			break
 		}
 
-		resp.Body.Close()
+		closeBody(resp)
 		opts.Page = resp.NextPage
 	}
 
@@ -531,7 +531,7 @@ func (c *RunnerCollector) pagedOrgRunners(ctx context.Context, name string) ([]*
 		)
 
 		if err != nil {
-			resp.Body.Close()
+			closeBody(resp)
 			return nil, err
 		}
 
@@ -541,11 +541,11 @@ func (c *RunnerCollector) pagedOrgRunners(ctx context.Context, name string) ([]*
 		)
 
 		if resp.NextPage == 0 {
-			resp.Body.Close()
+			closeBody(resp)
 			break
 		}
 
-		resp.Body.Close()
+		closeBody(resp)
 		opts.Page = resp.NextPage
 	}
 

pkg/exporter/workflow.go

@@ -249,7 +249,7 @@ func (c *WorkflowCollector) pagedRepoWorkflows(ctx context.Context, owner, name
 		)
 
 		if err != nil {
-			resp.Body.Close()
+			closeBody(resp)
 			return nil, err
 		}
 
@@ -259,11 +259,11 @@ func (c *WorkflowCollector) pagedRepoWorkflows(ctx context.Context, owner, name
 		)
 
 		if resp.NextPage == 0 {
-			resp.Body.Close()
+			closeBody(resp)
 			break
 		}
 
-		resp.Body.Close()
+		closeBody(resp)
 		opts.Page = resp.NextPage
 	}