Skip to content

Commit ad4c09b

Browse files
agneumagneum
committed
Merge branch '297-refactor-dle-api' into 'master'
refactor DLE API (#297) Closes #297 See merge request postgres-ai/database-lab!347
2 parents 6064a4f + 5afc60f commit ad4c09b

File tree

14 files changed

+549
-181
lines changed

14 files changed

+549
-181
lines changed

‎api/swagger-spec/dblab_server_swagger.yaml‎

Lines changed: 477 additions & 24 deletions
Large diffs are not rendered by default.

‎pkg/client/dblabapi/clone.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ func (c *Client) ListClones(ctx context.Context) ([]*models.Clone, error) {
3636
return nil, errors.Wrap(err, "failed to decode a response body")
3737
}
3838

39-
return instanceStatus.Clones, nil
39+
return instanceStatus.Cloning.Clones, nil
4040
}
4141

4242
// ListClonesRaw provides a raw list of Database Lab clones.

‎pkg/client/dblabapi/clone_test.go‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ func TestClientListClones(t *testing.T) {
2020
expectedClones := []*models.Clone{{
2121
ID: "testCloneID",
2222
Metadata: models.CloneMetadata{
23-
CloneDiffSize: 450,
24-
CloningTime: 1,
23+
CloneDiffSize: 450,
24+
CloningTime: 1,
2525
},
2626
Protected: true,
2727
DeleteAt: "2020-01-10 00:00:05.000 UTC",
@@ -40,7 +40,7 @@ func TestClientListClones(t *testing.T) {
4040
assert.Equal(t, req.URL.String(), "https://example.com/status")
4141

4242
// Prepare response.
43-
body, err := json.Marshal(models.InstanceStatus{Clones: expectedClones})
43+
body, err := json.Marshal(models.InstanceStatus{Cloning: models.Cloning{Clones: expectedClones}})
4444
require.NoError(t, err)
4545

4646
return &http.Response{
@@ -91,8 +91,8 @@ func TestClientCreateClone(t *testing.T) {
9191
expectedClone := models.Clone{
9292
ID: "testCloneID",
9393
Metadata: models.CloneMetadata{
94-
CloneDiffSize: 450,
95-
CloningTime: 1,
94+
CloneDiffSize: 450,
95+
CloningTime: 1,
9696
},
9797
Protected: true,
9898
DeleteAt: "2020-01-10 00:00:05.000 UTC",
@@ -169,8 +169,8 @@ func TestClientCreateCloneAsync(t *testing.T) {
169169
expectedClone := models.Clone{
170170
ID: "testCloneID",
171171
Metadata: models.CloneMetadata{
172-
CloneDiffSize: 450,
173-
CloningTime: 1,
172+
CloneDiffSize: 450,
173+
CloningTime: 1,
174174
},
175175
Protected: true,
176176
DeleteAt: "2020-01-10 00:00:05.000 UTC",
@@ -258,8 +258,8 @@ func TestClientGetClone(t *testing.T) {
258258
expectedClone := &models.Clone{
259259
ID: "testCloneID",
260260
Metadata: models.CloneMetadata{
261-
CloneDiffSize: 450,
262-
CloningTime: 1,
261+
CloneDiffSize: 450,
262+
CloningTime: 1,
263263
},
264264
Protected: true,
265265
DeleteAt: "2020-01-10 00:00:05.000 UTC",
@@ -329,8 +329,8 @@ func TestClientUpdateClone(t *testing.T) {
329329
cloneModel := &models.Clone{
330330
ID: "testCloneID",
331331
Metadata: models.CloneMetadata{
332-
CloneDiffSize: 450,
333-
CloningTime: 1,
332+
CloneDiffSize: 450,
333+
CloningTime: 1,
334334
},
335335
Protected: true,
336336
DeleteAt: "2020-01-10 00:00:05.000 UTC",

‎pkg/client/dblabapi/status_test.go‎

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,28 @@ func TestClientStatus(t *testing.T) {
2020
Code: "OK",
2121
Message: "Instance is ready",
2222
},
23-
ExpectedCloningTime: 0,
24-
NumClones: 1,
25-
Clones: []*models.Clone{{
26-
ID: "testCloneID",
27-
Metadata: models.CloneMetadata{
28-
CloneDiffSize: 450546851,
29-
CloningTime: 1,
30-
},
31-
Protected: true,
32-
DeleteAt: "2020-01-10 00:00:05.000 UTC",
33-
CreatedAt: "2020-01-10 00:00:00.000 UTC",
34-
Status: models.Status{
35-
Code: "OK",
36-
Message: "Instance is ready",
37-
},
38-
DB: models.Database{
39-
Username: "john",
40-
Password: "doe",
41-
},
42-
}},
23+
Cloning: models.Cloning{
24+
ExpectedCloningTime: 0,
25+
NumClones: 1,
26+
Clones: []*models.Clone{{
27+
ID: "testCloneID",
28+
Metadata: models.CloneMetadata{
29+
CloneDiffSize: 450546851,
30+
CloningTime: 1,
31+
},
32+
Protected: true,
33+
DeleteAt: "2020-01-10 00:00:05.000 UTC",
34+
CreatedAt: "2020-01-10 00:00:00.000 UTC",
35+
Status: models.Status{
36+
Code: "OK",
37+
Message: "Instance is ready",
38+
},
39+
DB: models.Database{
40+
Username: "john",
41+
Password: "doe",
42+
},
43+
}},
44+
},
4345
Pools: []models.PoolEntry{
4446
{
4547
Name: "test_pool",

‎pkg/client/dblabapi/types/observation.go‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,3 @@ type StopObservationRequest struct {
2424
CloneID string `json:"clone_id"`
2525
OverallError bool `json:"overall_error"`
2626
}
27-
28-
// SummaryObservationRequest represents a request for the summary observation endpoint.
29-
type SummaryObservationRequest struct {
30-
CloneID string `json:"clone_id"`
31-
SessionID string `json:"session_id"`
32-
}

‎pkg/models/database.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ type Database struct {
1111
Port string `json:"port"`
1212
Username string `json:"username"`
1313
Password string `json:"password"`
14-
DBName string `json:"db_name"`
14+
DBName string `json:"dbName"`
1515
}

‎pkg/models/instance_status.go‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@ import (
1212

1313
// InstanceStatus represents status of a Database Lab Engine instance.
1414
type InstanceStatus struct {
15-
Status *Status `json:"status"`
16-
Engine Engine `json:"engine"`
17-
ExpectedCloningTime float64 `json:"expectedCloningTime"`
18-
NumClones uint64 `json:"numClones"`
19-
Clones []*Clone `json:"clones"`
20-
Pools []PoolEntry `json:"pools"`
21-
Retrieving Retrieving `json:"retrieving"`
22-
Provisioner ContainerOptions `json:"provisioner"`
15+
Status *Status `json:"status"`
16+
Engine Engine `json:"engine"`
17+
Pools []PoolEntry `json:"pools"`
18+
Cloning Cloning `json:"cloning"`
19+
Retrieving Retrieving `json:"retrieving"`
20+
Provisioner ContainerOptions `json:"provisioner"`
2321
}
2422

2523
// PoolEntry represents a pool entry.
@@ -38,6 +36,13 @@ type ContainerOptions struct {
3836
ContainerConfig map[string]string `json:"containerConfig"`
3937
}
4038

39+
// Cloning represents info about the cloning process.
40+
type Cloning struct {
41+
ExpectedCloningTime float64 `json:"expectedCloningTime"`
42+
NumClones uint64 `json:"numClones"`
43+
Clones []*Clone `json:"clones"`
44+
}
45+
4146
// Engine represents info about Database Lab Engine instance.
4247
type Engine struct {
4348
Version string `json:"version"`
@@ -46,7 +51,7 @@ type Engine struct {
4651

4752
// CloneList represents a list of clones.
4853
type CloneList struct {
49-
Clones []*Clone `json:"clones"`
54+
Cloning Cloning `json:"cloning"`
5055
}
5156

5257
// CloneListView represents a list of clone views.

‎pkg/models/retrieval.go‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,10 @@ const (
5555

5656
// Retrieving represents state of retrieval subsystem.
5757
type Retrieving struct {
58-
Mode RetrievalMode `json:"mode"`
59-
Status RefreshStatus `json:"status"`
60-
LastRefresh *time.Time `json:"lastRefresh"`
61-
NextRefresh *time.Time `json:"nextRefresh"`
62-
Alerts map[AlertType]Alert `json:"alerts"`
58+
Mode RetrievalMode `json:"mode"`
59+
Status RefreshStatus `json:"status"`
60+
LastRefresh *time.Time `json:"lastRefresh"`
61+
NextRefresh *time.Time `json:"nextRefresh"`
6362
}
6463

6564
// Alert describes retrieval subsystem alert.

‎pkg/retrieval/retrieval.go‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ func New(cfg *dblabCfg.Config, docker *client.Client, pm *pool.Manager, runner r
6969
jobSpecs: make(map[string]config.JobSpec, len(cfg.Retrieval.Jobs)),
7070
State: State{
7171
Status: models.Inactive,
72-
alerts: make(map[models.AlertType]models.Alert),
7372
},
7473
}
7574
}
@@ -100,15 +99,15 @@ func (r *Retrieval) Run(ctx context.Context) error {
10099

101100
fsManager, err := r.getPoolToDataRefresh()
102101
if err != nil {
103-
r.State.addAlert(models.RefreshFailed, "pool to perform data refresh not found")
102+
r.State.sendAlert(models.RefreshFailed, "pool to perform data refresh not found")
104103

105104
return fmt.Errorf("failed to choose pool to refresh: %w", err)
106105
}
107106

108107
log.Msg("Pool to perform a full refresh: ", fsManager.Pool().Name)
109108

110109
if err := r.run(runCtx, fsManager); err != nil {
111-
r.State.addAlert(models.RefreshFailed, err.Error())
110+
r.State.sendAlert(models.RefreshFailed, err.Error())
112111
return err
113112
}
114113

@@ -184,7 +183,6 @@ func (r *Retrieval) run(ctx context.Context, fsm pool.FSManager) (err error) {
184183
}
185184

186185
r.poolManager.MakeActive(poolByName)
187-
r.State.cleanAlerts()
188186

189187
return nil
190188
}
@@ -345,7 +343,7 @@ func (r *Retrieval) setupScheduler(ctx context.Context) {
345343
func (r *Retrieval) refreshFunc(ctx context.Context) func() {
346344
return func() {
347345
if err := r.fullRefresh(ctx); err != nil {
348-
r.State.addAlert(models.RefreshFailed, err.Error())
346+
r.State.sendAlert(models.RefreshFailed, err.Error())
349347
log.Err("Failed to run full-refresh: ", err)
350348
}
351349
}
@@ -363,7 +361,7 @@ func (r *Retrieval) fullRefresh(ctx context.Context) error {
363361
elementToUpdate := r.poolManager.GetPoolToUpdate()
364362

365363
if elementToUpdate == nil || elementToUpdate.Value == nil {
366-
r.State.addAlert(models.RefreshSkipped, "Pool to perform full refresh not found. Skip refreshing")
364+
r.State.sendAlert(models.RefreshSkipped, "Pool to perform full refresh not found. Skip refreshing")
367365
log.Msg("Pool to perform full refresh not found. Skip refreshing")
368366
return nil
369367
}
@@ -391,7 +389,6 @@ func (r *Retrieval) fullRefresh(ctx context.Context) error {
391389
}
392390

393391
r.poolManager.MakeActive(elementToUpdate)
394-
r.State.cleanAlerts()
395392

396393
return nil
397394
}

‎pkg/retrieval/state.go‎

Lines changed: 1 addition & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
package retrieval
66

77
import (
8-
"sync"
98
"time"
109

1110
"gitlab.com/postgres-ai/database-lab/v2/pkg/models"
@@ -16,46 +15,6 @@ type State struct {
1615
Mode models.RetrievalMode
1716
Status models.RefreshStatus
1817
LastRefresh *time.Time
19-
mu sync.Mutex
20-
alerts map[models.AlertType]models.Alert
2118
}
2219

23-
// Alerts returns all registered retrieval alerts.
24-
func (s *State) Alerts() map[models.AlertType]models.Alert {
25-
s.mu.Lock()
26-
defer s.mu.Unlock()
27-
28-
alerts := s.alerts
29-
30-
return alerts
31-
}
32-
33-
func (s *State) addAlert(alertType models.AlertType, message string) {
34-
s.mu.Lock()
35-
defer s.mu.Unlock()
36-
37-
alert, ok := s.alerts[alertType]
38-
if ok {
39-
alert.Count++
40-
alert.LastSeen = time.Now()
41-
alert.Message = message
42-
s.alerts[alertType] = alert
43-
44-
return
45-
}
46-
47-
alert = models.Alert{
48-
Level: models.AlertLevelByType(alertType),
49-
Message: message,
50-
LastSeen: time.Now(),
51-
Count: 1,
52-
}
53-
54-
s.alerts[alertType] = alert
55-
}
56-
57-
func (s *State) cleanAlerts() {
58-
s.mu.Lock()
59-
s.alerts = make(map[models.AlertType]models.Alert)
60-
s.mu.Unlock()
61-
}
20+
func (s *State) sendAlert(_ models.AlertType, _ string) {}

0 commit comments

Comments
 (0)