Merge remote-tracking branch 'origin/main' into iwysiu/ds/329

Author: iwysiu

.github/workflows/check-grafana-compatibility.yml

@@ -5,49 +5,49 @@ name: Detect breaking change with Grafana
 on:
   pull_request:
     paths:
-      - 'go.mod'
-      - 'go.sum'
+      - "go.mod"
+      - "go.sum"
     branches:
-      - 'main'
+      - "main"
 
 jobs:
   buildPR:
     name: Build PR
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
-    - uses: actions/checkout@v4
-      with:
-        path: './grafana-plugin-sdk-go'
-    - uses: actions/checkout@v4
-      with:
-        repository: 'grafana/grafana'
-        path: './grafana'
-    - uses: actions/setup-go@v5
-      with:
-        cache: false
-        go-version: '~1.22'
-        check-latest: true
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+          path: "./grafana-plugin-sdk-go"
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+          repository: "grafana/grafana"
+          path: "./grafana"
+      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # 5.5.0
+        with:
+          cache: false
+          go-version: "~1.22"
+          check-latest: true
 
-    - name: Check if branch exists in Grafana
-      working-directory: './grafana'
-      run: |
-        if git ls-remote --heads --quiet --exit-code origin ${{ github.head_ref }}
-        then
-          echo "Found branch ${{ github.head_ref }} in Grafana"
-          git fetch origin ${{ github.head_ref }}
-          git checkout ${{ github.head_ref }}
-        else
-          echo "Branch ${{ github.head_ref }} not found in Grafana"
-        fi
+      - name: Check if branch exists in Grafana
+        working-directory: "./grafana"
+        env:
+          BRANCH: ${{ github.head_ref }}
+        run: |
+          if git ls-remote --heads --quiet --exit-code origin "$BRANCH"; then
+            echo "Found branch $BRANCH in Grafana"
+            git fetch origin "$BRANCH" && git checkout "$BRANCH"
+          else
+            echo "Branch $BRANCH not found in Grafana"
+          fi
 
-    - name: Link sdk
-      working-directory: './grafana'
-      run: go mod edit -replace github.com/grafana/grafana-plugin-sdk-go=../grafana-plugin-sdk-go
+      - name: Link sdk
+        working-directory: "./grafana"
+        run: go mod edit -replace github.com/grafana/grafana-plugin-sdk-go=../grafana-plugin-sdk-go
 
-    - name: Automatic updates
-      working-directory: './grafana'
-      run: go mod tidy
-
-    - name: Build Grafana
-      working-directory: './grafana'
-      run: make build-go
+      - name: Build Grafana
+        working-directory: "./grafana"
+        run: make build-go

.github/workflows/check-incompatibility.yml

@@ -14,11 +14,14 @@ on:
 jobs:
   main:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
+        persist-credentials: false
         path: './grafana-plugin-sdk-go'
-    - uses: actions/setup-go@v5
+    - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # 5.5.0
       with:
         cache: false
         check-latest: true

.github/workflows/ci.yml

@@ -9,33 +9,32 @@ on:
 permissions:
   contents: read
 
-env:
-  GOLANGCI_LINT_VERSION: v1.64.2
-
 jobs:
   lint-build-test:
     name: Lint, Build, and Test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
 
       - name: Setup go
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # 5.5.0
         with:
           go-version-file: ./go.mod
 
       - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@55c2c1448f86e01eaae002a5a3a9624417608d84 # v6.5.2
         with:
-          version: ${{env.GOLANGCI_LINT_VERSION}}
+          version: v1.64.2
           args: |
             "./..." --timeout=7m
           skip-cache: true
           install-mode: binary
 
       - name: Setup Mage
-        uses: magefile/mage-action@v3
+        uses: magefile/mage-action@6f50bbb8ea47d56e62dee92392788acbc8192d0b # v3
         with:
           install-only: true
 

.github/workflows/stale.yml

@@ -9,7 +9,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v9
+      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9
         with:
           # Number of days of inactivity before a stale Issue or Pull Request is closed.
           # Set to -1 to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.

.github/workflows/validate-protos.yml

@@ -12,13 +12,17 @@ on:
 jobs:
   main:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       # Run `git checkout`
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       # Install the `buf` CLI
-      - uses: bufbuild/buf-setup-action@v1
+      - uses: bufbuild/buf-setup-action@a47c93e0b1648d5651a065437926377d060baa99 # v1.50.0
       # Perform breaking change detection against the `proto` directory in the `main` branch
-      - uses: bufbuild/buf-breaking-action@v1
+      - uses: bufbuild/buf-breaking-action@c57b3d842a5c3f3b454756ef65305a50a587c5ba # v1.1.4
         with:
           input: 'proto'
           against: 'https://github.com/grafana/grafana-plugin-sdk-go.git#branch=main,subdir=proto'

backend/httpclient/datasource_metrics_middleware.go

@@ -52,6 +52,14 @@ var (
 		}, []string{"datasource_type", "secure_socks_ds_proxy_enabled", "endpoint"},
 	)
 
+	datasourceResponseGauge = promauto.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Namespace: "plugins",
+			Name:      "datasource_response_size",
+			Help:      "gauge of data source response sizes returned to Grafana in bytes",
+		}, []string{"datasource_type", "secure_socks_ds_proxy_enabled", "endpoint"},
+	)
+
 	datasourceRequestsInFlight = promauto.NewGaugeVec(
 		prometheus.GaugeOpts{
 			Namespace: "plugins",
@@ -128,6 +136,7 @@ func executeMiddleware(next http.RoundTripper, datasourceType string, secureSock
 		requestHistogram := datasourceRequestHistogram.MustCurryWith(labels)
 		requestInFlight := datasourceRequestsInFlight.With(labels)
 		responseSizeHistogram := datasourceResponseHistogram.With(labels)
+		responseSizeGauge := datasourceResponseGauge.With(labels)
 
 		res, err := promhttp.InstrumentRoundTripperDuration(requestHistogram,
 			promhttp.InstrumentRoundTripperCounter(requestCounter,
@@ -140,6 +149,7 @@ func executeMiddleware(next http.RoundTripper, datasourceType string, secureSock
 		if res != nil && res.StatusCode != http.StatusSwitchingProtocols {
 			res.Body = CountBytesReader(res.Body, func(bytesRead int64) {
 				responseSizeHistogram.Observe(float64(bytesRead))
+				responseSizeGauge.Set(float64(bytesRead))
 			})
 		}
 

backend/httpclient/http_client.go

@@ -14,17 +14,12 @@ import (
 )
 
 // New creates a new http.Client.
-// If opts is nil the http.DefaultClient will be returned.
 // If no middlewares are provided the DefaultMiddlewares will be used. If you
 // provide middlewares you have to manually add the DefaultMiddlewares for it to be
 // enabled.
 // Note: Middlewares will be executed in the same order as provided.
 // Note: If more than one Options is provided a panic is raised.
 func New(opts ...Options) (*http.Client, error) {
-	if opts == nil {
-		return http.DefaultClient, nil
-	}
-
 	clientOpts := createOptions(opts...)
 	transport, err := GetTransport(clientOpts)
 	if err != nil {

backend/httpclient/http_client_test.go

@@ -10,13 +10,27 @@ import (
 )
 
 func TestNewClient(t *testing.T) {
-	t.Run("New() without any opts should return http.DefaultClient", func(t *testing.T) {
+	t.Run("New() without any opts should return expected http client and middlewares", func(t *testing.T) {
 		client, err := New()
 		require.NoError(t, err)
-		require.Same(t, http.DefaultClient, client)
+		require.NotNil(t, client)
+		require.NotSame(t, http.DefaultClient, client)
+
+		require.Equal(t, 30*time.Second, client.Timeout)
+		require.NotSame(t, &http.DefaultTransport, &client.Transport)
+	})
+
+	t.Run("New() with opts and no middlewares specified should return expected http client and middlewares", func(t *testing.T) {
+		client, err := New(Options{})
+		require.NoError(t, err)
+		require.NotNil(t, client)
+		require.NotSame(t, http.DefaultClient, client)
+
+		require.Equal(t, 30*time.Second, client.Timeout)
+		require.NotSame(t, &http.DefaultTransport, &client.Transport)
 	})
 
-	t.Run("New() with opts and no middleware should return expected http client and transport", func(t *testing.T) {
+	t.Run("New() with opts and empty middlewares should return expected http client and transport", func(t *testing.T) {
 		client, err := New(Options{
 			Timeouts: &TimeoutOptions{
 				Timeout:               time.Second,
@@ -35,6 +49,7 @@ func TestNewClient(t *testing.T) {
 		require.NotNil(t, client)
 		require.Equal(t, time.Second, client.Timeout)
 
+		// this only works when there are no middlewares, otherwise the transport is wrapped
 		transport, ok := client.Transport.(*http.Transport)
 		require.True(t, ok)
 		require.NotNil(t, transport)

data/sqlutil/scanrow.go

@@ -8,6 +8,18 @@ import (
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 )
 
+// ErrColumnTypeNotSupported is returned when an SQL column has a type that cannot be processed.
+// This typically occurs when a database driver doesn't provide a valid scan type for a column
+// or when encountering custom/exotic data types that don't have appropriate conversion handlers.
+type ErrColumnTypeNotSupported struct {
+	Type   string
+	Column string
+}
+
+func (e ErrColumnTypeNotSupported) Error() string {
+	return fmt.Sprintf("type %q is not supported (column %q)", e.Type, e.Column)
+}
+
 // A ScanRow is a container for SQL metadata for a single row.
 // The row metadata is used to generate dataframe fields and a slice that can be used with sql.Scan
 type ScanRow struct {
@@ -87,7 +99,7 @@ func MakeScanRow(colTypes []*sql.ColumnType, colNames []string, converters ...Co
 		if !rc.hasConverter(i) {
 			scanTypeValue := colType.ScanType()
 			if scanTypeValue == nil {
-				return nil, fmt.Errorf(`type %s is not supported for column %s`, colType.DatabaseTypeName(), colName)
+				return nil, ErrColumnTypeNotSupported{Type: colType.DatabaseTypeName(), Column: colName}
 			}
 			v := NewDefaultConverter(colName, nullable, scanTypeValue)
 			rc.append(colName, scanType(v, colType.ScanType()), v)