Merge branch '335-local-timezone' into 'master'

feat(engine): allow configuring timezone in DLE CLI configuration (#335)

Closes #335

See merge request postgres-ai/database-lab!486

Author: agneum

engine/.gitlab-ci.yml

@@ -360,6 +360,9 @@ build-image-swagger-latest:
     - if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
       changes:
         - engine/**/*
+  artifacts:
+    paths:
+      - engine/bin
   script:
     - bash engine/test/1.synthetic.sh
     - bash engine/test/2.logical_generic.sh

engine/cmd/cli/commands/client.go

@@ -23,6 +23,7 @@ const (
 	FwServerURLKey    = "forwarding-server-url"
 	FwLocalPortKey    = "forwarding-local-port"
 	IdentityFileKey   = "identity-file"
+	TZKey             = "tz"
 )
 
 // ClientByCLIContext creates a new Database Lab API client.

engine/cmd/cli/commands/config/actions.go

@@ -260,3 +260,50 @@ func removeEnvironment() func(*cli.Context) error {
 		return commands.ToActionError(err)
 	}
 }
+
+// showSettings shows global CLI settings.
+func showSettings(cliCtx *cli.Context) error {
+	configFilename, err := GetFilename()
+	if err != nil {
+		return commands.ToActionError(err)
+	}
+
+	cfg, err := Load(configFilename)
+	if err != nil {
+		return commands.ToActionError(err)
+	}
+
+	settings, err := json.MarshalIndent(cfg.Settings, "", "    ")
+	if err != nil {
+		return commands.ToActionError(err)
+	}
+
+	_, err = fmt.Fprintln(cliCtx.App.Writer, string(settings))
+
+	return commands.ToActionError(err)
+}
+
+// updateSettings updates CLI settings.
+func updateSettings(cliCtx *cli.Context) error {
+	configFilename, err := GetFilename()
+	if err != nil {
+		return commands.ToActionError(err)
+	}
+
+	cfg, err := Load(configFilename)
+	if err != nil {
+		return commands.ToActionError(err)
+	}
+
+	if err := updateSettingsInConfig(cliCtx, cfg); err != nil {
+		return commands.ToActionError(err)
+	}
+
+	if err := SaveConfig(configFilename, cfg); err != nil {
+		return commands.ToActionError(err)
+	}
+
+	_, err = fmt.Fprintf(cliCtx.App.Writer, "CLI settings has been successfully updated.\n")
+
+	return commands.ToActionError(err)
+}

engine/cmd/cli/commands/config/command_list.go

@@ -113,6 +113,22 @@ func CommandList() []*cli.Command {
 					ArgsUsage: "ENVIRONMENT_ID",
 					Action:    removeEnvironment(),
 				},
+				{
+					Name:   "show-global",
+					Usage:  "show global CLI settings",
+					Action: showSettings,
+				},
+				{
+					Name:   "set-global",
+					Usage:  "update global CLI settings",
+					Action: updateSettings,
+					Flags: []cli.Flag{
+						&cli.StringFlag{
+							Name:  "tz",
+							Usage: "Timezone to display time in DLE responses",
+						},
+					},
+				},
 			},
 		},
 	}

engine/cmd/cli/commands/config/environment.go

@@ -15,6 +15,7 @@ import (
 type CLIConfig struct {
 	CurrentEnvironment string                 `yaml:"current_environment" json:"current_environment"`
 	Environments       map[string]Environment `yaml:"environments" json:"environments"`
+	Settings           Settings               `yaml:"settings" json:"settings"`
 }
 
 // Environment defines a format of environment configuration.
@@ -34,6 +35,11 @@ type Forwarding struct {
 	IdentityFile string `yaml:"identity_file" json:"identity_file"`
 }
 
+// Settings defines global CLI settings.
+type Settings struct {
+	TZ string `yaml:"tz" json:"tz"`
+}
+
 // AddEnvironmentToConfig adds a new environment to CLIConfig.
 func AddEnvironmentToConfig(c *cli.Context, cfg *CLIConfig, environmentID string) error {
 	if environmentID == "" {
@@ -162,3 +168,16 @@ func removeByID(cfg *CLIConfig, environmentID string) error {
 
 	return nil
 }
+
+// updateSettings updates CLI settings.
+func updateSettingsInConfig(c *cli.Context, cfg *CLIConfig) error {
+	if c.NumFlags() == 0 {
+		return errors.New("config unchanged. Set options to update")
+	}
+
+	if c.IsSet(commands.TZKey) {
+		cfg.Settings.TZ = c.String(commands.TZKey)
+	}
+
+	return nil
+}

engine/cmd/cli/main.go

@@ -91,6 +91,8 @@ func main() {
 	}
 }
 
+const tzConst = "TZ"
+
 // loadEnvironmentParams loads environment params from a Database Lab's config file.
 func loadEnvironmentParams(c *cli.Context) error {
 	dblabLog.SetDebug(c.IsSet("debug"))
@@ -106,6 +108,12 @@ func loadEnvironmentParams(c *cli.Context) error {
 		return nil
 	}
 
+	if _, ok := os.LookupEnv(tzConst); !ok {
+		if err := os.Setenv(tzConst, cfg.Settings.TZ); err != nil {
+			return err
+		}
+	}
+
 	currentEnv := cfg.CurrentEnvironment
 	if env, ok := cfg.Environments[currentEnv]; ok {
 		if !c.IsSet(commands.URLKey) {

engine/internal/cloning/base.go

@@ -160,7 +160,7 @@ func (c *Base) CreateClone(cloneRequest *types.CloneCreateRequest) (*models.Clon
 		ID:        cloneRequest.ID,
 		Snapshot:  snapshot,
 		Protected: cloneRequest.Protected,
-		CreatedAt: util.FormatTime(createdAt),
+		CreatedAt: models.NewLocalTime(createdAt),
 		Status: models.Status{
 			Code:    models.StatusCreating,
 			Message: models.CloneMessageCreating,
@@ -459,7 +459,7 @@ func (c *Base) ResetClone(cloneID string, resetOptions types.ResetCloneRequest)
 		c.tm.SendEvent(context.Background(), telemetry.CloneResetEvent, telemetry.CloneCreated{
 			ID:          util.HashID(w.Clone.ID),
 			CloningTime: w.Clone.Metadata.CloningTime,
-			DSADiff:     util.GetDataFreshness(snapshot.DataStateAt),
+			DSADiff:     util.GetDataFreshness(snapshot.DataStateAt.Time),
 		})
 	}()
 
@@ -512,7 +512,7 @@ func (c *Base) GetClones() []*models.Clone {
 	c.cloneMutex.RUnlock()
 
 	sort.Slice(clones, func(i, j int) bool {
-		return clones[i].CreatedAt > clones[j].CreatedAt
+		return clones[i].CreatedAt.After(clones[j].CreatedAt.Time)
 	})
 
 	return clones

engine/internal/cloning/base_test.go

@@ -6,6 +6,7 @@ package cloning
 
 import (
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -52,9 +53,9 @@ func (s *BaseCloningSuite) TestFindWrapper() {
 }
 
 func (s *BaseCloningSuite) TestCloneList() {
-	clone1 := &models.Clone{CreatedAt: "2020-02-20 01:23:45 UTC"}
-	clone2 := &models.Clone{CreatedAt: "2020-06-23 10:31:27 UTC"}
-	clone3 := &models.Clone{CreatedAt: "2020-05-20 00:43:21 UTC"}
+	clone1 := &models.Clone{CreatedAt: &models.LocalTime{Time: time.Date(2020, 02, 20, 01, 23, 45, 0, time.UTC)}}
+	clone2 := &models.Clone{CreatedAt: &models.LocalTime{Time: time.Date(2020, 06, 23, 10, 31, 27, 0, time.UTC)}}
+	clone3 := &models.Clone{CreatedAt: &models.LocalTime{Time: time.Date(2020, 05, 20, 00, 43, 21, 0, time.UTC)}}
 
 	s.cloning.setWrapper("testCloneID1", &CloneWrapper{Clone: clone1})
 	s.cloning.setWrapper("testCloneID2", &CloneWrapper{Clone: clone2})
@@ -66,9 +67,9 @@ func (s *BaseCloningSuite) TestCloneList() {
 
 	// Check clone order.
 	assert.Equal(s.T(), []*models.Clone{
-		{CreatedAt: "2020-06-23 10:31:27 UTC"},
-		{CreatedAt: "2020-05-20 00:43:21 UTC"},
-		{CreatedAt: "2020-02-20 01:23:45 UTC"},
+		{CreatedAt: &models.LocalTime{Time: time.Date(2020, 06, 23, 10, 31, 27, 0, time.UTC)}},
+		{CreatedAt: &models.LocalTime{Time: time.Date(2020, 05, 20, 00, 43, 21, 0, time.UTC)}},
+		{CreatedAt: &models.LocalTime{Time: time.Date(2020, 02, 20, 01, 23, 45, 0, time.UTC)}},
 	}, list)
 }
 

engine/internal/cloning/snapshots.go

@@ -12,7 +12,6 @@ import (
 
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/models"
-	"gitlab.com/postgres-ai/database-lab/v3/pkg/util"
 )
 
 // SnapshotBox contains instance snapshots.
@@ -44,8 +43,8 @@ func (c *Base) fetchSnapshots() error {
 
 		currentSnapshot := &models.Snapshot{
 			ID:           entry.ID,
-			CreatedAt:    util.FormatTime(entry.CreatedAt),
-			DataStateAt:  util.FormatTime(entry.DataStateAt),
+			CreatedAt:    models.NewLocalTime(entry.CreatedAt),
+			DataStateAt:  models.NewLocalTime(entry.DataStateAt),
 			PhysicalSize: entry.Used,
 			LogicalSize:  entry.LogicalReferenced,
 			Pool:         entry.Pool,
@@ -82,7 +81,7 @@ func (c *Base) addSnapshot(snapshot *models.Snapshot) {
 
 // defineLatestSnapshot compares two snapshots and defines the latest one.
 func defineLatestSnapshot(latest, challenger *models.Snapshot) *models.Snapshot {
-	if latest == nil || latest.DataStateAt == "" || latest.DataStateAt < challenger.DataStateAt {
+	if latest == nil || latest.DataStateAt == nil || latest.DataStateAt.IsZero() || latest.DataStateAt.Before(challenger.DataStateAt.Time) {
 		return challenger
 	}
 
@@ -162,7 +161,7 @@ func (c *Base) getSnapshotList() []models.Snapshot {
 	}
 
 	sort.Slice(snapshots, func(i, j int) bool {
-		return snapshots[i].CreatedAt > snapshots[j].CreatedAt
+		return snapshots[i].CreatedAt.After(snapshots[j].CreatedAt.Time)
 	})
 
 	return snapshots

engine/internal/cloning/snapshots_test.go

@@ -6,6 +6,7 @@ package cloning
 
 import (
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/require"
 
@@ -17,14 +18,14 @@ func (s *BaseCloningSuite) TestLatestSnapshot() {
 
 	snapshot1 := &models.Snapshot{
 		ID:          "TestSnapshotID1",
-		CreatedAt:   "2020-02-20 01:23:45",
-		DataStateAt: "2020-02-19 00:00:00",
+		CreatedAt:   &models.LocalTime{Time: time.Date(2020, 02, 20, 01, 23, 45, 0, time.UTC)},
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 19, 0, 0, 0, 0, time.UTC)},
 	}
 
 	snapshot2 := &models.Snapshot{
 		ID:          "TestSnapshotID2",
-		CreatedAt:   "2020-02-20 05:43:21",
-		DataStateAt: "2020-02-20 00:00:00",
+		CreatedAt:   &models.LocalTime{Time: time.Date(2020, 02, 20, 05, 43, 21, 0, time.UTC)},
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 20, 0, 0, 0, 0, time.UTC)},
 	}
 
 	require.Equal(s.T(), 0, len(s.cloning.snapshotBox.items))
@@ -41,8 +42,8 @@ func (s *BaseCloningSuite) TestLatestSnapshot() {
 
 	snapshot3 := &models.Snapshot{
 		ID:          "TestSnapshotID3",
-		CreatedAt:   "2020-02-21 05:43:21",
-		DataStateAt: "2020-02-21 00:00:00",
+		CreatedAt:   &models.LocalTime{Time: time.Date(2020, 02, 21, 05, 43, 21, 0, time.UTC)},
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 21, 0, 0, 0, 0, time.UTC)},
 	}
 
 	snapshotMap := make(map[string]*models.Snapshot)
@@ -62,14 +63,14 @@ func (s *BaseCloningSuite) TestSnapshotByID() {
 
 	snapshot1 := &models.Snapshot{
 		ID:          "TestSnapshotID1",
-		CreatedAt:   "2020-02-20 01:23:45",
-		DataStateAt: "2020-02-19 00:00:00",
+		CreatedAt:   &models.LocalTime{Time: time.Date(2020, 02, 20, 01, 23, 45, 0, time.UTC)},
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 19, 0, 0, 0, 0, time.UTC)},
 	}
 
 	snapshot2 := &models.Snapshot{
 		ID:          "TestSnapshotID2",
-		CreatedAt:   "2020-02-20 05:43:21",
-		DataStateAt: "2020-02-20 00:00:00",
+		CreatedAt:   &models.LocalTime{Time: time.Date(2020, 02, 20, 05, 43, 21, 0, time.UTC)},
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 20, 0, 0, 0, 0, time.UTC)},
 	}
 
 	require.Equal(s.T(), 0, len(s.cloning.snapshotBox.items))
@@ -122,13 +123,13 @@ func TestCloneCounter(t *testing.T) {
 
 func TestLatestSnapshots(t *testing.T) {
 	baseSnapshot := &models.Snapshot{
-		DataStateAt: "2020-02-19 00:00:00",
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 19, 0, 0, 0, 0, time.UTC)},
 	}
 	newSnapshot := &models.Snapshot{
-		DataStateAt: "2020-02-21 00:00:00",
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 21, 0, 0, 0, 0, time.UTC)},
 	}
 	oldSnapshot := &models.Snapshot{
-		DataStateAt: "2020-02-01 00:00:00",
+		DataStateAt: &models.LocalTime{Time: time.Date(2020, 02, 01, 0, 0, 0, 0, time.UTC)},
 	}
 
 	testCases := []struct {