applicationID and installationID validation errors are replace with a generic error in GitHub Runner Scaler

[swgriffith]

Report

The scaled object for the Github runner scaler takes an 'installationID' and 'applicationId' parameter as input, which are both expected to be int. The method that parses those values checks that they are valid integers and will raise an error, however the calling method ignores the detailed error and raises a generic "applicationID, installationID and applicationKey must be given" error message, which is misleading. The values were given, but they were invalid.

Expected Behavior

The detailed parsing error message should be returned from the setupGitHubApp method so that the author has better information to debug their issue.

Actual Behavior

Passing a string to either applicationID or installationID will raise the following error in the operator logs.

"error parsing GitHub Runner metadata: applicationID, installationID and applicationKey must be given"

Steps to Reproduce the Problem

1. Deploy keda to the cluster
2. Follow the keda logs: kubectl logs -f -l app=keda-operator -n keda
3. Create and deploy the following manifest

apiVersion: v1
kind: Namespace
metadata:
  name: github-runner
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: github-auth
  namespace: github-runner
data:
  appKey: REDACTED
---
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
  name: github-trigger-auth
  namespace: github-runner
spec:
  secretTargetRef:
    - parameter: appKey
      name: github-auth
      key: appKey
---
apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
  name: scaledjob-github-runner
  namespace: github-runner
spec:
  jobTargetRef:
    template:
      metadata:
        labels:
          app: scaledjob-github-runner
      spec:
        containers:
        - name: scaledjob-github-runner
          image: myoung34/github-runner:2.302.1-ubuntu-focal
          imagePullPolicy: Always
          env:
          - name: EPHEMERAL
            value: "true"
          - name: DISABLE_RUNNER_UPDATE
            value: "true"
          - name: REPO_URL
            value: "REDACTED"
          - name: RUNNER_SCOPE
            value: "repo"
          - name: LABELS
            value: "test-local-runner"
        restartPolicy: Never
  minReplicaCount: 0
  maxReplicaCount: 20
  pollingInterval: 30
  triggers:
  - type: github-runner
    metadata:
      owner: "REDACTED"
      repos: "github-aca-runner"
      labelsFromEnv: "LABELS"
      runnerScope: "repo"
      applicationID: "fail"
      installationID: "fail"
    authenticationRef:
      name: github-trigger-auth

Logs from KEDA operator

ERROR	Failed to ensure ScaledJob is correctly created	{"controller": "scaledjob", "controllerGroup": "keda.sh", "controllerKind": "ScaledJob", "ScaledJob": {"name":"scaledjob-github-runner","namespace":"github-runner"}, "namespace": "github-runner", "name": "scaledjob-github-runner", "reconcileID": "4c1c09f4-44cb-48eb-8881-6eb2fe8b2f54", "error": "error parsing GitHub Runner metadata: applicationID, installationID and applicationKey must be given"}

KEDA Version

2.15.1

Kubernetes Version

1.29

Platform

Microsoft Azure

Scaler Details

Github Runner Scaler

Anything else?

Code reference:

Parse method does a good job of validating the content and raising an informative error:

keda/pkg/scalers/github_runner_scaler.go

Line 371 in f6358d5

func getInt64ValueFromMetaOrEnv(key string, config *scalersconfig.ScalerConfig) (int64, error) {

setupGithubApp method swallows the detailed error and raises a generic error:

keda/pkg/scalers/github_runner_scaler.go

Line 442 in f6358d5

func setupGitHubApp(config *scalersconfig.ScalerConfig) (*int64, *int64, *string, error) {