libgit2 / libgit2/libgit2sharp

Question: Using `RewriteHistory` multiple times on the same commit

オープン
#2,023 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C#
スター
3.5k
フォーク
925
PR マージ指標
30日以内にマージされた PR はありません

説明

Hi Folks, This isn't a bug report but a question I have regarding calling the RewriteHistory method on the same commit.

public class Tests
{
    Repository Repository;
    DirectoryInfo RepositoryDirectoryInfo;

    private static void CopyDirectoryContents(string sourcePath, string targetPath)
    {
       // copies repository, containg .git and repository content to a temp path. not important for this.
    }

    private static Repository LoadRepository(string repositoryAbsolutePath)
    {
        return new Repository(repositoryAbsolutePath);
    }

    [SetUp]
    public void Setup()
    {
        // Create a temporary directory
        string temporaryGitRepositoryAbsPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
        RepositoryDirectoryInfo = Directory.CreateDirectory(temporaryGitRepositoryAbsPath);

        // Create a copy of the git Repository fixture as testing will modify the fixture itself
        string fixtureGitRepositoryRelPath = "Fixtures\\SampleGitRepository";
        CopyDirectoryContents(fixtureGitRepositoryRelPath, RepositoryDirectoryInfo.FullName);

        Repository = LoadRepository(RepositoryDirectoryInfo.FullName);
    }

    [Test]
    public void Test1()
    {
        // Get the commits and grab the first one
        List<Commit> firstCommits = Repository.Commits.ToList();
        Commit firstChangeToFirstCommit = firstCommits.First();

        // Rewrite commit. Change commit message.
        GitRewriter.RewriteCommit(
            repository: Repository,
            commit: firstChangeToFirstCommit,
            author: firstChangeToFirstCommit.Author,
            committer: firstChangeToFirstCommit.Committer,
            commitMessage: "first change to commit message"
        );

        // Not sure if required (I dont think it is)
        Repository.Reset(ResetMode.Hard, Repository.Head.Tip);

        // Reload Repository thats changed.
        // a.k.a return new Repository("the abs path of the repository");
        Repository = LoadRepository(RepositoryDirectoryInfo.FullName);

        // Get the commits again, and grab the first one like before
        List<Commit> secondCommits = Repository.Commits.ToList();
        Commit secondChangeToFirstCommit = secondCommits.First();

        // Rewrite a second time
        GitRewriter.RewriteCommit(
            repository: Repository,
            commit: secondChangeToFirstCommit,
            author: secondChangeToFirstCommit.Author,
            committer: secondChangeToFirstCommit.Committer,
            commitMessage: "second change to commit message"
        );
    }
}
public class GitRewriter
{
  public static void RewriteCommits(Repository repository, Commit[] commits, Signature author, Signature committer, string commitMessage)
  {
      RewriteHistoryOptions options = new()
      {
          OnError = (error) => ... ,
          OnSucceeding = () => ... ,
          CommitHeaderRewriter = commit =>
          {
              return CommitRewriteInfo.From(
                  commit: commit,
                  author: author,
                  committer: committer,
                  message: commitMessage
              );
          }
      };
      repository.Refs.RewriteHistory(options, commits);
  }
  public static void RewriteCommit(Repository repository, Commit commit, Signature author, Signature committer, string commitMessage)
  {
      Commit[] singleCommit = new Commit[] { commit };
      RewriteCommits(
          repository: repository,
          commits: singleCommit,
          author: author,
          committer: committer,
          commitMessage: commitMessage
      );
  }
}

If you look at my test case Test1, I'm trying to use RewriteHistory on the same commit, twice.

The first rewrite works fine.

On the second attempt, I get the exception: Can't back up reference 'refs/heads/master' - 'refs/original/heads/master' already exists

Message: 
System.InvalidOperationException : Can't back up reference 'refs/heads/master' - 'refs/original/heads/master' already exists

Stack Trace: 
HistoryRewriter.RewriteReference[TRef,TTarget](TRef oldRef, Func`2 selectTarget, Func`2 rewriteTarget, ReferenceUpdater`2 updateTarget)
HistoryRewriter.RewriteReference(Reference reference)
HistoryRewriter.Execute()
ReferenceCollection.RewriteHistory(RewriteHistoryOptions options, IEnumerable`1 commitsToRewrite)
ReferenceCollection.RewriteHistory(RewriteHistoryOptions options, Commit[] commitsToRewrite)
GitRewriter.RewriteCommit(Repository repository, Commit[] commits, Signature author, Signature committer, String commitMessage) line 29
GitRewriter.RewriteCommit(Repository repository, Commit commit, Signature author, Signature committer, String commitMessage) line 34
Tests.Test1() line 168
RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
MethodInvoker.Invoke(Object obj, IntPtr* args, BindingFlags invokeAttr)

I'm aware that when a commit is changed, a new SHA is allocated to that changed commit, and when after I've changed the commit the first time, the SHA does indeed change, but when I attempt to change it the second time, using the changed SHA, I recieve the error as described above.

I've checked the examples of LibGit2 and I could not find anything specific regarding this use-case of changing the same commit twice.

I've tried 'reloading' the repository by created a new Repository but no dice.

Any help, tips or pointers to documentation would be greatly appreciated. Thank you,

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ReferenceCollection.RewriteHistory と HistoryRewriter.RewriteReference から始め、Test1 シーケンスに従って GitRewriter.RewriteCommit まで追跡します。書き換えの間に refs/heads/master と refs/original/heads/master がどのようにバックアップされるかを調査します。繰り返しの書き換えがサポートされているかを明らかにし、既存のバックアップ参照に必要な動作または解決方法を文書化できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, git
領域
devtools
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。