Merge pull request prometheus#17713 from roidelapluie/roidelapluie/fix_ui_updates

web/ui: Add checks for Mantine UI PromQL docs and update generated files

Author: roidelapluie

.github/workflows/ci.yml

@@ -202,20 +202,22 @@ jobs:
         if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
         run: exit 1
   check_generated_parser:
+    # Checks generated parser and UI functions list. Not renaming as it is a required check.
     name: Check generated parser
     runs-on: ubuntu-latest
+    container:
+      image: quay.io/prometheus/golang-builder:1.25-base
     steps:
       - name: Checkout repository
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
         with:
           persist-credentials: false
-      - name: Install Go
-        uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6.1.0
+      - uses: prometheus/promci@c0916f0a41f13444612a8f0f5e700ea34edd7c19 # v0.5.3
+      - uses: ./.github/promci/actions/setup_environment
         with:
-          cache: false
-          go-version: 1.25.x
-      - name: Run goyacc and check for diff
-        run: make install-goyacc check-generated-parser
+          enable_npm: true
+      - run: make install-goyacc check-generated-parser
+      - run: make check-generated-promql-functions
   golangci:
     name: golangci-lint
     runs-on: ubuntu-latest

.gitignore

@@ -26,6 +26,7 @@ npm_licenses.tar.bz2
 
 /vendor
 /.build
+/go.work.sum
 
 /**/node_modules
 

Makefile

@@ -79,6 +79,20 @@ ui-lint:
 	# new Mantine-based UI is fully integrated and the old app can be removed.
 	cd $(UI_PATH)/react-app && npm run lint
 
+.PHONY: generate-promql-functions
+generate-promql-functions: ui-install
+	@echo ">> generating PromQL function signatures"
+	@cd $(UI_PATH)/mantine-ui/src/promql/tools && $(GO) run ./gen_functions_list > ../functionSignatures.ts
+	@echo ">> generating PromQL function documentation"
+	@cd $(UI_PATH)/mantine-ui/src/promql/tools && $(GO) run ./gen_functions_docs $(CURDIR)/docs/querying/functions.md > ../functionDocs.tsx
+	@echo ">> formatting generated files"
+	@cd $(UI_PATH)/mantine-ui && npx prettier --write --print-width 120 src/promql/functionSignatures.ts src/promql/functionDocs.tsx
+
+.PHONY: check-generated-promql-functions
+check-generated-promql-functions: generate-promql-functions
+	@echo ">> checking generated PromQL functions"
+	@git diff --exit-code -- $(UI_PATH)/mantine-ui/src/promql/functionSignatures.ts $(UI_PATH)/mantine-ui/src/promql/functionDocs.tsx || (echo "Generated PromQL function files are out of date. Please run 'make generate-promql-functions' and commit the changes." && false)
+
 .PHONY: assets
 ifndef SKIP_UI_BUILD
 assets: check-node-version ui-install ui-build
@@ -194,6 +208,8 @@ GO_SUBMODULE_DIRS := documentation/examples/remote_storage internal/tools web/ui
 .PHONY: update-all-go-deps
 update-all-go-deps: update-go-deps
 	$(foreach dir,$(GO_SUBMODULE_DIRS),$(MAKE) update-go-deps-in-dir DIR=$(dir);)
+	@echo ">> syncing Go workspace"
+	@$(GO) work sync
 
 .PHONY: update-go-deps-in-dir
 update-go-deps-in-dir:

go.work

@@ -0,0 +1,8 @@
+go 1.24.9
+
+use (
+	.
+	./documentation/examples/remote_storage
+	./internal/tools
+	./web/ui/mantine-ui/src/promql/tools
+)

web/ui/mantine-ui/src/promql/functionDocs.tsx

@@ -18,28 +18,31 @@ import (
 	"fmt"
 	"io"
 	"log"
-	"net/http"
+	"os"
 	"sort"
 	"strings"
 
 	"github.com/grafana/regexp"
 	"github.com/russross/blackfriday/v2"
 )
 
-var funcDocsRe = regexp.MustCompile("^## `(.+)\\(\\)`\n$|^## (Trigonometric Functions)\n$")
+var funcDocsRe = regexp.MustCompile("^## `([^)]+)\\(\\)` and `([^)]+)\\(\\)`\n$|^## `(.+)\\(\\)`\n$|^## (Trigonometric Functions)\n$")
 
 func main() {
-	resp, err := http.Get("https://raw.githubusercontent.com/prometheus/prometheus/master/docs/querying/functions.md")
-	if err != nil {
-		log.Fatalln("Failed to fetch function docs:", err)
+	// Read from local file instead of fetching from upstream.
+	if len(os.Args) < 2 {
+		log.Fatalln("Usage: gen_functions_docs <path-to-functions.md>")
 	}
-	if resp.StatusCode != 200 {
-		log.Fatalln("Bad status code while fetching function docs:", resp.Status)
+	functionsPath := os.Args[1]
+	file, err := os.Open(functionsPath)
+	if err != nil {
+		log.Fatalln("Failed to open function docs:", err)
 	}
+	defer file.Close()
 
 	funcDocs := map[string]string{}
 
-	r := bufio.NewReader(resp.Body)
+	r := bufio.NewReader(file)
 	currentFunc := ""
 	currentDocs := ""
 
@@ -58,6 +61,11 @@ func main() {
 				"last_over_time",
 				"present_over_time",
 				"mad_over_time",
+				"first_over_time",
+				"ts_of_first_over_time",
+				"ts_of_last_over_time",
+				"ts_of_max_over_time",
+				"ts_of_min_over_time",
 			} {
 				funcDocs[fn] = currentDocs
 			}
@@ -81,6 +89,12 @@ func main() {
 			} {
 				funcDocs[fn] = currentDocs
 			}
+		case "histogram_count_and_histogram_sum":
+			funcDocs["histogram_count"] = currentDocs
+			funcDocs["histogram_sum"] = currentDocs
+		case "histogram_stddev_and_histogram_stdvar":
+			funcDocs["histogram_stddev"] = currentDocs
+			funcDocs["histogram_stdvar"] = currentDocs
 		default:
 			funcDocs[currentFunc] = currentDocs
 		}
@@ -103,10 +117,16 @@ func main() {
 			}
 			currentDocs = ""
 
-			currentFunc = string(matches[1])
-			if matches[2] != "" {
-				// This is the case for "## Trigonometric Functions"
-				currentFunc = matches[2]
+			if matches[1] != "" && matches[2] != "" {
+				// Combined functions: "## `function1()` and `function2()`"
+				// Store as "function1_and_function2" and handle in saveCurrent.
+				currentFunc = matches[1] + "_and_" + matches[2]
+			} else if matches[3] != "" {
+				// Single function: "## `function_name()`"
+				currentFunc = string(matches[3])
+			} else if matches[4] != "" {
+				// Special section: "## Trigonometric Functions"
+				currentFunc = matches[4]
 			}
 		} else {
 			currentDocs += line

web/ui/mantine-ui/src/promql/functionSignatures.ts

@@ -41,10 +41,10 @@ func main() {
 	sort.Strings(fnNames)
 	fmt.Println(`import { valueType, Func } from './ast';
 
-	export const functionSignatures: Record<string, Func> = {`)
+export const functionSignatures: Record<string, Func> = {`)
 	for _, fnName := range fnNames {
 		fn := parser.Functions[fnName]
 		fmt.Printf("  %s: { name: '%s', argTypes: [%s], variadic: %d, returnType: %s },\n", fn.Name, fn.Name, formatValueTypes(fn.ArgTypes), fn.Variadic, formatValueType(fn.ReturnType))
 	}
-	fmt.Println("}")
+	fmt.Println("};")
 }