aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2020-11-29 20:22:09 +0100
committerMichael Muré <batolettre@gmail.com>2021-02-14 12:17:48 +0100
commit2788c5fc87507974d3237d4edc233fda3f784b35 (patch)
tree3bc2f384cfceecf3a48864c039a6f52f744e8323
parent497ec1376ab510af740910ed9c99b159809cf0e8 (diff)
downloadgit-bug-2788c5fc87507974d3237d4edc233fda3f784b35.tar.gz
bug: don't store the id in Bug, match how it's done for Identity
-rw-r--r--bug/bug.go42
-rw-r--r--bug/op_create.go17
-rw-r--r--bug/with_snapshot.go2
3 files changed, 26 insertions, 35 deletions
diff --git a/bug/bug.go b/bug/bug.go
index 86227c6b..fb36bfd8 100644
--- a/bug/bug.go
+++ b/bug/bug.go
@@ -44,16 +44,12 @@ var _ entity.Interface = &Bug{}
// how it will be persisted inside Git. This is the data structure
// used to merge two different version of the same Bug.
type Bug struct {
-
// A Lamport clock is a logical clock that allow to order event
// inside a distributed system.
// It must be the first field in this struct due to https://github.com/golang/go/issues/599
createTime lamport.Time
editTime lamport.Time
- // Id used as unique identifier
- id entity.Id
-
lastCommit repository.Hash
// all the committed operations
@@ -66,9 +62,8 @@ type Bug struct {
// NewBug create a new Bug
func NewBug() *Bug {
- // No id yet
// No logical clock yet
- return &Bug{id: entity.UnsetId}
+ return &Bug{}
}
// ReadLocal will read a local bug from its hash
@@ -111,9 +106,7 @@ func read(repo repository.ClockedRepo, identityResolver identity.Resolver, ref s
return nil, fmt.Errorf("empty bug")
}
- bug := Bug{
- id: id,
- }
+ bug := Bug{}
// Load each OperationPack
for _, hash := range hashes {
@@ -164,7 +157,7 @@ func read(repo repository.ClockedRepo, identityResolver identity.Resolver, ref s
if len(bug.packs[0].Operations) == 0 {
return nil, fmt.Errorf("first OperationPack is empty")
}
- if bug.id != bug.packs[0].Operations[0].Id() {
+ if id != bug.packs[0].Operations[0].Id() {
return nil, fmt.Errorf("bug ID doesn't match the first operation ID")
}
@@ -319,13 +312,6 @@ func (bug *Bug) Validate() error {
return fmt.Errorf("first operation should be a Create op")
}
- // The bug Id should be the id of the first operation
- if bug.FirstOp().Id() != bug.id {
- fmt.Println("bug", bug.id.String())
- fmt.Println("op", bug.FirstOp().Id().String())
- return fmt.Errorf("bug id should be the first commit hash")
- }
-
// Check that there is no more CreateOp op
// Check that there is no colliding operation's ID
it := NewOperationIterator(bug)
@@ -354,7 +340,6 @@ func (bug *Bug) Append(op Operation) {
if op.base().OperationType != CreateOp {
panic("first operation should be a Create")
}
- bug.id = op.Id()
}
bug.staging.Append(op)
}
@@ -454,15 +439,10 @@ func (bug *Bug) Commit(repo repository.ClockedRepo) error {
bug.packs = append(bug.packs, bug.staging)
bug.staging = OperationPack{}
- // if it was the first commit, use the Id of the first op (create)
- if bug.id == "" || bug.id == entity.UnsetId {
- bug.id = bug.packs[0].Operations[0].Id()
- }
-
// Create or update the Git reference for this bug
// When pushing later, the remote will ensure that this ref update
// is fast-forward, that is no data has been overwritten
- ref := fmt.Sprintf("%s%s", bugsRefPattern, bug.id)
+ ref := fmt.Sprintf("%s%s", bugsRefPattern, bug.Id().String())
return repo.UpdateRef(ref, hash)
}
@@ -488,7 +468,7 @@ func (bug *Bug) Merge(repo repository.Repo, other Interface) (bool, error) {
// Reading the other side is still necessary to validate remote data, at least
// for new operations
- if bug.id != otherBug.id {
+ if bug.Id() != otherBug.Id() {
return false, errors.New("merging unrelated bugs is not supported")
}
@@ -562,7 +542,7 @@ func (bug *Bug) Merge(repo repository.Repo, other Interface) (bool, error) {
bug.packs = newPacks
// Update the git ref
- err = repo.UpdateRef(bugsRefPattern+bug.id.String(), bug.lastCommit)
+ err = repo.UpdateRef(bugsRefPattern+bug.Id().String(), bug.lastCommit)
if err != nil {
return false, err
}
@@ -572,12 +552,8 @@ func (bug *Bug) Merge(repo repository.Repo, other Interface) (bool, error) {
// Id return the Bug identifier
func (bug *Bug) Id() entity.Id {
- if bug.id == "" || bug.id == entity.UnsetId {
- // simply panic as it would be a coding error
- // (using an id of a bug without operation yet)
- panic("no id yet")
- }
- return bug.id
+ // id is the id of the first operation
+ return bug.FirstOp().Id()
}
// CreateLamportTime return the Lamport time of creation
@@ -629,7 +605,7 @@ func (bug *Bug) LastOp() Operation {
// Compile a bug in a easily usable snapshot
func (bug *Bug) Compile() Snapshot {
snap := Snapshot{
- id: bug.id,
+ id: bug.Id(),
Status: OpenStatus,
}
diff --git a/bug/op_create.go b/bug/op_create.go
index 3c8ce658..41e0fca1 100644
--- a/bug/op_create.go
+++ b/bug/op_create.go
@@ -38,6 +38,21 @@ func (op *CreateOperation) Id() entity.Id {
return idOperation(op)
}
+// OVERRIDE
+func (op *CreateOperation) SetMetadata(key string, value string) {
+ // sanity check: we make sure we are not in the following scenario:
+ // - the bug is created with a first operation
+ // - Id() is used
+ // - metadata are added, which will change the Id
+ // - Id() is used again
+
+ if op.id != entity.UnsetId {
+ panic("usage of Id() after changing the first operation")
+ }
+
+ op.OpBase.SetMetadata(key, value)
+}
+
func (op *CreateOperation) Apply(snapshot *Snapshot) {
snapshot.addActor(op.Author)
snapshot.addParticipant(op.Author)
@@ -95,7 +110,7 @@ func (op *CreateOperation) Validate() error {
return nil
}
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
// This workaround is necessary to avoid the inner OpBase.MarshalJSON
// overriding the outer op's MarshalJSON
func (op *CreateOperation) UnmarshalJSON(data []byte) error {
diff --git a/bug/with_snapshot.go b/bug/with_snapshot.go
index 2b2439df..41192d39 100644
--- a/bug/with_snapshot.go
+++ b/bug/with_snapshot.go
@@ -47,7 +47,7 @@ func (b *WithSnapshot) Commit(repo repository.ClockedRepo) error {
return nil
}
- b.snap.id = b.Bug.id
+ b.snap.id = b.Bug.Id()
return nil
}