[history server][collector] Enable run with race condition checker (#4430)

* build: with -race when building go binary

Signed-off-by: machichima <nary12321@gmail.com>

* build: update makefile with race command

Signed-off-by: machichima <nary12321@gmail.com>

* build: add collector.race dockerfile

Signed-off-by: machichima <nary12321@gmail.com>

* docs: update docs

Signed-off-by: machichima <nary12321@gmail.com>

* fix: add GOOS and GOARCH back

Signed-off-by: machichima <nary12321@gmail.com>

* fix: set diff image name for race detector version

Signed-off-by: machichima <nary12321@gmail.com>

* build: add build-arg for enable race

Signed-off-by: machichima <nary12321@gmail.com>

* build: add -race to go test

Signed-off-by: machichima <nary12321@gmail.com>

* Trigger CI

Signed-off-by: machichima <nary12321@gmail.com>

* fix: set --platform linux/amd64 to run on linux

Signed-off-by: machichima <nary12321@gmail.com>

---------

Signed-off-by: machichima <nary12321@gmail.com>
Co-authored-by: Future-Outlier <eric901201@gmail.com>

Author: machichima

historyserver/Dockerfile.collector

@@ -1,6 +1,7 @@
 FROM golang:1.25.1 AS builder
 
 ARG GOPROXY=https://proxy.golang.org,direct
+ARG ENABLE_RACE=false
 ENV GOPROXY=${GOPROXY}
 WORKDIR /historyserver
 
@@ -18,7 +19,11 @@ COPY pkg/utils/ pkg/utils/
 
 # Build the collector binary.
 COPY Makefile Makefile
-RUN make buildcollector GOOS=linux GOARCH=amd64
+RUN if [ "$ENABLE_RACE" = "true" ]; then \
+        make buildcollector-race GOOS=linux GOARCH=amd64; \
+    else \
+        make buildcollector GOOS=linux GOARCH=amd64; \
+    fi
 
 FROM ubuntu:22.04
 RUN apt-get update && apt-get upgrade -y && rm -rf /var/cache/apt/ && apt-get install -y ca-certificates

historyserver/Makefile

@@ -56,6 +56,12 @@ buildcollector: mod
 	@echo "go build ..."
 	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) go build -v $(GO_BUILD_FLAGS) -o $(BIN_DIR)/$(BINARY_NAME_COLLECTOR) ./cmd/collector/main.go
 
+.PHONY: buildcollector-race
+buildcollector-race: mod
+	@echo ""
+	@echo "go build with race detector..."
+	CGO_ENABLED=1 GOOS=$(GOOS) GOARCH=$(GOARCH) go build -race -v $(GO_BUILD_FLAGS) -o $(BIN_DIR)/$(BINARY_NAME_COLLECTOR) ./cmd/collector/main.go
+
 .PHONY: buildhistoryserver
 #build: mod alllint test
 buildhistoryserver: mod
@@ -87,6 +93,10 @@ else
 	${ENGINE} build -t $(COLLECTOR_IMG) --build-arg GOPROXY=$(GOPROXY) -f Dockerfile.collector .
 endif
 
+.PHONY: localimage-collector-race
+localimage-collector-race:
+	${ENGINE} build --platform linux/amd64 -t $(COLLECTOR_IMG)-race --build-arg GOPROXY=$(GOPROXY) --build-arg ENABLE_RACE=true -f Dockerfile.collector .
+
 .PHONY: localimage-historyserver
 localimage-historyserver:
 ifdef PLATFORM
@@ -105,7 +115,7 @@ endif
 # Run tests
 .PHONY: test
 test:
-	go test -v ./pkg/... ./cmd/...
+	go test -race -v ./pkg/... ./cmd/...
 
 .PHONY: alllint
 alllint: todolist issuelint ## Run go lint against code.

historyserver/docs/set_up_collector.md

@@ -76,6 +76,9 @@ k9s
 # Build the collector image.
 make -C historyserver localimage-collector
 
+# Or to build the collector image with race detector
+# make -C historyserver localimage-collector-race
+
 # Check the built image.
 docker images | grep collector
 ```
@@ -89,6 +92,9 @@ it.
 # Load the image into the kind cluster.
 kind load docker-image collector:v0.1.0
 
+# Or to load the collector image with race detector
+# kind load docker-image collector:v0.1.0-race
+
 # Check the loaded image.
 docker exec -it kind-control-plane crictl images | grep collector
 ```