feat: implement project labels (resolve #204)

models/filters.go

@@ -6,6 +6,7 @@ type Filters struct {
 	Language string
 	Editor   string
 	Machine  string
+	Label    string
 }
 
 type FilterElement struct {
@@ -25,6 +26,8 @@ func NewFiltersWith(entity uint8, key string) *Filters {
 		return &Filters{Editor: key}
 	case SummaryMachine:
 		return &Filters{Machine: key}
+	case SummaryLabel:
+		return &Filters{Label: key}
 	}
 	return &Filters{}
 }
@@ -40,6 +43,8 @@ func (f *Filters) One() (bool, uint8, string) {
 		return true, SummaryEditor, f.Editor
 	} else if f.Machine != "" {
 		return true, SummaryMachine, f.Machine
+	} else if f.Machine != "" {
+		return true, SummaryLabel, f.Label
 	}
 	return false, 0, ""
 }

models/project_label.go

@@ -0,0 +1,13 @@
+package models
+
+type ProjectLabel struct {
+	ID         uint   `json:"id" gorm:"primary_key"`
+	User       *User  `json:"-" gorm:"not null; constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
+	UserID     string `json:"-" gorm:"not null; index:idx_language_mapping_user; index:idx_project_label_user"`
+	ProjectKey string `json:"project"`
+	Label      string `json:"label" gorm:"type:varchar(64)"`
+}
+
+func (l *ProjectLabel) IsValid() bool {
+	return l.ProjectKey != "" && l.Label != ""
+}

models/summary.go

@@ -1,6 +1,7 @@
 package models
 
 import (
+	"errors"
 	"sort"
 	"time"
 )
@@ -12,9 +13,11 @@ const (
 	SummaryEditor   uint8 = 2
 	SummaryOS       uint8 = 3
 	SummaryMachine  uint8 = 4
+	SummaryLabel    uint8 = 5
 )
 
 const UnknownSummaryKey = "unknown"
+const DefaultProjectLabel = "default"
 
 type Summary struct {
 	ID               uint         `json:"-" gorm:"primary_key"`
@@ -27,6 +30,7 @@ type Summary struct {
 	Editors          SummaryItems `json:"editors" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
 	OperatingSystems SummaryItems `json:"operating_systems" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
 	Machines         SummaryItems `json:"machines" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
+	Labels           SummaryItems `json:"labels" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
 }
 
 type SummaryItems []*SummaryItem
@@ -68,6 +72,10 @@ type SummaryParams struct {
 type AliasResolver func(t uint8, k string) string
 
 func SummaryTypes() []uint8 {
+	return []uint8{SummaryProject, SummaryLanguage, SummaryEditor, SummaryOS, SummaryMachine, SummaryLabel}
+}
+
+func NativeSummaryTypes() []uint8 {
 	return []uint8{SummaryProject, SummaryLanguage, SummaryEditor, SummaryOS, SummaryMachine}
 }
 
@@ -77,6 +85,7 @@ func (s *Summary) Sorted() *Summary {
 	sort.Sort(sort.Reverse(s.OperatingSystems))
 	sort.Sort(sort.Reverse(s.Languages))
 	sort.Sort(sort.Reverse(s.Editors))
+	sort.Sort(sort.Reverse(s.Labels))
 	return s
 }
 
@@ -91,6 +100,7 @@ func (s *Summary) MappedItems() map[uint8]*SummaryItems {
 		SummaryEditor:   &s.Editors,
 		SummaryOS:       &s.OperatingSystems,
 		SummaryMachine:  &s.Machines,
+		SummaryLabel:    &s.Labels,
 	}
 }
 
@@ -109,7 +119,7 @@ of time than the other ones.
 To avoid having to modify persisted data retrospectively, i.e. inserting a dummy SummaryItem for the new type,
 such is generated dynamically here, considering the "machine" for all old heartbeats "unknown".
 */
-func (s *Summary) FillUnknown() {
+func (s *Summary) FillMissing() {
 	types := s.Types()
 	typeItems := s.MappedItems()
 	missingTypes := make([]uint8, 0)
@@ -125,14 +135,38 @@ func (s *Summary) FillUnknown() {
 		return
 	}
 
-	timeSum := s.TotalTime()
-
 	// construct dummy item for all missing types
+	presentType, _ := s.findFirstPresentType()
 	for _, t := range missingTypes {
-		*typeItems[t] = append(*typeItems[t], &SummaryItem{
-			Type:  t,
-			Key:   UnknownSummaryKey,
-			Total: timeSum,
+		s.FillBy(presentType, t)
+	}
+}
+
+// inplace!
+func (s *Summary) FillBy(fromType uint8, toType uint8) {
+	typeItems := s.MappedItems()
+	totalWanted := s.TotalTimeBy(fromType) / time.Second
+	totalActual := s.TotalTimeBy(toType) / time.Second
+
+	key := UnknownSummaryKey
+	if toType == SummaryLabel {
+		key = DefaultProjectLabel
+	}
+
+	existingEntryIdx := -1
+	for i, item := range *typeItems[toType] {
+		if item.Key == key {
+			existingEntryIdx = i
+			break
+		}
+	}
+	if existingEntryIdx >= 0 {
+		(*typeItems[toType])[existingEntryIdx].Total = totalWanted - totalActual
+	} else {
+		*typeItems[toType] = append(*typeItems[toType], &SummaryItem{
+			Type:  toType,
+			Key:   key,
+			Total: totalWanted - totalActual,
 		})
 	}
 }
@@ -141,19 +175,26 @@ func (s *Summary) TotalTime() time.Duration {
 	var timeSum time.Duration
 
 	mappedItems := s.MappedItems()
-	// calculate total duration from any of the present sets of items
-	for _, t := range s.Types() {
-		if items := mappedItems[t]; len(*items) > 0 {
-			for _, item := range *items {
-				timeSum += item.Total
-			}
-			break
-		}
+	t, err := s.findFirstPresentType()
+	if err != nil {
+		return 0
+	}
+	for _, item := range *mappedItems[t] {
+		timeSum += item.Total
 	}
 
 	return timeSum * time.Second
 }
 
+func (s *Summary) findFirstPresentType() (uint8, error) {
+	for _, t := range s.Types() {
+		if s.TotalTimeBy(t) > 0 {
+			return t, nil
+		}
+	}
+	return 127, errors.New("no type present")
+}
+
 func (s *Summary) TotalTimeBy(entityType uint8) (timeSum time.Duration) {
 	mappedItems := s.MappedItems()
 	if items := mappedItems[entityType]; len(*items) > 0 {
@@ -231,6 +272,7 @@ func (s *Summary) WithResolvedAliases(resolve AliasResolver) *Summary {
 	s.Languages = processAliases(s.Languages)
 	s.OperatingSystems = processAliases(s.OperatingSystems)
 	s.Machines = processAliases(s.Machines)
+	s.Labels = processAliases(s.Labels)
 
 	return s
 }

models/summary_test.go

@@ -20,7 +20,7 @@ func TestSummary_FillUnknown(t *testing.T) {
 		},
 	}
 
-	sut.FillUnknown()
+	sut.FillMissing()
 
 	itemLists := [][]*SummaryItem{
 		sut.Machines,

models/user.go

@@ -23,6 +23,7 @@ type User struct {
 	ShareProjects    bool       `json:"-" gorm:"default:false; type:bool"`
 	ShareOSs         bool       `json:"-" gorm:"default:false; type:bool; column:share_oss"`
 	ShareMachines    bool       `json:"-" gorm:"default:false; type:bool"`
+	ShareLabels      bool       `json:"-" gorm:"default:false; type:bool"`
 	IsAdmin          bool       `json:"-" gorm:"default:false; type:bool"`
 	HasData          bool       `json:"-" gorm:"default:false; type:bool"`
 	WakatimeApiKey   string     `json:"-"`