Skip to content

Commit

Permalink
Fix go imports at least 2x faster (filecoin-project#11695)
Browse files Browse the repository at this point in the history
Use native go implementation to sort and adjust imports. Compared to the
previous bash version, this is at least 2X faster.
  • Loading branch information
masih authored Mar 14, 2024
1 parent b909db3 commit b56af9b
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 25 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ actors-code-gen:
$(GOCC) fmt ./...

actors-gen: actors-code-gen
./scripts/fiximports
$(GOCC) run ./scripts/fiximports
.PHONY: actors-gen

bundle-gen:
Expand Down Expand Up @@ -392,10 +392,10 @@ docsgen-openrpc-gateway: docsgen-openrpc-bin
.PHONY: docsgen docsgen-md-bin docsgen-openrpc-bin

fiximports:
./scripts/fiximports
$(GOCC) run ./scripts/fiximports

gen: actors-code-gen type-gen cfgdoc-gen docsgen api-gen circleci
./scripts/fiximports
$(GOCC) run ./scripts/fiximports
@echo ">>> IF YOU'VE MODIFIED THE CLI OR CONFIG, REMEMBER TO ALSO RUN 'make docsgen-cli'"
.PHONY: gen

Expand Down
22 changes: 0 additions & 22 deletions scripts/fiximports

This file was deleted.

92 changes: 92 additions & 0 deletions scripts/fiximports/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package main

import (
"bytes"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"regexp"
"strings"

"golang.org/x/tools/imports"
)

var (
// groupByPrefixes is the list of import prefixes that should _each_ be grouped separately.
// See: imports.LocalPrefix.
groupByPrefixes = []string{
"github.com/filecoin-project",
"github.com/filecoin-project/lotus",
}
newline = []byte("\n")
importBlockRegex = regexp.MustCompile(`(?s)import\s*\((.*?)\)`)
consecutiveNewlinesRegex = regexp.MustCompile(`\n\s*\n`)
)

func main() {
if err := filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
switch {
case err != nil:
return err
case // Skip the entire "./extern/..." directory and its contents.
strings.HasPrefix(path, "extern/"):
return filepath.SkipDir
case // Skip directories, generated cborgen go files and any other non-go files.
info.IsDir(),
strings.HasSuffix(info.Name(), "_cbor_gen.go"),
!strings.HasSuffix(info.Name(), ".go"):
return nil
}
return fixGoImports(path)
}); err != nil {
fmt.Printf("Error fixing go imports: %v\n", err)
os.Exit(1)
}
}

func fixGoImports(path string) error {
sourceFile, err := os.OpenFile(path, os.O_RDWR, 0666)
if err != nil {
return err
}
defer func() { _ = sourceFile.Close() }()

source, err := io.ReadAll(sourceFile)
if err != nil {
return err
}
formatted := collapseImportNewlines(source)
for _, prefix := range groupByPrefixes {
imports.LocalPrefix = prefix
formatted, err = imports.Process(path, formatted, nil)
if err != nil {
return err
}
}
if !bytes.Equal(source, formatted) {
if err := replaceFileContent(sourceFile, formatted); err != nil {
return err
}
}
return nil
}

func replaceFileContent(target *os.File, replacement []byte) error {
if _, err := target.Seek(0, io.SeekStart); err != nil {
return err
}
written, err := target.Write(replacement)
if err != nil {
return err
}
return target.Truncate(int64(written))
}

func collapseImportNewlines(content []byte) []byte {
return importBlockRegex.ReplaceAllFunc(content, func(importBlock []byte) []byte {
// Replace consecutive newlines with a single newline within the import block
return consecutiveNewlinesRegex.ReplaceAll(importBlock, newline)
})
}

0 comments on commit b56af9b

Please sign in to comment.