Add client nil checks to avoid panics (#2008)

* Add client nil checks to avoid panics * Update docs * Fix docs again * Update docs
grafana · Jan 29, 2025 · f572d44 · f572d44
1 parent 8ad5c07
commit f572d44
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 3 deletions.
diff --git a/docs/resources/dashboard_public.md b/docs/resources/dashboard_public.md
@@ -5,7 +5,7 @@ subcategory: "Grafana OSS"
 description: |-
   Manages Grafana public dashboards.
   Note: This resource is available only with Grafana 10.2+.
-  Official documentation https://grafana.com/docs/grafana/latest/dashboards/dashboard-public/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/dashboard_public/
+  Official documentation https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/shared-dashboards/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/dashboard_public/
 ---
 
 # grafana_dashboard_public (Resource)
@@ -14,7 +14,7 @@ Manages Grafana public dashboards.
 
 **Note:** This resource is available only with Grafana 10.2+.
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/dashboard-public/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/shared-dashboards/)
 * [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/dashboard_public/)
 
 ## Example Usage

diff --git a/internal/resources/cloud/common.go b/internal/resources/cloud/common.go
@@ -104,5 +104,14 @@ func (r *basePluginFrameworkResource) Configure(ctx context.Context, req resourc
 		return
 	}
 
+	if client.GrafanaCloudAPI == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the Grafana Cloud API.",
+			"Please ensure that cloud_api_url and cloud_access_policy_token are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.client = client.GrafanaCloudAPI
 }
diff --git a/internal/resources/grafana/common_plugin_framework.go b/internal/resources/grafana/common_plugin_framework.go
@@ -38,6 +38,15 @@ func (r *basePluginFrameworkDataSource) Configure(ctx context.Context, req datas
 		return
 	}
 
+	if client.GrafanaAPI == nil || client.GrafanaAPIConfig == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the Grafana API.",
+			"Please ensure that url and auth are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.client = client.GrafanaAPI
 	r.config = client.GrafanaAPIConfig
 }
@@ -81,6 +90,15 @@ func (r *basePluginFrameworkResource) Configure(ctx context.Context, req resourc
 		return
 	}
 
+	if client.GrafanaAPI == nil || client.GrafanaAPIConfig == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the Grafana API.",
+			"Please ensure that url and auth are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.client = client.GrafanaAPI
 	r.config = client.GrafanaAPIConfig
 }

diff --git a/internal/resources/grafana/resource_dashboard_public.go b/internal/resources/grafana/resource_dashboard_public.go
@@ -27,7 +27,7 @@ Manages Grafana public dashboards.
 
 **Note:** This resource is available only with Grafana 10.2+.
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/dashboard-public/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/shared-dashboards/)
 * [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/dashboard_public/)
 `,
 

diff --git a/internal/resources/machinelearning/resource_alert.go b/internal/resources/machinelearning/resource_alert.go
@@ -76,6 +76,15 @@ func (r *alertResource) Configure(ctx context.Context, req resource.ConfigureReq
 		return
 	}
 
+	if client.MLAPI == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the MLAPI API.",
+			"Please ensure that url and auth are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.mlapi = client.MLAPI
 }
 

diff --git a/internal/resources/oncall/resources.go b/internal/resources/oncall/resources.go
@@ -36,6 +36,15 @@ func (r *basePluginFrameworkResource) Configure(ctx context.Context, req resourc
 		return
 	}
 
+	if client.OnCallClient == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the OnCall API.",
+			"Please ensure that oncall_url and oncall_access_token/auth are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.client = client.OnCallClient
 }
 
@@ -60,6 +69,15 @@ func (r *basePluginFrameworkDataSource) Configure(ctx context.Context, req datas
 		return
 	}
 
+	if client.OnCallClient == nil {
+		resp.Diagnostics.AddError(
+			"The Grafana Provider is missing a configuration for the OnCall API.",
+			"Please ensure that oncall_url and oncall_access_token/auth are set in the provider configuration.",
+		)
+
+		return
+	}
+
 	r.client = client.OnCallClient
 }