Hide Snapshot::Timeline from public access

GlancingMind · GlancingMind · commit 64c5ebe6b389 · 2021-07-05T17:41:11.000+02:00
diff --git a/api/graphql/models/lazy_bug.go b/api/graphql/models/lazy_bug.go
@@ -141,7 +141,7 @@ func (lb *lazyBug) Timeline() ([]bug.TimelineItem, error) {
 	if err != nil {
 		return nil, err
 	}
-	return lb.snap.Timeline, nil
+	return lb.snap.Timeline(), nil
 }
 
 func (lb *lazyBug) Operations() ([]bug.Operation, error) {
@@ -207,7 +207,7 @@ func (l *loadedBug) CreatedAt() time.Time {
 }
 
 func (l *loadedBug) Timeline() ([]bug.TimelineItem, error) {
-	return l.Snapshot.Timeline, nil
+	return l.Snapshot.Timeline(), nil
 }
 
 func (l *loadedBug) Operations() ([]bug.Operation, error) {
diff --git a/bug/op_add_comment.go b/bug/op_add_comment.go
@@ -45,7 +45,7 @@ func (op *AddCommentOperation) Apply(snapshot *Snapshot) {
 		CommentTimelineItem: NewCommentTimelineItem(comment),
 	}
 
-	snapshot.Timeline = append(snapshot.Timeline, item)
+	snapshot.timeline = append(snapshot.timeline, item)
 }
 
 func (op *AddCommentOperation) GetFiles() []repository.Hash {
diff --git a/bug/op_create.go b/bug/op_create.go
@@ -64,7 +64,7 @@ func (op *CreateOperation) Apply(snapshot *Snapshot) {
 	snapshot.author = op.Author_
 	snapshot.CreateTime = op.Time()
 
-	snapshot.Timeline = []TimelineItem{
+	snapshot.timeline = []TimelineItem{
 		&CreateTimelineItem{
 			CommentTimelineItem: NewCommentTimelineItem(comment),
 		},
diff --git a/bug/op_create_test.go b/bug/op_create_test.go
@@ -47,7 +47,7 @@ func TestCreate(t *testing.T) {
 		participants: []identity.Interface{rene},
 		actors:       []identity.Interface{rene},
 		CreateTime:   create.Time(),
-		Timeline: []TimelineItem{
+		timeline: []TimelineItem{
 			&CreateTimelineItem{
 				CommentTimelineItem: NewCommentTimelineItem(comment),
 			},
diff --git a/bug/op_edit_comment.go b/bug/op_edit_comment.go
@@ -38,9 +38,9 @@ func (op *EditCommentOperation) Apply(snapshot *Snapshot) {
 	commentId := entity.CombineIds(snapshot.Id(), op.Target)
 
 	var target TimelineItem
-	for i, item := range snapshot.Timeline {
+	for i, item := range snapshot.timeline {
 		if item.Id() == commentId {
-			target = snapshot.Timeline[i]
+			target = snapshot.timeline[i]
 			break
 		}
 	}
diff --git a/bug/op_edit_comment_test.go b/bug/op_edit_comment_test.go
@@ -43,32 +43,32 @@ func TestEdit(t *testing.T) {
 	edit := NewEditCommentOp(rene, unix, create.Id(), "create edited", nil)
 	edit.Apply(&snapshot)
 
-	require.Len(t, snapshot.Timeline, 4)
-	require.Len(t, snapshot.Timeline[0].(*CreateTimelineItem).History, 2)
-	require.Len(t, snapshot.Timeline[1].(*AddCommentTimelineItem).History, 1)
-	require.Len(t, snapshot.Timeline[3].(*AddCommentTimelineItem).History, 1)
+	require.Len(t, snapshot.Timeline(), 4)
+	require.Len(t, snapshot.Timeline()[0].(*CreateTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline()[1].(*AddCommentTimelineItem).History, 1)
+	require.Len(t, snapshot.Timeline()[3].(*AddCommentTimelineItem).History, 1)
 	require.Equal(t, snapshot.Comments()[0].Message, "create edited")
 	require.Equal(t, snapshot.Comments()[1].Message, "comment 1")
 	require.Equal(t, snapshot.Comments()[2].Message, "comment 2")
 
 	edit2 := NewEditCommentOp(rene, unix, comment1.Id(), "comment 1 edited", nil)
 	edit2.Apply(&snapshot)
 
-	require.Len(t, snapshot.Timeline, 4)
-	require.Len(t, snapshot.Timeline[0].(*CreateTimelineItem).History, 2)
-	require.Len(t, snapshot.Timeline[1].(*AddCommentTimelineItem).History, 2)
-	require.Len(t, snapshot.Timeline[3].(*AddCommentTimelineItem).History, 1)
+	require.Len(t, snapshot.Timeline(), 4)
+	require.Len(t, snapshot.Timeline()[0].(*CreateTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline()[1].(*AddCommentTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline()[3].(*AddCommentTimelineItem).History, 1)
 	require.Equal(t, snapshot.Comments()[0].Message, "create edited")
 	require.Equal(t, snapshot.Comments()[1].Message, "comment 1 edited")
 	require.Equal(t, snapshot.Comments()[2].Message, "comment 2")
 
 	edit3 := NewEditCommentOp(rene, unix, comment2.Id(), "comment 2 edited", nil)
 	edit3.Apply(&snapshot)
 
-	require.Len(t, snapshot.Timeline, 4)
-	require.Len(t, snapshot.Timeline[0].(*CreateTimelineItem).History, 2)
-	require.Len(t, snapshot.Timeline[1].(*AddCommentTimelineItem).History, 2)
-	require.Len(t, snapshot.Timeline[3].(*AddCommentTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline(), 4)
+	require.Len(t, snapshot.Timeline()[0].(*CreateTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline()[1].(*AddCommentTimelineItem).History, 2)
+	require.Len(t, snapshot.Timeline()[3].(*AddCommentTimelineItem).History, 2)
 	require.Equal(t, snapshot.Comments()[0].Message, "create edited")
 	require.Equal(t, snapshot.Comments()[1].Message, "comment 1 edited")
 	require.Equal(t, snapshot.Comments()[2].Message, "comment 2 edited")
diff --git a/bug/op_label_change.go b/bug/op_label_change.go
@@ -67,7 +67,7 @@ AddLoop:
 		Removed:  op.Removed,
 	}
 
-	snapshot.Timeline = append(snapshot.Timeline, item)
+	snapshot.timeline = append(snapshot.timeline, item)
 }
 
 func (op *LabelChangeOperation) Validate() error {
diff --git a/bug/op_set_status.go b/bug/op_set_status.go
@@ -33,7 +33,7 @@ func (op *SetStatusOperation) Apply(snapshot *Snapshot) {
 		Status:   op.Status,
 	}
 
-	snapshot.Timeline = append(snapshot.Timeline, item)
+	snapshot.timeline = append(snapshot.timeline, item)
 }
 
 func (op *SetStatusOperation) Validate() error {
diff --git a/bug/op_set_title.go b/bug/op_set_title.go
@@ -36,7 +36,7 @@ func (op *SetTitleOperation) Apply(snapshot *Snapshot) {
 		Was:      op.Was,
 	}
 
-	snapshot.Timeline = append(snapshot.Timeline, item)
+	snapshot.timeline = append(snapshot.timeline, item)
 }
 
 func (op *SetTitleOperation) Validate() error {
diff --git a/bug/snapshot.go b/bug/snapshot.go
@@ -21,7 +21,7 @@ type Snapshot struct {
 	participants []identity.Interface
 	CreateTime   time.Time
 
-	Timeline []TimelineItem
+	timeline []TimelineItem
 
 	Operations []Operation
 }
@@ -70,6 +70,11 @@ func (snap *Snapshot) Participants() []identity.Interface {
 	return snap.participants
 }
 
+// Return the bugs timeline
+func (snap *Snapshot) Timeline() []TimelineItem {
+	return snap.timeline
+}
+
 // Return the last time a bug was modified
 func (snap *Snapshot) EditTime() time.Time {
 	if len(snap.Operations) == 0 {
@@ -86,9 +91,9 @@ func (snap *Snapshot) GetCreateMetadata(key string) (string, bool) {
 
 // SearchTimelineItem will search in the timeline for an item matching the given hash
 func (snap *Snapshot) SearchTimelineItem(id entity.Id) (TimelineItem, error) {
-	for i := range snap.Timeline {
-		if snap.Timeline[i].Id() == id {
-			return snap.Timeline[i], nil
+	for i := range snap.timeline {
+		if snap.timeline[i].Id() == id {
+			return snap.timeline[i], nil
 		}
 	}
 
diff --git a/termui/show_bug.go b/termui/show_bug.go
@@ -216,7 +216,7 @@ func (sb *showBug) renderMain(g *gocui.Gui, mainView *gocui.View) error {
 
 	sb.mainSelectableView = nil
 
-	createTimelineItem := snap.Timeline[0].(*bug.CreateTimelineItem)
+	createTimelineItem := snap.Timeline()[0].(*bug.CreateTimelineItem)
 
 	edited := ""
 	if createTimelineItem.Edited() {
@@ -241,7 +241,7 @@ func (sb *showBug) renderMain(g *gocui.Gui, mainView *gocui.View) error {
 	_, _ = fmt.Fprint(v, bugHeader)
 	y0 += lines + 1
 
-	for _, op := range snap.Timeline {
+	for _, op := range snap.Timeline() {
 		viewName := op.Id().String()
 
 		// TODO: me might skip the rendering of blocks that are outside of the view

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ func (lb *lazyBug) Timeline() ([]bug.TimelineItem, error) {`
`141`	`141`	`if err != nil {`
`142`	`142`	`return nil, err`
`143`	`143`	`}`
`144`		`- return lb.snap.Timeline, nil`
	`144`	`+ return lb.snap.Timeline(), nil`
`145`	`145`	`}`
`146`	`146`
`147`	`147`	`func (lb *lazyBug) Operations() ([]bug.Operation, error) {`
`@@ -207,7 +207,7 @@ func (l *loadedBug) CreatedAt() time.Time {`
`207`	`207`	`}`
`208`	`208`
`209`	`209`	`func (l *loadedBug) Timeline() ([]bug.TimelineItem, error) {`
`210`		`- return l.Snapshot.Timeline, nil`
	`210`	`+ return l.Snapshot.Timeline(), nil`
`211`	`211`	`}`
`212`	`212`
`213`	`213`	`func (l *loadedBug) Operations() ([]bug.Operation, error) {`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func (op AddCommentOperation) Apply(snapshot Snapshot) {`
`45`	`45`	`CommentTimelineItem: NewCommentTimelineItem(comment),`
`46`	`46`	`}`
`47`	`47`
`48`		`- snapshot.Timeline = append(snapshot.Timeline, item)`
	`48`	`+ snapshot.timeline = append(snapshot.timeline, item)`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`func (op *AddCommentOperation) GetFiles() []repository.Hash {`
Original file line number	Diff line number	Diff line change
`@@ -38,9 +38,9 @@ func (op EditCommentOperation) Apply(snapshot Snapshot) {`
`38`	`38`	`commentId := entity.CombineIds(snapshot.Id(), op.Target)`
`39`	`39`
`40`	`40`	`var target TimelineItem`
`41`		`- for i, item := range snapshot.Timeline {`
	`41`	`+ for i, item := range snapshot.timeline {`
`42`	`42`	`if item.Id() == commentId {`
`43`		`- target = snapshot.Timeline[i]`
	`43`	`+ target = snapshot.timeline[i]`
`44`	`44`	`break`
`45`	`45`	`}`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ AddLoop:`
`67`	`67`	`Removed: op.Removed,`
`68`	`68`	`}`
`69`	`69`
`70`		`- snapshot.Timeline = append(snapshot.Timeline, item)`
	`70`	`+ snapshot.timeline = append(snapshot.timeline, item)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`func (op *LabelChangeOperation) Validate() error {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func (op SetStatusOperation) Apply(snapshot Snapshot) {`
`33`	`33`	`Status: op.Status,`
`34`	`34`	`}`
`35`	`35`
`36`		`- snapshot.Timeline = append(snapshot.Timeline, item)`
	`36`	`+ snapshot.timeline = append(snapshot.timeline, item)`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`func (op *SetStatusOperation) Validate() error {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (op SetTitleOperation) Apply(snapshot Snapshot) {`
`36`	`36`	`Was: op.Was,`
`37`	`37`	`}`
`38`	`38`
`39`		`- snapshot.Timeline = append(snapshot.Timeline, item)`
	`39`	`+ snapshot.timeline = append(snapshot.timeline, item)`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`func (op *SetTitleOperation) Validate() error {`