API key and cluster ID string stripping (#84)

* Trim API key and Cluster ID in config to avoid users adding whitespace. Signed-off-by: Taras Priadka <[email protected]> * Add string trimming on backend. Signed-off-by: Taras Priadka <[email protected]>
pixie-io · Jul 19, 2022 · 0b300bb · 0b300bb
1 parent 9596acb
commit 0b300bb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/pkg/pixie_plugin.go b/pkg/pixie_plugin.go
@@ -22,6 +22,7 @@ import (
  "context"
  "encoding/json"
  "fmt"
+ "strings"
 
  "github.com/grafana/grafana-plugin-sdk-go/backend"
  "github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
@@ -70,6 +71,9 @@ func (td *PixieDatasource) QueryData(ctx context.Context, req *backend.QueryData
 
 // Creates Pixie API client using API key and cloud Address
 func createClient(ctx context.Context, apiKey string, cloudAddr string) (*pxapi.Client, error) {
+ // untrimmed apiKey string will cause an error when creating a client
+ apiKey = strings.TrimSpace(apiKey)
+
  var client *pxapi.Client
  var err error
  // First, create a client connecting to Pixie Cloud.
@@ -169,6 +173,9 @@ func (td *PixieDatasource) query(ctx context.Context, query backend.DataQuery,
  clusterID = qm.QueryBody.ClusterID
  }
 
+ // untrimmed clusterID string will cause an error when creating a vizier client
+ clusterID = strings.TrimSpace(clusterID)
+
  if qm.QueryType != GetClusters && (len(qm.QueryBody.ClusterID) == 0 && clusterID == "") {
  return nil, fmt.Errorf("no clusterID present in the request or default clusterID configured. Please set `pixieCluster` dashboard variable to `Pixie Datasource`->`Clusters`")
  }

diff --git a/src/config_editor.tsx b/src/config_editor.tsx
@@ -139,7 +139,7 @@ export class ConfigEditor extends PureComponent<Props, State> {
  <SecretFormField
  isConfigured={(secureJsonFields && secureJsonFields.clusterId) as boolean}
  value={secureJsonData.clusterId || ''}
- label="Cluster ID"
+ label="Default Cluster ID"
  placeholder="Default Cluster ID"
  labelWidth={20}
  inputWidth={20}