add: version column to crawls table

Author: dennis-tra

cmd/nebula/cmd_crawl.go

@@ -194,7 +194,7 @@ func CrawlAction(c *cli.Context) error {
 	// Inserting a crawl row into the db so that we
 	// can associate results with this crawl via
 	// its DB identifier
-	dbCrawl, err := dbc.InitCrawl(ctx)
+	dbCrawl, err := dbc.InitCrawl(ctx, cfg.Root.Version())
 	if err != nil {
 		return fmt.Errorf("creating crawl in db: %w", err)
 	}

pkg/db/client.go

@@ -16,7 +16,7 @@ import (
 
 type Client interface {
 	io.Closer
-	InitCrawl(ctx context.Context) (*models.Crawl, error)
+	InitCrawl(ctx context.Context, version string) (*models.Crawl, error)
 	UpdateCrawl(ctx context.Context, crawl *models.Crawl) error
 	PersistCrawlProperties(ctx context.Context, crawl *models.Crawl, properties map[string]map[string]int) error
 	PersistCrawlVisit(ctx context.Context, crawlID int, peerID peer.ID, maddrs []ma.Multiaddr, protocols []string, agentVersion string, connectDuration time.Duration, crawlDuration time.Duration, visitStartedAt time.Time, visitEndedAt time.Time, connectErrorStr string, crawlErrorStr string, properties null.JSON) (*InsertVisitResult, error)

pkg/db/client_db.go

@@ -255,10 +255,11 @@ func partitionQuery(table string, lower time.Time, upper time.Time) string {
 
 // InitCrawl inserts a crawl instance into the database in the state `started`.
 // This is done to receive a database ID that all subsequent database entities can be linked to.
-func (c *DBClient) InitCrawl(ctx context.Context) (*models.Crawl, error) {
+func (c *DBClient) InitCrawl(ctx context.Context, version string) (*models.Crawl, error) {
 	crawl := &models.Crawl{
 		State:     models.CrawlStateStarted,
 		StartedAt: time.Now(),
+		Version:   version,
 	}
 	return crawl, crawl.Insert(ctx, c.dbh, boil.Infer())
 }

pkg/db/client_json.go

@@ -66,10 +66,13 @@ func InitJSONClient(out string) (Client, error) {
 	return client, nil
 }
 
-func (c *JSONClient) InitCrawl(ctx context.Context) (*models.Crawl, error) {
+func (c *JSONClient) InitCrawl(ctx context.Context, version string) (*models.Crawl, error) {
 	crawl := &models.Crawl{
 		State:     models.CrawlStateStarted,
 		StartedAt: time.Now(),
+		Version:   version,
+		UpdatedAt: time.Now(),
+		CreatedAt: time.Now(),
 	}
 
 	data, err := json.Marshal(crawl)
@@ -85,6 +88,8 @@ func (c *JSONClient) InitCrawl(ctx context.Context) (*models.Crawl, error) {
 }
 
 func (c *JSONClient) UpdateCrawl(ctx context.Context, crawl *models.Crawl) error {
+	crawl.UpdatedAt = time.Now()
+
 	data, err := json.Marshal(crawl)
 	if err != nil {
 		return fmt.Errorf("marshal crawl json: %w", err)

pkg/db/client_noop.go

@@ -19,11 +19,12 @@ func InitNoopClient() *NoopClient {
 	return &NoopClient{}
 }
 
-func (n *NoopClient) InitCrawl(ctx context.Context) (*models.Crawl, error) {
+func (n *NoopClient) InitCrawl(ctx context.Context, version string) (*models.Crawl, error) {
 	return &models.Crawl{
 		ID:        1,
 		StartedAt: time.Now(),
 		State:     models.CrawlStateStarted,
+		Version:   version,
 		UpdatedAt: time.Now(),
 		CreatedAt: time.Now(),
 	}, nil

pkg/db/migrations/000027_alter_table_crawls_add_nebula_version.down.sql

@@ -0,0 +1 @@
+ALTER TABLE crawls DROP COLUMN version;

pkg/db/migrations/000027_alter_table_crawls_add_nebula_version.up.sql

@@ -0,0 +1,9 @@
+BEGIN;
+
+ALTER TABLE crawls ADD COLUMN version TEXT;
+
+UPDATE crawls SET version = 'undefined';
+
+ALTER TABLE crawls ALTER COLUMN version SET NOT NULL;
+
+COMMIT;