Files
Kent GruberandGitHub eadf754dc8 Use better string splitting techniques where possible (#8226)
## What changed?

This PR aims to avoid usage of
[`strings.Split`](https://pkg.go.dev/strings#Split) where possible in
favor of better string splitting techniques, speficially:
[`strings.SplitN`](https://pkg.go.dev/strings#SplitN) and
[`strings.SplitSeq`](https://pkg.go.dev/strings#SplitSeq) where
appropriate.

There was also a [`strings.Fields`](https://pkg.go.dev/strings#Fields)
change I made to use
[`strings.FieldsSeq`](https://pkg.go.dev/strings#FieldsSeq) instead, and
another for S3 to use the [`path`](https://pkg.go.dev/path) package
instead of [`strings.Split`](https://pkg.go.dev/strings#Split).

## Why?

[`strings.SplitN`](https://pkg.go.dev/strings#SplitN) and
[`strings.SplitSeq`](https://pkg.go.dev/strings#SplitSeq) are often
better options in many cases, and can be _partially_ detected using
[`modernize`](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/modernize):
> `stringsseq`: replace Split in "for range strings.Split(...)" by
go1.24's more efficient `SplitSeq`, or `Fields` with `FieldSeq`.

## How did you test it?
- [X] built
- [X] run locally and tested manually
- [x] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)

## Potential risks

There are lots of potentially subtle behaviors from the `strings.Split`
(and `strings.Fields`) usage that should be accounted for. If our
existing tests don't cover those subtleties, there's risk for
introducing an unintended bug. More intricate handling/parsing
previously using the `strings` package should get extra attention from
reviewers. I've attempted to break up my changes into logical commit
chunks to aid in review / help spot potentially concerning changes.
2025-08-26 13:23:40 -04:00

185 lines
4.3 KiB
Go

package main
import (
"flag"
"fmt"
"io/fs"
"log"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
expmaps "golang.org/x/exp/maps"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protodesc"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/descriptorpb"
)
var (
matchImport = regexp.MustCompile(`^\s*import\s+"([^"]+\.proto)"\s*;\s*$`)
versionSuffix = regexp.MustCompile(`^(.*)/v\d+$`)
// set by files.go if present
importMap map[string]protoreflect.FileDescriptor
)
func fatalIfErr(err error) {
if err != nil {
log.Fatal(err)
}
}
func findProtoImports() []string {
importMap := make(map[string]struct{})
fatalIfErr(filepath.WalkDir("proto/internal", func(path string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
if d.Type().IsRegular() && strings.HasSuffix(path, ".proto") {
protoFile, err := os.ReadFile(path)
fatalIfErr(err)
for line := range strings.SplitSeq(string(protoFile), "\n") {
if match := matchImport.FindStringSubmatch(line); len(match) > 0 {
i := match[1]
if strings.HasPrefix(i, "temporal/api/") ||
strings.HasPrefix(i, "google/") {
importMap[i] = struct{}{}
}
}
}
}
return nil
}))
return expmaps.Keys(importMap)
}
func getImportName(i string) string {
withoutV := i
if match := versionSuffix.FindStringSubmatch(i); match != nil {
withoutV = match[1]
}
return filepath.Base(withoutV)
}
func mangle(p string) string {
mangled := strings.ReplaceAll(p, "/", "_")
return "File_" + strings.ReplaceAll(mangled, ".", "_")
}
func genFileList(protoImports []string) {
sort.Strings(protoImports)
goImportsMap := make(map[string]string)
protoToPackage := make(map[string]string)
for _, i := range protoImports {
if strings.HasPrefix(i, "temporal/api/") {
goImport := filepath.Dir(strings.Replace(i, "temporal/api/", "go.temporal.io/api/", 1))
importName := getImportName(goImport)
goImportsMap[goImport] = importName
protoToPackage[i] = importName
} else if strings.HasPrefix(i, "google/") {
base := strings.TrimSuffix(filepath.Base(i), ".proto") + "pb"
base = strings.ReplaceAll(base, "field_mask", "fieldmask")
goImport := "google.golang.org/protobuf/types/known/" + base
goImportsMap[goImport] = base
protoToPackage[i] = base
}
}
goImports := expmaps.Keys(goImportsMap)
sort.Strings(goImports)
out, err := os.Create("cmd/tools/getproto/files.go")
fatalIfErr(err)
defer out.Close()
fmt.Fprintf(out, `
// Code generated by getproto. DO NOT EDIT.
// If you get build errors in this file, just delete it. It will be regenerated.
package main
import (
"google.golang.org/protobuf/reflect/protoreflect"
`)
for _, i := range goImports {
fmt.Fprintf(out, "\t%s %q\n", goImportsMap[i], i)
}
fmt.Fprintf(out, `)
func init() {
importMap = make(map[string]protoreflect.FileDescriptor)
`)
for _, i := range protoImports {
fmt.Fprintf(out, "\timportMap[%q] = %s.%s\n", i, protoToPackage[i], mangle(i))
}
out.WriteString("}\n")
}
func addImports(missing []string) {
newImportMap := make(map[string]struct{})
for i, _ := range importMap {
newImportMap[i] = struct{}{}
}
for _, i := range missing {
newImportMap[i] = struct{}{}
}
genFileList(expmaps.Keys(newImportMap))
fmt.Println("<rerun>")
os.Exit(0)
}
func initSeeds() {
genFileList(findProtoImports())
fmt.Println("<rerun>")
os.Exit(0)
}
func checkImports(files map[string]protoreflect.FileDescriptor) {
missing := make(map[string]struct{})
for _, fd := range files {
imports := fd.Imports()
num := imports.Len()
for i := 0; i < num; i++ {
imp := imports.Get(i).Path()
if strings.HasPrefix(imp, "temporal/api/") || strings.HasPrefix(imp, "google/") {
if _, ok := files[imp]; !ok {
missing[imp] = struct{}{}
}
}
}
}
if len(missing) > 0 {
addImports(expmaps.Keys(missing)) // doesn't return
}
}
func main() {
out := flag.String("out", "", "where to put the serialized FileDescriptorSet")
flag.Parse()
if *out == "" {
flag.Usage()
os.Exit(1)
}
if len(importMap) == 0 {
initSeeds() // doesn't return
}
checkImports(importMap) // doesn't return if any errors
set := &descriptorpb.FileDescriptorSet{}
for _, fd := range importMap {
set.File = append(set.File, protodesc.ToFileDescriptorProto(fd))
}
b, err := proto.Marshal(set)
fatalIfErr(err)
fatalIfErr(os.WriteFile(*out, b, 0644))
}