Skip to content

feat: migrate logger generics #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReneWerner87 merged 1 commit into from
Aug 24, 2025
Merged

feat: migrate logger generics #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cmd/internal/migrations/lists.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ var Migrations = []Migration{
v3migrations.MigrateAddMethod,
v3migrations.MigrateMimeConstants,
v3migrations.MigrateLoggerTags,
v3migrations.MigrateLoggerGenerics,
v3migrations.MigrateStaticRoutes,
v3migrations.MigrateTrustedProxyConfig,
v3migrations.MigrateMount,
Expand Down
37 changes: 37 additions & 0 deletions cmd/internal/migrations/v3/logger_generics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package v3

import (
"fmt"
"regexp"

semver "github.com/Masterminds/semver/v3"
"github.com/spf13/cobra"

"github.com/gofiber/cli/cmd/internal"
)

func MigrateLoggerGenerics(cmd *cobra.Command, cwd string, _, _ *semver.Version) error {
reAllLogger := regexp.MustCompile(`(\w+)\.AllLogger([^\w\[]|$)`)
reConfigurableLogger := regexp.MustCompile(`(\w+)\.ConfigurableLogger([^\w\[]|$)`)
reDefaultLogger := regexp.MustCompile(`(\w+)\.DefaultLogger\(\)`)
reSetLogger := regexp.MustCompile(`(\w+)\.SetLogger\(`)
reLoggerToWriter := regexp.MustCompile(`(\w+)\.LoggerToWriter\(`)

changed, err := internal.ChangeFileContent(cwd, func(content string) string {
content = reAllLogger.ReplaceAllString(content, `$1.AllLogger[any]$2`)
content = reConfigurableLogger.ReplaceAllString(content, `$1.ConfigurableLogger[any]$2`)
content = reDefaultLogger.ReplaceAllString(content, `$1.DefaultLogger[any]()`)
content = reSetLogger.ReplaceAllString(content, `$1.SetLogger[any](`)
content = reLoggerToWriter.ReplaceAllString(content, `$1.LoggerToWriter[any](`)
return content
})
if err != nil {
return fmt.Errorf("failed to migrate logger generics: %w", err)
}
if !changed {
return nil
}

cmd.Println("Migrating logger generics")
return nil
}
Comment on lines +13 to +37
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Aug 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For performance and to follow Go best practices, regular expressions should be compiled only once. You can define them as package-level variables using regexp.MustCompile. This avoids recompiling them every time MigrateLoggerGenerics is called. While the performance impact is likely negligible in this command-line tool context, this change improves code structure and adheres to common Go idioms.

var (
	reAllLogger          = regexp.MustCompile("(\\w+)\\.AllLogger([^\\w\\[]|$)")
	reConfigurableLogger = regexp.MustCompile("(\\w+)\\.ConfigurableLogger([^\\w\\[]|$)")
	reDefaultLogger      = regexp.MustCompile("(\\w+)\\.DefaultLogger\\(\\)")
	reSetLogger          = regexp.MustCompile("(\\w+)\\.SetLogger\\(")
	reLoggerToWriter     = regexp.MustCompile("(\\w+)\\.LoggerToWriter\\(")
)

func MigrateLoggerGenerics(cmd *cobra.Command, cwd string, _, _ *semver.Version) error {
	changed, err := internal.ChangeFileContent(cwd, func(content string) string {
		content = reAllLogger.ReplaceAllString(content, "$1.AllLogger[any]$2")
		content = reConfigurableLogger.ReplaceAllString(content, "$1.ConfigurableLogger[any]$2")
		content = reDefaultLogger.ReplaceAllString(content, "$1.DefaultLogger[any]()")
		content = reSetLogger.ReplaceAllString(content, "$1.SetLogger[any](")
		content = reLoggerToWriter.ReplaceAllString(content, "$1.LoggerToWriter[any](")
		return content
	})
	if err != nil {
		return fmt.Errorf("failed to migrate logger generics: %w", err)
	}
	if !changed {
		return nil
	}

	cmd.Println("Migrating logger generics")
	return nil
}

47 changes: 47 additions & 0 deletions cmd/internal/migrations/v3/logger_generics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package v3_test

import (
"bytes"
"os"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/gofiber/cli/cmd/internal/migrations/v3"
)

func Test_MigrateLoggerGenerics(t *testing.T) {
t.Parallel()

dir, err := os.MkdirTemp("", "mloggenericstest")
require.NoError(t, err)
defer func() { require.NoError(t, os.RemoveAll(dir)) }()

file := writeTempFile(t, dir, `package main
import (
fiberlog "github.com/gofiber/fiber/v2/log"
)
var _ fiberlog.AllLogger = (*customLogger)(nil)
var _ fiberlog.ConfigurableLogger = (*customLogger)(nil)
func main() {
logger := fiberlog.DefaultLogger()
fiberlog.SetLogger(logger)
_ = fiberlog.LoggerToWriter(logger, fiberlog.LevelInfo)
}
`)

var buf bytes.Buffer
cmd := newCmd(&buf)
require.NoError(t, v3.MigrateLoggerGenerics(cmd, dir, nil, nil))

content := readFile(t, file)
assert.NotContains(t, content, "AllLogger =")
assert.NotContains(t, content, "ConfigurableLogger =")
assert.Contains(t, content, "AllLogger[any]")
assert.Contains(t, content, "ConfigurableLogger[any]")
assert.Contains(t, content, "DefaultLogger[any]()")
assert.Contains(t, content, "SetLogger[any](")
assert.Contains(t, content, "LoggerToWriter[any](")
assert.Contains(t, buf.String(), "Migrating logger generics")
}
Loading