[otp] minor fixes

Author: capcom6

configs/config.example.yml

@@ -40,7 +40,7 @@ pubsub: # pubsub config
   url: memory:// # pubsub url (memory:// or redis://) [PUBSUB__URL]
 otp: # otp config
   ttl: 300 # otp ttl in seconds [OTP__TTL]
-  retries: 3 # otp generation retries [OTP__RETRIES]
+  retries: 3 # otp generation retries (collision handling) [OTP__RETRIES]
 
 ## Worker Config ##
 

internal/sms-gateway/modules/auth/service.go

@@ -66,7 +66,7 @@ func New(
 
 // GenerateUserCode generates a unique one-time user authorization code
 func (s *Service) GenerateUserCode(ctx context.Context, userID string) (*otp.Code, error) {
-	code, err := s.otpSvc.Generate(context.Background(), userID)
+	code, err := s.otpSvc.Generate(ctx, userID)
 	if err != nil {
 		return nil, fmt.Errorf("failed to generate code: %w", err)
 	}

internal/sms-gateway/otp/config.go

@@ -5,9 +5,10 @@ import (
 	"time"
 )
 
+// Config configures the OTP service.
 type Config struct {
-	TTL     time.Duration
-	Retries int
+	TTL     time.Duration `yaml:"ttl" envconfig:"OTP__TTL"`
+	Retries int           `yaml:"retries" envconfig:"OTP__RETRIES"`
 }
 
 func (c Config) Validate() error {

internal/sms-gateway/otp/errors.go

@@ -3,6 +3,8 @@ package otp
 import "errors"
 
 var (
+	// ErrInvalidConfig indicates that the OTP configuration is invalid.
 	ErrInvalidConfig = errors.New("invalid config")
-	ErrInitFailed    = errors.New("initialization failed")
+	// ErrInitFailed indicates that the OTP service failed to initialize.
+	ErrInitFailed = errors.New("initialization failed")
 )

internal/sms-gateway/otp/service.go

@@ -18,6 +18,14 @@ type Service struct {
 	logger *zap.Logger
 }
 
+// NewService returns a new OTP service.
+//
+// It takes the configuration for the OTP service,
+// a storage interface for storing the OTP codes,
+// and a logger for logging events.
+//
+// It returns an error if the configuration is invalid,
+// or if either the storage or logger is nil.
 func NewService(cfg Config, storage *Storage, logger *zap.Logger) (*Service, error) {
 	if err := cfg.Validate(); err != nil {
 		return nil, err
@@ -34,6 +42,14 @@ func NewService(cfg Config, storage *Storage, logger *zap.Logger) (*Service, err
 	return &Service{cfg: cfg, storage: storage, logger: logger}, nil
 }
 
+// Generate generates a new one-time user authorization code.
+//
+// It takes a context and the ID of the user for whom the code is being generated.
+//
+// It returns the generated code and an error. If the code can't be generated
+// within the configured number of retries, it returns an error.
+//
+// The generated code is stored with a TTL of the configured duration.
 func (s *Service) Generate(ctx context.Context, userID string) (*Code, error) {
 	var code string
 	var err error
@@ -65,6 +81,14 @@ func (s *Service) Generate(ctx context.Context, userID string) (*Code, error) {
 	return &Code{Code: code, ValidUntil: validUntil}, nil
 }
 
+// Validate validates a one-time user authorization code.
+//
+// It takes a context and the one-time code to be validated.
+//
+// It returns the user ID associated with the code, and an error.
+// If the code is invalid, it returns ErrKeyNotFound.
+// If there is an error while validating the code, it returns the error.
+// If the code is valid, it deletes the code from the storage and returns the user ID.
 func (s *Service) Validate(ctx context.Context, code string) (string, error) {
 	return s.storage.GetAndDelete(ctx, code)
 }