package bug import ( "fmt" "strings" "github.com/MichaelMure/git-bug/identity" "github.com/MichaelMure/git-bug/repository" "github.com/pkg/errors" ) // Note: // // For the actions (fetch/push/pull/merge/commit), this package act as a master for // the identity package and will also drive the needed identity actions. That is, // if bug.Push() is called, identity.Push will also be called to make sure that // the dependant identities are also present and up to date on the remote. // // I'm not entirely sure this is the correct way to do it, as it might introduce // too much complexity and hard coupling, but it does make this package easier // to use. // Fetch retrieve updates from a remote // This does not change the local bugs state func Fetch(repo repository.Repo, remote string) (string, error) { stdout, err := identity.Fetch(repo, remote) if err != nil { return stdout, err } remoteRefSpec := fmt.Sprintf(bugsRemoteRefPattern, remote) fetchRefSpec := fmt.Sprintf("%s*:%s*", bugsRefPattern, remoteRefSpec) stdout2, err := repo.FetchRefs(remote, fetchRefSpec) return stdout + "\n" + stdout2, err } // Push update a remote with the local changes func Push(repo repository.Repo, remote string) (string, error) { stdout, err := identity.Push(repo, remote) if err != nil { return stdout, err } stdout2, err := repo.PushRefs(remote, bugsRefPattern+"*") return stdout + "\n" + stdout2, err } // Pull will do a Fetch + MergeAll // This function will return an error if a merge fail func Pull(repo repository.ClockedRepo, remote string) error { _, err := identity.Fetch(repo, remote) if err != nil { return err } for merge := range identity.MergeAll(repo, remote) { if merge.Err != nil { return merge.Err } if merge.Status == identity.MergeStatusInvalid { return errors.Errorf("merge failure: %s", merge.Reason) } } _, err = Fetch(repo, remote) if err != nil { return err } for merge := range MergeAll(repo, remote) { if merge.Err != nil { return merge.Err } if merge.Status == MergeStatusInvalid { return errors.Errorf("merge failure: %s", merge.Reason) } } return nil } // MergeAll will merge all the available remote bug: // // - If the remote has new commit, the local bug is updated to match the same history // (fast-forward update) // - if the local bug has new commits but the remote don't, nothing is changed // - if both local and remote bug have new commits (that is, we have a concurrent edition), // new local commits are rewritten at the head of the remote history (that is, a rebase) func MergeAll(repo repository.ClockedRepo, remote string) <-chan MergeResult { out := make(chan MergeResult) go func() { defer close(out) remoteRefSpec := fmt.Sprintf(bugsRemoteRefPattern, remote) remoteRefs, err := repo.ListRefs(remoteRefSpec) if err != nil { out <- MergeResult{Err: err} return } for _, remoteRef := range remoteRefs { refSplitted := strings.Split(remoteRef, "/") id := refSplitted[len(refSplitted)-1] remoteBug, err := readBug(repo, remoteRef) if err != nil { out <- newMergeInvalidStatus(id, errors.Wrap(err, "remote bug is not readable").Error()) continue } // Check for error in remote data if err := remoteBug.Validate(); err != nil { out <- newMergeInvalidStatus(id, errors.Wrap(err, "remote bug is invalid").Error()) continue } localRef := bugsRefPattern + remoteBug.Id() localExist, err := repo.RefExist(localRef) if err != nil { out <- newMergeError(err, id) continue } // the bug is not local yet, simply create the reference if !localExist { err := repo.CopyRef(remoteRef, localRef) if err != nil { out <- newMergeError(err, id) return } out <- newMergeStatus(MergeStatusNew, id, remoteBug) continue } localBug, err := readBug(repo, localRef) if err != nil { out <- newMergeError(errors.Wrap(err, "local bug is not readable"), id) return } updated, err := localBug.Merge(repo, remoteBug) if err != nil { out <- newMergeInvalidStatus(id, errors.Wrap(err, "merge failed").Error()) return } if updated { out <- newMergeStatus(MergeStatusUpdated, id, localBug) } else { out <- newMergeStatus(MergeStatusNothing, id, localBug) } } }() return out } // MergeStatus represent the result of a merge operation of a bug type MergeStatus int const ( _ MergeStatus = iota MergeStatusNew MergeStatusInvalid MergeStatusUpdated MergeStatusNothing ) type MergeResult struct { // Err is set when a terminal error occur in the process Err error Id string Status MergeStatus // Only set for invalid status Reason string // Not set for invalid status Bug *Bug } func (mr MergeResult) String() string { switch mr.Status { case MergeStatusNew: return "new" case MergeStatusInvalid: return fmt.Sprintf("invalid data: %s", mr.Reason) case MergeStatusUpdated: return "updated" case MergeStatusNothing: return "nothing to do" default: panic("unknown merge status") } } func newMergeError(err error, id string) MergeResult { return MergeResult{ Err: err, Id: id, } } func newMergeStatus(status MergeStatus, id string, bug *Bug) MergeResult { return MergeResult{ Id: id, Status: status, // Bug is not set for an invalid merge result Bug: bug, } } func newMergeInvalidStatus(id string, reason string) MergeResult { return MergeResult{ Id: id, Status: MergeStatusInvalid, Reason: reason, } }