Added CreatedAt and UpdatedAt (#111)

* Added CreatedAt and UpdatedAt

* Added TimeMetadata to response models

* Changed UpdatedAt & CreatedAt to be nullable

* Updated CHANGELOG.md

* Fixed linting

Author: applejag

CHANGELOG.md

@@ -83,6 +83,20 @@ This project tries to follow [SemVer 2.0.0](https://semver.org/).
 
 - Added dependency on `gorm.io/driver/sqlite`. (#86)
 
+- Added `updatedAt` and `createdAt` fields to the following models: (#111)
+
+  - `response.Artifact`
+  - `response.Branch`
+  - `response.Build`
+  - `response.Project`
+  - `response.Provider`
+  - `response.TestResultDetail`
+  - `response.TestResultSummary`
+  - `response.Token`
+
+  Objects created and updated before this patch will have the value `null`, but
+  will get a valid date on first update, such as on first refresh for a project.
+
 - Fixed bug where unable to delete a Project without first deleting all child
   objects. (#64)
 

pkg/model/database/database.go

@@ -27,6 +27,15 @@ import (
 // One seems to take precedence, but to make sure and to keep the code
 // consistent we add it to both referencing fields.
 
+// TimeMetadata contains fields that GORM will recognize and update
+// automatically for us.
+//
+// Docs: https://gorm.io/docs/models.html#Creating-Updating-Time-Unix-Milli-Nano-Seconds-Tracking
+type TimeMetadata struct {
+	CreatedAt *time.Time `gorm:"nullable"`
+	UpdatedAt *time.Time `gorm:"nullable"`
+}
+
 // SafeSQLName represents a value that is safe to use as an SQL table or column
 // name without the need of escaping.
 //
@@ -68,6 +77,7 @@ var ProviderColumns = struct {
 // importance are the URL field of where to find the remote, and the token field
 // used to authenticate.
 type Provider struct {
+	TimeMetadata
 	ProviderID uint   `gorm:"primaryKey"`
 	Name       string `gorm:"size:20;not null"`
 	URL        string `gorm:"size:500;not null"`
@@ -103,6 +113,7 @@ var TokenColumns = struct {
 
 // Token holds credentials for a remote provider.
 type Token struct {
+	TimeMetadata
 	TokenID  uint   `gorm:"primaryKey"`
 	Token    string `gorm:"size:500;not null"`
 	UserName string `gorm:"size:500;not null;default:''"`
@@ -165,6 +176,7 @@ var ProjectColumns = struct {
 // to be populated with data from the remote provider, such as the description
 // and avatar.
 type Project struct {
+	TimeMetadata
 	ProjectID       uint      `gorm:"primaryKey"`
 	RemoteProjectID string    `gorm:"not null;default:''"`
 	Name            string    `gorm:"size:500;not null"`
@@ -209,6 +221,7 @@ var BranchColumns = struct {
 // Branch is a single branch in the VCS that can be targeted during builds.
 // For example a Git branch.
 type Branch struct {
+	TimeMetadata
 	BranchID  uint     `gorm:"primaryKey"`
 	ProjectID uint     `gorm:"not null;index:branch_idx_project_id"`
 	Project   *Project `gorm:"foreignKey:ProjectID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
@@ -269,6 +282,7 @@ var BuildColumns = struct {
 // Build holds data about the state of a build. Which parameters was used to
 // start it, what status it holds, et.al.
 type Build struct {
+	TimeMetadata
 	BuildID             uint                `gorm:"primaryKey"`
 	StatusID            BuildStatus         `gorm:"not null"`
 	ProjectID           uint                `gorm:"not null;index:build_idx_project_id"`
@@ -385,6 +399,7 @@ var ArtifactFields = struct {
 // Artifact holds the binary data as well as metadata about that binary such as
 // the file name and which build it belongs to.
 type Artifact struct {
+	TimeMetadata
 	ArtifactID uint   `gorm:"primaryKey"`
 	BuildID    uint   `gorm:"not null;index:artifact_idx_build_id"`
 	Build      *Build `gorm:"foreignKey:BuildID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
@@ -404,6 +419,7 @@ var TestResultSummaryFields = struct {
 
 // TestResultSummary contains data about a single test result file.
 type TestResultSummary struct {
+	TimeMetadata
 	TestResultSummaryID uint      `gorm:"primaryKey"`
 	FileName            string    `gorm:"not null;default:''"`
 	ArtifactID          uint      `gorm:"not null;index:testresultsummary_idx_artifact_id"`
@@ -430,6 +446,7 @@ const (
 
 // TestResultDetail contains data about a single test in a test result file.
 type TestResultDetail struct {
+	TimeMetadata
 	TestResultDetailID uint             `gorm:"primaryKey"`
 	ArtifactID         uint             `gorm:"not null;index:testresultdetail_idx_artifact_id"`
 	Artifact           *Artifact        `gorm:"foreignKey:ArtifactID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL"`

pkg/model/response/response.go

@@ -8,6 +8,13 @@ import (
 	"gopkg.in/guregu/null.v4"
 )
 
+// TimeMetadata contains fields of when an object was created/added to the
+// database, and when any field was last updated.
+type TimeMetadata struct {
+	UpdatedAt *time.Time `json:"updatedAt" format:"date-time" extensions:"x-nullable"`
+	CreatedAt *time.Time `json:"createdAt" format:"date-time" extensions:"x-nullable"`
+}
+
 // ArtifactJSONFields holds the JSON field names for each field.
 // Useful in ordering statements to map the correct field to the correct
 // database column.
@@ -24,6 +31,7 @@ var ArtifactJSONFields = struct {
 // Artifact holds the binary data as well as metadata about that binary such as
 // the file name and which build it belongs to.
 type Artifact struct {
+	TimeMetadata
 	ArtifactID uint   `json:"artifactId" minimum:"0"`
 	BuildID    uint   `json:"buildId" minimum:"0"`
 	Name       string `json:"name"`
@@ -32,12 +40,14 @@ type Artifact struct {
 
 // ArtifactMetadata contains the file name and artifact ID of an Artifact.
 type ArtifactMetadata struct {
+	TimeMetadata
 	FileName   string `json:"fileName"`
 	ArtifactID uint   `json:"artifactId" minimum:"0"`
 }
 
 // Branch holds details about a project's branch.
 type Branch struct {
+	TimeMetadata
 	BranchID  uint   `json:"branchId" minimum:"0"`
 	ProjectID uint   `json:"projectId" minimum:"0"`
 	Name      string `json:"name"`
@@ -78,6 +88,7 @@ var BuildJSONFields = struct {
 // Build holds data about the state of a build. Which parameters was used to
 // start it, what status it holds, et.al.
 type Build struct {
+	TimeMetadata
 	BuildID               uint                  `json:"buildId" minimum:"0"`
 	StatusID              int                   `json:"statusId" enums:"0,1,2,3"`
 	Status                BuildStatus           `json:"status" enums:"Scheduling,Running,Completed,Failed"`
@@ -214,6 +225,7 @@ var ProjectJSONFields = struct {
 
 // Project holds details about a project.
 type Project struct {
+	TimeMetadata
 	ProjectID             uint        `json:"projectId" minimum:"0"`
 	RemoteProjectID       string      `json:"remoteProjectId"`
 	Name                  string      `json:"name"`
@@ -248,6 +260,7 @@ var ProviderJSONFields = struct {
 // importance are the URL field of where to find the remote, and the token field
 // used to authenticate.
 type Provider struct {
+	TimeMetadata
 	ProviderID uint         `json:"providerId" minimum:"0"`
 	Name       ProviderName `json:"name" enums:"azuredevops,gitlab,github"`
 	URL        string       `json:"url"`
@@ -291,6 +304,7 @@ const (
 
 // TestResultDetail contains data about a single test in a test result file.
 type TestResultDetail struct {
+	TimeMetadata
 	TestResultDetailID uint             `json:"testResultDetailId" minimum:"0"`
 	ArtifactID         uint             `json:"artifactId" minimum:"0"`
 	BuildID            uint             `json:"buildId" minimum:"0"`
@@ -324,6 +338,7 @@ const (
 
 // TestResultSummary contains data about a single test result file.
 type TestResultSummary struct {
+	TimeMetadata
 	TestResultSummaryID uint   `json:"testResultSummaryId" minimum:"0"`
 	FileName            string `json:"fileName"`
 	ArtifactID          uint   `json:"artifactId" minimum:"0"`
@@ -359,6 +374,7 @@ var TokenJSONFields = struct {
 
 // Token holds credentials for a remote provider.
 type Token struct {
+	TimeMetadata
 	TokenID  uint   `json:"tokenId" minimum:"0"`
 	Token    string `json:"token" format:"password"`
 	UserName string `json:"userName"`

pkg/modelconv/artifactconv.go

@@ -8,10 +8,11 @@ import (
 // DBArtifactToResponse converts a database artifact to a response artifact.
 func DBArtifactToResponse(dbArtifact database.Artifact) response.Artifact {
 	return response.Artifact{
-		ArtifactID: dbArtifact.ArtifactID,
-		BuildID:    dbArtifact.BuildID,
-		Name:       dbArtifact.Name,
-		FileName:   dbArtifact.FileName,
+		TimeMetadata: DBTimeMetadataToResponse(dbArtifact.TimeMetadata),
+		ArtifactID:   dbArtifact.ArtifactID,
+		BuildID:      dbArtifact.BuildID,
+		Name:         dbArtifact.Name,
+		FileName:     dbArtifact.FileName,
 	}
 }
 

pkg/modelconv/branchconv.go

@@ -33,11 +33,12 @@ func DBBranchesToResponses(dbBranches []database.Branch) []response.Branch {
 // DBBranchToResponse converts a database branch to a response branch.
 func DBBranchToResponse(dbBranch database.Branch) response.Branch {
 	return response.Branch{
-		BranchID:  dbBranch.BranchID,
-		ProjectID: dbBranch.ProjectID,
-		Name:      dbBranch.Name,
-		Default:   dbBranch.Default,
-		TokenID:   dbBranch.TokenID,
+		TimeMetadata: DBTimeMetadataToResponse(dbBranch.TimeMetadata),
+		BranchID:     dbBranch.BranchID,
+		ProjectID:    dbBranch.ProjectID,
+		Name:         dbBranch.Name,
+		Default:      dbBranch.Default,
+		TokenID:      dbBranch.TokenID,
 	}
 }
 

pkg/modelconv/buildconv.go

@@ -58,6 +58,7 @@ func DBBuildToResponse(dbBuild database.Build) response.Build {
 		Failed:  failed,
 	}
 	return response.Build{
+		TimeMetadata:          DBTimeMetadataToResponse(dbBuild.TimeMetadata),
 		BuildID:               dbBuild.BuildID,
 		StatusID:              int(dbBuild.StatusID),
 		Status:                DBBuildStatusToResponse(dbBuild.StatusID),

pkg/modelconv/metadataconv.go

@@ -0,0 +1,15 @@
+package modelconv
+
+import (
+	"github.com/iver-wharf/wharf-api/pkg/model/database"
+	"github.com/iver-wharf/wharf-api/pkg/model/response"
+)
+
+// DBTimeMetadataToResponse converts a database timestamp metadata to a response
+// timestamp metadata.
+func DBTimeMetadataToResponse(timeMetadata database.TimeMetadata) response.TimeMetadata {
+	return response.TimeMetadata{
+		CreatedAt: timeMetadata.CreatedAt,
+		UpdatedAt: timeMetadata.UpdatedAt,
+	}
+}

pkg/modelconv/projectconv.go

@@ -33,6 +33,7 @@ func DBProjectToResponse(dbProject database.Project) response.Project {
 			Message("Failed to parse build-definition.")
 	}
 	return response.Project{
+		TimeMetadata:          DBTimeMetadataToResponse(dbProject.TimeMetadata),
 		ProjectID:             dbProject.ProjectID,
 		Name:                  dbProject.Name,
 		GroupName:             dbProject.GroupName,

pkg/modelconv/providerconv.go

@@ -18,9 +18,10 @@ func DBProvidersToResponses(dbProviders []database.Provider) []response.Provider
 // DBProviderToResponse converts a database provider to a response provider.
 func DBProviderToResponse(dbProvider database.Provider) response.Provider {
 	return response.Provider{
-		ProviderID: dbProvider.ProviderID,
-		Name:       response.ProviderName(dbProvider.Name),
-		URL:        dbProvider.URL,
-		TokenID:    dbProvider.TokenID,
+		TimeMetadata: DBTimeMetadataToResponse(dbProvider.TimeMetadata),
+		ProviderID:   dbProvider.ProviderID,
+		Name:         response.ProviderName(dbProvider.Name),
+		URL:          dbProvider.URL,
+		TokenID:      dbProvider.TokenID,
 	}
 }

pkg/modelconv/testresultconv.go

@@ -19,6 +19,7 @@ func DBTestResultSummariesToResponses(dbSummaries []database.TestResultSummary)
 // response test result summary.
 func DBTestResultSummaryToResponse(dbSummary database.TestResultSummary) response.TestResultSummary {
 	return response.TestResultSummary{
+		TimeMetadata:        DBTimeMetadataToResponse(dbSummary.TimeMetadata),
 		TestResultSummaryID: dbSummary.TestResultSummaryID,
 		FileName:            dbSummary.FileName,
 		ArtifactID:          dbSummary.ArtifactID,
@@ -44,6 +45,7 @@ func DBTestResultDetailsToResponses(dbDetails []database.TestResultDetail) []res
 // response test result detail.
 func DBTestResultDetailToResponse(dbDetail database.TestResultDetail) response.TestResultDetail {
 	return response.TestResultDetail{
+		TimeMetadata:       DBTimeMetadataToResponse(dbDetail.TimeMetadata),
 		TestResultDetailID: dbDetail.TestResultDetailID,
 		ArtifactID:         dbDetail.ArtifactID,
 		BuildID:            dbDetail.BuildID,