feat: enhance device management with new types and metadata handling

Author: raphico

internal/db/migrations/20250821113750_create_telemetry_table.sql

@@ -3,7 +3,7 @@
 CREATE TABLE IF NOT EXISTS telemetry (
     id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
     device_id UUID NOT NULL REFERENCES devices(id) ON DELETE CASCADE,
-    type VARCHAR(50) NOT NULL,
+    telemetry_type VARCHAR(50) NOT NULL,
     payload JSONB,
     recorded_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
 );

internal/db/telemetry_repository.go

@@ -29,7 +29,7 @@ func (r *TelemetryRepository) Create(ctx context.Context, t *telemetry.Telemetry
 	}
 
 	query := `
-		INSERT INTO telemetry (device_id, type, payload)	
+		INSERT INTO telemetry (device_id, telemetry_type, payload)	
 		VALUES ($1, $2, $3)
 		RETURNING id, recorded_at
 	`

internal/domain/device/device_type.go

@@ -0,0 +1,39 @@
+package device
+
+import (
+	"errors"
+	"regexp"
+	"strings"
+)
+
+type DeviceType struct {
+	value string
+}
+
+var deviceTypeRegex = regexp.MustCompile(`^[a-zA-Z0-9_-]+$`)
+
+func NewDeviceType(t string) (DeviceType, error) {
+	t = strings.TrimSpace(t)
+
+	if len(t) == 0 {
+		return DeviceType{}, errors.New("device type is required")
+	}
+
+	if len(t) < 3 {
+		return DeviceType{}, errors.New("device type must be at least 3 characters")
+	}
+
+	if len(t) > 50 {
+		return DeviceType{}, errors.New("device type must be at most 50 characters")
+	}
+
+	if matches := deviceTypeRegex.MatchString(t); !matches {
+		return DeviceType{}, errors.New("device type can only contain letters, numbers, _ and -")
+	}
+
+	return DeviceType{value: t}, nil
+}
+
+func (t DeviceType) String() string {
+	return t.value
+}

internal/domain/device/errors.go

@@ -3,12 +3,5 @@ package device
 import "errors"
 
 var (
-	ErrDeviceNotFound    = errors.New("device not found")
-	ErrNameRequired      = errors.New("device name is required")
-	ErrNameTooShort      = errors.New("device name must be at least 3 characters")
-	ErrNameTooLong       = errors.New("device name must be at most 50 characters")
-	ErrNameInvalidChars  = errors.New("device name may only contain letters, numbers, underscores, periods, or hyphens")
-	ErrInvalidStatus     = errors.New("device status must be either 'offline' or 'online'")
-	ErrInvalidDeviceType = errors.New("device type is invalid")
-	ErrInvalidMetadata   = errors.New("device metadata is invalid")
+	ErrDeviceNotFound = errors.New("device not found")
 )

internal/domain/device/metadata.go

@@ -0,0 +1,22 @@
+package device
+
+import "errors"
+
+type Metadata map[string]any
+
+func NewMetadata(raw any) (Metadata, error) {
+	if raw == nil {
+		return Metadata{}, errors.New("device metadata is required")
+	}
+
+	p, ok := raw.(map[string]any)
+	if !ok {
+		return Metadata{}, errors.New("device metadata must be a valid JSON object")
+	}
+
+	if len(p) == 0 {
+		return Metadata{}, errors.New("device metadata cannot be empty")
+	}
+
+	return Metadata(p), nil
+}

internal/domain/device/name.go

@@ -1,6 +1,7 @@
 package device
 
 import (
+	"errors"
 	"regexp"
 	"strings"
 )
@@ -9,23 +10,24 @@ type Name struct {
 	value string
 }
 
+var nameRegex = regexp.MustCompile(`^[a-zA-Z0-9 _.-]+$`)
+
 func NewName(value string) (Name, error) {
 	value = strings.TrimSpace(value)
 
 	if value == "" {
-		return Name{}, ErrNameRequired
+		return Name{}, errors.New("device name is required")
 	}
 
 	if len(value) < 3 {
-		return Name{}, ErrNameTooShort
+		return Name{}, errors.New("device name must be at least 3 characters")
 	}
 	if len(value) > 50 {
-		return Name{}, ErrNameTooLong
+		return Name{}, errors.New("device name must be at most 50 characters")
 	}
 
-	valid := regexp.MustCompile(`^[a-zA-Z0-9 _.-]+$`)
-	if !valid.MatchString(value) {
-		return Name{}, ErrNameInvalidChars
+	if !nameRegex.MatchString(value) {
+		return Name{}, errors.New("device name may only contain letters, numbers, underscores, periods, or hyphens")
 	}
 
 	return Name{value: value}, nil

internal/domain/device/service.go

@@ -14,7 +14,7 @@ type Service struct {
 type UpdateDeviceInput struct {
 	Name       *Name
 	DeviceType *DeviceType
-	Metadata   *map[string]any
+	Metadata   *Metadata
 }
 
 func NewService(repo Repository) *Service {
@@ -29,7 +29,7 @@ func (s *Service) CreateDevice(
 	name Name,
 	status Status,
 	deviceType DeviceType,
-	metadata map[string]any,
+	metadata Metadata,
 ) (*Device, error) {
 	dev := NewDevice(userId, name, status, deviceType, metadata)
 

internal/domain/device/status.go

@@ -1,5 +1,7 @@
 package device
 
+import "errors"
+
 type Status string
 
 const (
@@ -14,6 +16,6 @@ func NewStatus(value string) (Status, error) {
 	case string(StatusOnline):
 		return StatusOnline, nil
 	default:
-		return "", ErrInvalidStatus
+		return "", errors.New("device status must be either 'offline' or 'online'")
 	}
 }

internal/domain/device/type.go

@@ -1,6 +1,7 @@
 package user
 
 import (
+	"errors"
 	"net/mail"
 	"strings"
 )
@@ -12,14 +13,12 @@ type Email struct {
 func NewEmail(value string) (Email, error) {
 	value = strings.TrimSpace(value)
 
-	// Required
 	if value == "" {
-		return Email{}, ErrEmailRequired
+		return Email{}, errors.New("email is required")
 	}
 
-	// Validate format
 	if _, err := mail.ParseAddress(value); err != nil {
-		return Email{}, ErrEmailInvalid
+		return Email{}, errors.New("invalid email format")
 	}
 
 	return Email{value: value}, nil