Package: Validate package types (#436)

This PR adds package type check/validation.

It fixes grafana/data-sources#386 error that
is return by github api that happens if the package type is random
non-supported string.

And also it is also improvement for package types that are valid, but
not supported by graphql and return errors (more in
#366.) So instead of
sending package type we know will return error, we return error early
with helpful message.

[Ok DOCKER
package](http://localhost:3000/explore?schemaVersion=1&panes=%7B%22g9y%22:%7B%22datasource%22:%22ddyrfpv6iitj4b%22,%22queries%22:%5B%7B%22refId%22:%22A%22,%22datasource%22:%7B%22type%22:%22grafana-github-datasource%22,%22uid%22:%22ddyrfpv6iitj4b%22%7D,%22queryType%22:%22Packages%22,%22options%22:%7B%22packageType%22:%22DOCKER%22%7D,%22repository%22:%22grafana%22,%22owner%22:%22grafana%22%7D%5D,%22range%22:%7B%22from%22:%22now-1h%22,%22to%22:%22now%22%7D%7D%7D&orgId=1)

<img width="1504" alt="image"
src="https://github.com/user-attachments/assets/e6bce93d-9d61-4a88-8fd9-84f114fa6cfe"
/>

[Not supported NPM
package](http://localhost:3000/explore?schemaVersion=1&panes=%7B%22g9y%22:%7B%22datasource%22:%22ddyrfpv6iitj4b%22,%22queries%22:%5B%7B%22refId%22:%22A%22,%22datasource%22:%7B%22type%22:%22grafana-github-datasource%22,%22uid%22:%22ddyrfpv6iitj4b%22%7D,%22queryType%22:%22Packages%22,%22options%22:%7B%22packageType%22:%22NPM%22%7D,%22repository%22:%22grafana%22,%22owner%22:%22grafana%22%7D%5D,%22range%22:%7B%22from%22:%22now-1h%22,%22to%22:%22now%22%7D%7D%7D&orgId=1)

<img width="1510" alt="image"
src="https://github.com/user-attachments/assets/cef5fe39-d7e8-4ba0-aca6-1b80caa87e4b"
/>

[Invalid "abc"
package](http://localhost:3000/explore?schemaVersion=1&panes=%7B%22g9y%22%3A%7B%22datasource%22%3A%22ddyrfpv6iitj4b%22%2C%22queries%22%3A%5B%7B%22refId%22%3A%22A%22%2C%22datasource%22%3A%7B%22type%22%3A%22grafana-github-datasource%22%2C%22uid%22%3A%22ddyrfpv6iitj4b%22%7D%2C%22queryType%22%3A%22Packages%22%2C%22options%22%3A%7B%22packageType%22%3A%22abc%22%7D%2C%22repository%22%3A%22grafana%22%2C%22owner%22%3A%22grafana%22%7D%5D%2C%22range%22%3A%7B%22from%22%3A%22now-1h%22%2C%22to%22%3A%22now%22%7D%7D%7D&orgId=1)
<img width="1502" alt="image"
src="https://github.com/user-attachments/assets/07e1eeb5-46dd-47c8-a971-75c08865ad15"
/>

Author: ivanahuckova

.changeset/stupid-teams-trade.md

@@ -0,0 +1,5 @@
+---
+'grafana-github-datasource': patch
+---
+
+chore: Add validation for package types

pkg/github/client/errorsourcehandling.go

@@ -20,7 +20,6 @@ var (
 		"Resource not accessible by personal access token",
 		"API rate limit exceeded",
 		"Resource not accessible by integration", // issue with incorrectly set permissions for token/app
-		"registry is not supported by GraphQL APIs",
 	}
 )
 

pkg/github/datasource.go

@@ -117,7 +117,10 @@ func (d *Datasource) HandleMilestonesQuery(ctx context.Context, query *models.Mi
 
 // HandlePackagesQuery is the query handler for listing GitHub Packages
 func (d *Datasource) HandlePackagesQuery(ctx context.Context, query *models.PackagesQuery, req backend.DataQuery) (dfutil.Framer, error) {
-	opt := models.PackagesOptionsWithRepo(query.Options, query.Owner, query.Repository)
+	opt, err := models.PackagesOptionsWithRepo(query.Options, query.Owner, query.Repository)
+	if err != nil {
+		return nil, err
+	}
 
 	return GetAllPackages(ctx, d.client, opt)
 }

pkg/models/packages.go

@@ -1,6 +1,12 @@
 package models
 
-import "github.com/shurcooL/githubv4"
+import (
+	"fmt"
+	"slices"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+	"github.com/shurcooL/githubv4"
+)
 
 // ListPackagesOptions provides options when retrieving commits
 type ListPackagesOptions struct {
@@ -11,11 +17,43 @@ type ListPackagesOptions struct {
 }
 
 // PackagesOptionsWithRepo adds Owner and Repo to a ListPackagesOptions. This is just for convenience
-func PackagesOptionsWithRepo(opt ListPackagesOptions, owner string, repo string) ListPackagesOptions {
+func PackagesOptionsWithRepo(opt ListPackagesOptions, owner string, repo string) (ListPackagesOptions, error) {
+	err := validatePackageType(opt.PackageType)
+	if err != nil {
+		return ListPackagesOptions{}, err
+	}
+
 	return ListPackagesOptions{
 		Owner:       owner,
 		Repository:  repo,
 		Names:       opt.Names,
 		PackageType: opt.PackageType,
-	}
+	}, nil
+}
+
+// validPackageTypes is a list of valid package types that are supported by the GitHub graphql API that we are using
+var validPackageTypes = []githubv4.PackageType{
+	githubv4.PackageTypeMaven,
+	githubv4.PackageTypeDocker,
+	githubv4.PackageTypeDebian,
+	githubv4.PackageTypePypi,
 }
+
+// notSupportedPackageTypes is a list of package types that are not supported by the GitHub graphql API 
+// They were supported in the past but are not supported anymore and we want to return an error if they are used
+var notSupportedPackageTypes = []githubv4.PackageType{
+	githubv4.PackageTypeNpm,
+	githubv4.PackageTypeRubygems,
+	githubv4.PackageTypeNuget,
+}
+
+func validatePackageType(packageType githubv4.PackageType) error {
+	if slices.Contains(validPackageTypes, packageType) {
+		return nil
+	}
+
+	if slices.Contains(notSupportedPackageTypes, packageType) {
+		return backend.DownstreamError(fmt.Errorf("package type %q is not supported. Valid types are: MAVEN, DOCKER, DEBIAN, PYPI", packageType))
+	}
+	return backend.DownstreamError(fmt.Errorf("invalid package type %q. Valid types are: MAVEN, DOCKER, DEBIAN, PYPI", packageType))
+}

pkg/models/packages_test.go

@@ -0,0 +1,83 @@
+package models
+
+import (
+	"testing"
+
+	"github.com/shurcooL/githubv4"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_validatePackageType(t *testing.T) {
+	tests := []struct {
+		name        string
+		packageType githubv4.PackageType
+		wantErr     bool
+		errMessage  string
+	}{
+		// Valid package types
+		{
+			name:        "valid PYPI package type",
+			packageType: githubv4.PackageTypePypi,
+			wantErr:     false,
+		},
+		{
+			name:        "valid Docker package type",
+			packageType: githubv4.PackageTypeDocker,
+			wantErr:     false,
+		},
+		{
+			name:        "valid Maven package type",
+			packageType: githubv4.PackageTypeMaven,
+			wantErr:     false,
+		},
+		{
+			name:        "valid Debian package type",
+			packageType: githubv4.PackageTypeDebian,
+			wantErr:     false,
+		},
+		// Not supported package types by GraphQL API anymore
+		{
+			name:        "not supported NPM package type",
+			packageType: githubv4.PackageTypeNpm,
+			wantErr:     true,
+			errMessage:  `package type "NPM" is not supported`,
+		},
+		{
+			name:        "not supported Rubygems package type",
+			packageType: githubv4.PackageTypeRubygems,
+			wantErr:     true,
+			errMessage:  `package type "RUBYGEMS" is not supported`,
+		},
+		{
+			name:        "not supported Nuget package type",
+			packageType: githubv4.PackageTypeNuget,
+			wantErr:     true,
+			errMessage:  `package type "NUGET" is not supported`,
+		},
+		// Invalid package types
+		{
+			name:        "invalid package type",
+			packageType: "INVALID",
+			wantErr:     true,
+			errMessage:  `invalid package type "INVALID"`,
+		},
+		{
+			name:        "empty package type",
+			packageType: "",
+			wantErr:     true,
+			errMessage:  `invalid package type ""`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := validatePackageType(tt.packageType)
+			if tt.wantErr {
+				require.Error(t, err)
+				require.ErrorContains(t, err, tt.errMessage)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}