Add contrib v3 migration and update contrib tooling #222
+251
−12
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package v3 | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io/fs" | ||
| "os" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| semver "github.com/Masterminds/semver/v3" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/gofiber/cli/cmd/internal" | ||
| ) | ||
|
|
||
| var ( | ||
| contribImportRe = regexp.MustCompile(`(["\x60])github\.com/gofiber/contrib/([^"\x60\s]+)`) | ||
| contribModRe = regexp.MustCompile(`github\.com/gofiber/contrib/[^\s]+`) | ||
| ) | ||
|
|
||
| const ( | ||
| contribPrefix = "github.com/gofiber/contrib/" | ||
| contribV3Prefix = "github.com/gofiber/contrib/v3/" | ||
| ) | ||
|
|
||
| // MigrateContribPackages updates imports and module requirements that reference | ||
| // github.com/gofiber/contrib to use the v3 module path. | ||
| func MigrateContribPackages(cmd *cobra.Command, cwd string, _, _ *semver.Version) error { | ||
| changedImports, err := internal.ChangeFileContent(cwd, func(content string) string { | ||
| return contribImportRe.ReplaceAllStringFunc(content, func(match string) string { | ||
| sub := contribImportRe.FindStringSubmatch(match) | ||
| if len(sub) != 3 { | ||
| return match | ||
| } | ||
| rest := sub[2] | ||
| if hasVersionPrefix(rest) { | ||
| return match | ||
| } | ||
| return sub[1] + contribV3Prefix + rest | ||
| }) | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to migrate contrib imports: %w", err) | ||
| } | ||
|
|
||
| modChanged := false | ||
| walkErr := filepath.WalkDir(cwd, func(path string, d fs.DirEntry, walkErr error) error { | ||
| if walkErr != nil { | ||
| return walkErr | ||
| } | ||
| if d.IsDir() { | ||
| if d.Name() == "vendor" { | ||
| return filepath.SkipDir | ||
| } | ||
| return nil | ||
| } | ||
| if d.Name() != "go.mod" { | ||
| return nil | ||
| } | ||
|
|
||
| b, err := os.ReadFile(path) // #nosec G304 -- reading module file | ||
| if err != nil { | ||
| return fmt.Errorf("read %s: %w", path, err) | ||
| } | ||
| content := string(b) | ||
| if !contribModRe.MatchString(content) { | ||
| return nil | ||
| } | ||
| updated := contribModRe.ReplaceAllStringFunc(content, func(match string) string { | ||
| rest := strings.TrimPrefix(match, contribPrefix) | ||
| if rest == match || hasVersionPrefix(rest) { | ||
| return match | ||
| } | ||
| return contribV3Prefix + rest | ||
| }) | ||
| if updated == content { | ||
| return nil | ||
| } | ||
| if err := os.WriteFile(path, []byte(updated), 0o600); err != nil { | ||
| return fmt.Errorf("write %s: %w", path, err) | ||
| } | ||
| modChanged = true | ||
| return nil | ||
| }) | ||
| if walkErr != nil { | ||
| return fmt.Errorf("failed to migrate contrib modules: %w", walkErr) | ||
| } | ||
|
|
||
| if !changedImports && !modChanged { | ||
| return nil | ||
| } | ||
|
|
||
| cmd.Println("Migrating contrib packages") | ||
| return nil | ||
| } | ||
|
|
||
| func hasVersionPrefix(rest string) bool { | ||
| if len(rest) < 2 || rest[0] != 'v' || rest[1] < '0' || rest[1] > '9' { | ||
| return false | ||
| } | ||
| i := 2 | ||
| for i < len(rest) && rest[i] >= '0' && rest[i] <= '9' { | ||
| i++ | ||
| } | ||
| if i == len(rest) { | ||
| return true | ||
| } | ||
| return rest[i] == '/' | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| package v3_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/gofiber/cli/cmd/internal/migrations/v3" | ||
| ) | ||
|
|
||
| func Test_MigrateContribPackages(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dir := t.TempDir() | ||
|
|
||
| file := writeTempFile(t, dir, `package main | ||
| import ( | ||
| session "github.com/gofiber/contrib/session" | ||
| ) | ||
|
|
||
| func main() { | ||
| _ = session.NewStore | ||
| }`) | ||
|
|
||
| modContent := `module example | ||
|
|
||
| go 1.22 | ||
|
|
||
| require ( | ||
| github.com/gofiber/fiber/v2 v2.0.0 | ||
| github.com/gofiber/contrib/session v1.2.3 | ||
| )` | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "go.mod"), []byte(modContent), 0o600)) | ||
|
|
||
| var buf bytes.Buffer | ||
| cmd := newCmd(&buf) | ||
| require.NoError(t, v3.MigrateContribPackages(cmd, dir, nil, nil)) | ||
|
|
||
| content := readFile(t, file) | ||
| assert.Contains(t, content, "github.com/gofiber/contrib/v3/session") | ||
| assert.NotContains(t, content, "github.com/gofiber/contrib/session") | ||
|
|
||
| mod := readFile(t, filepath.Join(dir, "go.mod")) | ||
| assert.Contains(t, mod, "github.com/gofiber/contrib/v3/session v1.2.3") | ||
| assert.NotContains(t, mod, "github.com/gofiber/contrib/session v1.2.3") | ||
|
|
||
| assert.Contains(t, buf.String(), "Migrating contrib packages") | ||
| } | ||
|
|
||
| func Test_MigrateContribPackages_Replace(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dir := t.TempDir() | ||
|
|
||
| file := writeTempFile(t, dir, `package main | ||
| import ( | ||
| websocket "github.com/gofiber/contrib/websocket" | ||
| ) | ||
|
|
||
| var _ = websocket.New`) // keep import | ||
|
|
||
| modContent := `module example | ||
|
|
||
| go 1.22 | ||
|
|
||
| require github.com/gofiber/contrib/websocket v1.0.0 | ||
|
|
||
| replace github.com/gofiber/contrib/websocket => ../local` | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "go.mod"), []byte(modContent), 0o600)) | ||
|
|
||
| var buf bytes.Buffer | ||
| cmd := newCmd(&buf) | ||
| require.NoError(t, v3.MigrateContribPackages(cmd, dir, nil, nil)) | ||
|
|
||
| content := readFile(t, file) | ||
| assert.Contains(t, content, "github.com/gofiber/contrib/v3/websocket") | ||
|
|
||
| mod := readFile(t, filepath.Join(dir, "go.mod")) | ||
| assert.Contains(t, mod, "github.com/gofiber/contrib/v3/websocket v1.0.0") | ||
| assert.Contains(t, mod, "replace github.com/gofiber/contrib/v3/websocket => ../local") | ||
|
|
||
| assert.Contains(t, buf.String(), "Migrating contrib packages") | ||
| } | ||
|
|
||
| func Test_MigrateContribPackages_Idempotent(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dir := t.TempDir() | ||
|
|
||
| file := writeTempFile(t, dir, `package main | ||
| import ( | ||
| "github.com/gofiber/contrib/v3/session" | ||
| ) | ||
|
|
||
| func main() { | ||
| _ = session.NewStore | ||
| }`) | ||
|
|
||
| modContent := `module example | ||
|
|
||
| go 1.22 | ||
|
|
||
| require github.com/gofiber/contrib/v3/session v1.2.3` | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "go.mod"), []byte(modContent), 0o600)) | ||
|
|
||
| var buf bytes.Buffer | ||
| cmd := newCmd(&buf) | ||
| require.NoError(t, v3.MigrateContribPackages(cmd, dir, nil, nil)) | ||
| first := readFile(t, file) | ||
| firstMod := readFile(t, filepath.Join(dir, "go.mod")) | ||
|
|
||
| require.NoError(t, v3.MigrateContribPackages(cmd, dir, nil, nil)) | ||
| second := readFile(t, file) | ||
| secondMod := readFile(t, filepath.Join(dir, "go.mod")) | ||
|
|
||
| assert.Equal(t, first, second) | ||
| assert.Equal(t, firstMod, secondMod) | ||
| assert.Equal(t, "", buf.String()) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When updating the
go.modfile, the original file permissions are not preserved becauseos.WriteFileis called with a hardcoded mode0o600. This could cause unexpected permission changes in the user's project. It's better to read the original file's permissions and use them when writing the updated file.