refactor(GitlabInstance): update class attributes

use builtin retryablehttp client instead of homemade one
refactor the GitlabInstance init method to use a custom dict as singular arg instead of too many separate args
add a "Role" field to the GitlabInstance

Author: BoxBoxJason

internal/mirroring/const.go

@@ -0,0 +1,10 @@
+package mirroring
+
+const (
+	// GitLab Instance role keyword
+	ROLE = "role"
+	// Source GitLab Instance role
+	ROLE_SOURCE = "source"
+	// Destination GitLab Instance role
+	ROLE_DESTINATION = "destination"
+)

internal/mirroring/instance.go

@@ -6,23 +6,68 @@ import (
 
 	"gitlab-sync/internal/utils"
 
+	"github.com/hashicorp/go-retryablehttp"
 	gitlab "gitlab.com/gitlab-org/api/client-go"
+	"go.uber.org/zap"
 )
 
 type GitlabInstance struct {
-	Gitlab        *gitlab.Client
-	Projects      map[string]*gitlab.Project
-	muProjects    sync.RWMutex
-	Groups        map[string]*gitlab.Group
-	muGroups      sync.RWMutex
+	// Gitlab is the GitLab client used to interact with the GitLab API
+	Gitlab *gitlab.Client
+	// Projects is a map of project paths to GitLab project objects, it is used to
+	// cache projects and avoid unnecessary API calls
+	Projects map[string]*gitlab.Project
+	// muProjects is a mutex used to synchronize access to the Projects map
+	// It ensures that only one goroutine can read or write to the Projects map at a time
+	muProjects sync.RWMutex
+	// Groups is a map of group paths to GitLab group objects, it is used to
+	// cache groups and avoid unnecessary API calls
+	Groups map[string]*gitlab.Group
+	// muGroups is a mutex used to synchronize access to the Groups map
+	// It ensures that only one goroutine can read or write to the Groups map at a time
+	muGroups sync.RWMutex
+	// GraphQLClient is the GraphQL client used to interact with the GitLab GraphQL API
+	// It is used to perform GraphQL queries and mutations
+	// It is initialized with the GitLab token and URL
 	GraphQLClient *utils.GraphQLClient
+	// Role is the role of the GitLab instance, it can be either "source" or "destination"
+	// It is used to determine the behavior of the mirroring process
+	Role string
+	// BigInstance indicates whether the GitLab instance is a large instance
+	// It is used to determine the behavior of the fetching process
+	BigInstance bool
+}
+
+type GitlabInstanceOpts struct {
+	// GitlabURL is the URL of the GitLab instance
+	GitlabURL string
+	// GitlabToken is the token used to authenticate with the GitLab API
+	GitlabToken string
+	// Role is the role of the GitLab instance, it can be either "source" or "destination"
+	Role string
+	// Timeout is the timeout for GitLab API requests
+	Timeout time.Duration
+	// MaxRetries is the maximum number of retries for GitLab API requests
+	MaxRetries int
+	// BigInstance indicates whether the GitLab instance is a large instance
+	BigInstance bool
 }
 
 // newGitlabInstance creates a new GitlabInstance with the provided parameters
 // and initializes the GitLab client with a custom HTTP client.
-func newGitlabInstance(gitlabURL string, gitlabToken string, timeout time.Duration, maxRetries int) (*GitlabInstance, error) {
+func newGitlabInstance(initArgs *GitlabInstanceOpts) (*GitlabInstance, error) {
+	// Create a custom HTTP client with the specified timeout and max retries
+	retryClient := retryablehttp.NewClient()
+	retryClient.HTTPClient.Timeout = initArgs.Timeout
+	retryClient.RetryMax = initArgs.MaxRetries
+	retryClient.CheckRetry = retryablehttp.DefaultRetryPolicy
+	retryClient.RetryWaitMin = 1 * time.Second
+	retryClient.RetryWaitMax = 5 * time.Second
+	retryClient.Backoff = retryablehttp.DefaultBackoff
+	retryClient.Logger = zap.L()
+
 	// Initialize the GitLab client with the custom HTTP client
-	gitlabClient, err := gitlab.NewClient(gitlabToken, gitlab.WithBaseURL(gitlabURL))
+	gitlabClient, err := gitlab.NewClient(initArgs.GitlabToken, gitlab.WithBaseURL(initArgs.GitlabURL), gitlab.WithHTTPClient(retryClient.StandardClient()))
 	if err != nil {
 		return nil, err
 	}
@@ -31,7 +76,8 @@ func newGitlabInstance(gitlabURL string, gitlabToken string, timeout time.Durati
 		Gitlab:        gitlabClient,
 		Projects:      make(map[string]*gitlab.Project),
 		Groups:        make(map[string]*gitlab.Group),
-		GraphQLClient: utils.NewGitlabGraphQLClient(gitlabToken, gitlabURL),
+		GraphQLClient: utils.NewGitlabGraphQLClient(initArgs.GitlabToken, initArgs.GitlabURL),
+		Role:          initArgs.Role,
 	}
 
 	return gitlabInstance, nil

internal/mirroring/instance_test.go

@@ -10,7 +10,14 @@ func TestNewGitlabInstance(t *testing.T) {
 	gitlabURL := "https://gitlab.example.com"
 	gitlabToken := "test-token"
 
-	instance, err := newGitlabInstance(gitlabURL, gitlabToken, 10, 3)
+	instance, err := newGitlabInstance(&GitlabInstanceOpts{
+		GitlabURL:   gitlabURL,
+		GitlabToken: gitlabToken,
+		Role:        ROLE_SOURCE,
+		Timeout:     10,
+		MaxRetries:  3,
+		BigInstance: false,
+	})
 	if err != nil {
 		t.Fatalf("expected no error, got %v", err)
 	}

internal/mirroring/main.go

@@ -16,12 +16,24 @@ import (
 // It then processes the filters for groups and projects, and finally creates the groups and projects in the destination GitLab instance.
 // If the dry run flag is set, it will only print the groups and projects that would be created or updated.
 func MirrorGitlabs(gitlabMirrorArgs *utils.ParserArgs) error {
-	sourceGitlabInstance, err := newGitlabInstance(gitlabMirrorArgs.SourceGitlabURL, gitlabMirrorArgs.SourceGitlabToken, gitlabMirrorArgs.Timeout, gitlabMirrorArgs.Retry)
+	sourceGitlabInstance, err := newGitlabInstance(&GitlabInstanceOpts{
+		GitlabURL:   gitlabMirrorArgs.SourceGitlabURL,
+		GitlabToken: gitlabMirrorArgs.SourceGitlabToken,
+		Role:        ROLE_SOURCE,
+		Timeout:     gitlabMirrorArgs.Timeout,
+		MaxRetries:  gitlabMirrorArgs.Retry,
+	})
 	if err != nil {
 		return err
 	}
 
-	destinationGitlabInstance, err := newGitlabInstance(gitlabMirrorArgs.DestinationGitlabURL, gitlabMirrorArgs.DestinationGitlabToken, gitlabMirrorArgs.Timeout, gitlabMirrorArgs.Retry)
+	destinationGitlabInstance, err := newGitlabInstance(&GitlabInstanceOpts{
+		GitlabURL:   gitlabMirrorArgs.DestinationGitlabURL,
+		GitlabToken: gitlabMirrorArgs.DestinationGitlabToken,
+		Role:        ROLE_DESTINATION,
+		Timeout:     gitlabMirrorArgs.Timeout,
+		MaxRetries:  gitlabMirrorArgs.Retry,
+	})
 	if err != nil {
 		return err
 	}