Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
129 changes: 108 additions & 21 deletions cmd/internal/migrations/v3/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,48 +166,135 @@ func replaceField(src, field string, fn func(indent, val, comma, comment, newlin
}

func replaceFieldImpl(src, field string, unquote bool, fn func(indent, val, comma, comment, newline string) string) string {
re := regexp.MustCompile(`(?m)^(\s*)` + regexp.QuoteMeta(field) + `:\s*([^\n]+)(\n?)`)
return re.ReplaceAllStringFunc(src, func(s string) string {
sub := re.FindStringSubmatch(s)
indent := sub[1]
val := strings.TrimSpace(sub[2])
newline := sub[3]

comment := ""
if idx := strings.Index(val, "//"); idx >= 0 {
comment = strings.TrimSpace(val[idx:])
val = strings.TrimSpace(val[:idx])
} else if idx := strings.Index(val, "/*"); idx >= 0 {
comment = strings.TrimSpace(val[idx:])
val = strings.TrimSpace(val[:idx])
re := regexp.MustCompile(regexp.QuoteMeta(field) + `:\s*`)
var b strings.Builder
pos := 0

for {
loc := re.FindStringIndex(src[pos:])
if loc == nil {
break
}
loc[0] += pos
loc[1] += pos

start := loc[0]
valStart := loc[1]

prefix := ""
prefixStart := start
if prefixStart > 0 && (src[prefixStart-1] == '{' || src[prefixStart-1] == ',') {
prefix = string(src[prefixStart-1])
prefixStart--
}

indentStart := prefixStart
for indentStart > 0 && (src[indentStart-1] == ' ' || src[indentStart-1] == '\t') {
indentStart--
}
indent := src[indentStart:prefixStart]

b.WriteString(src[pos:indentStart]) //nolint:errcheck // WriteString never returns an error

i := valStart
depth := 0
inString := false
comma := ""
newline := ""
for i < len(src) {
ch := src[i]
if inString {
if ch == '\\' && i+1 < len(src) {
i += 2
continue
}
if ch == '"' {
inString = false
}
i++
continue
}

switch ch {
case '"':
inString = true
case '(', '{', '[':
depth++
case ')', ']':
if depth > 0 {
depth--
}
case '}':
if depth == 0 {
goto endValue
}
depth--
case ',':
if depth == 0 {
comma = ","
suffixStart := i
i = skipCommaSuffix(src, i)
if strings.Contains(src[suffixStart:i], "\n") {
newline = "\n"
}
goto endValue
}
case '\n':
if depth == 0 {
newline = "\n"
i++
goto endValue
}
default:
}
i++
}

endValue:
end := i
val := strings.TrimSpace(src[valStart:end])
val, comment := ExtractCommentAndValue(val)

if strings.HasSuffix(val, ",") {
comma = ","
if comma == "" {
comma = ","
}
val = strings.TrimSpace(strings.TrimSuffix(val, ","))
}

if unquote {
uq, err := strconv.Unquote(val)
if err != nil {
replacement := fmt.Sprintf("%s%s// TODO: migrate %s: %s", prefix, indent, field, val)
if comment != "" {
return fmt.Sprintf("%s// TODO: migrate %s: %s %s%s", indent, field, val, comment, newline)
replacement = fmt.Sprintf("%s %s", replacement, comment)
}
return fmt.Sprintf("%s// TODO: migrate %s: %s%s", indent, field, val, newline)
replacement += newline
b.WriteString(replacement) //nolint:errcheck // WriteString never returns an error
pos = end
continue
}
val = uq
}

repl := fn(indent, val, comma, comment, newline)
var replacement string
if repl == "" {
if comment != "" {
return fmt.Sprintf("%s%s%s", indent, comment, newline)
replacement = fmt.Sprintf("%s%s%s%s", prefix, indent, comment, newline)
} else {
replacement = prefix + newline
}
return newline
} else {
replacement = prefix + repl
}
return repl
})

b.WriteString(replacement) //nolint:errcheck // WriteString never returns an error
pos = end
}

b.WriteString(src[pos:]) //nolint:errcheck // WriteString never returns an error
return b.String()
}

func collectAliases(content string, reImport *regexp.Regexp, defaults []string) []string {
Expand Down
123 changes: 123 additions & 0 deletions cmd/internal/migrations/v3/jwt_extractor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,29 @@ var _ = authjwt.New(authjwt.Config{
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}

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

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

file := writeTempFile(t, dir, `package main
import jwtware "github.com/gofiber/contrib/jwt"

var _ = jwtware.New(jwtware.Config{TokenLookup: "cookie:jwt"})`)

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

content := readFile(t, file)
assert.NotContains(t, content, "TokenLookup")
assert.Regexp(t, `Extractor:\s*extractors.FromCookie\("jwt"\)`, content)
assert.Contains(t, content, `"github.com/gofiber/fiber/v3/extractors"`)
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}

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

Expand Down Expand Up @@ -124,6 +147,76 @@ func JWTMiddleware() fiber.Handler {
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}

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

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

file := writeTempFile(t, dir, `package auth

import (
"os"
"strconv"

jwtware "github.com/gofiber/contrib/jwt"
"github.com/gofiber/fiber/v2"
"github.com/golang-jwt/jwt/v5"
)

// JWT error message.
func jwtError(c *fiber.Ctx, err error) error {
if err.Error() == "Missing or malformed JWT" {
return c.Status(fiber.StatusBadRequest).JSON(&fiber.Map{
"status": "error",
"message": "Missing or malformed JWT!",
})
}

return c.Status(fiber.StatusUnauthorized).JSON(&fiber.Map{
"status": "error",
"message": "Invalid or expired JWT!",
})
}

// Guards a specific endpoint in the API.
func JWTMiddleware() fiber.Handler {
return jwtware.New(jwtware.Config{
ErrorHandler: jwtError,
SigningKey: jwtware.SigningKey{Key: []byte(os.Getenv("JWT_SECRET"))},
TokenLookup: "cookie:jwt",
})
}

// Gets user data (their ID) from the JWT middleware. Should be executed after calling 'JWTMiddleware()'.
func GetDataFromJWT(c *fiber.Ctx) error {
jwtData := c.Locals("user").(*jwt.Token)
claims := jwtData.Claims.(jwt.MapClaims)
parsedUserID := claims["uid"].(string)
userID, err := strconv.Atoi(parsedUserID)
if err != nil {
return c.Status(fiber.StatusInternalServerError).JSON(&fiber.Map{
"status": "fail",
"message": err.Error(),
})
}

c.Locals("currentUser", userID)
return c.Next()
}`)

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

content := readFile(t, file)
assert.NotContains(t, content, "TokenLookup")
assert.Regexp(t, `Extractor:\s*extractors.FromCookie\("jwt"\)`, content)
assert.Contains(t, content, `"github.com/gofiber/fiber/v3/extractors"`)
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}

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

Expand Down Expand Up @@ -157,6 +250,36 @@ func JWTMiddleware() fiber.Handler {
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}

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

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

file := writeTempFile(t, dir, `package main
import (
jwtware "github.com/gofiber/contrib/jwt"
"github.com/gofiber/fiber/v2"
)

func JWTMiddleware() fiber.Handler {
return jwtware.New(&jwtware.Config{
TokenLookup: "cookie:jwt",
})
}`)

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

content := readFile(t, file)
assert.NotContains(t, content, "TokenLookup")
assert.Regexp(t, `Extractor:\s*extractors.FromCookie\("jwt"\)`, content)
assert.Contains(t, content, `"github.com/gofiber/fiber/v3/extractors"`)
assert.Contains(t, buf.String(), "Migrating jwt middleware configs")
}
Comment thread
ReneWerner87 marked this conversation as resolved.

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

Expand Down
Loading