types: introduce Commit type #859

merged
opened by
oppi.li 1 week ago targeting master from op/rkowwwsvpoqx
this is a backwards compatible structure that is capable of deserializing both go-git Commit structs and the existing types.NiceDiff.Commit struct.
Signed-off-by: oppiliappan me@oppi.li
options
unified split
Changed files
+168
types
commit.go
+168
types/commit.go
···

       1
       1
       +
       package types

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"bytes"

     

       5
       5
       +
       	"encoding/json"

     

       6
       6
       +
       	"fmt"

     

       7
       7
       +
       	"maps"

     

       8
       8
       +
       	"strings"

     

       9
       9
       +
       

     

       10
       10
       +
       	"github.com/go-git/go-git/v5/plumbing"

     

       11
       11
       +
       	"github.com/go-git/go-git/v5/plumbing/object"

     

       12
       12
       +
       )

     

       13
       13
       +
       

     

       14
       14
       +
       type Commit struct {

     

       15
       15
       +
       	// hash of the commit object.

     

       16
       16
       +
       	Hash plumbing.Hash `json:"hash,omitempty"`

     

       17
       17
       +
       

     

       18
       18
       +
       	// author is the original author of the commit.

     

       19
       19
       +
       	Author object.Signature `json:"author"`

     

       20
       20
       +
       

     

       21
       21
       +
       	// committer is the one performing the commit, might be different from author.

     

       22
       22
       +
       	Committer object.Signature `json:"committer"`

     

       23
       23
       +
       

     

       24
       24
       +
       	// message is the commit message, contains arbitrary text.

     

       25
       25
       +
       	Message string `json:"message"`

     

       26
       26
       +
       

     

       27
       27
       +
       	// treehash is the hash of the root tree of the commit.

     

       28
       28
       +
       	Tree string `json:"tree"`

     

       29
       29
       +
       

     

       30
       30
       +
       	// parents are the hashes of the parent commits of the commit.

     

       31
       31
       +
       	ParentHashes []plumbing.Hash `json:"parent_hashes,omitempty"`

     

       32
       32
       +
       

     

       33
       33
       +
       	// pgpsignature is the pgp signature of the commit.

     

       34
       34
       +
       	PGPSignature string `json:"pgp_signature,omitempty"`

     

       35
       35
       +
       

     

       36
       36
       +
       	// mergetag is the embedded tag object when a merge commit is created by

     

       37
       37
       +
       	// merging a signed tag.

     

       38
       38
       +
       	MergeTag string `json:"merge_tag,omitempty"`

     

       39
       39
       +
       

     

       40
       40
       +
       	// changeid is a unique identifier for the change (e.g., gerrit change-id).

     

       41
       41
       +
       	ChangeId string `json:"change_id,omitempty"`

     

       42
       42
       +
       

     

       43
       43
       +
       	// extraheaders contains additional headers not captured by other fields.

     

       44
       44
       +
       	ExtraHeaders map[string][]byte `json:"extra_headers,omitempty"`

     

       45
       45
       +
       

     

       46
       46
       +
       	// deprecated: kept for backwards compatibility with old json format.

     

       47
       47
       +
       	This string `json:"this,omitempty"`

     

       48
       48
       +
       

     

       49
       49
       +
       	// deprecated: kept for backwards compatibility with old json format.

     

       50
       50
       +
       	Parent string `json:"parent,omitempty"`

     

       51
       51
       +
       }

     

       52
       52
       +
       

     

       53
       53
       +
       // types.Commit is an unify two commit structs:

     

       54
       54
       +
       //   - git.object.Commit from

     

       55
       55
       +
       //   - types.NiceDiff.commit

     

       56
       56
       +
       //

     

       57
       57
       +
       // to do this in backwards compatible fashion, we define the base struct

     

       58
       58
       +
       // to use the same fields as NiceDiff.Commit, and then we also unmarshal

     

       59
       59
       +
       // the struct fields from go-git structs, this custom unmarshal makes sense

     

       60
       60
       +
       // of both representations and unifies them to have maximal data in either

     

       61
       61
       +
       // form.

     

       62
       62
       +
       func (c *Commit) UnmarshalJSON(data []byte) error {

     

       63
       63
       +
       	type Alias Commit

     

       64
       64
       +
       

     

       65
       65
       +
       	aux := &struct {

     

       66
       66
       +
       		*object.Commit

     

       67
       67
       +
       		*Alias

     

       68
       68
       +
       	}{

     

       69
       69
       +
       		Alias: (*Alias)(c),

     

       70
       70
       +
       	}

     

       71
       71
       +
       

     

       72
       72
       +
       	if err := json.Unmarshal(data, aux); err != nil {

     

       73
       73
       +
       		return err

     

       74
       74
       +
       	}

     

       75
       75
       +
       

     

       76
       76
       +
       	c.FromGoGitCommit(aux.Commit)

     

       77
       77
       +
       

     

       78
       78
       +
       	return nil

     

       79
       79
       +
       }

     

       80
       80
       +
       

     

       81
       81
       +
       // fill in as much of Commit as possible from the given go-git commit

     

       82
       82
       +
       func (c *Commit) FromGoGitCommit(gc *object.Commit) {

     

       83
       83
       +
       	if gc == nil {

     

       84
       84
       +
       		return

     

       85
       85
       +
       	}

     

       86
       86
       +
       

     

       87
       87
       +
       	if c.Hash.IsZero() {

     

       88
       88
       +
       		c.Hash = gc.Hash

     

       89
       89
       +
       	}

     

       90
       90
       +
       	if c.This == "" {

     

       91
       91
       +
       		c.This = gc.Hash.String()

     

       92
       92
       +
       	}

     

       93
       93
       +
       	if isEmptySignature(c.Author) {

     

       94
       94
       +
       		c.Author = gc.Author

     

       95
       95
       +
       	}

     

       96
       96
       +
       	if isEmptySignature(c.Committer) {

     

       97
       97
       +
       		c.Committer = gc.Committer

     

       98
       98
       +
       	}

     

       99
       99
       +
       	if c.Message == "" {

     

       100
       100
       +
       		c.Message = gc.Message

     

       101
       101
       +
       	}

     

       102
       102
       +
       	if c.Tree == "" {

     

       103
       103
       +
       		c.Tree = gc.TreeHash.String()

     

       104
       104
       +
       	}

     

       105
       105
       +
       	if c.PGPSignature == "" {

     

       106
       106
       +
       		c.PGPSignature = gc.PGPSignature

     

       107
       107
       +
       	}

     

       108
       108
       +
       	if c.MergeTag == "" {

     

       109
       109
       +
       		c.MergeTag = gc.MergeTag

     

       110
       110
       +
       	}

     

       111
       111
       +
       

     

       112
       112
       +
       	if len(c.ParentHashes) == 0 {

     

       113
       113
       +
       		c.ParentHashes = gc.ParentHashes

     

       114
       114
       +
       	}

     

       115
       115
       +
       	if c.Parent == "" && len(gc.ParentHashes) > 0 {

     

       116
       116
       +
       		c.Parent = gc.ParentHashes[0].String()

     

       117
       117
       +
       	}

     

       118
       118
       +
       

     

       119
       119
       +
       	if len(c.ExtraHeaders) == 0 {

     

       120
       120
       +
       		c.ExtraHeaders = make(map[string][]byte)

     

       121
       121
       +
       		maps.Copy(c.ExtraHeaders, gc.ExtraHeaders)

     

       122
       122
       +
       	}

     

       123
       123
       +
       

     

       124
       124
       +
       	if c.ChangeId == "" {

     

       125
       125
       +
       		if v, ok := gc.ExtraHeaders["change-id"]; ok {

     

       126
       126
       +
       			c.ChangeId = string(v)

     

       127
       127
       +
       		}

     

       128
       128
       +
       	}

     

       129
       129
       +
       }

     

       130
       130
       +
       

     

       131
       131
       +
       func isEmptySignature(s object.Signature) bool {

     

       132
       132
       +
       	return s.Email == "" && s.Name == "" && s.When.IsZero()

     

       133
       133
       +
       }

     

       134
       134
       +
       

     

       135
       135
       +
       // produce a verifiable payload from this commit's metadata

     

       136
       136
       +
       func (c *Commit) Payload() string {

     

       137
       137
       +
       	author := bytes.NewBuffer([]byte{})

     

       138
       138
       +
       	c.Author.Encode(author)

     

       139
       139
       +
       

     

       140
       140
       +
       	committer := bytes.NewBuffer([]byte{})

     

       141
       141
       +
       	c.Committer.Encode(committer)

     

       142
       142
       +
       

     

       143
       143
       +
       	payload := strings.Builder{}

     

       144
       144
       +
       

     

       145
       145
       +
       	fmt.Fprintf(&payload, "tree %s\n", c.Tree)

     

       146
       146
       +
       

     

       147
       147
       +
       	if len(c.ParentHashes) > 0 {

     

       148
       148
       +
       		for _, p := range c.ParentHashes {

     

       149
       149
       +
       			fmt.Fprintf(&payload, "parent %s\n", p.String())

     

       150
       150
       +
       		}

     

       151
       151
       +
       	} else {

     

       152
       152
       +
       		// present for backwards compatibility

     

       153
       153
       +
       		fmt.Fprintf(&payload, "parent %s\n", c.Parent)

     

       154
       154
       +
       	}

     

       155
       155
       +
       

     

       156
       156
       +
       	fmt.Fprintf(&payload, "author %s\n", author.String())

     

       157
       157
       +
       	fmt.Fprintf(&payload, "committer %s\n", committer.String())

     

       158
       158
       +
       

     

       159
       159
       +
       	if c.ChangeId != "" {

     

       160
       160
       +
       		fmt.Fprintf(&payload, "change-id %s\n", c.ChangeId)

     

       161
       161
       +
       	} else if v, ok := c.ExtraHeaders["change-id"]; ok {

     

       162
       162
       +
       		fmt.Fprintf(&payload, "change-id %s\n", string(v))

     

       163
       163
       +
       	}

     

       164
       164
       +
       

     

       165
       165
       +
       	fmt.Fprintf(&payload, "\n%s", c.Message)

     

       166
       166
       +
       

     

       167
       167
       +
       	return payload.String()

     

       168
       168
       +
       }