Request to add a parameter to gh gei migrate-repo

[Jay-jakwak4]

Description

Hi Team

gh gei migrate-repo performs a status check every 10 seconds.

private const int CHECK_STATUS_DELAY_IN_MILLISECONDS = 10000; // 10 seconds

https://github.com/github/gh-gei/blob/67a062c20245127c46c444f8d81b3356252b104e/src/gei/Commands/MigrateRepo/MigrateRepoCommandHandler.cs#L29C23-L29C57
For GHEC, the default rate limit is 5,000/h, and the rate limit is reached when migrating 100+ repos.

To prevent this, it would be better to set the status check interval as a parameter instead of the default value.

Thanks

[JONGBURMPARK]

Could you please forward this diff patch to github engineering team and request their review of this feature?

diff --git a/src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs b/src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs
index 409dce2d..99895d97 100644
--- a/src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs
+++ b/src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs
@@ -43,6 +43,7 @@ namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateRepo
             AddOption(Verbose);
             AddOption(KeepArchive);
             AddOption(UseGithubStorage);
+            AddOption(StatusCheckInterval);
         }

         public Option<string> GithubSourceOrg { get; } = new("--github-source-org")
@@ -159,6 +160,11 @@ namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateRepo
             Description = "Keeps the archive on this machine after uploading to the blob storage account. Only applicable for migrations from GitHub Enterprise Server versions before 3.8.0 or when used with --use-github-storage."
         };

+        public Option<int> StatusCheckInterval { get; } = new("--status-check-interval")
+        {
+            Description = "The interval (in milliseconds) between migration status checks. Defaults to 10000 (10 seconds)."
+        };
+

         public override MigrateRepoCommandHandler BuildHandler(MigrateRepoCommandArgs args, IServiceProvider sp)
         {
             if (args is null)
diff --git a/src/gei/Commands/MigrateRepo/MigrateRepoCommandArgs.cs b/src/gei/Commands/MigrateRepo/MigrateRepoCommandArgs.cs
index 07697947..3dc655a2 100644
--- a/src/gei/Commands/MigrateRepo/MigrateRepoCommandArgs.cs
+++ b/src/gei/Commands/MigrateRepo/MigrateRepoCommandArgs.cs
@@ -38,6 +38,7 @@ namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateRepo
         public string GithubTargetPat { get; set; }
         public bool KeepArchive { get; set; }
         public bool UseGithubStorage { get; set; }
+        public int StatusCheckInterval { get; set; }
         public override void Validate(OctoLogger log)
         {

@@ -63,6 +64,7 @@ namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateRepo

             DefaultSourcePat(log);
             DefaultTargetRepo(log);
+            DefaultStatusCheckInterval(log);

             if (GitArchiveUrl.HasValue() && GitArchivePath.HasValue())
             {
@@ -135,5 +137,14 @@ namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateRepo
                 log?.LogInformation("Since github-target-pat is provided, github-source-pat will also use its value.");
             }
         }

+
+        private void DefaultStatusCheckInterval(OctoLogger log)
+        {
+            if (StatusCheckInterval <= 0)
+            {
+                StatusCheckInterval = 10000; // 10 seconds default
+                log?.LogInformation("Status check interval not provided or invalid, defaulting to 10 seconds (10000 ms)");
+            }
+        }
     }
}

diff --git a/src/gei/Commands/MigrateRepo/MigrateRepoCommandHandler.cs b/src/gei/Commands/MigrateRepo/MigrateRepoCommandHandler.cs
index 138fc0c9..91a00d39 100644
--- a/src/gei/Commands/MigrateRepo/MigrateRepoCommandHandler.cs
+++ b/src/gei/Commands/MigrateRepo/MigrateRepoCommandHandler.cs
@@ -26,7 +26,6 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
     private readonly RetryPolicy _retryPolicy;
     private readonly WarningsCountLogger _warningsCountLogger;
     private const int ARCHIVE_GENERATION_TIMEOUT_IN_HOURS = 20;
-    private const int CHECK_STATUS_DELAY_IN_MILLISECONDS = 10000; // 10 seconds
     private const string GIT_ARCHIVE_FILE_NAME = "git_archive.tar.gz";
     private const string METADATA_ARCHIVE_FILE_NAME = "metadata_archive.tar.gz";
     private const string DUPLICATE_ARCHIVE_FILE_NAME = "archive.tar.gz";
@@ -116,7 +115,8 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
               args.LockSourceRepo,
               blobCredentialsRequired,
               args.KeepArchive,
-              args.UseGithubStorage
+              args.UseGithubStorage,
+              args.StatusCheckInterval
             );


             if (args.UseGithubStorage || blobCredentialsRequired)
@@ -193,8 +193,8 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>


         while (RepositoryMigrationStatus.IsPending(migrationState))
         {
-            _log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting 10 seconds...");
-            await Task.Delay(10000);
+            _log.LogInformation($"Migration in progress (ID: {migrationId}). State: {migrationState}. Waiting {args.StatusCheckInterval / 1000} seconds...");
+            await Task.Delay(args.StatusCheckInterval);
             (migrationState, _, warningsCount, failureReason, migrationLogUrl) = await _targetGithubApi.GetMigration(migrationId);
         }


@@ -245,10 +245,11 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
       bool lockSourceRepo,
       bool blobCredentialsRequired,
       bool keepArchive,
-      bool useGithubStorage)
+      bool useGithubStorage,
+      int statusCheckInterval)
     {
         var (gitArchiveUrl, metadataArchiveUrl, gitArchiveId, metadataArchiveId) = await _retryPolicy.Retry(
-            async () => await GenerateArchives(githubSourceOrg, sourceRepo, skipReleases, lockSourceRepo));
+            async () => await GenerateArchives(githubSourceOrg, sourceRepo, skipReleases, lockSourceRepo, statusCheckInterval));

         if (!useGithubStorage && !blobCredentialsRequired)
         {

@@ -344,17 +345,18 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
         string githubSourceOrg,
         string sourceRepo,
         bool skipReleases,
-        bool lockSourceRepo)
+        bool lockSourceRepo,
+        int statusCheckInterval)

     {
         var gitArchiveId = await _sourceGithubApi.StartGitArchiveGeneration(githubSourceOrg, sourceRepo);
         _log.LogInformation($"Archive generation of git data started with id: {gitArchiveId}");
         var metadataArchiveId = await _sourceGithubApi.StartMetadataArchiveGeneration(githubSourceOrg, sourceRepo, skipReleases, lockSourceRepo);
         _log.LogInformation($"Archive generation of metadata started with id: {metadataArchiveId}");

-        var gitArchiveUrl = await WaitForArchiveGeneration(_sourceGithubApi, githubSourceOrg, gitArchiveId);
+        var gitArchiveUrl = await WaitForArchiveGeneration(_sourceGithubApi, githubSourceOrg, gitArchiveId, statusCheckInterval);
         _log.LogInformation($"Archive (git) download url: {gitArchiveUrl}");

-        var metadataArchiveUrl = await WaitForArchiveGeneration(_sourceGithubApi, githubSourceOrg, metadataArchiveId);
+        var metadataArchiveUrl = await WaitForArchiveGeneration(_sourceGithubApi, githubSourceOrg, metadataArchiveId, statusCheckInterval);
         _log.LogInformation($"Archive (metadata) download url: {metadataArchiveUrl}");


         return (gitArchiveUrl, metadataArchiveUrl, gitArchiveId, metadataArchiveId);
@@ -404,7 +406,7 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
         return uploadedArchiveUrl;
     }


-    private async Task<string> WaitForArchiveGeneration(GithubApi githubApi, string githubSourceOrg, int archiveId)
+    private async Task<string> WaitForArchiveGeneration(GithubApi githubApi, string githubSourceOrg, int archiveId, int statusCheckInterval)
     {
         var timeout = DateTime.Now.AddHours(ARCHIVE_GENERATION_TIMEOUT_IN_HOURS);
         while (DateTime.Now < timeout)
@@ -419,7 +421,7 @@ public class MigrateRepoCommandHandler : ICommandHandler<MigrateRepoCommandArgs>
             {
                 throw new OctoshiftCliException($"Archive generation failed for id: {archiveId}");
             }
-            await Task.Delay(CHECK_STATUS_DELAY_IN_MILLISECONDS);
+            await Task.Delay(statusCheckInterval);
         }
         throw new TimeoutException($"Archive generation timed out after {ARCHIVE_GENERATION_TIMEOUT_IN_HOURS} hours");
     }

Issue description

Add Configurable Status Check Interval for migrate-repo Command

🎯 Problem

Currently, the gh gei migrate-repo command has a hardcoded 10-second delay when checking migration and archive generation status. This fixed interval may not be optimal for all use cases:

• Fast migrations: 10 seconds might be too long, causing unnecessary waiting

• Large migrations: Users might prefer longer intervals to reduce API calls and log noise

• Different environments: Various network conditions may require different polling frequencies

💡 Solution

Add a new optional parameter --status-check-interval to make the polling interval configurable while maintaining full backward compatibility.

✨ Features

New CLI Parameter

--status-check-interval <milliseconds>

• Type: Integer (milliseconds)

• Default: 10000 (10 seconds) - maintains existing behavior

• Minimum: Any positive integer

• Description: "The interval (in milliseconds) between migration status checks. Defaults to 10000 (10 seconds)."

Usage Examples

# Default behavior (10 seconds) - existing usage unchanged

gh gei migrate-repo --github-source-org myorg --source-repo myrepo --github-target-org targetorg

 

# Fast polling (5 seconds)

gh gei migrate-repo --github-source-org myorg --source-repo myrepo --github-target-org targetorg --status-check-interval 5000

 

# Slow polling (30 seconds)

gh gei migrate-repo --github-source-org myorg --source-repo myrepo --github-target-org targetorg --status-check-interval 30000

🔧 Technical Implementation

Files Modified

1. MigrateRepoCommand.cs: Added new CLI option definition

2. MigrateRepoCommandArgs.cs: Added parameter property and validation logic

3. MigrateRepoCommandHandler.cs: Replaced hardcoded constant with configurable parameter

Key Changes

• ❌ Removed: private const int CHECK_STATUS_DELAY_IN_MILLISECONDS = 10000;

• ✅ Added: public int StatusCheckInterval { get; set; }

• ✅ Added: Default value logic with validation (sets to 10000 if not provided or ≤ 0)

• ✅ Updated: All Task.Delay() calls to use the configurable parameter

• ✅ Enhanced: Log messages now show dynamic wait time

Affected Operations

This parameter controls the delay interval for:

1. Migration status polling: Checking if repository migration is complete

2. Archive generation waiting: Waiting for git and metadata archive generation to finish

🎉 Benefits

• Flexibility: Users can optimize polling frequency for their specific use case

• Performance: Reduce unnecessary API calls with longer intervals for large migrations

• User Experience: Faster feedback with shorter intervals for quick migrations

• Backward Compatible: Zero impact on existing workflows

• Consistent: Follows existing CLI parameter patterns and conventions

[akordowski]

I would suggest to set the value to CHECK_STATUS_DELAY_IN_MILLISECONDS = 60000 as in the bbs2gh extension:

gh-gei/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs

Line 23 in 4fbc5e5

private const int CHECK_MIGRATION_STATUS_DELAY_IN_MILLISECONDS = 60000;