Extend the user agent and fix the build version for the listener app (actions#2892)

Author: nikola-jokic

.github/workflows/arc-publish.yaml

@@ -18,7 +18,7 @@ on:
         default: false
 
 permissions:
- contents: write 
+ contents: write
  packages: write
 
 env:
@@ -34,16 +34,16 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     # gha-runner-scale-set has its own release workflow.
-    # We don't want to publish a new actions-runner-controller image 
+    # We don't want to publish a new actions-runner-controller image
     # we release gha-runner-scale-set.
     if: ${{ !startsWith(github.event.inputs.release_tag_name, 'gha-runner-scale-set-') }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
-          go-version: '1.18.2'
+          go-version-file: 'go.mod'
 
       - name: Install tools
         run: |

Dockerfile

@@ -24,7 +24,7 @@ RUN go mod download
 # With the above commmand,
 # TARGETOS can be "linux", TARGETARCH can be "amd64", "arm64", and "arm", TARGETVARIANT can be "v7".
 
-ARG TARGETPLATFORM TARGETOS TARGETARCH TARGETVARIANT VERSION=dev
+ARG TARGETPLATFORM TARGETOS TARGETARCH TARGETVARIANT VERSION=dev COMMIT_SHA=dev
 
 # We intentionally avoid `--mount=type=cache,mode=0777,target=/go/pkg/mod` in the `go mod download` and the `go build` runs
 # to avoid https://github.com/moby/buildkit/issues/2334
@@ -36,8 +36,8 @@ ENV GOCACHE /build/${TARGETPLATFORM}/root/.cache/go-build
 RUN --mount=target=. \
   --mount=type=cache,mode=0777,target=${GOCACHE} \
   export GOOS=${TARGETOS} GOARCH=${TARGETARCH} GOARM=${TARGETVARIANT#v} && \
-  go build -trimpath -ldflags="-s -w -X 'github.com/actions/actions-runner-controller/build.Version=${VERSION}'" -o /out/manager main.go && \
-  go build -trimpath -ldflags="-s -w" -o /out/github-runnerscaleset-listener ./cmd/githubrunnerscalesetlistener && \
+  go build -trimpath -ldflags="-s -w -X 'github.com/actions/actions-runner-controller/build.Version=${VERSION}' -X 'github.com/actions/actions-runner-controller/build.CommitSHA=${COMMIT_SHA}'" -o /out/manager main.go && \
+  go build -trimpath -ldflags="-s -w -X 'github.com/actions/actions-runner-controller/build.Version=${VERSION}' -X 'github.com/actions/actions-runner-controller/build.CommitSHA=${COMMIT_SHA}'" -o /out/github-runnerscaleset-listener ./cmd/githubrunnerscalesetlistener && \
   go build -trimpath -ldflags="-s -w" -o /out/github-webhook-server ./cmd/githubwebhookserver && \
   go build -trimpath -ldflags="-s -w" -o /out/actions-metrics-server ./cmd/actionsmetricsserver && \
   go build -trimpath -ldflags="-s -w" -o /out/sleep ./cmd/sleep

Makefile

@@ -5,6 +5,7 @@ else
 endif
 DOCKER_USER ?= $(shell echo ${DOCKER_IMAGE_NAME} | cut -d / -f1)
 VERSION ?= dev
+COMMIT_SHA = $(shell git rev-parse HEAD)
 RUNNER_VERSION ?= 2.309.0
 TARGETPLATFORM ?= $(shell arch)
 RUNNER_NAME ?= ${DOCKER_USER}/actions-runner
@@ -67,7 +68,7 @@ endif
 all: manager
 
 lint:
-	docker run --rm -v $(PWD):/app -w /app golangci/golangci-lint:v1.49.0 golangci-lint run
+	docker run --rm -v $(PWD):/app -w /app golangci/golangci-lint:v1.54.2 golangci-lint run
 
 GO_TEST_ARGS ?= -short
 
@@ -215,6 +216,7 @@ docker-buildx:
 		--build-arg RUNNER_VERSION=${RUNNER_VERSION} \
 		--build-arg DOCKER_VERSION=${DOCKER_VERSION} \
 		--build-arg VERSION=${VERSION} \
+		--build-arg COMMIT_SHA=${COMMIT_SHA} \
 		-t "${DOCKER_IMAGE_NAME}:${VERSION}" \
 		-f Dockerfile \
 		. ${PUSH_ARG}

build/version.go

@@ -2,3 +2,5 @@ package build
 
 // This is overridden at build-time using go-build ldflags. dev is the fallback value
 var Version = "NA"
+
+var CommitSHA = "NA"

cmd/githubrunnerscalesetlistener/main.go

@@ -190,8 +190,12 @@ func run(ctx context.Context, rc RunnerScaleSetListenerConfig, logger logr.Logge
 		rc,
 		creds,
 		actions.WithLogger(logger),
-		actions.WithUserAgent(fmt.Sprintf("actions-runner-controller/%s", build.Version)),
 	)
+	actionsServiceClient.SetUserAgent(actions.UserAgentInfo{
+		Version:    build.Version,
+		CommitSHA:  build.CommitSHA,
+		ScaleSetID: rc.RunnerScaleSetId,
+	})
 	if err != nil {
 		return fmt.Errorf("failed to create an Actions Service client: %w", err)
 	}

cmd/githubrunnerscalesetlistener/mock_KubernetesManager.go

@@ -463,6 +463,12 @@ func (r *AutoscalingRunnerSetReconciler) createRunnerScaleSet(ctx context.Contex
 		}
 	}
 
+	actionsClient.SetUserAgent(actions.UserAgentInfo{
+		Version:    build.Version,
+		CommitSHA:  build.CommitSHA,
+		ScaleSetID: runnerScaleSet.Id,
+	})
+
 	logger.Info("Created/Reused a runner scale set", "id", runnerScaleSet.Id, "runnerGroupName", runnerScaleSet.RunnerGroupName)
 	if autoscalingRunnerSet.Annotations == nil {
 		autoscalingRunnerSet.Annotations = map[string]string{}

cmd/githubrunnerscalesetlistener/mock_RunnerScaleSetClient.go

@@ -888,8 +888,9 @@ var _ = Describe("Test client optional configuration", Ordered, func() {
 				Log:                                logf.Log,
 				ControllerNamespace:                autoscalingNS.Name,
 				DefaultRunnerScaleSetListenerImage: "ghcr.io/actions/arc",
-				ActionsClient:                      actions.NewMultiClient("test", logr.Discard()),
+				ActionsClient:                      actions.NewMultiClient(logr.Discard()),
 			}
+
 			err := controller.SetupWithManager(mgr)
 			Expect(err).NotTo(HaveOccurred(), "failed to setup controller")
 
@@ -1079,7 +1080,7 @@ var _ = Describe("Test client optional configuration", Ordered, func() {
 		})
 
 		It("should be able to make requests to a server using root CAs", func() {
-			controller.ActionsClient = actions.NewMultiClient("test", logr.Discard())
+			controller.ActionsClient = actions.NewMultiClient(logr.Discard())
 
 			certsFolder := filepath.Join(
 				"../../",

controllers/actions.github.com/autoscalingrunnerset_controller.go

@@ -729,7 +729,7 @@ var _ = Describe("EphemeralRunner", func() {
 
 		It("uses an actions client with proxy transport", func() {
 			// Use an actual client
-			controller.ActionsClient = actions.NewMultiClient("test", logr.Discard())
+			controller.ActionsClient = actions.NewMultiClient(logr.Discard())
 
 			proxySuccessfulllyCalled := false
 			proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -914,7 +914,7 @@ var _ = Describe("EphemeralRunner", func() {
 			server.StartTLS()
 
 			// Use an actual client
-			controller.ActionsClient = actions.NewMultiClient("test", logr.Discard())
+			controller.ActionsClient = actions.NewMultiClient(logr.Discard())
 
 			ephemeralRunner := newExampleRunner("test-runner", autoScalingNS.Name, configSecret.Name)
 			ephemeralRunner.Spec.GitHubConfigUrl = server.ConfigURLForOrg("my-org")

controllers/actions.github.com/autoscalingrunnerset_controller_test.go

@@ -753,7 +753,7 @@ var _ = Describe("Test EphemeralRunnerSet controller with proxy settings", func(
 			Client:        mgr.GetClient(),
 			Scheme:        mgr.GetScheme(),
 			Log:           logf.Log,
-			ActionsClient: actions.NewMultiClient("test", logr.Discard()),
+			ActionsClient: actions.NewMultiClient(logr.Discard()),
 		}
 		err := controller.SetupWithManager(mgr)
 		Expect(err).NotTo(HaveOccurred(), "failed to setup controller")
@@ -1052,7 +1052,7 @@ var _ = Describe("Test EphemeralRunnerSet controller with custom root CA", func(
 			Client:        mgr.GetClient(),
 			Scheme:        mgr.GetScheme(),
 			Log:           logf.Log,
-			ActionsClient: actions.NewMultiClient("test", logr.Discard()),
+			ActionsClient: actions.NewMultiClient(logr.Discard()),
 		}
 		err = controller.SetupWithManager(mgr)
 		Expect(err).NotTo(HaveOccurred(), "failed to setup controller")

controllers/actions.github.com/ephemeralrunner_controller_test.go

@@ -17,6 +17,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/actions/actions-runner-controller/build"
 	"github.com/go-logr/logr"
 	"github.com/golang-jwt/jwt/v4"
 	"github.com/google/uuid"
@@ -53,6 +54,8 @@ type ActionsService interface {
 	GetRunner(ctx context.Context, runnerId int64) (*RunnerReference, error)
 	GetRunnerByName(ctx context.Context, runnerName string) (*RunnerReference, error)
 	RemoveRunner(ctx context.Context, runnerId int64) error
+
+	SetUserAgent(info UserAgentInfo)
 }
 
 type Client struct {
@@ -72,7 +75,7 @@ type Client struct {
 	creds     *ActionsAuth
 	config    *GitHubConfig
 	logger    logr.Logger
-	userAgent string
+	userAgent UserAgentInfo
 
 	rootCAs               *x509.CertPool
 	tlsInsecureSkipVerify bool
@@ -84,10 +87,24 @@ type ProxyFunc func(req *http.Request) (*url.URL, error)
 
 type ClientOption func(*Client)
 
-func WithUserAgent(userAgent string) ClientOption {
-	return func(c *Client) {
-		c.userAgent = userAgent
+type UserAgentInfo struct {
+	Version    string
+	CommitSHA  string
+	ScaleSetID int
+}
+
+func (u UserAgentInfo) String() string {
+	var scaleSetID = "NA"
+	if u.ScaleSetID > 0 {
+		scaleSetID = strconv.Itoa(u.ScaleSetID)
 	}
+
+	return fmt.Sprintf(
+		"actions-runner-controller/%s CommitSHA/%s ScaleSetID/%s",
+		u.Version,
+		u.CommitSHA,
+		scaleSetID,
+	)
 }
 
 func WithLogger(logger logr.Logger) ClientOption {
@@ -140,6 +157,11 @@ func NewClient(githubConfigURL string, creds *ActionsAuth, options ...ClientOpti
 		// retryablehttp defaults
 		retryMax:     4,
 		retryWaitMax: 30 * time.Second,
+		userAgent: UserAgentInfo{
+			Version:    build.Version,
+			CommitSHA:  build.CommitSHA,
+			ScaleSetID: 0,
+		},
 	}
 
 	for _, option := range options {
@@ -178,6 +200,10 @@ func NewClient(githubConfigURL string, creds *ActionsAuth, options ...ClientOpti
 	return ac, nil
 }
 
+func (c *Client) SetUserAgent(info UserAgentInfo) {
+	c.userAgent = info
+}
+
 // Identifier returns a string to help identify a client uniquely.
 // This is used for caching client instances and understanding when a config
 // change warrants creating a new client. Any changes to Client that would
@@ -186,7 +212,7 @@ func (c *Client) Identifier() string {
 	identifier := fmt.Sprintf("configURL:%q,", c.config.ConfigURL.String())
 
 	if c.creds.Token != "" {
-		identifier += fmt.Sprintf("token:%q", c.creds.Token)
+		identifier += fmt.Sprintf("token:%q,", c.creds.Token)
 	}
 
 	if c.creds.AppCreds != nil {
@@ -234,9 +260,7 @@ func (c *Client) NewGitHubAPIRequest(ctx context.Context, method, path string, b
 		return nil, err
 	}
 
-	if c.userAgent != "" {
-		req.Header.Set("User-Agent", c.userAgent)
-	}
+	req.Header.Set("User-Agent", c.userAgent.String())
 
 	return req, nil
 }
@@ -278,9 +302,7 @@ func (c *Client) NewActionsServiceRequest(ctx context.Context, method, path stri
 
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", c.ActionsServiceAdminToken))
-	if c.userAgent != "" {
-		req.Header.Set("User-Agent", c.userAgent)
-	}
+	req.Header.Set("User-Agent", c.userAgent.String())
 
 	return req, nil
 }
@@ -473,9 +495,7 @@ func (c *Client) GetMessage(ctx context.Context, messageQueueUrl, messageQueueAc
 
 	req.Header.Set("Accept", "application/json; api-version=6.0-preview")
 	req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", messageQueueAccessToken))
-	if c.userAgent != "" {
-		req.Header.Set("User-Agent", c.userAgent)
-	}
+	req.Header.Set("User-Agent", c.userAgent.String())
 
 	resp, err := c.Do(req)
 	if err != nil {
@@ -524,9 +544,7 @@ func (c *Client) DeleteMessage(ctx context.Context, messageQueueUrl, messageQueu
 
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", messageQueueAccessToken))
-	if c.userAgent != "" {
-		req.Header.Set("User-Agent", c.userAgent)
-	}
+	req.Header.Set("User-Agent", c.userAgent.String())
 
 	resp, err := c.Do(req)
 	if err != nil {
@@ -624,9 +642,7 @@ func (c *Client) AcquireJobs(ctx context.Context, runnerScaleSetId int, messageQ
 
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", messageQueueAccessToken))
-	if c.userAgent != "" {
-		req.Header.Set("User-Agent", c.userAgent)
-	}
+	req.Header.Set("User-Agent", c.userAgent.String())
 
 	resp, err := c.Do(req)
 	if err != nil {

controllers/actions.github.com/ephemeralrunnerset_controller_test.go

@@ -282,3 +282,5 @@ func (f *FakeClient) GetRunnerByName(ctx context.Context, runnerName string) (*a
 func (f *FakeClient) RemoveRunner(ctx context.Context, runnerId int64) error {
 	return f.removeRunnerResult.err
 }
+
+func (f *FakeClient) SetUserAgent(_ actions.UserAgentInfo) {}